blob: b1eca64f4d9c599181b6f764f1262a66981f45b5 [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;
Antoine Pitrou8ad982c2011-11-15 22:27:32 +01001198 PyObject *cpathname_tmp;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001199#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001200 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001201#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001202 mode_t dirmode = (srcstat->st_mode |
1203 S_IXUSR | S_IXGRP | S_IXOTH |
1204 S_IWUSR | S_IWGRP | S_IWOTH);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001205 PyObject *dirbytes;
Antoine Pitrou707033a2011-10-17 19:28:44 +02001206 PyObject *cpathbytes, *cpathbytes_tmp;
Victor Stinner783c82c2011-04-20 03:27:51 +02001207#endif
Charles-François Natali0c929d92011-11-10 19:12:29 +01001208 int fd;
Victor Stinner783c82c2011-04-20 03:27:51 +02001209 PyObject *dirname;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001210 Py_UCS4 *dirsep;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001211 int res, ok;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001212
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001213 /* Ensure that the __pycache__ directory exists. */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001214 cpathname_ucs4 = PyUnicode_AsUCS4Copy(cpathname);
1215 if (!cpathname_ucs4)
1216 return;
1217 dirsep = rightmost_sep(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001218 if (dirsep == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001219 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001220 PySys_FormatStderr("# no %s path found %R\n", CACHEDIR, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001221 return;
1222 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001223 dirname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
1224 cpathname_ucs4,
1225 dirsep - cpathname_ucs4);
1226 PyMem_Free(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001227 if (dirname == NULL) {
1228 PyErr_Clear();
1229 return;
1230 }
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001231
1232#ifdef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001233 res = CreateDirectoryW(PyUnicode_AS_UNICODE(dirname), NULL);
1234 ok = (res != 0);
1235 if (!ok && GetLastError() == ERROR_ALREADY_EXISTS)
1236 ok = 1;
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001237#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001238 dirbytes = PyUnicode_EncodeFSDefault(dirname);
1239 if (dirbytes == NULL) {
1240 PyErr_Clear();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001241 return;
1242 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001243 res = mkdir(PyBytes_AS_STRING(dirbytes), dirmode);
1244 Py_DECREF(dirbytes);
1245 if (0 <= res)
1246 ok = 1;
1247 else
1248 ok = (errno == EEXIST);
1249#endif
1250 if (!ok) {
1251 if (Py_VerboseFlag)
1252 PySys_FormatStderr("# cannot create cache dir %R\n", dirname);
1253 Py_DECREF(dirname);
1254 return;
1255 }
1256 Py_DECREF(dirname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001257
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001258 /* We first write to a tmp file and then take advantage
Antoine Pitrou8ad982c2011-11-15 22:27:32 +01001259 of atomic renaming (which *should* be true even under Windows).
1260 As in importlib, we use id(something) to generate a pseudo-random
1261 filename. mkstemp() can't be used since it doesn't allow specifying
1262 the file access permissions.
1263 */
1264 cpathname_tmp = PyUnicode_FromFormat("%U.%zd",
1265 cpathname, (Py_ssize_t) co);
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001266 if (cpathname_tmp == NULL) {
1267 PyErr_Clear();
1268 return;
1269 }
Antoine Pitrou8ad982c2011-11-15 22:27:32 +01001270#ifdef MS_WINDOWS
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001271 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname_tmp));
1272 fd = _wopen(PyUnicode_AS_UNICODE(cpathname_tmp),
1273 O_EXCL | O_CREAT | O_WRONLY | O_BINARY,
1274 mode);
Victor Stinner783c82c2011-04-20 03:27:51 +02001275 if (0 <= fd)
1276 fp = fdopen(fd, "wb");
1277 else
1278 fp = NULL;
1279#else
Antoine Pitrou8ad982c2011-11-15 22:27:32 +01001280 cpathbytes_tmp = PyUnicode_EncodeFSDefault(cpathname_tmp);
1281 Py_DECREF(cpathname_tmp);
1282 if (cpathbytes_tmp == NULL) {
1283 PyErr_Clear();
1284 return;
1285 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001286 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1287 if (cpathbytes == NULL) {
1288 PyErr_Clear();
1289 return;
1290 }
Charles-François Natali0c929d92011-11-10 19:12:29 +01001291 fd = open(PyBytes_AS_STRING(cpathbytes_tmp),
1292 O_CREAT | O_EXCL | O_WRONLY, 0666);
Charles-François Natalie695eec2011-10-31 20:47:31 +01001293 if (0 <= fd)
1294 fp = fdopen(fd, "wb");
1295 else
1296 fp = NULL;
Victor Stinner783c82c2011-04-20 03:27:51 +02001297#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001298 if (fp == NULL) {
1299 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001300 PySys_FormatStderr(
1301 "# can't create %R\n", cpathname);
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001302#ifdef MS_WINDOWS
1303 Py_DECREF(cpathname_tmp);
1304#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001305 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001306 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001307#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001308 return;
1309 }
1310 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1311 /* First write a 0 for mtime */
1312 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1313 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001314 fflush(fp);
1315 /* Now write the true mtime */
1316 fseek(fp, 4L, 0);
1317 assert(mtime < LONG_MAX);
1318 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001319 if (fflush(fp) != 0 || ferror(fp)) {
1320 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001321 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001322 /* Don't keep partial file */
1323 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001324#ifdef MS_WINDOWS
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001325 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname_tmp));
1326 Py_DECREF(cpathname_tmp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001327#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001328 (void) unlink(PyBytes_AS_STRING(cpathbytes_tmp));
Victor Stinner2f42ae52011-03-20 00:41:24 +01001329 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001330 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001331#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001332 return;
1333 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001334 fclose(fp);
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001335 /* Do a (hopefully) atomic rename */
1336#ifdef MS_WINDOWS
1337 if (!MoveFileExW(PyUnicode_AS_UNICODE(cpathname_tmp),
1338 PyUnicode_AS_UNICODE(cpathname),
1339 MOVEFILE_REPLACE_EXISTING)) {
1340 if (Py_VerboseFlag)
1341 PySys_FormatStderr("# can't write %R\n", cpathname);
1342 /* Don't keep tmp file */
1343 (void) DeleteFileW(PyUnicode_AS_UNICODE(cpathname_tmp));
1344 Py_DECREF(cpathname_tmp);
1345 return;
1346 }
1347 Py_DECREF(cpathname_tmp);
1348#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001349 if (rename(PyBytes_AS_STRING(cpathbytes_tmp),
1350 PyBytes_AS_STRING(cpathbytes))) {
1351 if (Py_VerboseFlag)
1352 PySys_FormatStderr("# can't write %R\n", cpathname);
1353 /* Don't keep tmp file */
1354 unlink(PyBytes_AS_STRING(cpathbytes_tmp));
1355 Py_DECREF(cpathbytes);
1356 Py_DECREF(cpathbytes_tmp);
1357 return;
1358 }
1359 Py_DECREF(cpathbytes);
1360 Py_DECREF(cpathbytes_tmp);
1361#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001362 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001363 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001364}
1365
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001366static void
1367update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1368{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001369 PyObject *constants, *tmp;
1370 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 if (PyUnicode_Compare(co->co_filename, oldname))
1373 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001374
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001375 tmp = co->co_filename;
1376 co->co_filename = newname;
1377 Py_INCREF(co->co_filename);
1378 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001379
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001380 constants = co->co_consts;
1381 n = PyTuple_GET_SIZE(constants);
1382 for (i = 0; i < n; i++) {
1383 tmp = PyTuple_GET_ITEM(constants, i);
1384 if (PyCode_Check(tmp))
1385 update_code_filenames((PyCodeObject *)tmp,
1386 oldname, newname);
1387 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001388}
1389
Victor Stinner2f42ae52011-03-20 00:41:24 +01001390static void
1391update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001392{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001393 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001394
Victor Stinner2f42ae52011-03-20 00:41:24 +01001395 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1396 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001397
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001398 oldname = co->co_filename;
1399 Py_INCREF(oldname);
1400 update_code_filenames(co, oldname, newname);
1401 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001402}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001403
Brett Cannon442c9b92011-03-23 16:14:42 -07001404static PyObject *
1405imp_fix_co_filename(PyObject *self, PyObject *args)
1406{
1407 PyObject *co;
1408 PyObject *file_path;
1409
1410 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
1411 return NULL;
1412
1413 if (!PyCode_Check(co)) {
1414 PyErr_SetString(PyExc_TypeError,
1415 "first argument must be a code object");
1416 return NULL;
1417 }
1418
1419 if (!PyUnicode_Check(file_path)) {
1420 PyErr_SetString(PyExc_TypeError,
1421 "second argument must be a string");
1422 return NULL;
1423 }
1424
1425 update_compiled_module((PyCodeObject*)co, file_path);
1426
1427 Py_RETURN_NONE;
1428}
1429
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001430/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001431 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1432 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001433
Guido van Rossum79f25d91997-04-29 20:08:16 +00001434static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001435load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001436{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001437 struct stat st;
1438 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001439 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001440 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001441 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001442
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001443 if (fstat(fileno(fp), &st) != 0) {
1444 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001445 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001446 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001447 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 }
Fred Drake4c82b232000-06-30 16:18:57 +00001449#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001450 /* Python's .pyc timestamp handling presumes that the timestamp fits
1451 in 4 bytes. This will be fine until sometime in the year 2038,
1452 when a 4-byte signed time_t will overflow.
1453 */
1454 if (st.st_mtime >> 32) {
1455 PyErr_SetString(PyExc_OverflowError,
1456 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001457 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001458 }
Fred Drake4c82b232000-06-30 16:18:57 +00001459#endif
Martin v. Löwis30260a72011-10-23 17:35:46 +02001460 if (PyUnicode_READY(pathname) < 0)
1461 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001462 cpathname = make_compiled_pathname(pathname, !Py_OptimizeFlag);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001463
1464 if (cpathname != NULL)
1465 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1466 else
1467 fpc = NULL;
1468
1469 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001470 co = read_compiled_module(cpathname, fpc);
1471 fclose(fpc);
1472 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001473 goto error;
1474 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001475 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001476 PySys_FormatStderr("import %U # precompiled from %R\n",
1477 name, cpathname);
1478 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1479 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001480 }
1481 else {
1482 co = parse_source_module(pathname, fp);
1483 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001484 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001485 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001486 PySys_FormatStderr("import %U # from %R\n",
Victor Stinner98dbba52011-03-14 15:15:47 -04001487 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001488 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001489 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1490 if (ro == NULL || !PyObject_IsTrue(ro))
1491 write_compiled_module(co, cpathname, &st);
1492 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001493 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1494 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001495 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001497
Victor Stinner2f42ae52011-03-20 00:41:24 +01001498error:
1499 Py_XDECREF(cpathbytes);
1500 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001501 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001502}
1503
Christian Heimes3b06e532008-01-07 20:12:44 +00001504/* Get source file -> unicode or None
1505 * Returns the path to the py file if available, else the given path
1506 */
1507static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001508get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001509{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001510 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001511 Py_UCS4 *fileuni;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001512 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001513 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001514
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001515 len = PyUnicode_GET_LENGTH(filename);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001516 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001517 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001518
Victor Stinnerc9abda02011-03-14 13:33:46 -04001519 /* don't match *.pyc or *.pyo? */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001520 fileuni = PyUnicode_AsUCS4Copy(filename);
1521 if (!fileuni)
1522 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001523 if (len < 5
1524 || fileuni[len-4] != '.'
1525 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1526 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1527 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001529 /* Start by trying to turn PEP 3147 path into source path. If that
1530 * fails, just chop off the trailing character, i.e. legacy pyc path
1531 * to py.
1532 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001533 py = make_source_pathname(filename);
1534 if (py == NULL) {
1535 PyErr_Clear();
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001536 py = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001537 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001538 if (py == NULL)
1539 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001540
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001541 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode)) {
1542 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001543 return py;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001544 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001545 Py_DECREF(py);
1546 goto unchanged;
1547
1548error:
1549 PyErr_Clear();
1550unchanged:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001551 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001552 Py_INCREF(filename);
1553 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001554}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001555
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001556/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001557static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001558static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001559 PyObject **, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001560static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001561
1562/* Load a package and return its module object WITH INCREMENTED
1563 REFERENCE COUNT */
1564
1565static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001566load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001567{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001568 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001569 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001570 int err;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001571 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001572 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001573
Victor Stinnerc9abda02011-03-14 13:33:46 -04001574 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001575 if (m == NULL)
1576 return NULL;
1577 if (Py_VerboseFlag)
Victor Stinner98dbba52011-03-14 15:15:47 -04001578 PySys_FormatStderr("import %U # directory %R\n",
1579 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001580 file = get_sourcefile(pathname);
1581 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001582 return NULL;
1583 path_list = Py_BuildValue("[O]", file);
1584 if (path_list == NULL) {
1585 Py_DECREF(file);
1586 return NULL;
1587 }
1588 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001589 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001590 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001591 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001592 err = PyDict_SetItemString(d, "__path__", path_list);
1593 if (err != 0) {
1594 Py_DECREF(path_list);
1595 return NULL;
1596 }
Victor Stinner533d7832011-03-14 13:22:54 -04001597 fdp = find_module(name, initstr, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001598 &bufobj, &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001599 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001600 if (fdp == NULL) {
1601 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1602 PyErr_Clear();
1603 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001604 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001605 }
1606 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001607 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001608 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001609 m = load_module(name, fp, bufobj, fdp->type, NULL);
1610 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001611 if (fp != NULL)
1612 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001614}
1615
1616
1617/* Helper to test for built-in module */
1618
1619static int
Victor Stinner95872862011-03-07 18:20:56 +01001620is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001621{
Victor Stinner95872862011-03-07 18:20:56 +01001622 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001624 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1625 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001626 if (PyImport_Inittab[i].initfunc == NULL)
1627 return -1;
1628 else
1629 return 1;
1630 }
1631 }
1632 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001633}
1634
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001635
Just van Rossum52e14d62002-12-30 22:08:05 +00001636/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1637 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001638 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001639 that can handle the path item. Return None if no hook could;
1640 this tells our caller it should fall back to the builtin
1641 import mechanism. Cache the result in path_importer_cache.
1642 Returns a borrowed reference. */
1643
1644static PyObject *
1645get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001646 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001647{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 PyObject *importer;
1649 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001650
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001651 /* These conditions are the caller's responsibility: */
1652 assert(PyList_Check(path_hooks));
1653 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001654
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001655 nhooks = PyList_Size(path_hooks);
1656 if (nhooks < 0)
1657 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001658
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001659 importer = PyDict_GetItem(path_importer_cache, p);
1660 if (importer != NULL)
1661 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001662
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001663 /* set path_importer_cache[p] to None to avoid recursion */
1664 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1665 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001666
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001667 for (j = 0; j < nhooks; j++) {
1668 PyObject *hook = PyList_GetItem(path_hooks, j);
1669 if (hook == NULL)
1670 return NULL;
1671 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1672 if (importer != NULL)
1673 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001674
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001675 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1676 return NULL;
1677 }
1678 PyErr_Clear();
1679 }
1680 if (importer == NULL) {
1681 importer = PyObject_CallFunctionObjArgs(
1682 (PyObject *)&PyNullImporter_Type, p, NULL
1683 );
1684 if (importer == NULL) {
1685 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1686 PyErr_Clear();
1687 return Py_None;
1688 }
1689 }
1690 }
1691 if (importer != NULL) {
1692 int err = PyDict_SetItem(path_importer_cache, p, importer);
1693 Py_DECREF(importer);
1694 if (err != 0)
1695 return NULL;
1696 }
1697 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001698}
1699
Christian Heimes9cd17752007-11-18 19:35:23 +00001700PyAPI_FUNC(PyObject *)
1701PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001702 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001703
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001704 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1705 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1706 importer = get_path_importer(path_importer_cache,
1707 path_hooks, path);
1708 }
1709 }
1710 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1711 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001712}
1713
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001714/* Search the path (default sys.path) for a module. Return the
1715 corresponding filedescr struct, and (via return arguments) the
1716 pathname and an open file. Return NULL if the module is not found. */
1717
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001718#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001719extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1720 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001721#endif
1722
Victor Stinner547a2a62011-03-20 03:07:28 +01001723/* Forward */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001724static int case_ok(PyObject *, Py_ssize_t, PyObject *);
Victor Stinner547a2a62011-03-20 03:07:28 +01001725static int find_init_module(PyObject *);
Just van Rossum52e14d62002-12-30 22:08:05 +00001726static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001727
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001728/* Get the path of a module: get its importer and call importer.find_module()
1729 hook, or check if the module if a package (if path/__init__.py exists).
1730
1731 -1: error: a Python error occurred
1732 0: ignore: an error occurred because of invalid data, but the error is not
1733 important enough to be reported.
1734 1: get path: module not found, but *buf contains its path
1735 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1736 and *buf is the path */
1737
1738static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001739find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001740 PyObject *path_hooks, PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001741 PyObject **p_path, PyObject **p_loader, struct filedescr **p_fd)
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001742{
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001743 PyObject *path_unicode, *filename = NULL;
1744 Py_ssize_t len, pos;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001745 struct stat statbuf;
1746 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001747 int result, addsep;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001748
1749 if (PyUnicode_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001750 Py_INCREF(path);
1751 path_unicode = path;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001752 }
1753 else if (PyBytes_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001754 path_unicode = PyUnicode_DecodeFSDefaultAndSize(
1755 PyBytes_AS_STRING(path), PyBytes_GET_SIZE(path));
1756 if (path_unicode == NULL)
1757 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001758 }
1759 else
1760 return 0;
1761
Victor Stinner46084ba2011-10-06 02:39:42 +02001762 if (PyUnicode_READY(path_unicode))
1763 return -1;
1764
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001765 len = PyUnicode_GET_LENGTH(path_unicode);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001766 if (PyUnicode_FindChar(path_unicode, 0, 0, len, 1) != -1) {
1767 result = 0;
1768 goto out; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001769 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001770
1771 /* sys.path_hooks import hook */
1772 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001773 _Py_IDENTIFIER(find_module);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001774 PyObject *importer;
1775
1776 importer = get_path_importer(path_importer_cache,
1777 path_hooks, path);
1778 if (importer == NULL) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001779 result = -1;
1780 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001781 }
1782 /* Note: importer is a borrowed reference */
1783 if (importer != Py_None) {
1784 PyObject *loader;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001785 loader = _PyObject_CallMethodId(importer,
1786 &PyId_find_module, "O", fullname);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001787 if (loader == NULL) {
1788 result = -1; /* error */
1789 goto out;
1790 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001791 if (loader != Py_None) {
1792 /* a loader was found */
1793 *p_loader = loader;
1794 *p_fd = &importhookdescr;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001795 result = 2;
1796 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001797 }
1798 Py_DECREF(loader);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001799 result = 0;
1800 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001801 }
1802 }
1803 /* no hook was found, use builtin import */
1804
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001805 addsep = 0;
1806 if (len > 0 && PyUnicode_READ_CHAR(path_unicode, len-1) != SEP
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001807#ifdef ALTSEP
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001808 && PyUnicode_READ_CHAR(path_unicode, len-1) != ALTSEP
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001809#endif
1810 )
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001811 addsep = 1;
1812 filename = PyUnicode_New(len + PyUnicode_GET_LENGTH(name) + addsep,
1813 Py_MAX(PyUnicode_MAX_CHAR_VALUE(path_unicode),
1814 PyUnicode_MAX_CHAR_VALUE(name)));
1815 if (filename == NULL) {
1816 result = -1;
1817 goto out;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001818 }
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001819 PyUnicode_CopyCharacters(filename, 0, path_unicode, 0, len);
1820 pos = len;
1821 if (addsep)
1822 PyUnicode_WRITE(PyUnicode_KIND(filename),
1823 PyUnicode_DATA(filename),
1824 pos++, SEP);
1825 PyUnicode_CopyCharacters(filename, pos, name, 0,
1826 PyUnicode_GET_LENGTH(name));
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001827
1828 /* Check for package import (buf holds a directory name,
1829 and there's an __init__ module in that directory */
1830#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001831 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001832 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1833 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001834 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001835
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001836 match = case_ok(filename, 0, name);
1837 if (match < 0) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001838 result = -1;
1839 goto out;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001840 }
1841 if (match) { /* case matches */
1842 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001843 *p_path = filename;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001844 filename = NULL;
Victor Stinnerd0296212011-03-14 14:04:10 -04001845 *p_fd = &fd_package;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001846 result = 2;
1847 goto out;
Victor Stinnerd0296212011-03-14 14:04:10 -04001848 }
1849 else {
1850 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001851 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001852 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001853 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001854 if (err) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001855 result = -1;
1856 goto out;
Victor Stinner547a2a62011-03-20 03:07:28 +01001857 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001858 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001859 }
1860 }
1861#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001862 *p_path = filename;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001863 filename = NULL;
1864 result = 1;
1865 out:
1866 Py_DECREF(path_unicode);
1867 Py_XDECREF(filename);
1868 return result;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001869}
1870
1871/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001872 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001873
1874 If the module is found, return a file descriptor, write the path in
1875 *p_filename, write the pointer to the file object into *p_fp, and (if
1876 p_loader is not NULL) the loader into *p_loader.
1877
1878 Otherwise, raise an exception and return NULL. */
1879
Victor Stinner37580282011-03-20 01:34:43 +01001880static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001881find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001882 PyObject *search_path_list, PyObject *path_hooks,
1883 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001884 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001885{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001886 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001887 struct filedescr *fdp = NULL;
1888 char *filemode;
1889 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001890 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001891 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001892
Victor Stinner37580282011-03-20 01:34:43 +01001893 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001894 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001895 PyObject *path;
1896 int ok;
1897
1898 path = PyList_GetItem(search_path_list, i);
1899 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001900 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001901
Victor Stinner2fd76e42011-03-14 15:19:39 -04001902 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001903 ok = find_module_path(fullname, name, path,
1904 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001905 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001906 if (ok < 0)
1907 return NULL;
1908 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001909 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001910 if (ok == 2) {
1911 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001912 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001913 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001914
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001915 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001916 struct stat statbuf;
1917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001918 filemode = fdp->mode;
1919 if (filemode[0] == 'U')
1920 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001921
Victor Stinner2fd76e42011-03-14 15:19:39 -04001922 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1923 if (filename == NULL) {
1924 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001925 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001926 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001927
1928 if (Py_VerboseFlag > 1)
1929 PySys_FormatStderr("# trying %R\n", filename);
1930
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001931 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
1932 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1933 {
1934 Py_DECREF(filename);
1935 continue;
1936 }
1937
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001938 fp = _Py_fopen(filename, filemode);
1939 if (fp == NULL) {
1940 Py_DECREF(filename);
Victor Stinner925ef392011-06-20 15:01:10 +02001941 if (PyErr_Occurred()) {
1942 Py_DECREF(prefix);
1943 return NULL;
1944 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001945 continue;
1946 }
1947 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1948 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001949 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001950 Py_DECREF(filename);
1951 return NULL;
1952 }
1953 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001954 Py_DECREF(prefix);
1955 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001956 *p_fp = fp;
1957 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001958 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001959 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001960
1961 fclose(fp);
1962 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001963 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001964 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001965 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001966 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04001967 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04001968 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001969}
1970
Victor Stinner37580282011-03-20 01:34:43 +01001971/* Find a module:
1972
1973 - try find_module() of each sys.meta_path hook
1974 - try find_frozen()
1975 - try is_builtin()
1976 - try _PyWin_FindRegisteredModule() (Windows only)
1977 - otherwise, call find_module_path_list() with search_path_list (if not
1978 NULL) or sys.path
1979
Victor Stinner2fd76e42011-03-14 15:19:39 -04001980 fullname can be NULL, but only if p_loader is NULL.
1981
Victor Stinner37580282011-03-20 01:34:43 +01001982 Return:
1983
1984 - &fd_builtin (C_BUILTIN) if it is a builtin
1985 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04001986 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01001987 if it is a package
1988 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1989 importer loader was found
1990 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1991 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04001992 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01001993 - NULL on error
1994
Victor Stinner2fd76e42011-03-14 15:19:39 -04001995 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
1996 Eg. *p_path is set to NULL for a builtin package.
1997*/
Victor Stinner37580282011-03-20 01:34:43 +01001998
1999static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002000find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002001 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01002002{
2003 Py_ssize_t i, npath;
2004 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
2005 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
2006 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01002007
Victor Stinner2fd76e42011-03-14 15:19:39 -04002008 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01002009 *p_fp = NULL;
2010 if (p_loader != NULL)
2011 *p_loader = NULL;
2012
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002013 if (PyUnicode_GET_LENGTH(name) > MAXPATHLEN) {
2014 PyErr_SetString(PyExc_OverflowError,
2015 "module name is too long");
2016 return NULL;
2017 }
2018
Victor Stinner37580282011-03-20 01:34:43 +01002019 /* sys.meta_path import hook */
2020 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002021 _Py_IDENTIFIER(find_module);
Victor Stinner37580282011-03-20 01:34:43 +01002022 PyObject *meta_path;
2023
2024 meta_path = PySys_GetObject("meta_path");
2025 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02002026 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002027 "sys.meta_path must be a list of "
2028 "import hooks");
2029 return NULL;
2030 }
2031 Py_INCREF(meta_path); /* zap guard */
2032 npath = PyList_Size(meta_path);
2033 for (i = 0; i < npath; i++) {
2034 PyObject *loader;
2035 PyObject *hook = PyList_GetItem(meta_path, i);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002036 loader = _PyObject_CallMethodId(hook, &PyId_find_module,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002037 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01002038 search_path_list != NULL ?
2039 search_path_list : Py_None);
2040 if (loader == NULL) {
2041 Py_DECREF(meta_path);
2042 return NULL; /* true error */
2043 }
2044 if (loader != Py_None) {
2045 /* a loader was found */
2046 *p_loader = loader;
2047 Py_DECREF(meta_path);
2048 return &importhookdescr;
2049 }
2050 Py_DECREF(loader);
2051 }
2052 Py_DECREF(meta_path);
2053 }
2054
Victor Stinnerdf75a022011-03-14 13:40:04 -04002055 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002056 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01002057
2058 if (search_path_list == NULL) {
2059#ifdef MS_COREDLL
2060 FILE *fp;
2061 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01002062#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04002063 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01002064 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01002065#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04002066 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01002067 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01002068 *p_fp = fp;
2069 return fdp;
2070 }
2071 else if (PyErr_Occurred())
2072 return NULL;
2073#endif
Victor Stinner37580282011-03-20 01:34:43 +01002074 search_path_list = PySys_GetObject("path");
2075 }
2076
2077 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
Victor Stinner16191322011-09-15 19:28:05 +02002078 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002079 "sys.path must be a list of directory names");
2080 return NULL;
2081 }
2082
2083 path_hooks = PySys_GetObject("path_hooks");
2084 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02002085 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002086 "sys.path_hooks must be a list of "
2087 "import hooks");
2088 return NULL;
2089 }
2090 path_importer_cache = PySys_GetObject("path_importer_cache");
2091 if (path_importer_cache == NULL ||
2092 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02002093 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002094 "sys.path_importer_cache must be a dict");
2095 return NULL;
2096 }
2097
2098 return find_module_path_list(fullname, name,
2099 search_path_list, path_hooks,
2100 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002101 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002102}
2103
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002104/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002105 * The arguments here are tricky, best shown by example:
2106 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2107 * ^ ^ ^ ^
2108 * |--------------------- buf ---------------------|
2109 * |------------------- len ------------------|
2110 * |------ name -------|
2111 * |----- namelen -----|
2112 * buf is the full path, but len only counts up to (& exclusive of) the
2113 * extension. name is the module name, also exclusive of extension.
2114 *
2115 * We've already done a successful stat() or fopen() on buf, so know that
2116 * there's some match, possibly case-insensitive.
2117 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002118 * case_bytes() is to return 1 if there's a case-sensitive match for
2119 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002120 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002121 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002122 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002123 * on platforms with case-insensitive filesystems. It's trivial to implement
2124 * for case-sensitive filesystems. It's pretty much a cross-platform
2125 * nightmare for systems with case-insensitive filesystems.
2126 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002127
Tim Peters50d8d372001-02-28 05:34:27 +00002128/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002129 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002130 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002131#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002132#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002133
Tim Peters50d8d372001-02-28 05:34:27 +00002134#elif defined(DJGPP)
2135#include <dir.h>
2136
Jason Tishler7961aa62005-05-20 00:56:54 +00002137#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002138#include <sys/types.h>
2139#include <dirent.h>
2140
Andrew MacIntyred9400542002-02-26 11:41:34 +00002141#elif defined(PYOS_OS2)
2142#define INCL_DOS
2143#define INCL_DOSERRORS
2144#define INCL_NOPMAPI
2145#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002146#endif
2147
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002148#if defined(DJGPP) \
2149 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2150 && defined(HAVE_DIRENT_H)) \
2151 || defined(PYOS_OS2)
2152# define USE_CASE_OK_BYTES
2153#endif
2154
2155
2156#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002157static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002158case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002159{
Tim Peters50d8d372001-02-28 05:34:27 +00002160/* Pick a platform-specific implementation; the sequence of #if's here should
2161 * match the sequence just above.
2162 */
2163
Tim Peters50d8d372001-02-28 05:34:27 +00002164/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002165#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002166 struct ffblk ffblk;
2167 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002168
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002169 if (Py_GETENV("PYTHONCASEOK") != NULL)
2170 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002171
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002172 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2173 if (done) {
2174 PyErr_Format(PyExc_NameError,
2175 "Can't find file for module %.100s\n(filename %.300s)",
2176 name, buf);
Victor Stinner9c61e242011-03-22 01:22:27 +01002177 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002178 }
2179 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002180
Jason Tishler7961aa62005-05-20 00:56:54 +00002181/* new-fangled macintosh (macosx) or Cygwin */
2182#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002183 DIR *dirp;
2184 struct dirent *dp;
2185 char dirname[MAXPATHLEN + 1];
2186 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002187
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002188 if (Py_GETENV("PYTHONCASEOK") != NULL)
2189 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002190
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002191 /* Copy the dir component into dirname; substitute "." if empty */
2192 if (dirlen <= 0) {
2193 dirname[0] = '.';
2194 dirname[1] = '\0';
2195 }
2196 else {
2197 assert(dirlen <= MAXPATHLEN);
2198 memcpy(dirname, buf, dirlen);
2199 dirname[dirlen] = '\0';
2200 }
2201 /* Open the directory and search the entries for an exact match. */
2202 dirp = opendir(dirname);
2203 if (dirp) {
2204 char *nameWithExt = buf + len - namelen;
2205 while ((dp = readdir(dirp)) != NULL) {
2206 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002207#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002208 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002209#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002210 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002211#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002212 if (thislen >= namelen &&
2213 strcmp(dp->d_name, nameWithExt) == 0) {
2214 (void)closedir(dirp);
2215 return 1; /* Found */
2216 }
2217 }
2218 (void)closedir(dirp);
2219 }
2220 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002221
Andrew MacIntyred9400542002-02-26 11:41:34 +00002222/* OS/2 */
2223#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002224 HDIR hdir = 1;
2225 ULONG srchcnt = 1;
2226 FILEFINDBUF3 ffbuf;
2227 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002228
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002229 if (Py_GETENV("PYTHONCASEOK") != NULL)
2230 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002231
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002232 rc = DosFindFirst(buf,
2233 &hdir,
2234 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2235 &ffbuf, sizeof(ffbuf),
2236 &srchcnt,
2237 FIL_STANDARD);
2238 if (rc != NO_ERROR)
2239 return 0;
2240 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002241
Tim Peters50d8d372001-02-28 05:34:27 +00002242/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2243#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002244# error "USE_CASE_OK_BYTES is not correctly defined"
2245#endif
2246}
2247#endif
2248
2249/*
2250 * Check if a filename case matchs the name case. We've already done a
2251 * successful stat() or fopen() on buf, so know that there's some match,
2252 * possibly case-insensitive.
2253 *
2254 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2255 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2256 * if envar PYTHONCASEOK exists.
2257 *
2258 * case_ok() is used to implement case-sensitive import semantics even
2259 * on platforms with case-insensitive filesystems. It's trivial to implement
2260 * for case-sensitive filesystems. It's pretty much a cross-platform
2261 * nightmare for systems with case-insensitive filesystems.
2262 */
2263
2264static int
2265case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2266{
2267#ifdef MS_WINDOWS
2268 WIN32_FIND_DATAW data;
2269 HANDLE h;
2270 int cmp;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002271 wchar_t *wname;
Victor Stinner8c981892011-10-11 22:27:13 +02002272 Py_ssize_t wname_len;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002273
2274 if (Py_GETENV("PYTHONCASEOK") != NULL)
2275 return 1;
2276
2277 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2278 if (h == INVALID_HANDLE_VALUE) {
2279 PyErr_Format(PyExc_NameError,
2280 "Can't find file for module %R\n(filename %R)",
2281 name, filename);
2282 return 0;
2283 }
2284 FindClose(h);
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002285
2286 wname = PyUnicode_AsUnicodeAndSize(name, &wname_len);
2287 if (wname == NULL)
2288 return -1;
2289
2290 cmp = wcsncmp(data.cFileName, wname, wname_len);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002291 return cmp == 0;
2292#elif defined(USE_CASE_OK_BYTES)
2293 int match;
2294 PyObject *filebytes, *namebytes;
2295 filebytes = PyUnicode_EncodeFSDefault(filename);
2296 if (filebytes == NULL)
2297 return -1;
2298 namebytes = PyUnicode_EncodeFSDefault(name);
2299 if (namebytes == NULL) {
2300 Py_DECREF(filebytes);
2301 return -1;
2302 }
2303 match = case_bytes(
2304 PyBytes_AS_STRING(filebytes),
2305 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002306 PyBytes_GET_SIZE(namebytes),
2307 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002308 Py_DECREF(filebytes);
2309 Py_DECREF(namebytes);
2310 return match;
2311#else
2312 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002313 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002314
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002315#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002316}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002317
Guido van Rossum197346f1997-10-31 18:38:52 +00002318#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002319
Victor Stinner547a2a62011-03-20 03:07:28 +01002320/* Helper to look for __init__.py or __init__.py[co] in potential package.
2321 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002322static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002323find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002324{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002325 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002326 PyObject *filename;
2327 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002328
Victor Stinner547a2a62011-03-20 03:07:28 +01002329 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2330 if (filename == NULL)
2331 return -1;
2332 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002333 /* 3=len(".py") */
2334 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002335 if (match < 0) {
2336 Py_DECREF(filename);
2337 return -1;
2338 }
2339 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002340 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002341 return 1;
2342 }
2343 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002344 Py_DECREF(filename);
2345
2346 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2347 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2348 if (filename == NULL)
2349 return -1;
2350 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002351 /* 4=len(".pyc") */
2352 match = case_ok(filename, -4, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002353 if (match < 0) {
2354 Py_DECREF(filename);
2355 return -1;
2356 }
2357 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002358 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002359 return 1;
2360 }
2361 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002362 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002363 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002364}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002365
Guido van Rossum197346f1997-10-31 18:38:52 +00002366#endif /* HAVE_STAT */
2367
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002368
Victor Stinner95872862011-03-07 18:20:56 +01002369static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002370
Victor Stinner44c6c152010-08-09 00:59:10 +00002371static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002372load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002373{
2374 PyObject *m, *modules;
2375 int err;
2376
Victor Stinner44c6c152010-08-09 00:59:10 +00002377 if (type == C_BUILTIN)
2378 err = init_builtin(name);
2379 else
Victor Stinner95872862011-03-07 18:20:56 +01002380 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002381 if (err < 0)
2382 return NULL;
2383 if (err == 0) {
2384 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002385 "Purported %s module %R not found",
2386 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002387 name);
2388 return NULL;
2389 }
2390
2391 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002392 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002393 if (m == NULL) {
2394 PyErr_Format(
2395 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002396 "%s module %R not properly initialized",
2397 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002398 name);
2399 return NULL;
2400 }
2401 Py_INCREF(m);
2402 return m;
2403}
2404
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002405/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002406 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002407
Guido van Rossum79f25d91997-04-29 20:08:16 +00002408static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002409load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002410{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002411 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002412
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002413 /* First check that there's an open file (if we need one) */
2414 switch (type) {
2415 case PY_SOURCE:
2416 case PY_COMPILED:
2417 if (fp == NULL) {
2418 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002419 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002420 type);
2421 return NULL;
2422 }
2423 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002424
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002425 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002426
Victor Stinner41c5fec2011-03-13 21:46:30 -04002427 case PY_SOURCE:
2428 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002429 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002430
Victor Stinner41c5fec2011-03-13 21:46:30 -04002431 case PY_COMPILED:
2432 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002433 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002434
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002435#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002436 case C_EXTENSION:
2437 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002438 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002439#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002440
Victor Stinner41c5fec2011-03-13 21:46:30 -04002441 case PKG_DIRECTORY:
2442 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002443 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002445 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002446 case PY_FROZEN:
2447 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002448 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002450 case IMP_HOOK: {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002451 _Py_IDENTIFIER(load_module);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002452 if (loader == NULL) {
2453 PyErr_SetString(PyExc_ImportError,
2454 "import hook without loader");
2455 return NULL;
2456 }
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002457 m = _PyObject_CallMethodId(loader, &PyId_load_module, "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002458 break;
2459 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002460
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002461 default:
2462 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002463 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002464 name, type);
2465 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002466
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002467 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002470}
2471
2472
2473/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002474 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002475 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002476
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002477static int
Victor Stinner95872862011-03-07 18:20:56 +01002478init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002479{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002480 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002481
Victor Stinner95872862011-03-07 18:20:56 +01002482 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002483 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002484
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002485 for (p = PyImport_Inittab; p->name != NULL; p++) {
2486 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002487 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002488 if (p->initfunc == NULL) {
2489 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002490 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002491 name);
2492 return -1;
2493 }
2494 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002495 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002496 mod = (*p->initfunc)();
2497 if (mod == 0)
2498 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002499 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002500 return -1;
2501 /* FixupExtension has put the module into sys.modules,
2502 so we can release our own reference. */
2503 Py_DECREF(mod);
2504 return 1;
2505 }
2506 }
2507 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002508}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002509
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002510
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002511/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002512
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002513static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002514find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002515{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002516 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002517
Victor Stinner53dc7352011-03-20 01:50:21 +01002518 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002519 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002520
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002521 for (p = PyImport_FrozenModules; ; p++) {
2522 if (p->name == NULL)
2523 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002524 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002525 break;
2526 }
2527 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002528}
2529
Guido van Rossum79f25d91997-04-29 20:08:16 +00002530static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002531get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002532{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002533 struct _frozen *p = find_frozen(name);
2534 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002535
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002536 if (p == NULL) {
2537 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002538 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002539 name);
2540 return NULL;
2541 }
2542 if (p->code == NULL) {
2543 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002544 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002545 name);
2546 return NULL;
2547 }
2548 size = p->size;
2549 if (size < 0)
2550 size = -size;
2551 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002552}
2553
Brett Cannon8d110132009-03-15 02:20:16 +00002554static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002555is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002556{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002557 struct _frozen *p = find_frozen(name);
2558 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002559
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002560 if (p == NULL) {
2561 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002562 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002563 name);
2564 return NULL;
2565 }
Brett Cannon8d110132009-03-15 02:20:16 +00002566
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002567 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002568
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002569 if (size < 0)
2570 Py_RETURN_TRUE;
2571 else
2572 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002573}
2574
2575
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002576/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002577 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002578 an exception set if the initialization failed.
2579 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002580
2581int
Victor Stinner53dc7352011-03-20 01:50:21 +01002582PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002583{
Victor Stinner53dc7352011-03-20 01:50:21 +01002584 struct _frozen *p;
2585 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002586 int ispackage;
2587 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002588
Victor Stinner53dc7352011-03-20 01:50:21 +01002589 p = find_frozen(name);
2590
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002591 if (p == NULL)
2592 return 0;
2593 if (p->code == NULL) {
2594 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002595 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002596 name);
2597 return -1;
2598 }
2599 size = p->size;
2600 ispackage = (size < 0);
2601 if (ispackage)
2602 size = -size;
2603 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002604 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002605 name, ispackage ? " package" : "");
2606 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2607 if (co == NULL)
2608 return -1;
2609 if (!PyCode_Check(co)) {
2610 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002611 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002612 name);
2613 goto err_return;
2614 }
2615 if (ispackage) {
2616 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002617 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002618 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002619 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002620 if (m == NULL)
2621 goto err_return;
2622 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002623 l = PyList_New(1);
2624 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002625 goto err_return;
2626 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002627 Py_INCREF(name);
2628 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002629 err = PyDict_SetItemString(d, "__path__", l);
2630 Py_DECREF(l);
2631 if (err != 0)
2632 goto err_return;
2633 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002634 path = PyUnicode_FromString("<frozen>");
2635 if (path == NULL)
2636 goto err_return;
2637 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2638 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002639 if (m == NULL)
2640 goto err_return;
2641 Py_DECREF(co);
2642 Py_DECREF(m);
2643 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002644err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002645 Py_DECREF(co);
2646 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002647}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002648
Victor Stinner53dc7352011-03-20 01:50:21 +01002649int
2650PyImport_ImportFrozenModule(char *name)
2651{
2652 PyObject *nameobj;
2653 int ret;
2654 nameobj = PyUnicode_InternFromString(name);
2655 if (nameobj == NULL)
2656 return -1;
2657 ret = PyImport_ImportFrozenModuleObject(nameobj);
2658 Py_DECREF(nameobj);
2659 return ret;
2660}
2661
Guido van Rossum74e6a111994-08-29 12:54:38 +00002662
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002663/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002664 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002665
Guido van Rossum79f25d91997-04-29 20:08:16 +00002666PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002667PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002668{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002669 PyObject *pname;
2670 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002671
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002672 pname = PyUnicode_FromString(name);
2673 if (pname == NULL)
2674 return NULL;
2675 result = PyImport_Import(pname);
2676 Py_DECREF(pname);
2677 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002678}
2679
Christian Heimes072c0f12008-01-03 23:01:04 +00002680/* Import a module without blocking
2681 *
2682 * At first it tries to fetch the module from sys.modules. If the module was
2683 * never loaded before it loads it with PyImport_ImportModule() unless another
2684 * thread holds the import lock. In the latter case the function raises an
2685 * ImportError instead of blocking.
2686 *
2687 * Returns the module object with incremented ref count.
2688 */
2689PyObject *
2690PyImport_ImportModuleNoBlock(const char *name)
2691{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002692 PyObject *nameobj, *modules, *result;
Victor Stinner0af03062011-09-02 00:11:43 +02002693#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002694 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002695#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002696
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002697 /* Try to get the module from sys.modules[name] */
2698 modules = PyImport_GetModuleDict();
2699 if (modules == NULL)
2700 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002701
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002702 nameobj = PyUnicode_FromString(name);
2703 if (nameobj == NULL)
2704 return NULL;
2705 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002706 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002707 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002708 Py_INCREF(result);
2709 return result;
2710 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002711 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002712#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002713 /* check the import lock
2714 * me might be -1 but I ignore the error here, the lock function
2715 * takes care of the problem */
2716 me = PyThread_get_thread_ident();
2717 if (import_lock_thread == -1 || import_lock_thread == me) {
2718 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002719 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002720 }
2721 else {
2722 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002723 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002724 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002725 nameobj);
2726 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002727 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002728#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002729 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002730#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002731 Py_DECREF(nameobj);
2732 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002733}
2734
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002735/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002736static PyObject *get_parent(PyObject *globals,
2737 PyObject **p_name,
2738 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002739static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002740 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002741 PyObject **p_prefix);
Victor Stinner974389d2011-03-15 09:33:57 +01002742static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002743static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002744 PyObject *buf, int recursive);
2745static PyObject * import_submodule(PyObject *mod, PyObject *name,
2746 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002747
2748/* The Magnum Opus of dotted-name import :-) */
2749
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002750static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002751import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002752 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002753{
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002754 PyObject *parent, *next, *inputname, *outputname;
2755 PyObject *head = NULL;
2756 PyObject *tail = NULL;
2757 PyObject *prefix = NULL;
2758 PyObject *result = NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002759 Py_ssize_t sep, altsep;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002760
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002761 if (PyUnicode_READY(name))
2762 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002763
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002764 sep = PyUnicode_FindChar(name, SEP, 0, PyUnicode_GET_LENGTH(name), 1);
2765 if (sep == -2)
2766 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002767#ifdef ALTSEP
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002768 altsep = PyUnicode_FindChar(name, ALTSEP, 0, PyUnicode_GET_LENGTH(name), 1);
2769 if (altsep == -2)
2770 return NULL;
2771#else
2772 altsep = -1;
Christian Heimes454f37b2008-01-10 00:10:02 +00002773#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002774 if (sep != -1 || altsep != -1)
2775 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002776 PyErr_SetString(PyExc_ImportError,
2777 "Import by filename is not supported.");
2778 return NULL;
2779 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002780
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002781 parent = get_parent(globals, &prefix, level);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002782 if (parent == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002783 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002784 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002785
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002786 if (PyUnicode_READY(prefix))
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002787 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002788
2789 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002790 &prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002791 if (head == NULL)
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002792 goto out;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002793
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002794 tail = head;
2795 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002796
2797 if (outputname != NULL) {
2798 while (1) {
2799 inputname = outputname;
2800 next = load_next(tail, tail, inputname, &outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002801 &prefix);
2802 Py_CLEAR(tail);
2803 Py_CLEAR(inputname);
2804 if (next == NULL)
2805 goto out;
Victor Stinner974389d2011-03-15 09:33:57 +01002806 tail = next;
2807
2808 if (outputname == NULL) {
2809 break;
2810 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002811 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002812 }
2813 if (tail == Py_None) {
2814 /* If tail is Py_None, both get_parent and load_next found
2815 an empty module name: someone called __import__("") or
2816 doctored faulty bytecode */
Victor Stinner974389d2011-03-15 09:33:57 +01002817 PyErr_SetString(PyExc_ValueError, "Empty module name");
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002818 goto out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002819 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002820
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002821 if (fromlist != NULL) {
2822 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2823 fromlist = NULL;
2824 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002825
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002826 if (fromlist == NULL) {
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002827 result = head;
2828 Py_INCREF(result);
2829 goto out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002830 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002831
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002832 if (!ensure_fromlist(tail, fromlist, prefix, 0))
2833 goto out;
2834
2835 result = tail;
2836 Py_INCREF(result);
2837 out:
2838 Py_XDECREF(head);
2839 Py_XDECREF(tail);
2840 Py_XDECREF(prefix);
2841 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002842}
2843
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002844PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002845PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2846 PyObject *locals, PyObject *fromlist,
2847 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002848{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002849 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002850 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002851 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002852 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002853 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002854 PyErr_SetString(PyExc_RuntimeError,
2855 "not holding the import lock");
2856 return NULL;
2857 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002858 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002859}
2860
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002861PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05002862PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002863 PyObject *fromlist, int level)
2864{
2865 PyObject *nameobj, *mod;
2866 nameobj = PyUnicode_FromString(name);
2867 if (nameobj == NULL)
2868 return NULL;
2869 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2870 fromlist, level);
2871 Py_DECREF(nameobj);
2872 return mod;
2873}
2874
2875
Fred Drake87590902004-05-28 20:21:36 +00002876/* Return the package that an import is being performed in. If globals comes
2877 from the module foo.bar.bat (not itself a package), this returns the
2878 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002879 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002880
Victor Stinner974389d2011-03-15 09:33:57 +01002881 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002882
2883 If globals doesn't come from a package or a module in a package, or a
2884 corresponding entry is not found in sys.modules, Py_None is returned.
2885*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002886static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002887get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002888{
Victor Stinner974389d2011-03-15 09:33:57 +01002889 PyObject *nameobj;
2890
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002891 static PyObject *namestr = NULL;
2892 static PyObject *pathstr = NULL;
2893 static PyObject *pkgstr = NULL;
2894 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2895 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002896
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002897 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002898 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002899
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002900 if (namestr == NULL) {
2901 namestr = PyUnicode_InternFromString("__name__");
2902 if (namestr == NULL)
2903 return NULL;
2904 }
2905 if (pathstr == NULL) {
2906 pathstr = PyUnicode_InternFromString("__path__");
2907 if (pathstr == NULL)
2908 return NULL;
2909 }
2910 if (pkgstr == NULL) {
2911 pkgstr = PyUnicode_InternFromString("__package__");
2912 if (pkgstr == NULL)
2913 return NULL;
2914 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002915
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002916 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002918 if ((pkgname != NULL) && (pkgname != Py_None)) {
2919 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002920 if (!PyUnicode_Check(pkgname)) {
2921 PyErr_SetString(PyExc_ValueError,
2922 "__package__ set to non-string");
2923 return NULL;
2924 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002925 if (PyUnicode_GET_LENGTH(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002926 if (level > 0) {
2927 PyErr_SetString(PyExc_ValueError,
2928 "Attempted relative import in non-package");
2929 return NULL;
2930 }
Victor Stinner974389d2011-03-15 09:33:57 +01002931 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002932 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002933 Py_INCREF(pkgname);
2934 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002935 } else {
2936 /* __package__ not set, so figure it out and set it */
2937 modname = PyDict_GetItem(globals, namestr);
2938 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002939 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002940
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002941 modpath = PyDict_GetItem(globals, pathstr);
2942 if (modpath != NULL) {
2943 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002944 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002945
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002946 error = PyDict_SetItem(globals, pkgstr, modname);
2947 if (error) {
2948 PyErr_SetString(PyExc_ValueError,
2949 "Could not set __package__");
2950 return NULL;
2951 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002952 Py_INCREF(modname);
2953 nameobj = modname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002954 } else {
2955 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002956 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002957 len = PyUnicode_FindChar(modname, '.',
2958 0, PyUnicode_GET_LENGTH(modname), -1);
2959 if (len == -2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002960 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002961 if (len < 0) {
2962 if (level > 0) {
2963 PyErr_SetString(PyExc_ValueError,
2964 "Attempted relative import in non-package");
2965 return NULL;
2966 }
2967 if (PyDict_SetItem(globals, pkgstr, Py_None)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002968 PyErr_SetString(PyExc_ValueError,
2969 "Could not set __package__");
2970 return NULL;
2971 }
Victor Stinner974389d2011-03-15 09:33:57 +01002972 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002973 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002974 pkgname = PyUnicode_Substring(modname, 0, len);
2975 if (pkgname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002976 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002977 if (PyDict_SetItem(globals, pkgstr, pkgname)) {
2978 Py_DECREF(pkgname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002979 PyErr_SetString(PyExc_ValueError,
2980 "Could not set __package__");
2981 return NULL;
2982 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002983 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002984 }
2985 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002986 if (level > 1) {
2987 Py_ssize_t dot, end = PyUnicode_GET_LENGTH(nameobj);
2988 PyObject *newname;
2989 while (--level > 0) {
2990 dot = PyUnicode_FindChar(nameobj, '.', 0, end, -1);
2991 if (dot == -2) {
2992 Py_DECREF(nameobj);
2993 return NULL;
2994 }
2995 if (dot < 0) {
2996 Py_DECREF(nameobj);
2997 PyErr_SetString(PyExc_ValueError,
2998 "Attempted relative import beyond "
2999 "toplevel package");
3000 return NULL;
3001 }
3002 end = dot;
3003 }
3004 newname = PyUnicode_Substring(nameobj, 0, end);
3005 Py_DECREF(nameobj);
3006 if (newname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003007 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003008 nameobj = newname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003009 }
Victor Stinner974389d2011-03-15 09:33:57 +01003010
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003011 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003012 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003013 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003014 int err;
3015
3016 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003017 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01003018 "Parent module %R not loaded, "
3019 "cannot perform relative import", nameobj);
3020 Py_DECREF(nameobj);
3021 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003022 }
Victor Stinner974389d2011-03-15 09:33:57 +01003023
3024 err = PyErr_WarnFormat(
3025 PyExc_RuntimeWarning, 1,
3026 "Parent module %R not found while handling absolute import",
3027 nameobj);
3028 Py_DECREF(nameobj);
3029 if (err)
3030 return NULL;
3031
3032 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003033 }
Victor Stinner974389d2011-03-15 09:33:57 +01003034 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003035 return parent;
3036 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01003037 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003038 - parent.__dict__ is globals
3039 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01003040
3041return_none:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003042 nameobj = PyUnicode_New(0, 0);
Victor Stinner974389d2011-03-15 09:33:57 +01003043 if (nameobj == NULL)
3044 return NULL;
3045 *p_name = nameobj;
3046 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003047}
3048
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003049/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003050static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003051load_next(PyObject *mod, PyObject *altmod,
3052 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003053 PyObject **p_prefix)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003054{
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003055 Py_ssize_t dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003056 Py_ssize_t len;
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003057 PyObject *fullname, *name = NULL, *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003058
Victor Stinner974389d2011-03-15 09:33:57 +01003059 *p_outputname = NULL;
3060
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003061 len = PyUnicode_GET_LENGTH(inputname);
3062 if (len == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003063 /* completely empty module name should only happen in
3064 'from . import' (or '__import__("")')*/
3065 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003066 return mod;
3067 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00003068
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003069
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003070 dot = PyUnicode_FindChar(inputname, '.', 0, len, 1);
3071 if (dot >= 0) {
3072 len = dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003073 if (len == 0) {
3074 PyErr_SetString(PyExc_ValueError,
3075 "Empty module name");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003076 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003077 }
3078 }
Victor Stinner974389d2011-03-15 09:33:57 +01003079
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003080 /* name = inputname[:len] */
3081 name = PyUnicode_Substring(inputname, 0, len);
3082 if (name == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003083 goto error;
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003084
3085 if (PyUnicode_GET_LENGTH(*p_prefix)) {
3086 /* fullname = prefix + "." + name */
3087 fullname = PyUnicode_FromFormat("%U.%U", *p_prefix, name);
3088 if (fullname == NULL)
3089 goto error;
3090 }
3091 else {
3092 fullname = name;
3093 Py_INCREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003094 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003095
Victor Stinner974389d2011-03-15 09:33:57 +01003096 result = import_submodule(mod, name, fullname);
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003097 Py_DECREF(*p_prefix);
3098 /* Transfer reference. */
3099 *p_prefix = fullname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003100 if (result == Py_None && altmod != mod) {
3101 Py_DECREF(result);
3102 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003103 result = import_submodule(altmod, name, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003104 if (result != NULL && result != Py_None) {
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003105 if (mark_miss(*p_prefix) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003106 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003107 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003108 }
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003109 Py_DECREF(*p_prefix);
3110 *p_prefix = name;
3111 Py_INCREF(*p_prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003112 }
3113 }
3114 if (result == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003115 goto error;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003116
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003117 if (result == Py_None) {
3118 Py_DECREF(result);
3119 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003120 "No module named %R", inputname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003121 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003122 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003123
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003124 if (dot >= 0) {
3125 *p_outputname = PyUnicode_Substring(inputname, dot+1,
3126 PyUnicode_GET_LENGTH(inputname));
Victor Stinner974389d2011-03-15 09:33:57 +01003127 if (*p_outputname == NULL) {
3128 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003129 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003130 }
3131 }
3132
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003133 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003134 return result;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003135
3136error:
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003137 Py_XDECREF(name);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003138 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003139}
3140
3141static int
Victor Stinner974389d2011-03-15 09:33:57 +01003142mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003143{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003144 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003145 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003146}
3147
3148static int
Victor Stinner974389d2011-03-15 09:33:57 +01003149ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003150 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003151{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003152 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003153 PyObject *fullname;
3154 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003155
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003156 if (!_PyObject_HasAttrId(mod, &PyId___path__))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003157 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003158
Victor Stinner974389d2011-03-15 09:33:57 +01003159 fromlist_len = PySequence_Size(fromlist);
3160
3161 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003162 PyObject *item = PySequence_GetItem(fromlist, i);
3163 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003164 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003165 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003166 if (!PyUnicode_Check(item)) {
3167 PyErr_SetString(PyExc_TypeError,
3168 "Item in ``from list'' not a string");
3169 Py_DECREF(item);
3170 return 0;
3171 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003172 if (PyUnicode_READ_CHAR(item, 0) == '*') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003173 PyObject *all;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02003174 _Py_IDENTIFIER(__all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003175 Py_DECREF(item);
3176 /* See if the package defines __all__ */
3177 if (recursive)
3178 continue; /* Avoid endless recursion */
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003179 all = _PyObject_GetAttrId(mod, &PyId___all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003180 if (all == NULL)
3181 PyErr_Clear();
3182 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003183 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003184 Py_DECREF(all);
3185 if (!ret)
3186 return 0;
3187 }
3188 continue;
3189 }
3190 hasit = PyObject_HasAttr(mod, item);
3191 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003192 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003193 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3194 if (fullname != NULL) {
3195 submod = import_submodule(mod, item, fullname);
3196 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003197 }
Victor Stinner974389d2011-03-15 09:33:57 +01003198 else
3199 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003200 Py_XDECREF(submod);
3201 if (submod == NULL) {
3202 Py_DECREF(item);
3203 return 0;
3204 }
3205 }
3206 Py_DECREF(item);
3207 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003208
Victor Stinner974389d2011-03-15 09:33:57 +01003209 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003210}
3211
Neil Schemenauer00b09662003-06-16 21:03:07 +00003212static int
Victor Stinner974389d2011-03-15 09:33:57 +01003213add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3214 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003215{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003216 if (mod == Py_None)
3217 return 1;
3218 /* Irrespective of the success of this load, make a
3219 reference to it in the parent package module. A copy gets
3220 saved in the modules dictionary under the full name, so get a
3221 reference from there, if need be. (The exception is when the
3222 load failed with a SyntaxError -- then there's no trace in
3223 sys.modules. In that case, of course, do nothing extra.) */
3224 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003225 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003226 if (submod == NULL)
3227 return 1;
3228 }
3229 if (PyModule_Check(mod)) {
3230 /* We can't use setattr here since it can give a
3231 * spurious warning if the submodule name shadows a
3232 * builtin name */
3233 PyObject *dict = PyModule_GetDict(mod);
3234 if (!dict)
3235 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003236 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003237 return 0;
3238 }
3239 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003240 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003241 return 0;
3242 }
3243 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003244}
3245
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003246static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003247import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003248{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003249 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003250 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003251 struct filedescr *fdp;
3252 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003253
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003254 /* Require:
3255 if mod == None: subname == fullname
3256 else: mod.__name__ + "." + subname == fullname
3257 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003258
Victor Stinner974389d2011-03-15 09:33:57 +01003259 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003260 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003261 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003262 }
Victor Stinner9599de52011-03-13 22:38:38 -04003263
3264 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003265 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003266 else {
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003267 path_list = _PyObject_GetAttrId(mod, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003268 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003269 PyErr_Clear();
3270 Py_INCREF(Py_None);
3271 return Py_None;
3272 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003273 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003274
Victor Stinner533d7832011-03-14 13:22:54 -04003275 fdp = find_module(fullname, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003276 &bufobj, &fp, &loader);
Victor Stinner533d7832011-03-14 13:22:54 -04003277 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003278 if (fdp == NULL) {
3279 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3280 return NULL;
3281 PyErr_Clear();
3282 Py_INCREF(Py_None);
3283 return Py_None;
3284 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003285 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3286 Py_XDECREF(bufobj);
Victor Stinner9599de52011-03-13 22:38:38 -04003287 Py_XDECREF(loader);
3288 if (fp)
3289 fclose(fp);
3290 if (m == NULL)
3291 return NULL;
3292 if (!add_submodule(mod, m, fullname, subname, modules)) {
3293 Py_XDECREF(m);
3294 return NULL;
3295 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003296 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003297}
3298
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003299
3300/* Re-import a module of any kind and return its module object, WITH
3301 INCREMENTED REFERENCE COUNT */
3302
Guido van Rossum79f25d91997-04-29 20:08:16 +00003303PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003304PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003305{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003306 PyInterpreterState *interp = PyThreadState_Get()->interp;
3307 PyObject *modules_reloading = interp->modules_reloading;
3308 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003309 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003310 PyObject *name, *bufobj, *subname;
3311 Py_ssize_t subname_start;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003312 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003313 FILE *fp = NULL;
3314 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003315
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003316 if (modules_reloading == NULL) {
3317 Py_FatalError("PyImport_ReloadModule: "
3318 "no modules_reloading dictionary!");
3319 return NULL;
3320 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003321
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003322 if (m == NULL || !PyModule_Check(m)) {
3323 PyErr_SetString(PyExc_TypeError,
3324 "reload() argument must be module");
3325 return NULL;
3326 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003327 name = PyModule_GetNameObject(m);
3328 if (name == NULL || PyUnicode_READY(name) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003329 return NULL;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003330 if (m != PyDict_GetItem(modules, name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003331 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003332 "reload(): module %R not in sys.modules",
Martin v. Löwis796ea532011-10-30 09:07:07 +01003333 name);
3334 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003335 return NULL;
3336 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003337 existing_m = PyDict_GetItem(modules_reloading, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003338 if (existing_m != NULL) {
3339 /* Due to a recursive reload, this module is already
3340 being reloaded. */
Martin v. Löwis796ea532011-10-30 09:07:07 +01003341 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003342 Py_INCREF(existing_m);
3343 return existing_m;
3344 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003345 if (PyDict_SetItem(modules_reloading, name, m) < 0) {
3346 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003347 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003348 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003349
Martin v. Löwis796ea532011-10-30 09:07:07 +01003350 subname_start = PyUnicode_FindChar(name, '.', 0,
3351 PyUnicode_GET_LENGTH(name), -1);
3352 if (subname_start == -1) {
3353 Py_INCREF(name);
3354 subname = name;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003355 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003356 else {
3357 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003358 Py_ssize_t len;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003359 parentname = PyUnicode_Substring(name, 0, subname_start);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003360 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003361 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003362 }
3363 parent = PyDict_GetItem(modules, parentname);
3364 if (parent == NULL) {
3365 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003366 "reload(): parent %R not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003367 parentname);
3368 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003369 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003370 }
3371 Py_DECREF(parentname);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003372 path_list = _PyObject_GetAttrId(parent, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003373 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003374 PyErr_Clear();
Martin v. Löwis796ea532011-10-30 09:07:07 +01003375 subname_start++;
3376 len = PyUnicode_GET_LENGTH(name) - (subname_start + 1);
3377 subname = PyUnicode_Substring(name, subname_start, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003378 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003379 if (subname == NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003380 goto error;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003381 fdp = find_module(name, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003382 &bufobj, &fp, &loader);
Martin v. Löwis796ea532011-10-30 09:07:07 +01003383 Py_DECREF(subname);
Victor Stinner533d7832011-03-14 13:22:54 -04003384 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003385
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003386 if (fdp == NULL) {
3387 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003388 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003389 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003390
Martin v. Löwis796ea532011-10-30 09:07:07 +01003391 newm = load_module(name, fp, bufobj, fdp->type, loader);
Victor Stinner2fd76e42011-03-14 15:19:39 -04003392 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003393 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003394
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003395 if (fp)
3396 fclose(fp);
3397 if (newm == NULL) {
3398 /* load_module probably removed name from modules because of
3399 * the error. Put back the original module object. We're
3400 * going to return NULL in this case regardless of whether
3401 * replacing name succeeds, so the return value is ignored.
3402 */
Martin v. Löwis796ea532011-10-30 09:07:07 +01003403 PyDict_SetItem(modules, name, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003404 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003405
3406error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003407 imp_modules_reloading_clear();
Martin v. Löwis796ea532011-10-30 09:07:07 +01003408 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003409 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003410}
3411
3412
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003413/* Higher-level import emulator which emulates the "import" statement
3414 more accurately -- it invokes the __import__() function from the
3415 builtins of the current globals. This means that the import is
3416 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003417 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003418 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003419 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003420 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003421
3422PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003423PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003424{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003425 static PyObject *silly_list = NULL;
3426 static PyObject *builtins_str = NULL;
3427 static PyObject *import_str = NULL;
3428 PyObject *globals = NULL;
3429 PyObject *import = NULL;
3430 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003431 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003432 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003433
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003434 /* Initialize constant string objects */
3435 if (silly_list == NULL) {
3436 import_str = PyUnicode_InternFromString("__import__");
3437 if (import_str == NULL)
3438 return NULL;
3439 builtins_str = PyUnicode_InternFromString("__builtins__");
3440 if (builtins_str == NULL)
3441 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003442 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003443 if (silly_list == NULL)
3444 return NULL;
3445 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003447 /* Get the builtins from current globals */
3448 globals = PyEval_GetGlobals();
3449 if (globals != NULL) {
3450 Py_INCREF(globals);
3451 builtins = PyObject_GetItem(globals, builtins_str);
3452 if (builtins == NULL)
3453 goto err;
3454 }
3455 else {
3456 /* No globals -- use standard builtins, and fake globals */
3457 builtins = PyImport_ImportModuleLevel("builtins",
3458 NULL, NULL, NULL, 0);
3459 if (builtins == NULL)
3460 return NULL;
3461 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3462 if (globals == NULL)
3463 goto err;
3464 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003466 /* Get the __import__ function from the builtins */
3467 if (PyDict_Check(builtins)) {
3468 import = PyObject_GetItem(builtins, import_str);
3469 if (import == NULL)
3470 PyErr_SetObject(PyExc_KeyError, import_str);
3471 }
3472 else
3473 import = PyObject_GetAttr(builtins, import_str);
3474 if (import == NULL)
3475 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003476
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003477 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003478 Always use absolute import here.
3479 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003480 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3481 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003482 if (r == NULL)
3483 goto err;
3484 Py_DECREF(r);
3485
3486 modules = PyImport_GetModuleDict();
3487 r = PyDict_GetItem(modules, module_name);
3488 if (r != NULL)
3489 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003490
3491 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003492 Py_XDECREF(globals);
3493 Py_XDECREF(builtins);
3494 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003495
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003496 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003497}
3498
3499
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003500/* Module 'imp' provides Python access to the primitives used for
3501 importing modules.
3502*/
3503
Guido van Rossum79f25d91997-04-29 20:08:16 +00003504static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003505imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003506{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003507 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003508
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003509 buf[0] = (char) ((magic >> 0) & 0xff);
3510 buf[1] = (char) ((magic >> 8) & 0xff);
3511 buf[2] = (char) ((magic >> 16) & 0xff);
3512 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003513
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003514 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003515}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003516
3517static PyObject *
3518imp_get_magic(PyObject *self, PyObject *noargs)
3519{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003520 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003521}
3522
3523static PyObject *
3524imp_get_tag(PyObject *self, PyObject *noargs)
3525{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003526 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003527}
3528
Guido van Rossum79f25d91997-04-29 20:08:16 +00003529static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003530imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003531{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003532 PyObject *list;
3533 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003534
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003535 list = PyList_New(0);
3536 if (list == NULL)
3537 return NULL;
3538 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3539 PyObject *item = Py_BuildValue("ssi",
3540 fdp->suffix, fdp->mode, fdp->type);
3541 if (item == NULL) {
3542 Py_DECREF(list);
3543 return NULL;
3544 }
3545 if (PyList_Append(list, item) < 0) {
3546 Py_DECREF(list);
3547 Py_DECREF(item);
3548 return NULL;
3549 }
3550 Py_DECREF(item);
3551 }
3552 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003553}
3554
Guido van Rossum79f25d91997-04-29 20:08:16 +00003555static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003556call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003557{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003558 extern int fclose(FILE *);
3559 PyObject *fob, *ret;
3560 PyObject *pathobj;
3561 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003562 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003563 int fd = -1;
3564 char *found_encoding = NULL;
3565 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003566
Victor Stinner533d7832011-03-14 13:22:54 -04003567 if (path_list == Py_None)
3568 path_list = NULL;
3569 fdp = find_module(NULL, name, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003570 &pathobj, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003571 if (fdp == NULL)
3572 return NULL;
3573 if (fp != NULL) {
3574 fd = fileno(fp);
3575 if (fd != -1)
3576 fd = dup(fd);
3577 fclose(fp);
Victor Stinnerd417d012011-06-20 15:16:55 +02003578 if (fd == -1) {
3579 PyErr_SetFromErrno(PyExc_OSError);
3580 return NULL;
3581 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003582 fp = NULL;
3583 }
3584 if (fd != -1) {
3585 if (strchr(fdp->mode, 'b') == NULL) {
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003586 /* PyTokenizer_FindEncodingFilename() returns PyMem_MALLOC'ed
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003587 memory. */
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003588 found_encoding = PyTokenizer_FindEncodingFilename(fd, pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003589 lseek(fd, 0, 0); /* Reset position */
Victor Stinner2fd76e42011-03-14 15:19:39 -04003590 if (found_encoding == NULL && PyErr_Occurred()) {
3591 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003592 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04003593 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003594 encoding = (found_encoding != NULL) ? found_encoding :
3595 (char*)PyUnicode_GetDefaultEncoding();
3596 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003597 fob = PyFile_FromFd(fd, NULL, fdp->mode, -1,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003598 (char*)encoding, NULL, NULL, 1);
3599 if (fob == NULL) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04003600 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003601 close(fd);
3602 PyMem_FREE(found_encoding);
3603 return NULL;
3604 }
3605 }
3606 else {
3607 fob = Py_None;
3608 Py_INCREF(fob);
3609 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003610 if (pathobj == NULL) {
3611 Py_INCREF(Py_None);
3612 pathobj = Py_None;
3613 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003614 ret = Py_BuildValue("NN(ssi)",
3615 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3616 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003617
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003618 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003619}
3620
Guido van Rossum79f25d91997-04-29 20:08:16 +00003621static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003622imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003623{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003624 PyObject *name, *path_list = NULL;
3625 if (!PyArg_ParseTuple(args, "U|O:find_module",
3626 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003627 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003628 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003629}
3630
3631static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003632imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003633{
Victor Stinner95872862011-03-07 18:20:56 +01003634 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003635 int ret;
3636 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003637 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003638 return NULL;
3639 ret = init_builtin(name);
3640 if (ret < 0)
3641 return NULL;
3642 if (ret == 0) {
3643 Py_INCREF(Py_None);
3644 return Py_None;
3645 }
Victor Stinner95872862011-03-07 18:20:56 +01003646 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003647 Py_XINCREF(m);
3648 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003649}
3650
Guido van Rossum79f25d91997-04-29 20:08:16 +00003651static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003652imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003653{
Victor Stinner53dc7352011-03-20 01:50:21 +01003654 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003655 int ret;
3656 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003657 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003658 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003659 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003660 if (ret < 0)
3661 return NULL;
3662 if (ret == 0) {
3663 Py_INCREF(Py_None);
3664 return Py_None;
3665 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003666 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003667 Py_XINCREF(m);
3668 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003669}
3670
Guido van Rossum79f25d91997-04-29 20:08:16 +00003671static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003672imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003673{
Victor Stinner53dc7352011-03-20 01:50:21 +01003674 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003675
Victor Stinner53dc7352011-03-20 01:50:21 +01003676 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003677 return NULL;
3678 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003679}
3680
Guido van Rossum79f25d91997-04-29 20:08:16 +00003681static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003682imp_is_frozen_package(PyObject *self, PyObject *args)
3683{
Victor Stinner53dc7352011-03-20 01:50:21 +01003684 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003685
Victor Stinner53dc7352011-03-20 01:50:21 +01003686 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003687 return NULL;
3688 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003689}
3690
3691static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003692imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003693{
Victor Stinner95872862011-03-07 18:20:56 +01003694 PyObject *name;
3695 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003696 return NULL;
3697 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003698}
3699
Guido van Rossum79f25d91997-04-29 20:08:16 +00003700static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003701imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003702{
Victor Stinner53dc7352011-03-20 01:50:21 +01003703 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003704 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003705 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003706 return NULL;
3707 p = find_frozen(name);
3708 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003709}
3710
3711static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003712get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003713{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003714 FILE *fp;
3715 if (mode[0] == 'U')
3716 mode = "r" PY_STDIOTEXTMODE;
3717 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003718 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003719 }
3720 else {
3721 int fd = PyObject_AsFileDescriptor(fob);
3722 if (fd == -1)
3723 return NULL;
3724 if (!_PyVerify_fd(fd))
3725 goto error;
3726 /* the FILE struct gets a new fd, so that it can be closed
3727 * independently of the file descriptor given
3728 */
3729 fd = dup(fd);
3730 if (fd == -1)
3731 goto error;
3732 fp = fdopen(fd, mode);
3733 }
3734 if (fp)
3735 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003736error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003737 PyErr_SetFromErrno(PyExc_IOError);
3738 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003739}
3740
Guido van Rossum79f25d91997-04-29 20:08:16 +00003741static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003742imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003743{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003744 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003745 PyObject *fob = NULL;
3746 PyObject *m;
3747 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003748 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003749 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003750 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003751 &fob))
3752 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003753 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003754 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003755 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003756 return NULL;
3757 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003758 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003759 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003760 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003761 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003762}
3763
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003764#ifdef HAVE_DYNAMIC_LOADING
3765
Guido van Rossum79f25d91997-04-29 20:08:16 +00003766static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003767imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003768{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003769 PyObject *name, *pathname, *fob = NULL, *mod;
3770 FILE *fp;
3771
3772 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3773 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003774 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003775 if (fob != NULL) {
3776 fp = get_file(NULL, fob, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003777 if (fp == NULL) {
3778 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003779 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003780 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003781 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003782 else
3783 fp = NULL;
3784 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003785 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003786 if (fp)
3787 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003788 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003789}
3790
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003791#endif /* HAVE_DYNAMIC_LOADING */
3792
Guido van Rossum79f25d91997-04-29 20:08:16 +00003793static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003794imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003795{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003796 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003797 PyObject *fob = NULL;
3798 PyObject *m;
3799 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003800 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003801 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003802 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003803 &fob))
3804 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003805 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003806 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003807 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003808 return NULL;
3809 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003810 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003811 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003812 fclose(fp);
3813 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003814}
3815
Guido van Rossum79f25d91997-04-29 20:08:16 +00003816static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003817imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003818{
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003819 PyObject *name, *fob, *pathname, *pathname_obj, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003820 char *suffix; /* Unused */
3821 char *mode;
3822 int type;
3823 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003824
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003825 if (!PyArg_ParseTuple(args, "UOO(ssi):load_module",
3826 &name, &fob, &pathname_obj, &suffix, &mode, &type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003827 return NULL;
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003828 if (pathname_obj != Py_None) {
3829 if (!PyUnicode_FSDecoder(pathname_obj, &pathname))
3830 return NULL;
3831 }
3832 else
3833 pathname = NULL;
3834
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003835 if (*mode) {
3836 /* Mode must start with 'r' or 'U' and must not contain '+'.
3837 Implicit in this test is the assumption that the mode
3838 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003839
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003840 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3841 PyErr_Format(PyExc_ValueError,
3842 "invalid file open mode %.200s", mode);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003843 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003844 return NULL;
3845 }
3846 }
3847 if (fob == Py_None)
3848 fp = NULL;
3849 else {
3850 fp = get_file(NULL, fob, mode);
3851 if (fp == NULL) {
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003852 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003853 return NULL;
3854 }
3855 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003856 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003857 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003858 if (fp)
3859 fclose(fp);
3860 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003861}
3862
3863static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003864imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003865{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003866 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003867 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003868 if (!PyArg_ParseTuple(args, "UO&:load_package",
3869 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003870 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003871 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003872 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003873 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003874}
3875
3876static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003877imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003878{
Victor Stinnerfe19d212011-03-14 14:53:28 -04003879 PyObject *name;
3880 if (!PyArg_ParseTuple(args, "U:new_module", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003881 return NULL;
Victor Stinnerfe19d212011-03-14 14:53:28 -04003882 return PyModule_NewObject(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003883}
3884
Christian Heimes13a7a212008-01-07 17:13:09 +00003885static PyObject *
3886imp_reload(PyObject *self, PyObject *v)
3887{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003888 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003889}
3890
3891PyDoc_STRVAR(doc_reload,
3892"reload(module) -> module\n\
3893\n\
3894Reload the module. The module must have been successfully imported before.");
3895
Barry Warsaw28a691b2010-04-17 00:19:56 +00003896static PyObject *
3897imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3898{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003899 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003900
Victor Stinner2f42ae52011-03-20 00:41:24 +01003901 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003902 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003903 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003904
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003905 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003906 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003907 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003908 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003909
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003910 if (debug_override != NULL &&
3911 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003912 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003913 return NULL;
3914 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003915
Martin v. Löwis30260a72011-10-23 17:35:46 +02003916 if (PyUnicode_READY(pathname) < 0)
3917 return NULL;
3918
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003919 cpathname = make_compiled_pathname(pathname, debug);
Victor Stinner2f42ae52011-03-20 00:41:24 +01003920 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003921
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003922 if (cpathname == NULL) {
3923 PyErr_Format(PyExc_SystemError, "path buffer too short");
3924 return NULL;
3925 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003926 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003927}
3928
3929PyDoc_STRVAR(doc_cache_from_source,
Éric Araujo5df11082011-11-03 03:38:44 +01003930"cache_from_source(path, [debug_override]) -> path\n\
3931Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003932\n\
3933The .py file does not need to exist; this simply returns the path to the\n\
3934.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3935will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3936\n\
3937If debug_override is not None, then it must be a boolean and is taken as\n\
3938the value of __debug__ instead.");
3939
3940static PyObject *
3941imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3942{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003943 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003944 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003945
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003946 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003947 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003948 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003949 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003950
Victor Stinnerc9abda02011-03-14 13:33:46 -04003951 source = make_source_pathname(pathname);
3952 if (source == NULL) {
3953 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003954 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003955 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003956 return NULL;
3957 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003958 Py_DECREF(pathname);
3959 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003960}
3961
3962PyDoc_STRVAR(doc_source_from_cache,
Éric Araujo5df11082011-11-03 03:38:44 +01003963"source_from_cache(path) -> path\n\
3964Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003965\n\
3966The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3967the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3968does not conform to PEP 3147 format, ValueError will be raised.");
3969
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003970/* Doc strings */
3971
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003972PyDoc_STRVAR(doc_imp,
3973"This module provides the components needed to build your own\n\
3974__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003975
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003976PyDoc_STRVAR(doc_find_module,
3977"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003978Search for a module. If path is omitted or None, search for a\n\
3979built-in, frozen or special module and continue search in sys.path.\n\
3980The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003981package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003982
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003983PyDoc_STRVAR(doc_load_module,
3984"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003985Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003986The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003987
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003988PyDoc_STRVAR(doc_get_magic,
3989"get_magic() -> string\n\
3990Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003991
Barry Warsaw28a691b2010-04-17 00:19:56 +00003992PyDoc_STRVAR(doc_get_tag,
3993"get_tag() -> string\n\
3994Return the magic tag for .pyc or .pyo files.");
3995
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003996PyDoc_STRVAR(doc_get_suffixes,
3997"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003998Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003999that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004000
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004001PyDoc_STRVAR(doc_new_module,
4002"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004003Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004004The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004005
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004006PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00004007"lock_held() -> boolean\n\
4008Return True if the import lock is currently held, else False.\n\
4009On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00004010
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004011PyDoc_STRVAR(doc_acquire_lock,
4012"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00004013Acquires the interpreter's import lock for the current thread.\n\
4014This lock should be used by import hooks to ensure thread-safety\n\
4015when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004016On platforms without threads, this function does nothing.");
4017
4018PyDoc_STRVAR(doc_release_lock,
4019"release_lock() -> None\n\
4020Release the interpreter's import lock.\n\
4021On platforms without threads, this function does nothing.");
4022
Guido van Rossum79f25d91997-04-29 20:08:16 +00004023static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004024 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
4025 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
4026 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
4027 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
4028 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
4029 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
4030 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
4031 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
4032 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
4033 {"reload", imp_reload, METH_O, doc_reload},
4034 {"cache_from_source", (PyCFunction)imp_cache_from_source,
4035 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
4036 {"source_from_cache", (PyCFunction)imp_source_from_cache,
4037 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
4038 /* The rest are obsolete */
4039 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
4040 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
4041 {"init_builtin", imp_init_builtin, METH_VARARGS},
4042 {"init_frozen", imp_init_frozen, METH_VARARGS},
4043 {"is_builtin", imp_is_builtin, METH_VARARGS},
4044 {"is_frozen", imp_is_frozen, METH_VARARGS},
4045 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004046#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004047 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004048#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004049 {"load_package", imp_load_package, METH_VARARGS},
4050 {"load_source", imp_load_source, METH_VARARGS},
Brett Cannon442c9b92011-03-23 16:14:42 -07004051 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004052 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004053};
4054
Guido van Rossum1a8791e1998-08-04 22:46:29 +00004055static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004056setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004057{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004058 PyObject *v;
4059 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004060
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004061 v = PyLong_FromLong((long)value);
4062 err = PyDict_SetItemString(d, name, v);
4063 Py_XDECREF(v);
4064 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004065}
4066
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004067typedef struct {
4068 PyObject_HEAD
4069} NullImporter;
4070
4071static int
4072NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4073{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004074#ifndef MS_WINDOWS
4075 PyObject *path;
4076 struct stat statbuf;
4077 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004078
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004079 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4080 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004081
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004082 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4083 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004084 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004085
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004086 if (PyBytes_GET_SIZE(path) == 0) {
4087 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004088 PyErr_SetString(PyExc_ImportError, "empty pathname");
4089 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004090 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004091
4092 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4093 Py_DECREF(path);
4094 if (rv == 0) {
4095 /* it exists */
4096 if (S_ISDIR(statbuf.st_mode)) {
4097 /* it's a directory */
4098 PyErr_SetString(PyExc_ImportError, "existing directory");
4099 return -1;
4100 }
4101 }
4102#else /* MS_WINDOWS */
4103 PyObject *pathobj;
4104 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004105 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004106
4107 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4108 return -1;
4109
4110 if (!PyArg_ParseTuple(args, "U:NullImporter",
4111 &pathobj))
4112 return -1;
4113
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02004114 if (PyUnicode_GET_LENGTH(pathobj) == 0) {
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004115 PyErr_SetString(PyExc_ImportError, "empty pathname");
4116 return -1;
4117 }
4118
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004119 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004120 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004121 return -1;
4122 /* see issue1293 and issue3677:
4123 * stat() on Windows doesn't recognise paths like
4124 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4125 */
4126 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004127 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004128 if (rv != INVALID_FILE_ATTRIBUTES) {
4129 /* it exists */
4130 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4131 /* it's a directory */
4132 PyErr_SetString(PyExc_ImportError, "existing directory");
4133 return -1;
4134 }
4135 }
4136#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004137 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004138}
4139
4140static PyObject *
4141NullImporter_find_module(NullImporter *self, PyObject *args)
4142{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004143 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004144}
4145
4146static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004147 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4148 "Always return None"
4149 },
4150 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004151};
4152
4153
Christian Heimes9cd17752007-11-18 19:35:23 +00004154PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004155 PyVarObject_HEAD_INIT(NULL, 0)
4156 "imp.NullImporter", /*tp_name*/
4157 sizeof(NullImporter), /*tp_basicsize*/
4158 0, /*tp_itemsize*/
4159 0, /*tp_dealloc*/
4160 0, /*tp_print*/
4161 0, /*tp_getattr*/
4162 0, /*tp_setattr*/
4163 0, /*tp_reserved*/
4164 0, /*tp_repr*/
4165 0, /*tp_as_number*/
4166 0, /*tp_as_sequence*/
4167 0, /*tp_as_mapping*/
4168 0, /*tp_hash */
4169 0, /*tp_call*/
4170 0, /*tp_str*/
4171 0, /*tp_getattro*/
4172 0, /*tp_setattro*/
4173 0, /*tp_as_buffer*/
4174 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4175 "Null importer object", /* tp_doc */
4176 0, /* tp_traverse */
4177 0, /* tp_clear */
4178 0, /* tp_richcompare */
4179 0, /* tp_weaklistoffset */
4180 0, /* tp_iter */
4181 0, /* tp_iternext */
4182 NullImporter_methods, /* tp_methods */
4183 0, /* tp_members */
4184 0, /* tp_getset */
4185 0, /* tp_base */
4186 0, /* tp_dict */
4187 0, /* tp_descr_get */
4188 0, /* tp_descr_set */
4189 0, /* tp_dictoffset */
4190 (initproc)NullImporter_init, /* tp_init */
4191 0, /* tp_alloc */
4192 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004193};
4194
Martin v. Löwis1a214512008-06-11 05:26:20 +00004195static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004196 PyModuleDef_HEAD_INIT,
4197 "imp",
4198 doc_imp,
4199 0,
4200 imp_methods,
4201 NULL,
4202 NULL,
4203 NULL,
4204 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004205};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004206
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004207PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004208PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004209{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004210 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004211
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004212 if (PyType_Ready(&PyNullImporter_Type) < 0)
4213 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004215 m = PyModule_Create(&impmodule);
4216 if (m == NULL)
4217 goto failure;
4218 d = PyModule_GetDict(m);
4219 if (d == NULL)
4220 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004221
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004222 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4223 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4224 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4225 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4226 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4227 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4228 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4229 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4230 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4231 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004232
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004233 Py_INCREF(&PyNullImporter_Type);
4234 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4235 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004236 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004237 Py_XDECREF(m);
4238 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004239}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004240
4241
Guido van Rossumb18618d2000-05-03 23:44:39 +00004242/* API for embedding applications that want to add their own entries
4243 to the table of built-in modules. This should normally be called
4244 *before* Py_Initialize(). When the table resize fails, -1 is
4245 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004246
4247 After a similar function by Just van Rossum. */
4248
4249int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004250PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004251{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004252 static struct _inittab *our_copy = NULL;
4253 struct _inittab *p;
4254 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004255
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004256 /* Count the number of entries in both tables */
4257 for (n = 0; newtab[n].name != NULL; n++)
4258 ;
4259 if (n == 0)
4260 return 0; /* Nothing to do */
4261 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4262 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004263
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004264 /* Allocate new memory for the combined table */
4265 p = our_copy;
4266 PyMem_RESIZE(p, struct _inittab, i+n+1);
4267 if (p == NULL)
4268 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004269
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004270 /* Copy the tables into the new memory */
4271 if (our_copy != PyImport_Inittab)
4272 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4273 PyImport_Inittab = our_copy = p;
4274 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004275
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004276 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004277}
4278
4279/* Shorthand to add a single entry given a name and a function */
4280
4281int
Brett Cannona826f322009-04-02 03:41:46 +00004282PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004283{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004284 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004285
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004286 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004287
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004288 newtab[0].name = (char *)name;
4289 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004290
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004291 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004292}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004293
4294#ifdef __cplusplus
4295}
4296#endif