blob: 3842c63c2e84ae6f7e64bfe92069de20f4d0c2d1 [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
271void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000272_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000273{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000274 Py_XDECREF(extensions);
275 extensions = NULL;
276 PyMem_DEL(_PyImport_Filetab);
277 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000278}
279
280
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000281/* Locking primitives to prevent parallel imports of the same module
282 in different threads to return with a partially loaded module.
283 These calls are serialized by the global interpreter lock. */
284
285#ifdef WITH_THREAD
286
Guido van Rossum49b56061998-10-01 20:42:43 +0000287#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000288
Guido van Rossum65d5b571998-12-21 19:32:43 +0000289static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000290static long import_lock_thread = -1;
291static int import_lock_level = 0;
292
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000293void
294_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000295{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000296 long me = PyThread_get_thread_ident();
297 if (me == -1)
298 return; /* Too bad */
299 if (import_lock == NULL) {
300 import_lock = PyThread_allocate_lock();
301 if (import_lock == NULL)
302 return; /* Nothing much we can do. */
303 }
304 if (import_lock_thread == me) {
305 import_lock_level++;
306 return;
307 }
308 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
309 {
310 PyThreadState *tstate = PyEval_SaveThread();
311 PyThread_acquire_lock(import_lock, 1);
312 PyEval_RestoreThread(tstate);
313 }
314 import_lock_thread = me;
315 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000316}
317
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000318int
319_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000320{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000321 long me = PyThread_get_thread_ident();
322 if (me == -1 || import_lock == NULL)
323 return 0; /* Too bad */
324 if (import_lock_thread != me)
325 return -1;
326 import_lock_level--;
327 if (import_lock_level == 0) {
328 import_lock_thread = -1;
329 PyThread_release_lock(import_lock);
330 }
331 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000332}
333
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000334/* This function is called from PyOS_AfterFork to ensure that newly
335 created child processes do not share locks with the parent.
336 We now acquire the import lock around fork() calls but on some platforms
337 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000338
339void
340_PyImport_ReInitLock(void)
341{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000342 if (import_lock != NULL)
343 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000344 if (import_lock_level > 1) {
345 /* Forked as a side effect of import */
346 long me = PyThread_get_thread_ident();
347 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100348 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000349 import_lock_thread = me;
350 import_lock_level--;
351 } else {
352 import_lock_thread = -1;
353 import_lock_level = 0;
354 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000355}
356
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000357#endif
358
Tim Peters69232342001-08-30 05:16:13 +0000359static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000360imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000361{
Tim Peters69232342001-08-30 05:16:13 +0000362#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000363 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000364#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000365 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000366#endif
367}
368
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000369static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000370imp_acquire_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 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000374#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000375 Py_INCREF(Py_None);
376 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000377}
378
379static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000380imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000381{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000382#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000383 if (_PyImport_ReleaseLock() < 0) {
384 PyErr_SetString(PyExc_RuntimeError,
385 "not holding the import lock");
386 return NULL;
387 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000388#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000389 Py_INCREF(Py_None);
390 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000391}
392
Guido van Rossumd8faa362007-04-27 19:54:29 +0000393static void
394imp_modules_reloading_clear(void)
395{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000396 PyInterpreterState *interp = PyThreadState_Get()->interp;
397 if (interp->modules_reloading != NULL)
398 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000399}
400
Guido van Rossum25ce5661997-08-02 03:10:38 +0000401/* Helper for sys */
402
403PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000404PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000405{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000406 PyInterpreterState *interp = PyThreadState_GET()->interp;
407 if (interp->modules == NULL)
408 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
409 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000410}
411
Guido van Rossum3f5da241990-12-20 15:06:42 +0000412
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000413/* List of names to clear in sys */
414static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000415 "path", "argv", "ps1", "ps2",
416 "last_type", "last_value", "last_traceback",
417 "path_hooks", "path_importer_cache", "meta_path",
418 /* misc stuff */
419 "flags", "float_info",
420 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000421};
422
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000423static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000424 "stdin", "__stdin__",
425 "stdout", "__stdout__",
426 "stderr", "__stderr__",
427 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000428};
429
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000430
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000431/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000432
Guido van Rossum3f5da241990-12-20 15:06:42 +0000433void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000434PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000435{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000436 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000437 PyObject *key, *value, *dict;
438 PyInterpreterState *interp = PyThreadState_GET()->interp;
439 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000440
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000441 if (modules == NULL)
442 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000444 /* Delete some special variables first. These are common
445 places where user values hide and people complain when their
446 destructors fail. Since the modules containing them are
447 deleted *last* of all, they would come too late in the normal
448 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000450 value = PyDict_GetItemString(modules, "builtins");
451 if (value != NULL && PyModule_Check(value)) {
452 dict = PyModule_GetDict(value);
453 if (Py_VerboseFlag)
454 PySys_WriteStderr("# clear builtins._\n");
455 PyDict_SetItemString(dict, "_", Py_None);
456 }
457 value = PyDict_GetItemString(modules, "sys");
458 if (value != NULL && PyModule_Check(value)) {
459 char **p;
460 PyObject *v;
461 dict = PyModule_GetDict(value);
462 for (p = sys_deletes; *p != NULL; p++) {
463 if (Py_VerboseFlag)
464 PySys_WriteStderr("# clear sys.%s\n", *p);
465 PyDict_SetItemString(dict, *p, Py_None);
466 }
467 for (p = sys_files; *p != NULL; p+=2) {
468 if (Py_VerboseFlag)
469 PySys_WriteStderr("# restore sys.%s\n", *p);
470 v = PyDict_GetItemString(dict, *(p+1));
471 if (v == NULL)
472 v = Py_None;
473 PyDict_SetItemString(dict, *p, v);
474 }
475 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000476
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000477 /* First, delete __main__ */
478 value = PyDict_GetItemString(modules, "__main__");
479 if (value != NULL && PyModule_Check(value)) {
480 if (Py_VerboseFlag)
481 PySys_WriteStderr("# cleanup __main__\n");
482 _PyModule_Clear(value);
483 PyDict_SetItemString(modules, "__main__", Py_None);
484 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000485
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000486 /* The special treatment of "builtins" here is because even
487 when it's not referenced as a module, its dictionary is
488 referenced by almost every module's __builtins__. Since
489 deleting a module clears its dictionary (even if there are
490 references left to it), we need to delete the "builtins"
491 module last. Likewise, we don't delete sys until the very
492 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000493
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000494 Also note that we 'delete' modules by replacing their entry
495 in the modules dict with None, rather than really deleting
496 them; this avoids a rehash of the modules dictionary and
497 also marks them as "non existent" so they won't be
498 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000499
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000500 /* Next, repeatedly delete modules with a reference count of
501 one (skipping builtins and sys) and delete them */
502 do {
503 ndone = 0;
504 pos = 0;
505 while (PyDict_Next(modules, &pos, &key, &value)) {
506 if (value->ob_refcnt != 1)
507 continue;
508 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100509 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000510 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100511 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000512 continue;
513 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100514 PySys_FormatStderr(
515 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000516 _PyModule_Clear(value);
517 PyDict_SetItem(modules, key, Py_None);
518 ndone++;
519 }
520 }
521 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000522
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000523 /* Next, delete all modules (still skipping builtins and sys) */
524 pos = 0;
525 while (PyDict_Next(modules, &pos, &key, &value)) {
526 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100527 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000528 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100529 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000530 continue;
531 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100532 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000533 _PyModule_Clear(value);
534 PyDict_SetItem(modules, key, Py_None);
535 }
536 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 /* Next, delete sys and builtins (in that order) */
539 value = PyDict_GetItemString(modules, "sys");
540 if (value != NULL && PyModule_Check(value)) {
541 if (Py_VerboseFlag)
542 PySys_WriteStderr("# cleanup sys\n");
543 _PyModule_Clear(value);
544 PyDict_SetItemString(modules, "sys", Py_None);
545 }
546 value = PyDict_GetItemString(modules, "builtins");
547 if (value != NULL && PyModule_Check(value)) {
548 if (Py_VerboseFlag)
549 PySys_WriteStderr("# cleanup builtins\n");
550 _PyModule_Clear(value);
551 PyDict_SetItemString(modules, "builtins", Py_None);
552 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000553
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000554 /* Finally, clear and delete the modules directory */
555 PyDict_Clear(modules);
556 interp->modules = NULL;
557 Py_DECREF(modules);
558 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000559}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000560
561
Barry Warsaw28a691b2010-04-17 00:19:56 +0000562/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000563
564long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000565PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000566{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000567 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000568}
569
570
Barry Warsaw28a691b2010-04-17 00:19:56 +0000571const char *
572PyImport_GetMagicTag(void)
573{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000574 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000575}
576
Guido van Rossum25ce5661997-08-02 03:10:38 +0000577/* Magic for extension modules (built-in as well as dynamically
578 loaded). To prevent initializing an extension module more than
579 once, we keep a static dictionary 'extensions' keyed by module name
580 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000581 modules), containing these modules. A copy of the module's
Victor Stinner95872862011-03-07 18:20:56 +0100582 dictionary is stored by calling _PyImport_FixupExtensionObject()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000583 immediately after the module initialization function succeeds. A
584 copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100585 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000586
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000587 Modules which do support multiple initialization set their m_size
588 field to a non-negative number (indicating the size of the
589 module-specific state). They are still recorded in the extensions
590 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000591*/
592
593int
Victor Stinner95872862011-03-07 18:20:56 +0100594_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
595 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000596{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000597 PyObject *modules, *dict;
598 struct PyModuleDef *def;
599 if (extensions == NULL) {
600 extensions = PyDict_New();
601 if (extensions == NULL)
602 return -1;
603 }
604 if (mod == NULL || !PyModule_Check(mod)) {
605 PyErr_BadInternalCall();
606 return -1;
607 }
608 def = PyModule_GetDef(mod);
609 if (!def) {
610 PyErr_BadInternalCall();
611 return -1;
612 }
613 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100614 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000615 return -1;
616 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100617 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000618 return -1;
619 }
620 if (def->m_size == -1) {
621 if (def->m_base.m_copy) {
622 /* Somebody already imported the module,
623 likely under a different name.
624 XXX this should really not happen. */
625 Py_DECREF(def->m_base.m_copy);
626 def->m_base.m_copy = NULL;
627 }
628 dict = PyModule_GetDict(mod);
629 if (dict == NULL)
630 return -1;
631 def->m_base.m_copy = PyDict_Copy(dict);
632 if (def->m_base.m_copy == NULL)
633 return -1;
634 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000635 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000636 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000637}
638
Victor Stinner49d3f252010-10-17 01:24:53 +0000639int
640_PyImport_FixupBuiltin(PyObject *mod, char *name)
641{
642 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100643 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100644 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100645 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000646 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100647 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
648 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000649 return res;
650}
651
Guido van Rossum25ce5661997-08-02 03:10:38 +0000652PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100653_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000654{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000655 PyObject *mod, *mdict;
656 PyModuleDef* def;
657 if (extensions == NULL)
658 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000659 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000660 if (def == NULL)
661 return NULL;
662 if (def->m_size == -1) {
663 /* Module does not support repeated initialization */
664 if (def->m_base.m_copy == NULL)
665 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100666 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000667 if (mod == NULL)
668 return NULL;
669 mdict = PyModule_GetDict(mod);
670 if (mdict == NULL)
671 return NULL;
672 if (PyDict_Update(mdict, def->m_base.m_copy))
673 return NULL;
674 }
675 else {
676 if (def->m_base.m_init == NULL)
677 return NULL;
678 mod = def->m_base.m_init();
679 if (mod == NULL)
680 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100681 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000682 Py_DECREF(mod);
683 }
684 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100685 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000686 Py_DECREF(mod);
687 return NULL;
688 }
689 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100690 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000691 name, filename);
692 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000693
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000694}
695
Victor Stinner49d3f252010-10-17 01:24:53 +0000696PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000697_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000698{
Victor Stinner95872862011-03-07 18:20:56 +0100699 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100700 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100701 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000702 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100703 res = _PyImport_FindExtensionObject(nameobj, nameobj);
704 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000705 return res;
706}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000707
708/* Get the module object corresponding to a module name.
709 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000710 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000711 Because the former action is most common, THIS DOES NOT RETURN A
712 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000713
Guido van Rossum79f25d91997-04-29 20:08:16 +0000714PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000715PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000716{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000717 PyObject *modules = PyImport_GetModuleDict();
718 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000719
Victor Stinner27ee0892011-03-04 12:57:09 +0000720 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000721 PyModule_Check(m))
722 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000723 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000724 if (m == NULL)
725 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000726 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000727 Py_DECREF(m);
728 return NULL;
729 }
730 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000731
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000732 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000733}
734
Victor Stinner27ee0892011-03-04 12:57:09 +0000735PyObject *
736PyImport_AddModule(const char *name)
737{
738 PyObject *nameobj, *module;
739 nameobj = PyUnicode_FromString(name);
740 if (nameobj == NULL)
741 return NULL;
742 module = PyImport_AddModuleObject(nameobj);
743 Py_DECREF(nameobj);
744 return module;
745}
746
747
Tim Peters1cd70172004-08-02 03:52:12 +0000748/* Remove name from sys.modules, if it's there. */
749static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000750remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000751{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000752 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000753 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000754 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000755 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000756 Py_FatalError("import: deleting existing key in"
757 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000758}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000759
Victor Stinnerc9abda02011-03-14 13:33:46 -0400760static PyObject * get_sourcefile(PyObject *filename);
761static PyObject *make_source_pathname(PyObject *pathname);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200762static PyObject* make_compiled_pathname(PyObject *pathname, int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000763
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000764/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000765 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
766 * removed from sys.modules, to avoid leaving damaged module objects
767 * in sys.modules. The caller may wish to restore the original
768 * module object (if any) in this case; PyImport_ReloadModule is an
769 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000770 *
771 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
772 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000773 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000774PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000775PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000776{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000777 return PyImport_ExecCodeModuleWithPathnames(
778 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000779}
780
781PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000782PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000783{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000784 return PyImport_ExecCodeModuleWithPathnames(
785 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000786}
787
788PyObject *
789PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000790 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000791{
Victor Stinner27ee0892011-03-04 12:57:09 +0000792 PyObject *m = NULL;
793 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
794
795 nameobj = PyUnicode_FromString(name);
796 if (nameobj == NULL)
797 return NULL;
798
799 if (pathname != NULL) {
800 pathobj = PyUnicode_DecodeFSDefault(pathname);
801 if (pathobj == NULL)
802 goto error;
803 } else
804 pathobj = NULL;
805 if (cpathname != NULL) {
806 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
807 if (cpathobj == NULL)
808 goto error;
809 } else
810 cpathobj = NULL;
811 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
812error:
813 Py_DECREF(nameobj);
814 Py_XDECREF(pathobj);
815 Py_XDECREF(cpathobj);
816 return m;
817}
818
819PyObject*
820PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
821 PyObject *cpathname)
822{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000823 PyObject *modules = PyImport_GetModuleDict();
824 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000825
Victor Stinner27ee0892011-03-04 12:57:09 +0000826 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000827 if (m == NULL)
828 return NULL;
829 /* If the module is being reloaded, we get the old module back
830 and re-use its dict to exec the new code. */
831 d = PyModule_GetDict(m);
832 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
833 if (PyDict_SetItemString(d, "__builtins__",
834 PyEval_GetBuiltins()) != 0)
835 goto error;
836 }
837 /* Remember the filename as the __file__ attribute */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000838 if (pathname != NULL) {
Victor Stinnerc9abda02011-03-14 13:33:46 -0400839 v = get_sourcefile(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000840 if (v == NULL)
841 PyErr_Clear();
842 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000843 else
844 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000845 if (v == NULL) {
846 v = ((PyCodeObject *)co)->co_filename;
847 Py_INCREF(v);
848 }
849 if (PyDict_SetItemString(d, "__file__", v) != 0)
850 PyErr_Clear(); /* Not important enough to report */
851 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000852
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000853 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000854 if (cpathname != NULL)
855 v = cpathname;
856 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000857 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000858 if (PyDict_SetItemString(d, "__cached__", v) != 0)
859 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000860
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000861 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000862 if (v == NULL)
863 goto error;
864 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000865
Victor Stinner27ee0892011-03-04 12:57:09 +0000866 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000868 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000869 name);
870 return NULL;
871 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000872
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000873 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000874
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000875 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000876
877 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000878 remove_module(name);
879 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000880}
881
882
Barry Warsaw28a691b2010-04-17 00:19:56 +0000883/* Like strrchr(string, '/') but searches for the rightmost of either SEP
884 or ALTSEP, if the latter is defined.
885*/
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200886static Py_UCS4*
887rightmost_sep(Py_UCS4 *s)
Victor Stinnerc9abda02011-03-14 13:33:46 -0400888{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200889 Py_UCS4 *found, c;
Victor Stinnerc9abda02011-03-14 13:33:46 -0400890 for (found = NULL; (c = *s); s++) {
891 if (c == SEP
892#ifdef ALTSEP
893 || c == ALTSEP
894#endif
895 )
896 {
897 found = s;
898 }
899 }
900 return found;
901}
902
Martin v. Löwis2db72862011-10-23 17:29:08 +0200903/* Like rightmost_sep, but operate on unicode objects. */
904static Py_ssize_t
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200905rightmost_sep_obj(PyObject* o, Py_ssize_t start, Py_ssize_t end)
Martin v. Löwis2db72862011-10-23 17:29:08 +0200906{
907 Py_ssize_t found, i;
908 Py_UCS4 c;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200909 for (found = -1, i = start; i < end; i++) {
Martin v. Löwis2db72862011-10-23 17:29:08 +0200910 c = PyUnicode_READ_CHAR(o, i);
911 if (c == SEP
912#ifdef ALTSEP
913 || c == ALTSEP
914#endif
915 )
916 {
917 found = i;
918 }
919 }
920 return found;
921}
Victor Stinnerc9abda02011-03-14 13:33:46 -0400922
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000923/* Given a pathname for a Python source file, fill a buffer with the
924 pathname for the corresponding compiled file. Return the pathname
925 for the compiled file, or NULL if there's no space in the buffer.
Victor Stinner2f42ae52011-03-20 00:41:24 +0100926 Doesn't set an exception.
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000927
Martin v. Löwis30260a72011-10-23 17:35:46 +0200928 foo.py -> __pycache__/foo.<tag>.pyc
929
930 pathstr is assumed to be "ready".
931*/
Victor Stinner2f42ae52011-03-20 00:41:24 +0100932
933static PyObject*
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200934make_compiled_pathname(PyObject *pathstr, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000935{
Martin v. Löwis2db72862011-10-23 17:29:08 +0200936 PyObject *result;
937 Py_ssize_t fname, ext, len, i, pos, taglen;
Martin v. Löwisfadcd312011-10-23 18:08:20 +0200938 Py_ssize_t pycache_len = sizeof(CACHEDIR) - 1;
Martin v. Löwis2db72862011-10-23 17:29:08 +0200939 int kind;
940 void *data;
Antoine Pitroub528fcf2011-10-25 00:21:02 +0200941 Py_UCS4 lastsep;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000942
Martin v. Löwis2db72862011-10-23 17:29:08 +0200943 /* Compute the output string size. */
944 len = PyUnicode_GET_LENGTH(pathstr);
945 /* If there is no separator, this returns -1, so
Antoine Pitroub528fcf2011-10-25 00:21:02 +0200946 fname will be 0. */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200947 fname = rightmost_sep_obj(pathstr, 0, len) + 1;
Antoine Pitroub528fcf2011-10-25 00:21:02 +0200948 /* Windows: re-use the last separator character (/ or \\) when
949 appending the __pycache__ path. */
950 if (fname > 0)
951 lastsep = PyUnicode_READ_CHAR(pathstr, fname -1);
952 else
953 lastsep = SEP;
Martin v. Löwis2db72862011-10-23 17:29:08 +0200954 ext = fname - 1;
955 for(i = fname; i < len; i++)
956 if (PyUnicode_READ_CHAR(pathstr, i) == '.')
957 ext = i + 1;
958 if (ext < fname)
959 /* No dot in filename; use entire filename */
960 ext = len;
961
962 /* result = pathstr[:fname] + "__pycache__" + SEP +
963 pathstr[fname:ext] + tag + ".py[co]" */
964 taglen = strlen(pyc_tag);
Martin v. Löwis2cc0cc52011-10-23 18:41:56 +0200965 result = PyUnicode_New(ext + pycache_len + 1 + taglen + 4,
Martin v. Löwis2db72862011-10-23 17:29:08 +0200966 PyUnicode_MAX_CHAR_VALUE(pathstr));
967 if (!result)
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200968 return NULL;
Martin v. Löwis2db72862011-10-23 17:29:08 +0200969 kind = PyUnicode_KIND(result);
970 data = PyUnicode_DATA(result);
971 PyUnicode_CopyCharacters(result, 0, pathstr, 0, fname);
972 pos = fname;
Martin v. Löwis2cc0cc52011-10-23 18:41:56 +0200973 for (i = 0; i < pycache_len; i++)
Martin v. Löwisfadcd312011-10-23 18:08:20 +0200974 PyUnicode_WRITE(kind, data, pos++, CACHEDIR[i]);
Antoine Pitroub528fcf2011-10-25 00:21:02 +0200975 PyUnicode_WRITE(kind, data, pos++, lastsep);
Martin v. Löwis2db72862011-10-23 17:29:08 +0200976 PyUnicode_CopyCharacters(result, pos, pathstr,
977 fname, ext - fname);
978 pos += ext - fname;
979 for (i = 0; pyc_tag[i]; i++)
980 PyUnicode_WRITE(kind, data, pos++, pyc_tag[i]);
981 PyUnicode_WRITE(kind, data, pos++, '.');
982 PyUnicode_WRITE(kind, data, pos++, 'p');
983 PyUnicode_WRITE(kind, data, pos++, 'y');
984 PyUnicode_WRITE(kind, data, pos++, debug ? 'c' : 'o');
985 return result;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000986}
987
988
Barry Warsaw28a691b2010-04-17 00:19:56 +0000989/* Given a pathname to a Python byte compiled file, return the path to the
990 source file, if the path matches the PEP 3147 format. This does not check
991 for any file existence, however, if the pyc file name does not match PEP
992 3147 style, NULL is returned. buf must be at least as big as pathname;
Victor Stinnerc9abda02011-03-14 13:33:46 -0400993 the resulting path will always be shorter.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000994
Victor Stinnerc9abda02011-03-14 13:33:46 -0400995 (...)/__pycache__/foo.<tag>.pyc -> (...)/foo.py */
996
997static PyObject*
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200998make_source_pathname(PyObject *path)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000999{
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001000 Py_ssize_t left, right, dot0, dot1, len;
1001 Py_ssize_t i, j;
1002 PyObject *result;
1003 int kind;
1004 void *data;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001005
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001006 len = PyUnicode_GET_LENGTH(path);
1007 if (len > MAXPATHLEN)
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001008 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001009
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 /* Look back two slashes from the end. In between these two slashes
1011 must be the string __pycache__ or this is not a PEP 3147 style
1012 path. It's possible for there to be only one slash.
1013 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001014 right = rightmost_sep_obj(path, 0, len);
1015 if (right == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001016 return NULL;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001017 left = rightmost_sep_obj(path, 0, right);
1018 if (left == -1)
1019 left = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001020 else
1021 left++;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001022 if (right-left != sizeof(CACHEDIR)-1)
1023 return NULL;
1024 for (i = 0; i < sizeof(CACHEDIR)-1; i++)
1025 if (PyUnicode_READ_CHAR(path, left+i) != CACHEDIR[i])
1026 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001027
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001028 /* Now verify that the path component to the right of the last slash
1029 has two dots in it.
1030 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001031 dot0 = PyUnicode_FindChar(path, '.', right+1, len, 1);
1032 if (dot0 < 0)
1033 return NULL;
1034 dot1 = PyUnicode_FindChar(path, '.', dot0+1, len, 1);
1035 if (dot1 < 0)
1036 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001037 /* Too many dots? */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001038 if (PyUnicode_FindChar(path, '.', dot1+1, len, 1) != -1)
1039 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001040
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001041 /* This is a PEP 3147 path. Start by copying everything from the
1042 start of pathname up to and including the leftmost slash. Then
1043 copy the file's basename, removing the magic tag and adding a .py
1044 suffix.
1045 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001046 result = PyUnicode_New(left + (dot0-right) + 2,
1047 PyUnicode_MAX_CHAR_VALUE(path));
1048 if (!result)
1049 return NULL;
1050 kind = PyUnicode_KIND(result);
1051 data = PyUnicode_DATA(result);
1052 PyUnicode_CopyCharacters(result, 0, path, 0, (i = left));
1053 PyUnicode_CopyCharacters(result, left, path, right+1,
1054 (j = dot0-right));
1055 PyUnicode_WRITE(kind, data, i+j, 'p');
1056 PyUnicode_WRITE(kind, data, i+j+1, 'y');
1057 return result;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001058}
1059
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001060/* Given a pathname for a Python source file, its time of last
1061 modification, and a pathname for a compiled file, check whether the
1062 compiled file represents the same version of the source. If so,
1063 return a FILE pointer for the compiled file, positioned just after
1064 the header; if not, return NULL.
1065 Doesn't set an exception. */
1066
1067static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001068check_compiled_module(PyObject *pathname, time_t mtime, PyObject *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001069{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001070 FILE *fp;
1071 long magic;
1072 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001073
Victor Stinner2f42ae52011-03-20 00:41:24 +01001074 fp = _Py_fopen(cpathname, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001075 if (fp == NULL)
1076 return NULL;
1077 magic = PyMarshal_ReadLongFromFile(fp);
1078 if (magic != pyc_magic) {
1079 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001080 PySys_FormatStderr("# %R has bad magic\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001081 fclose(fp);
1082 return NULL;
1083 }
1084 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
1085 if (pyc_mtime != mtime) {
1086 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001087 PySys_FormatStderr("# %R has bad mtime\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001088 fclose(fp);
1089 return NULL;
1090 }
1091 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001092 PySys_FormatStderr("# %R matches %R\n", cpathname, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001094}
1095
1096
1097/* Read a code object from a file and check it for validity */
1098
Guido van Rossum79f25d91997-04-29 20:08:16 +00001099static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001100read_compiled_module(PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001101{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001102 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001103
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001104 co = PyMarshal_ReadLastObjectFromFile(fp);
1105 if (co == NULL)
1106 return NULL;
1107 if (!PyCode_Check(co)) {
1108 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001109 "Non-code object in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001110 Py_DECREF(co);
1111 return NULL;
1112 }
1113 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001114}
1115
1116
1117/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001118 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001119
Guido van Rossum79f25d91997-04-29 20:08:16 +00001120static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001121load_compiled_module(PyObject *name, PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001122{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001123 long magic;
1124 PyCodeObject *co;
1125 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001127 magic = PyMarshal_ReadLongFromFile(fp);
1128 if (magic != pyc_magic) {
1129 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001130 "Bad magic number in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001131 return NULL;
1132 }
1133 (void) PyMarshal_ReadLongFromFile(fp);
1134 co = read_compiled_module(cpathname, fp);
1135 if (co == NULL)
1136 return NULL;
1137 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001138 PySys_FormatStderr("import %U # precompiled from %R\n",
1139 name, cpathname);
1140 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1141 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001142 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001143
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001144 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001145}
1146
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001147/* Parse a source file and return the corresponding code object */
1148
Guido van Rossum79f25d91997-04-29 20:08:16 +00001149static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001150parse_source_module(PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001151{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001152 PyCodeObject *co;
1153 PyObject *pathbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001154 mod_ty mod;
1155 PyCompilerFlags flags;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001156 PyArena *arena;
1157
1158 pathbytes = PyUnicode_EncodeFSDefault(pathname);
1159 if (pathbytes == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001160 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001161
Victor Stinner2f42ae52011-03-20 00:41:24 +01001162 arena = PyArena_New();
1163 if (arena == NULL) {
1164 Py_DECREF(pathbytes);
1165 return NULL;
1166 }
1167
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001168 flags.cf_flags = 0;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001169 mod = PyParser_ASTFromFile(fp, PyBytes_AS_STRING(pathbytes), NULL,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001170 Py_file_input, 0, 0, &flags,
1171 NULL, arena);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001172 if (mod != NULL)
1173 co = PyAST_Compile(mod, PyBytes_AS_STRING(pathbytes), NULL, arena);
1174 else
1175 co = NULL;
1176 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001177 PyArena_Free(arena);
1178 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001179}
1180
Guido van Rossum55a83382000-09-20 20:31:38 +00001181/* Helper to open a bytecode file for writing in exclusive mode */
1182
Victor Stinner783c82c2011-04-20 03:27:51 +02001183#ifndef MS_WINDOWS
Guido van Rossum55a83382000-09-20 20:31:38 +00001184static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +00001185open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +00001186{
1187#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001188 /* Use O_EXCL to avoid a race condition when another process tries to
1189 write the same file. When that happens, our open() call fails,
1190 which is just fine (since it's only a cache).
1191 XXX If the file exists and is writable but the directory is not
1192 writable, the file will never be written. Oh well.
1193 */
1194 int fd;
1195 (void) unlink(filename);
1196 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +00001197#ifdef O_BINARY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001198 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +00001199#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001200#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001201 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001202#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001203 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001204#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001205 );
1206 if (fd < 0)
1207 return NULL;
1208 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001209#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001210 /* Best we can do -- on Windows this can't happen anyway */
1211 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001212#endif
1213}
Victor Stinner783c82c2011-04-20 03:27:51 +02001214#endif
Guido van Rossum55a83382000-09-20 20:31:38 +00001215
1216
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001217/* Write a compiled module to a file, placing the time of last
1218 modification of its source into the header.
1219 Errors are ignored, if a write error occurs an attempt is made to
1220 remove the file. */
1221
1222static void
Victor Stinner2f42ae52011-03-20 00:41:24 +01001223write_compiled_module(PyCodeObject *co, PyObject *cpathname,
1224 struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001225{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001226 Py_UCS4 *cpathname_ucs4;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001227 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001228 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001229#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001230 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001231#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001232 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
1233 mode_t dirmode = (srcstat->st_mode |
1234 S_IXUSR | S_IXGRP | S_IXOTH |
1235 S_IWUSR | S_IWGRP | S_IWOTH);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001236 PyObject *dirbytes;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001237#endif
Victor Stinner783c82c2011-04-20 03:27:51 +02001238#ifdef MS_WINDOWS
1239 int fd;
1240#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001241 PyObject *cpathbytes, *cpathbytes_tmp;
1242 Py_ssize_t cpathbytes_len;
Victor Stinner783c82c2011-04-20 03:27:51 +02001243#endif
1244 PyObject *dirname;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001245 Py_UCS4 *dirsep;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001246 int res, ok;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 /* Ensure that the __pycache__ directory exists. */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001249 cpathname_ucs4 = PyUnicode_AsUCS4Copy(cpathname);
1250 if (!cpathname_ucs4)
1251 return;
1252 dirsep = rightmost_sep(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001253 if (dirsep == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001254 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001255 PySys_FormatStderr("# no %s path found %R\n", CACHEDIR, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001256 return;
1257 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001258 dirname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
1259 cpathname_ucs4,
1260 dirsep - cpathname_ucs4);
1261 PyMem_Free(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001262 if (dirname == NULL) {
1263 PyErr_Clear();
1264 return;
1265 }
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001266
1267#ifdef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001268 res = CreateDirectoryW(PyUnicode_AS_UNICODE(dirname), NULL);
1269 ok = (res != 0);
1270 if (!ok && GetLastError() == ERROR_ALREADY_EXISTS)
1271 ok = 1;
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001272#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001273 dirbytes = PyUnicode_EncodeFSDefault(dirname);
1274 if (dirbytes == NULL) {
1275 PyErr_Clear();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001276 return;
1277 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001278 res = mkdir(PyBytes_AS_STRING(dirbytes), dirmode);
1279 Py_DECREF(dirbytes);
1280 if (0 <= res)
1281 ok = 1;
1282 else
1283 ok = (errno == EEXIST);
1284#endif
1285 if (!ok) {
1286 if (Py_VerboseFlag)
1287 PySys_FormatStderr("# cannot create cache dir %R\n", dirname);
1288 Py_DECREF(dirname);
1289 return;
1290 }
1291 Py_DECREF(dirname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001292
Victor Stinner783c82c2011-04-20 03:27:51 +02001293#ifdef MS_WINDOWS
1294 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1295 fd = _wopen(PyUnicode_AS_UNICODE(cpathname),
1296 O_EXCL | O_CREAT | O_WRONLY | O_TRUNC | O_BINARY,
1297 mode);
1298 if (0 <= fd)
1299 fp = fdopen(fd, "wb");
1300 else
1301 fp = NULL;
1302#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001303 /* Under POSIX, we first write to a tmp file and then take advantage
1304 of atomic renaming. */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001305 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1306 if (cpathbytes == NULL) {
1307 PyErr_Clear();
1308 return;
1309 }
Antoine Pitrou707033a2011-10-17 19:28:44 +02001310 cpathbytes_len = PyBytes_GET_SIZE(cpathbytes);
1311 cpathbytes_tmp = PyBytes_FromStringAndSize(NULL, cpathbytes_len + 4);
1312 if (cpathbytes_tmp == NULL) {
1313 Py_DECREF(cpathbytes);
1314 PyErr_Clear();
1315 return;
1316 }
1317 memcpy(PyBytes_AS_STRING(cpathbytes_tmp), PyBytes_AS_STRING(cpathbytes),
1318 cpathbytes_len);
1319 memcpy(PyBytes_AS_STRING(cpathbytes_tmp) + cpathbytes_len, ".tmp", 4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001320
Antoine Pitrou707033a2011-10-17 19:28:44 +02001321 fp = open_exclusive(PyBytes_AS_STRING(cpathbytes_tmp), mode);
Victor Stinner783c82c2011-04-20 03:27:51 +02001322#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001323 if (fp == NULL) {
1324 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001325 PySys_FormatStderr(
1326 "# can't create %R\n", cpathname);
Victor Stinner783c82c2011-04-20 03:27:51 +02001327#ifndef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001328 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001329 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001330#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001331 return;
1332 }
1333 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1334 /* First write a 0 for mtime */
1335 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1336 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001337 fflush(fp);
1338 /* Now write the true mtime */
1339 fseek(fp, 4L, 0);
1340 assert(mtime < LONG_MAX);
1341 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001342 if (fflush(fp) != 0 || ferror(fp)) {
1343 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001344 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001345 /* Don't keep partial file */
1346 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001347#ifdef MS_WINDOWS
1348 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1349#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001350 (void) unlink(PyBytes_AS_STRING(cpathbytes_tmp));
Victor Stinner2f42ae52011-03-20 00:41:24 +01001351 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001352 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001353#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001354 return;
1355 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001356 fclose(fp);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001357 /* Under POSIX, do an atomic rename */
1358#ifndef MS_WINDOWS
1359 if (rename(PyBytes_AS_STRING(cpathbytes_tmp),
1360 PyBytes_AS_STRING(cpathbytes))) {
1361 if (Py_VerboseFlag)
1362 PySys_FormatStderr("# can't write %R\n", cpathname);
1363 /* Don't keep tmp file */
1364 unlink(PyBytes_AS_STRING(cpathbytes_tmp));
1365 Py_DECREF(cpathbytes);
1366 Py_DECREF(cpathbytes_tmp);
1367 return;
1368 }
1369 Py_DECREF(cpathbytes);
1370 Py_DECREF(cpathbytes_tmp);
1371#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001373 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001374}
1375
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001376static void
1377update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1378{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 PyObject *constants, *tmp;
1380 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001381
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001382 if (PyUnicode_Compare(co->co_filename, oldname))
1383 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001384
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001385 tmp = co->co_filename;
1386 co->co_filename = newname;
1387 Py_INCREF(co->co_filename);
1388 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001390 constants = co->co_consts;
1391 n = PyTuple_GET_SIZE(constants);
1392 for (i = 0; i < n; i++) {
1393 tmp = PyTuple_GET_ITEM(constants, i);
1394 if (PyCode_Check(tmp))
1395 update_code_filenames((PyCodeObject *)tmp,
1396 oldname, newname);
1397 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001398}
1399
Victor Stinner2f42ae52011-03-20 00:41:24 +01001400static void
1401update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001402{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001403 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001404
Victor Stinner2f42ae52011-03-20 00:41:24 +01001405 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1406 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001407
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001408 oldname = co->co_filename;
1409 Py_INCREF(oldname);
1410 update_code_filenames(co, oldname, newname);
1411 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001412}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001413
Brett Cannon442c9b92011-03-23 16:14:42 -07001414static PyObject *
1415imp_fix_co_filename(PyObject *self, PyObject *args)
1416{
1417 PyObject *co;
1418 PyObject *file_path;
1419
1420 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
1421 return NULL;
1422
1423 if (!PyCode_Check(co)) {
1424 PyErr_SetString(PyExc_TypeError,
1425 "first argument must be a code object");
1426 return NULL;
1427 }
1428
1429 if (!PyUnicode_Check(file_path)) {
1430 PyErr_SetString(PyExc_TypeError,
1431 "second argument must be a string");
1432 return NULL;
1433 }
1434
1435 update_compiled_module((PyCodeObject*)co, file_path);
1436
1437 Py_RETURN_NONE;
1438}
1439
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001440/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001441 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1442 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001443
Guido van Rossum79f25d91997-04-29 20:08:16 +00001444static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001445load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001446{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001447 struct stat st;
1448 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001449 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001450 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001451 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001452
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001453 if (fstat(fileno(fp), &st) != 0) {
1454 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001455 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 pathname);
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#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001460 /* Python's .pyc timestamp handling presumes that the timestamp fits
1461 in 4 bytes. This will be fine until sometime in the year 2038,
1462 when a 4-byte signed time_t will overflow.
1463 */
1464 if (st.st_mtime >> 32) {
1465 PyErr_SetString(PyExc_OverflowError,
1466 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001467 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001468 }
Fred Drake4c82b232000-06-30 16:18:57 +00001469#endif
Martin v. Löwis30260a72011-10-23 17:35:46 +02001470 if (PyUnicode_READY(pathname) < 0)
1471 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001472 cpathname = make_compiled_pathname(pathname, !Py_OptimizeFlag);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001473
1474 if (cpathname != NULL)
1475 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1476 else
1477 fpc = NULL;
1478
1479 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001480 co = read_compiled_module(cpathname, fpc);
1481 fclose(fpc);
1482 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001483 goto error;
1484 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001485 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001486 PySys_FormatStderr("import %U # precompiled from %R\n",
1487 name, cpathname);
1488 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1489 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001490 }
1491 else {
1492 co = parse_source_module(pathname, fp);
1493 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001494 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001495 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001496 PySys_FormatStderr("import %U # from %R\n",
Victor Stinner98dbba52011-03-14 15:15:47 -04001497 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001498 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001499 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1500 if (ro == NULL || !PyObject_IsTrue(ro))
1501 write_compiled_module(co, cpathname, &st);
1502 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001503 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1504 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001506 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001507
Victor Stinner2f42ae52011-03-20 00:41:24 +01001508error:
1509 Py_XDECREF(cpathbytes);
1510 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001511 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001512}
1513
Christian Heimes3b06e532008-01-07 20:12:44 +00001514/* Get source file -> unicode or None
1515 * Returns the path to the py file if available, else the given path
1516 */
1517static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001518get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001519{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001520 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001521 Py_UCS4 *fileuni;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001522 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001523 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001524
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001525 len = PyUnicode_GET_LENGTH(filename);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001526 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001527 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001528
Victor Stinnerc9abda02011-03-14 13:33:46 -04001529 /* don't match *.pyc or *.pyo? */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001530 fileuni = PyUnicode_AsUCS4Copy(filename);
1531 if (!fileuni)
1532 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001533 if (len < 5
1534 || fileuni[len-4] != '.'
1535 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1536 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1537 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001538
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001539 /* Start by trying to turn PEP 3147 path into source path. If that
1540 * fails, just chop off the trailing character, i.e. legacy pyc path
1541 * to py.
1542 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001543 py = make_source_pathname(filename);
1544 if (py == NULL) {
1545 PyErr_Clear();
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001546 py = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001547 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001548 if (py == NULL)
1549 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001550
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001551 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode)) {
1552 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001553 return py;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001554 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001555 Py_DECREF(py);
1556 goto unchanged;
1557
1558error:
1559 PyErr_Clear();
1560unchanged:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001561 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001562 Py_INCREF(filename);
1563 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001564}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001565
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001566/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001567static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001568static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001569 PyObject **, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001570static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001571
1572/* Load a package and return its module object WITH INCREMENTED
1573 REFERENCE COUNT */
1574
1575static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001576load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001577{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001578 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001579 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001580 int err;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001581 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001582 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001583
Victor Stinnerc9abda02011-03-14 13:33:46 -04001584 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 if (m == NULL)
1586 return NULL;
1587 if (Py_VerboseFlag)
Victor Stinner98dbba52011-03-14 15:15:47 -04001588 PySys_FormatStderr("import %U # directory %R\n",
1589 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 file = get_sourcefile(pathname);
1591 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001592 return NULL;
1593 path_list = Py_BuildValue("[O]", file);
1594 if (path_list == NULL) {
1595 Py_DECREF(file);
1596 return NULL;
1597 }
1598 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001599 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001600 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001601 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001602 err = PyDict_SetItemString(d, "__path__", path_list);
1603 if (err != 0) {
1604 Py_DECREF(path_list);
1605 return NULL;
1606 }
Victor Stinner533d7832011-03-14 13:22:54 -04001607 fdp = find_module(name, initstr, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001608 &bufobj, &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001609 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001610 if (fdp == NULL) {
1611 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1612 PyErr_Clear();
1613 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001614 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 }
1616 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001617 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001618 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001619 m = load_module(name, fp, bufobj, fdp->type, NULL);
1620 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001621 if (fp != NULL)
1622 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001624}
1625
1626
1627/* Helper to test for built-in module */
1628
1629static int
Victor Stinner95872862011-03-07 18:20:56 +01001630is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001631{
Victor Stinner95872862011-03-07 18:20:56 +01001632 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001633 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001634 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1635 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001636 if (PyImport_Inittab[i].initfunc == NULL)
1637 return -1;
1638 else
1639 return 1;
1640 }
1641 }
1642 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001643}
1644
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001645
Just van Rossum52e14d62002-12-30 22:08:05 +00001646/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1647 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001648 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001649 that can handle the path item. Return None if no hook could;
1650 this tells our caller it should fall back to the builtin
1651 import mechanism. Cache the result in path_importer_cache.
1652 Returns a borrowed reference. */
1653
1654static PyObject *
1655get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001656 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001657{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001658 PyObject *importer;
1659 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001660
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001661 /* These conditions are the caller's responsibility: */
1662 assert(PyList_Check(path_hooks));
1663 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001664
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001665 nhooks = PyList_Size(path_hooks);
1666 if (nhooks < 0)
1667 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001668
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001669 importer = PyDict_GetItem(path_importer_cache, p);
1670 if (importer != NULL)
1671 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001672
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001673 /* set path_importer_cache[p] to None to avoid recursion */
1674 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1675 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001676
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 for (j = 0; j < nhooks; j++) {
1678 PyObject *hook = PyList_GetItem(path_hooks, j);
1679 if (hook == NULL)
1680 return NULL;
1681 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1682 if (importer != NULL)
1683 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001684
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1686 return NULL;
1687 }
1688 PyErr_Clear();
1689 }
1690 if (importer == NULL) {
1691 importer = PyObject_CallFunctionObjArgs(
1692 (PyObject *)&PyNullImporter_Type, p, NULL
1693 );
1694 if (importer == NULL) {
1695 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1696 PyErr_Clear();
1697 return Py_None;
1698 }
1699 }
1700 }
1701 if (importer != NULL) {
1702 int err = PyDict_SetItem(path_importer_cache, p, importer);
1703 Py_DECREF(importer);
1704 if (err != 0)
1705 return NULL;
1706 }
1707 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001708}
1709
Christian Heimes9cd17752007-11-18 19:35:23 +00001710PyAPI_FUNC(PyObject *)
1711PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001712 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001713
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001714 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1715 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1716 importer = get_path_importer(path_importer_cache,
1717 path_hooks, path);
1718 }
1719 }
1720 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1721 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001722}
1723
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001724/* Search the path (default sys.path) for a module. Return the
1725 corresponding filedescr struct, and (via return arguments) the
1726 pathname and an open file. Return NULL if the module is not found. */
1727
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001728#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001729extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1730 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001731#endif
1732
Victor Stinner547a2a62011-03-20 03:07:28 +01001733/* Forward */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001734static int case_ok(PyObject *, Py_ssize_t, PyObject *);
Victor Stinner547a2a62011-03-20 03:07:28 +01001735static int find_init_module(PyObject *);
Just van Rossum52e14d62002-12-30 22:08:05 +00001736static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001737
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001738/* Get the path of a module: get its importer and call importer.find_module()
1739 hook, or check if the module if a package (if path/__init__.py exists).
1740
1741 -1: error: a Python error occurred
1742 0: ignore: an error occurred because of invalid data, but the error is not
1743 important enough to be reported.
1744 1: get path: module not found, but *buf contains its path
1745 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1746 and *buf is the path */
1747
1748static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001749find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001750 PyObject *path_hooks, PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001751 PyObject **p_path, PyObject **p_loader, struct filedescr **p_fd)
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001752{
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001753 PyObject *path_unicode, *filename = NULL;
1754 Py_ssize_t len, pos;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001755 struct stat statbuf;
1756 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001757 int result, addsep;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001758
1759 if (PyUnicode_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001760 Py_INCREF(path);
1761 path_unicode = path;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001762 }
1763 else if (PyBytes_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001764 path_unicode = PyUnicode_DecodeFSDefaultAndSize(
1765 PyBytes_AS_STRING(path), PyBytes_GET_SIZE(path));
1766 if (path_unicode == NULL)
1767 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001768 }
1769 else
1770 return 0;
1771
Victor Stinner46084ba2011-10-06 02:39:42 +02001772 if (PyUnicode_READY(path_unicode))
1773 return -1;
1774
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001775 len = PyUnicode_GET_LENGTH(path_unicode);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001776 if (PyUnicode_FindChar(path_unicode, 0, 0, len, 1) != -1) {
1777 result = 0;
1778 goto out; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001779 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001780
1781 /* sys.path_hooks import hook */
1782 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001783 _Py_IDENTIFIER(find_module);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001784 PyObject *importer;
1785
1786 importer = get_path_importer(path_importer_cache,
1787 path_hooks, path);
1788 if (importer == NULL) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001789 result = -1;
1790 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001791 }
1792 /* Note: importer is a borrowed reference */
1793 if (importer != Py_None) {
1794 PyObject *loader;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001795 loader = _PyObject_CallMethodId(importer,
1796 &PyId_find_module, "O", fullname);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001797 if (loader == NULL) {
1798 result = -1; /* error */
1799 goto out;
1800 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001801 if (loader != Py_None) {
1802 /* a loader was found */
1803 *p_loader = loader;
1804 *p_fd = &importhookdescr;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001805 result = 2;
1806 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001807 }
1808 Py_DECREF(loader);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001809 result = 0;
1810 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001811 }
1812 }
1813 /* no hook was found, use builtin import */
1814
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001815 addsep = 0;
1816 if (len > 0 && PyUnicode_READ_CHAR(path_unicode, len-1) != SEP
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001817#ifdef ALTSEP
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001818 && PyUnicode_READ_CHAR(path_unicode, len-1) != ALTSEP
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001819#endif
1820 )
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001821 addsep = 1;
1822 filename = PyUnicode_New(len + PyUnicode_GET_LENGTH(name) + addsep,
1823 Py_MAX(PyUnicode_MAX_CHAR_VALUE(path_unicode),
1824 PyUnicode_MAX_CHAR_VALUE(name)));
1825 if (filename == NULL) {
1826 result = -1;
1827 goto out;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001828 }
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001829 PyUnicode_CopyCharacters(filename, 0, path_unicode, 0, len);
1830 pos = len;
1831 if (addsep)
1832 PyUnicode_WRITE(PyUnicode_KIND(filename),
1833 PyUnicode_DATA(filename),
1834 pos++, SEP);
1835 PyUnicode_CopyCharacters(filename, pos, name, 0,
1836 PyUnicode_GET_LENGTH(name));
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001837
1838 /* Check for package import (buf holds a directory name,
1839 and there's an __init__ module in that directory */
1840#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001841 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001842 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1843 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001844 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001845
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001846 match = case_ok(filename, 0, name);
1847 if (match < 0) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001848 result = -1;
1849 goto out;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001850 }
1851 if (match) { /* case matches */
1852 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001853 *p_path = filename;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001854 filename = NULL;
Victor Stinnerd0296212011-03-14 14:04:10 -04001855 *p_fd = &fd_package;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001856 result = 2;
1857 goto out;
Victor Stinnerd0296212011-03-14 14:04:10 -04001858 }
1859 else {
1860 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001861 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001862 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001863 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001864 if (err) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001865 result = -1;
1866 goto out;
Victor Stinner547a2a62011-03-20 03:07:28 +01001867 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001868 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001869 }
1870 }
1871#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001872 *p_path = filename;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001873 filename = NULL;
1874 result = 1;
1875 out:
1876 Py_DECREF(path_unicode);
1877 Py_XDECREF(filename);
1878 return result;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001879}
1880
1881/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001882 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001883
1884 If the module is found, return a file descriptor, write the path in
1885 *p_filename, write the pointer to the file object into *p_fp, and (if
1886 p_loader is not NULL) the loader into *p_loader.
1887
1888 Otherwise, raise an exception and return NULL. */
1889
Victor Stinner37580282011-03-20 01:34:43 +01001890static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001891find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001892 PyObject *search_path_list, PyObject *path_hooks,
1893 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001894 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001895{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001896 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001897 struct filedescr *fdp = NULL;
1898 char *filemode;
1899 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001900 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001901 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001902
Victor Stinner37580282011-03-20 01:34:43 +01001903 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001904 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001905 PyObject *path;
1906 int ok;
1907
1908 path = PyList_GetItem(search_path_list, i);
1909 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001910 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001911
Victor Stinner2fd76e42011-03-14 15:19:39 -04001912 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001913 ok = find_module_path(fullname, name, path,
1914 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001915 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001916 if (ok < 0)
1917 return NULL;
1918 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001919 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001920 if (ok == 2) {
1921 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001922 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001923 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001924
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001925 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001926 struct stat statbuf;
1927
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001928 filemode = fdp->mode;
1929 if (filemode[0] == 'U')
1930 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001931
Victor Stinner2fd76e42011-03-14 15:19:39 -04001932 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1933 if (filename == NULL) {
1934 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001935 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001936 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001937
1938 if (Py_VerboseFlag > 1)
1939 PySys_FormatStderr("# trying %R\n", filename);
1940
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001941 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
1942 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1943 {
1944 Py_DECREF(filename);
1945 continue;
1946 }
1947
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001948 fp = _Py_fopen(filename, filemode);
1949 if (fp == NULL) {
1950 Py_DECREF(filename);
Victor Stinner925ef392011-06-20 15:01:10 +02001951 if (PyErr_Occurred()) {
1952 Py_DECREF(prefix);
1953 return NULL;
1954 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001955 continue;
1956 }
1957 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1958 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001959 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001960 Py_DECREF(filename);
1961 return NULL;
1962 }
1963 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001964 Py_DECREF(prefix);
1965 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001966 *p_fp = fp;
1967 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001968 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001969 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001970
1971 fclose(fp);
1972 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001973 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001974 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001975 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001976 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04001977 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04001978 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001979}
1980
Victor Stinner37580282011-03-20 01:34:43 +01001981/* Find a module:
1982
1983 - try find_module() of each sys.meta_path hook
1984 - try find_frozen()
1985 - try is_builtin()
1986 - try _PyWin_FindRegisteredModule() (Windows only)
1987 - otherwise, call find_module_path_list() with search_path_list (if not
1988 NULL) or sys.path
1989
Victor Stinner2fd76e42011-03-14 15:19:39 -04001990 fullname can be NULL, but only if p_loader is NULL.
1991
Victor Stinner37580282011-03-20 01:34:43 +01001992 Return:
1993
1994 - &fd_builtin (C_BUILTIN) if it is a builtin
1995 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04001996 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01001997 if it is a package
1998 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1999 importer loader was found
2000 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
2001 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04002002 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01002003 - NULL on error
2004
Victor Stinner2fd76e42011-03-14 15:19:39 -04002005 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
2006 Eg. *p_path is set to NULL for a builtin package.
2007*/
Victor Stinner37580282011-03-20 01:34:43 +01002008
2009static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002010find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002011 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01002012{
2013 Py_ssize_t i, npath;
2014 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
2015 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
2016 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01002017
Victor Stinner2fd76e42011-03-14 15:19:39 -04002018 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01002019 *p_fp = NULL;
2020 if (p_loader != NULL)
2021 *p_loader = NULL;
2022
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002023 if (PyUnicode_GET_LENGTH(name) > MAXPATHLEN) {
2024 PyErr_SetString(PyExc_OverflowError,
2025 "module name is too long");
2026 return NULL;
2027 }
2028
Victor Stinner37580282011-03-20 01:34:43 +01002029 /* sys.meta_path import hook */
2030 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002031 _Py_IDENTIFIER(find_module);
Victor Stinner37580282011-03-20 01:34:43 +01002032 PyObject *meta_path;
2033
2034 meta_path = PySys_GetObject("meta_path");
2035 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02002036 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002037 "sys.meta_path must be a list of "
2038 "import hooks");
2039 return NULL;
2040 }
2041 Py_INCREF(meta_path); /* zap guard */
2042 npath = PyList_Size(meta_path);
2043 for (i = 0; i < npath; i++) {
2044 PyObject *loader;
2045 PyObject *hook = PyList_GetItem(meta_path, i);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002046 loader = _PyObject_CallMethodId(hook, &PyId_find_module,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002047 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01002048 search_path_list != NULL ?
2049 search_path_list : Py_None);
2050 if (loader == NULL) {
2051 Py_DECREF(meta_path);
2052 return NULL; /* true error */
2053 }
2054 if (loader != Py_None) {
2055 /* a loader was found */
2056 *p_loader = loader;
2057 Py_DECREF(meta_path);
2058 return &importhookdescr;
2059 }
2060 Py_DECREF(loader);
2061 }
2062 Py_DECREF(meta_path);
2063 }
2064
Victor Stinnerdf75a022011-03-14 13:40:04 -04002065 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002066 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01002067
2068 if (search_path_list == NULL) {
2069#ifdef MS_COREDLL
2070 FILE *fp;
2071 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01002072#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04002073 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01002074 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01002075#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04002076 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01002077 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01002078 *p_fp = fp;
2079 return fdp;
2080 }
2081 else if (PyErr_Occurred())
2082 return NULL;
2083#endif
Victor Stinner37580282011-03-20 01:34:43 +01002084 search_path_list = PySys_GetObject("path");
2085 }
2086
2087 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
Victor Stinner16191322011-09-15 19:28:05 +02002088 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002089 "sys.path must be a list of directory names");
2090 return NULL;
2091 }
2092
2093 path_hooks = PySys_GetObject("path_hooks");
2094 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02002095 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002096 "sys.path_hooks must be a list of "
2097 "import hooks");
2098 return NULL;
2099 }
2100 path_importer_cache = PySys_GetObject("path_importer_cache");
2101 if (path_importer_cache == NULL ||
2102 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02002103 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002104 "sys.path_importer_cache must be a dict");
2105 return NULL;
2106 }
2107
2108 return find_module_path_list(fullname, name,
2109 search_path_list, path_hooks,
2110 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002111 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002112}
2113
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002114/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002115 * The arguments here are tricky, best shown by example:
2116 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2117 * ^ ^ ^ ^
2118 * |--------------------- buf ---------------------|
2119 * |------------------- len ------------------|
2120 * |------ name -------|
2121 * |----- namelen -----|
2122 * buf is the full path, but len only counts up to (& exclusive of) the
2123 * extension. name is the module name, also exclusive of extension.
2124 *
2125 * We've already done a successful stat() or fopen() on buf, so know that
2126 * there's some match, possibly case-insensitive.
2127 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002128 * case_bytes() is to return 1 if there's a case-sensitive match for
2129 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002130 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002131 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002132 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002133 * on platforms with case-insensitive filesystems. It's trivial to implement
2134 * for case-sensitive filesystems. It's pretty much a cross-platform
2135 * nightmare for systems with case-insensitive filesystems.
2136 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002137
Tim Peters50d8d372001-02-28 05:34:27 +00002138/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002139 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002140 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002141#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002142#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002143
Tim Peters50d8d372001-02-28 05:34:27 +00002144#elif defined(DJGPP)
2145#include <dir.h>
2146
Jason Tishler7961aa62005-05-20 00:56:54 +00002147#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002148#include <sys/types.h>
2149#include <dirent.h>
2150
Andrew MacIntyred9400542002-02-26 11:41:34 +00002151#elif defined(PYOS_OS2)
2152#define INCL_DOS
2153#define INCL_DOSERRORS
2154#define INCL_NOPMAPI
2155#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002156#endif
2157
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002158#if defined(DJGPP) \
2159 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2160 && defined(HAVE_DIRENT_H)) \
2161 || defined(PYOS_OS2)
2162# define USE_CASE_OK_BYTES
2163#endif
2164
2165
2166#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002167static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002168case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002169{
Tim Peters50d8d372001-02-28 05:34:27 +00002170/* Pick a platform-specific implementation; the sequence of #if's here should
2171 * match the sequence just above.
2172 */
2173
Tim Peters50d8d372001-02-28 05:34:27 +00002174/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002175#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002176 struct ffblk ffblk;
2177 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002178
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002179 if (Py_GETENV("PYTHONCASEOK") != NULL)
2180 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002181
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002182 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2183 if (done) {
2184 PyErr_Format(PyExc_NameError,
2185 "Can't find file for module %.100s\n(filename %.300s)",
2186 name, buf);
Victor Stinner9c61e242011-03-22 01:22:27 +01002187 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002188 }
2189 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002190
Jason Tishler7961aa62005-05-20 00:56:54 +00002191/* new-fangled macintosh (macosx) or Cygwin */
2192#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002193 DIR *dirp;
2194 struct dirent *dp;
2195 char dirname[MAXPATHLEN + 1];
2196 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002197
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002198 if (Py_GETENV("PYTHONCASEOK") != NULL)
2199 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002200
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002201 /* Copy the dir component into dirname; substitute "." if empty */
2202 if (dirlen <= 0) {
2203 dirname[0] = '.';
2204 dirname[1] = '\0';
2205 }
2206 else {
2207 assert(dirlen <= MAXPATHLEN);
2208 memcpy(dirname, buf, dirlen);
2209 dirname[dirlen] = '\0';
2210 }
2211 /* Open the directory and search the entries for an exact match. */
2212 dirp = opendir(dirname);
2213 if (dirp) {
2214 char *nameWithExt = buf + len - namelen;
2215 while ((dp = readdir(dirp)) != NULL) {
2216 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002217#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002218 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002219#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002220 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002221#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002222 if (thislen >= namelen &&
2223 strcmp(dp->d_name, nameWithExt) == 0) {
2224 (void)closedir(dirp);
2225 return 1; /* Found */
2226 }
2227 }
2228 (void)closedir(dirp);
2229 }
2230 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002231
Andrew MacIntyred9400542002-02-26 11:41:34 +00002232/* OS/2 */
2233#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002234 HDIR hdir = 1;
2235 ULONG srchcnt = 1;
2236 FILEFINDBUF3 ffbuf;
2237 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002238
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002239 if (Py_GETENV("PYTHONCASEOK") != NULL)
2240 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002241
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002242 rc = DosFindFirst(buf,
2243 &hdir,
2244 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2245 &ffbuf, sizeof(ffbuf),
2246 &srchcnt,
2247 FIL_STANDARD);
2248 if (rc != NO_ERROR)
2249 return 0;
2250 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002251
Tim Peters50d8d372001-02-28 05:34:27 +00002252/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2253#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002254# error "USE_CASE_OK_BYTES is not correctly defined"
2255#endif
2256}
2257#endif
2258
2259/*
2260 * Check if a filename case matchs the name case. We've already done a
2261 * successful stat() or fopen() on buf, so know that there's some match,
2262 * possibly case-insensitive.
2263 *
2264 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2265 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2266 * if envar PYTHONCASEOK exists.
2267 *
2268 * case_ok() is used to implement case-sensitive import semantics even
2269 * on platforms with case-insensitive filesystems. It's trivial to implement
2270 * for case-sensitive filesystems. It's pretty much a cross-platform
2271 * nightmare for systems with case-insensitive filesystems.
2272 */
2273
2274static int
2275case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2276{
2277#ifdef MS_WINDOWS
2278 WIN32_FIND_DATAW data;
2279 HANDLE h;
2280 int cmp;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002281 wchar_t *wname;
Victor Stinner8c981892011-10-11 22:27:13 +02002282 Py_ssize_t wname_len;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002283
2284 if (Py_GETENV("PYTHONCASEOK") != NULL)
2285 return 1;
2286
2287 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2288 if (h == INVALID_HANDLE_VALUE) {
2289 PyErr_Format(PyExc_NameError,
2290 "Can't find file for module %R\n(filename %R)",
2291 name, filename);
2292 return 0;
2293 }
2294 FindClose(h);
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002295
2296 wname = PyUnicode_AsUnicodeAndSize(name, &wname_len);
2297 if (wname == NULL)
2298 return -1;
2299
2300 cmp = wcsncmp(data.cFileName, wname, wname_len);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002301 return cmp == 0;
2302#elif defined(USE_CASE_OK_BYTES)
2303 int match;
2304 PyObject *filebytes, *namebytes;
2305 filebytes = PyUnicode_EncodeFSDefault(filename);
2306 if (filebytes == NULL)
2307 return -1;
2308 namebytes = PyUnicode_EncodeFSDefault(name);
2309 if (namebytes == NULL) {
2310 Py_DECREF(filebytes);
2311 return -1;
2312 }
2313 match = case_bytes(
2314 PyBytes_AS_STRING(filebytes),
2315 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002316 PyBytes_GET_SIZE(namebytes),
2317 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002318 Py_DECREF(filebytes);
2319 Py_DECREF(namebytes);
2320 return match;
2321#else
2322 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002323 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002324
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002325#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002326}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002327
Guido van Rossum197346f1997-10-31 18:38:52 +00002328#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002329
Victor Stinner547a2a62011-03-20 03:07:28 +01002330/* Helper to look for __init__.py or __init__.py[co] in potential package.
2331 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002332static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002333find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002334{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002335 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002336 PyObject *filename;
2337 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002338
Victor Stinner547a2a62011-03-20 03:07:28 +01002339 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2340 if (filename == NULL)
2341 return -1;
2342 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002343 /* 3=len(".py") */
2344 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002345 if (match < 0) {
2346 Py_DECREF(filename);
2347 return -1;
2348 }
2349 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002350 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002351 return 1;
2352 }
2353 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002354 Py_DECREF(filename);
2355
2356 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2357 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2358 if (filename == NULL)
2359 return -1;
2360 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002361 /* 4=len(".pyc") */
2362 match = case_ok(filename, -4, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002363 if (match < 0) {
2364 Py_DECREF(filename);
2365 return -1;
2366 }
2367 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002368 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002369 return 1;
2370 }
2371 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002372 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002373 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002374}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002375
Guido van Rossum197346f1997-10-31 18:38:52 +00002376#endif /* HAVE_STAT */
2377
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002378
Victor Stinner95872862011-03-07 18:20:56 +01002379static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002380
Victor Stinner44c6c152010-08-09 00:59:10 +00002381static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002382load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002383{
2384 PyObject *m, *modules;
2385 int err;
2386
Victor Stinner44c6c152010-08-09 00:59:10 +00002387 if (type == C_BUILTIN)
2388 err = init_builtin(name);
2389 else
Victor Stinner95872862011-03-07 18:20:56 +01002390 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002391 if (err < 0)
2392 return NULL;
2393 if (err == 0) {
2394 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002395 "Purported %s module %R not found",
2396 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002397 name);
2398 return NULL;
2399 }
2400
2401 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002402 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002403 if (m == NULL) {
2404 PyErr_Format(
2405 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002406 "%s module %R not properly initialized",
2407 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002408 name);
2409 return NULL;
2410 }
2411 Py_INCREF(m);
2412 return m;
2413}
2414
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002415/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002416 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002417
Guido van Rossum79f25d91997-04-29 20:08:16 +00002418static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002419load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002420{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002421 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002422
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002423 /* First check that there's an open file (if we need one) */
2424 switch (type) {
2425 case PY_SOURCE:
2426 case PY_COMPILED:
2427 if (fp == NULL) {
2428 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002429 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002430 type);
2431 return NULL;
2432 }
2433 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002434
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002435 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002436
Victor Stinner41c5fec2011-03-13 21:46:30 -04002437 case PY_SOURCE:
2438 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002439 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002440
Victor Stinner41c5fec2011-03-13 21:46:30 -04002441 case PY_COMPILED:
2442 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002443 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002444
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002445#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002446 case C_EXTENSION:
2447 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002448 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002449#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002450
Victor Stinner41c5fec2011-03-13 21:46:30 -04002451 case PKG_DIRECTORY:
2452 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002453 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002454
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002455 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002456 case PY_FROZEN:
2457 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002458 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002460 case IMP_HOOK: {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002461 _Py_IDENTIFIER(load_module);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002462 if (loader == NULL) {
2463 PyErr_SetString(PyExc_ImportError,
2464 "import hook without loader");
2465 return NULL;
2466 }
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002467 m = _PyObject_CallMethodId(loader, &PyId_load_module, "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002468 break;
2469 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002471 default:
2472 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002473 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002474 name, type);
2475 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002476
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002477 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002478
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002479 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002480}
2481
2482
2483/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002484 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002485 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002486
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002487static int
Victor Stinner95872862011-03-07 18:20:56 +01002488init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002489{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002490 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002491
Victor Stinner95872862011-03-07 18:20:56 +01002492 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002493 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002494
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002495 for (p = PyImport_Inittab; p->name != NULL; p++) {
2496 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002497 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002498 if (p->initfunc == NULL) {
2499 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002500 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002501 name);
2502 return -1;
2503 }
2504 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002505 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002506 mod = (*p->initfunc)();
2507 if (mod == 0)
2508 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002509 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002510 return -1;
2511 /* FixupExtension has put the module into sys.modules,
2512 so we can release our own reference. */
2513 Py_DECREF(mod);
2514 return 1;
2515 }
2516 }
2517 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002518}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002519
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002520
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002521/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002522
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002523static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002524find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002525{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002526 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002527
Victor Stinner53dc7352011-03-20 01:50:21 +01002528 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002529 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002530
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002531 for (p = PyImport_FrozenModules; ; p++) {
2532 if (p->name == NULL)
2533 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002534 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002535 break;
2536 }
2537 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002538}
2539
Guido van Rossum79f25d91997-04-29 20:08:16 +00002540static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002541get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002542{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002543 struct _frozen *p = find_frozen(name);
2544 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002545
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002546 if (p == NULL) {
2547 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002548 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002549 name);
2550 return NULL;
2551 }
2552 if (p->code == NULL) {
2553 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002554 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002555 name);
2556 return NULL;
2557 }
2558 size = p->size;
2559 if (size < 0)
2560 size = -size;
2561 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002562}
2563
Brett Cannon8d110132009-03-15 02:20:16 +00002564static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002565is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002566{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002567 struct _frozen *p = find_frozen(name);
2568 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002569
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002570 if (p == NULL) {
2571 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002572 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002573 name);
2574 return NULL;
2575 }
Brett Cannon8d110132009-03-15 02:20:16 +00002576
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002577 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002578
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002579 if (size < 0)
2580 Py_RETURN_TRUE;
2581 else
2582 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002583}
2584
2585
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002586/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002587 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002588 an exception set if the initialization failed.
2589 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002590
2591int
Victor Stinner53dc7352011-03-20 01:50:21 +01002592PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002593{
Victor Stinner53dc7352011-03-20 01:50:21 +01002594 struct _frozen *p;
2595 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002596 int ispackage;
2597 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002598
Victor Stinner53dc7352011-03-20 01:50:21 +01002599 p = find_frozen(name);
2600
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002601 if (p == NULL)
2602 return 0;
2603 if (p->code == NULL) {
2604 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002605 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002606 name);
2607 return -1;
2608 }
2609 size = p->size;
2610 ispackage = (size < 0);
2611 if (ispackage)
2612 size = -size;
2613 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002614 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002615 name, ispackage ? " package" : "");
2616 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2617 if (co == NULL)
2618 return -1;
2619 if (!PyCode_Check(co)) {
2620 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002621 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002622 name);
2623 goto err_return;
2624 }
2625 if (ispackage) {
2626 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002627 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002628 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002629 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002630 if (m == NULL)
2631 goto err_return;
2632 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002633 l = PyList_New(1);
2634 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002635 goto err_return;
2636 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002637 Py_INCREF(name);
2638 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002639 err = PyDict_SetItemString(d, "__path__", l);
2640 Py_DECREF(l);
2641 if (err != 0)
2642 goto err_return;
2643 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002644 path = PyUnicode_FromString("<frozen>");
2645 if (path == NULL)
2646 goto err_return;
2647 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2648 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002649 if (m == NULL)
2650 goto err_return;
2651 Py_DECREF(co);
2652 Py_DECREF(m);
2653 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002654err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002655 Py_DECREF(co);
2656 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002657}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002658
Victor Stinner53dc7352011-03-20 01:50:21 +01002659int
2660PyImport_ImportFrozenModule(char *name)
2661{
2662 PyObject *nameobj;
2663 int ret;
2664 nameobj = PyUnicode_InternFromString(name);
2665 if (nameobj == NULL)
2666 return -1;
2667 ret = PyImport_ImportFrozenModuleObject(nameobj);
2668 Py_DECREF(nameobj);
2669 return ret;
2670}
2671
Guido van Rossum74e6a111994-08-29 12:54:38 +00002672
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002673/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002674 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002675
Guido van Rossum79f25d91997-04-29 20:08:16 +00002676PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002677PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002678{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002679 PyObject *pname;
2680 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002681
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002682 pname = PyUnicode_FromString(name);
2683 if (pname == NULL)
2684 return NULL;
2685 result = PyImport_Import(pname);
2686 Py_DECREF(pname);
2687 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002688}
2689
Christian Heimes072c0f12008-01-03 23:01:04 +00002690/* Import a module without blocking
2691 *
2692 * At first it tries to fetch the module from sys.modules. If the module was
2693 * never loaded before it loads it with PyImport_ImportModule() unless another
2694 * thread holds the import lock. In the latter case the function raises an
2695 * ImportError instead of blocking.
2696 *
2697 * Returns the module object with incremented ref count.
2698 */
2699PyObject *
2700PyImport_ImportModuleNoBlock(const char *name)
2701{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002702 PyObject *nameobj, *modules, *result;
Victor Stinner0af03062011-09-02 00:11:43 +02002703#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002704 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002705#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002706
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002707 /* Try to get the module from sys.modules[name] */
2708 modules = PyImport_GetModuleDict();
2709 if (modules == NULL)
2710 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002711
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002712 nameobj = PyUnicode_FromString(name);
2713 if (nameobj == NULL)
2714 return NULL;
2715 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002716 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002717 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002718 Py_INCREF(result);
2719 return result;
2720 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002721 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002722#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002723 /* check the import lock
2724 * me might be -1 but I ignore the error here, the lock function
2725 * takes care of the problem */
2726 me = PyThread_get_thread_ident();
2727 if (import_lock_thread == -1 || import_lock_thread == me) {
2728 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002729 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002730 }
2731 else {
2732 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002733 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002734 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002735 nameobj);
2736 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002737 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002738#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002739 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002740#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002741 Py_DECREF(nameobj);
2742 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002743}
2744
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002745/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002746static PyObject *get_parent(PyObject *globals,
2747 PyObject **p_name,
2748 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002749static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002750 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002751 Py_UCS4 *buf, Py_ssize_t *p_buflen,
Victor Stinner974389d2011-03-15 09:33:57 +01002752 Py_ssize_t bufsize);
2753static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002754static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002755 PyObject *buf, int recursive);
2756static PyObject * import_submodule(PyObject *mod, PyObject *name,
2757 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002758
2759/* The Magnum Opus of dotted-name import :-) */
2760
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002761static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002762import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002763 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002764{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002765 Py_UCS4 buf[MAXPATHLEN+1];
Victor Stinner974389d2011-03-15 09:33:57 +01002766 Py_ssize_t buflen;
2767 Py_ssize_t bufsize = MAXPATHLEN+1;
2768 PyObject *parent, *head, *next, *tail, *inputname, *outputname;
2769 PyObject *parent_name, *ensure_name;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002770 Py_ssize_t sep, altsep;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002771
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002772 if (PyUnicode_READY(name))
2773 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002774
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002775 sep = PyUnicode_FindChar(name, SEP, 0, PyUnicode_GET_LENGTH(name), 1);
2776 if (sep == -2)
2777 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002778#ifdef ALTSEP
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002779 altsep = PyUnicode_FindChar(name, ALTSEP, 0, PyUnicode_GET_LENGTH(name), 1);
2780 if (altsep == -2)
2781 return NULL;
2782#else
2783 altsep = -1;
Christian Heimes454f37b2008-01-10 00:10:02 +00002784#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002785 if (sep != -1 || altsep != -1)
2786 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002787 PyErr_SetString(PyExc_ImportError,
2788 "Import by filename is not supported.");
2789 return NULL;
2790 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002791
Victor Stinner974389d2011-03-15 09:33:57 +01002792 parent = get_parent(globals, &parent_name, level);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002793 if (parent == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002794 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002795 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002796
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002797 if (PyUnicode_READY(parent_name))
2798 return NULL;
2799 buflen = PyUnicode_GET_LENGTH(parent_name);
Georg Brandl4cb0de22011-09-28 21:49:49 +02002800 if (!PyUnicode_AsUCS4(parent_name, buf, Py_ARRAY_LENGTH(buf), 1)) {
Victor Stinner974389d2011-03-15 09:33:57 +01002801 Py_DECREF(parent_name);
2802 PyErr_SetString(PyExc_ValueError,
2803 "Module name too long");
2804 return NULL;
2805 }
Victor Stinner974389d2011-03-15 09:33:57 +01002806 Py_DECREF(parent_name);
2807
2808 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
2809 buf, &buflen, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002810 if (head == NULL)
2811 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002812
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002813 tail = head;
2814 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002815
2816 if (outputname != NULL) {
2817 while (1) {
2818 inputname = outputname;
2819 next = load_next(tail, tail, inputname, &outputname,
2820 buf, &buflen, bufsize);
2821 Py_DECREF(tail);
2822 Py_DECREF(inputname);
2823 if (next == NULL) {
2824 Py_DECREF(head);
2825 return NULL;
2826 }
2827 tail = next;
2828
2829 if (outputname == NULL) {
2830 break;
2831 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002832 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002833 }
2834 if (tail == Py_None) {
2835 /* If tail is Py_None, both get_parent and load_next found
2836 an empty module name: someone called __import__("") or
2837 doctored faulty bytecode */
2838 Py_DECREF(tail);
2839 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002840 PyErr_SetString(PyExc_ValueError, "Empty module name");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002841 return NULL;
2842 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002843
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002844 if (fromlist != NULL) {
2845 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2846 fromlist = NULL;
2847 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002848
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002849 if (fromlist == NULL) {
2850 Py_DECREF(tail);
2851 return head;
2852 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002853
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002854 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002855
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002856 ensure_name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
2857 buf, Py_UCS4_strlen(buf));
Victor Stinner974389d2011-03-15 09:33:57 +01002858 if (ensure_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002859 Py_DECREF(tail);
2860 return NULL;
2861 }
Victor Stinner974389d2011-03-15 09:33:57 +01002862 if (!ensure_fromlist(tail, fromlist, ensure_name, 0)) {
2863 Py_DECREF(tail);
2864 Py_DECREF(ensure_name);
2865 return NULL;
2866 }
2867 Py_DECREF(ensure_name);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002868
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002869 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002870}
2871
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002872PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002873PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2874 PyObject *locals, PyObject *fromlist,
2875 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002876{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002877 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002878 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002879 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002880 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002881 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002882 PyErr_SetString(PyExc_RuntimeError,
2883 "not holding the import lock");
2884 return NULL;
2885 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002886 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002887}
2888
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002889PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05002890PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002891 PyObject *fromlist, int level)
2892{
2893 PyObject *nameobj, *mod;
2894 nameobj = PyUnicode_FromString(name);
2895 if (nameobj == NULL)
2896 return NULL;
2897 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2898 fromlist, level);
2899 Py_DECREF(nameobj);
2900 return mod;
2901}
2902
2903
Fred Drake87590902004-05-28 20:21:36 +00002904/* Return the package that an import is being performed in. If globals comes
2905 from the module foo.bar.bat (not itself a package), this returns the
2906 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002907 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002908
Victor Stinner974389d2011-03-15 09:33:57 +01002909 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002910
2911 If globals doesn't come from a package or a module in a package, or a
2912 corresponding entry is not found in sys.modules, Py_None is returned.
2913*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002914static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002915get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002916{
Victor Stinner974389d2011-03-15 09:33:57 +01002917 PyObject *nameobj;
2918
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002919 static PyObject *namestr = NULL;
2920 static PyObject *pathstr = NULL;
2921 static PyObject *pkgstr = NULL;
2922 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2923 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002924
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002925 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002926 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002927
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002928 if (namestr == NULL) {
2929 namestr = PyUnicode_InternFromString("__name__");
2930 if (namestr == NULL)
2931 return NULL;
2932 }
2933 if (pathstr == NULL) {
2934 pathstr = PyUnicode_InternFromString("__path__");
2935 if (pathstr == NULL)
2936 return NULL;
2937 }
2938 if (pkgstr == NULL) {
2939 pkgstr = PyUnicode_InternFromString("__package__");
2940 if (pkgstr == NULL)
2941 return NULL;
2942 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002943
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002944 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002945
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002946 if ((pkgname != NULL) && (pkgname != Py_None)) {
2947 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002948 if (!PyUnicode_Check(pkgname)) {
2949 PyErr_SetString(PyExc_ValueError,
2950 "__package__ set to non-string");
2951 return NULL;
2952 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002953 if (PyUnicode_GET_LENGTH(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002954 if (level > 0) {
2955 PyErr_SetString(PyExc_ValueError,
2956 "Attempted relative import in non-package");
2957 return NULL;
2958 }
Victor Stinner974389d2011-03-15 09:33:57 +01002959 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002960 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002961 Py_INCREF(pkgname);
2962 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002963 } else {
2964 /* __package__ not set, so figure it out and set it */
2965 modname = PyDict_GetItem(globals, namestr);
2966 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002967 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002968
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002969 modpath = PyDict_GetItem(globals, pathstr);
2970 if (modpath != NULL) {
2971 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002972 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002973
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002974 error = PyDict_SetItem(globals, pkgstr, modname);
2975 if (error) {
2976 PyErr_SetString(PyExc_ValueError,
2977 "Could not set __package__");
2978 return NULL;
2979 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002980 Py_INCREF(modname);
2981 nameobj = modname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002982 } else {
2983 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002984 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002985 len = PyUnicode_FindChar(modname, '.',
2986 0, PyUnicode_GET_LENGTH(modname), -1);
2987 if (len == -2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002988 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002989 if (len < 0) {
2990 if (level > 0) {
2991 PyErr_SetString(PyExc_ValueError,
2992 "Attempted relative import in non-package");
2993 return NULL;
2994 }
2995 if (PyDict_SetItem(globals, pkgstr, Py_None)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002996 PyErr_SetString(PyExc_ValueError,
2997 "Could not set __package__");
2998 return NULL;
2999 }
Victor Stinner974389d2011-03-15 09:33:57 +01003000 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003001 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003002 pkgname = PyUnicode_Substring(modname, 0, len);
3003 if (pkgname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003004 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003005 if (PyDict_SetItem(globals, pkgstr, pkgname)) {
3006 Py_DECREF(pkgname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003007 PyErr_SetString(PyExc_ValueError,
3008 "Could not set __package__");
3009 return NULL;
3010 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003011 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003012 }
3013 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003014 if (level > 1) {
3015 Py_ssize_t dot, end = PyUnicode_GET_LENGTH(nameobj);
3016 PyObject *newname;
3017 while (--level > 0) {
3018 dot = PyUnicode_FindChar(nameobj, '.', 0, end, -1);
3019 if (dot == -2) {
3020 Py_DECREF(nameobj);
3021 return NULL;
3022 }
3023 if (dot < 0) {
3024 Py_DECREF(nameobj);
3025 PyErr_SetString(PyExc_ValueError,
3026 "Attempted relative import beyond "
3027 "toplevel package");
3028 return NULL;
3029 }
3030 end = dot;
3031 }
3032 newname = PyUnicode_Substring(nameobj, 0, end);
3033 Py_DECREF(nameobj);
3034 if (newname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003035 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003036 nameobj = newname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003037 }
Victor Stinner974389d2011-03-15 09:33:57 +01003038
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003039 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003040 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003041 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003042 int err;
3043
3044 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003045 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01003046 "Parent module %R not loaded, "
3047 "cannot perform relative import", nameobj);
3048 Py_DECREF(nameobj);
3049 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003050 }
Victor Stinner974389d2011-03-15 09:33:57 +01003051
3052 err = PyErr_WarnFormat(
3053 PyExc_RuntimeWarning, 1,
3054 "Parent module %R not found while handling absolute import",
3055 nameobj);
3056 Py_DECREF(nameobj);
3057 if (err)
3058 return NULL;
3059
3060 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003061 }
Victor Stinner974389d2011-03-15 09:33:57 +01003062 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003063 return parent;
3064 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01003065 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003066 - parent.__dict__ is globals
3067 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01003068
3069return_none:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003070 nameobj = PyUnicode_New(0, 0);
Victor Stinner974389d2011-03-15 09:33:57 +01003071 if (nameobj == NULL)
3072 return NULL;
3073 *p_name = nameobj;
3074 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003075}
3076
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003077/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003078static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003079load_next(PyObject *mod, PyObject *altmod,
3080 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003081 Py_UCS4 *buf, Py_ssize_t *p_buflen, Py_ssize_t bufsize)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003082{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003083 Py_UCS4 *dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003084 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003085 Py_UCS4 *p;
Victor Stinner974389d2011-03-15 09:33:57 +01003086 PyObject *fullname, *name, *result, *mark_name;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003087 Py_UCS4 *nameuni;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003088
Victor Stinner974389d2011-03-15 09:33:57 +01003089 *p_outputname = NULL;
3090
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003091 if (PyUnicode_GET_LENGTH(inputname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003092 /* completely empty module name should only happen in
3093 'from . import' (or '__import__("")')*/
3094 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003095 return mod;
3096 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00003097
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003098 nameuni = PyUnicode_AsUCS4Copy(inputname);
Victor Stinner974389d2011-03-15 09:33:57 +01003099 if (nameuni == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003100 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003101
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003102 dot = Py_UCS4_strchr(nameuni, '.');
Victor Stinner974389d2011-03-15 09:33:57 +01003103 if (dot != NULL) {
3104 len = dot - nameuni;
3105 if (len == 0) {
3106 PyErr_SetString(PyExc_ValueError,
3107 "Empty module name");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003108 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003109 }
3110 }
3111 else
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003112 len = PyUnicode_GET_LENGTH(inputname);
Victor Stinner974389d2011-03-15 09:33:57 +01003113
3114 if (*p_buflen+len+1 >= bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003115 PyErr_SetString(PyExc_ValueError,
3116 "Module name too long");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003117 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003118 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003119
Victor Stinner974389d2011-03-15 09:33:57 +01003120 p = buf + *p_buflen;
3121 if (p != buf) {
3122 *p++ = '.';
3123 *p_buflen += 1;
3124 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003125 Py_UCS4_strncpy(p, nameuni, len);
Victor Stinner974389d2011-03-15 09:33:57 +01003126 p[len] = '\0';
3127 *p_buflen += len;
3128
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003129 fullname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3130 buf, *p_buflen);
Victor Stinner974389d2011-03-15 09:33:57 +01003131 if (fullname == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003132 goto error;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003133 name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3134 p, len);
Victor Stinner974389d2011-03-15 09:33:57 +01003135 if (name == NULL) {
3136 Py_DECREF(fullname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003137 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003138 }
3139 result = import_submodule(mod, name, fullname);
3140 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003141 if (result == Py_None && altmod != mod) {
3142 Py_DECREF(result);
3143 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003144 result = import_submodule(altmod, name, name);
3145 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003146 if (result != NULL && result != Py_None) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003147 mark_name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3148 buf, *p_buflen);
Victor Stinner974389d2011-03-15 09:33:57 +01003149 if (mark_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003150 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003151 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003152 }
Victor Stinner974389d2011-03-15 09:33:57 +01003153 if (mark_miss(mark_name) != 0) {
3154 Py_DECREF(result);
3155 Py_DECREF(mark_name);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003156 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003157 }
3158 Py_DECREF(mark_name);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003159 Py_UCS4_strncpy(buf, nameuni, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003160 buf[len] = '\0';
3161 *p_buflen = len;
3162 }
3163 }
Victor Stinner974389d2011-03-15 09:33:57 +01003164 else
3165 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003166 if (result == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003167 goto error;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003168
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003169 if (result == Py_None) {
3170 Py_DECREF(result);
3171 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003172 "No module named %R", inputname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003173 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003174 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003175
Victor Stinner974389d2011-03-15 09:33:57 +01003176 if (dot != NULL) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003177 *p_outputname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3178 dot+1, Py_UCS4_strlen(dot+1));
Victor Stinner974389d2011-03-15 09:33:57 +01003179 if (*p_outputname == NULL) {
3180 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003181 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003182 }
3183 }
3184
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003185 PyMem_Free(nameuni);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003186 return result;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003187
3188error:
3189 PyMem_Free(nameuni);
3190 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003191}
3192
3193static int
Victor Stinner974389d2011-03-15 09:33:57 +01003194mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003195{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003196 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003197 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003198}
3199
3200static int
Victor Stinner974389d2011-03-15 09:33:57 +01003201ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003202 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003203{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003204 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003205 PyObject *fullname;
3206 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003207
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003208 if (!_PyObject_HasAttrId(mod, &PyId___path__))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003209 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003210
Victor Stinner974389d2011-03-15 09:33:57 +01003211 fromlist_len = PySequence_Size(fromlist);
3212
3213 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003214 PyObject *item = PySequence_GetItem(fromlist, i);
3215 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003216 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003217 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003218 if (!PyUnicode_Check(item)) {
3219 PyErr_SetString(PyExc_TypeError,
3220 "Item in ``from list'' not a string");
3221 Py_DECREF(item);
3222 return 0;
3223 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003224 if (PyUnicode_READ_CHAR(item, 0) == '*') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003225 PyObject *all;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02003226 _Py_IDENTIFIER(__all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003227 Py_DECREF(item);
3228 /* See if the package defines __all__ */
3229 if (recursive)
3230 continue; /* Avoid endless recursion */
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003231 all = _PyObject_GetAttrId(mod, &PyId___all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003232 if (all == NULL)
3233 PyErr_Clear();
3234 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003235 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003236 Py_DECREF(all);
3237 if (!ret)
3238 return 0;
3239 }
3240 continue;
3241 }
3242 hasit = PyObject_HasAttr(mod, item);
3243 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003244 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003245 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3246 if (fullname != NULL) {
3247 submod = import_submodule(mod, item, fullname);
3248 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003249 }
Victor Stinner974389d2011-03-15 09:33:57 +01003250 else
3251 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003252 Py_XDECREF(submod);
3253 if (submod == NULL) {
3254 Py_DECREF(item);
3255 return 0;
3256 }
3257 }
3258 Py_DECREF(item);
3259 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003260
Victor Stinner974389d2011-03-15 09:33:57 +01003261 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003262}
3263
Neil Schemenauer00b09662003-06-16 21:03:07 +00003264static int
Victor Stinner974389d2011-03-15 09:33:57 +01003265add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3266 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003267{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003268 if (mod == Py_None)
3269 return 1;
3270 /* Irrespective of the success of this load, make a
3271 reference to it in the parent package module. A copy gets
3272 saved in the modules dictionary under the full name, so get a
3273 reference from there, if need be. (The exception is when the
3274 load failed with a SyntaxError -- then there's no trace in
3275 sys.modules. In that case, of course, do nothing extra.) */
3276 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003277 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003278 if (submod == NULL)
3279 return 1;
3280 }
3281 if (PyModule_Check(mod)) {
3282 /* We can't use setattr here since it can give a
3283 * spurious warning if the submodule name shadows a
3284 * builtin name */
3285 PyObject *dict = PyModule_GetDict(mod);
3286 if (!dict)
3287 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003288 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003289 return 0;
3290 }
3291 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003292 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003293 return 0;
3294 }
3295 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003296}
3297
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003298static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003299import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003300{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003301 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003302 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003303 struct filedescr *fdp;
3304 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003305
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003306 /* Require:
3307 if mod == None: subname == fullname
3308 else: mod.__name__ + "." + subname == fullname
3309 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003310
Victor Stinner974389d2011-03-15 09:33:57 +01003311 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003312 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003313 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003314 }
Victor Stinner9599de52011-03-13 22:38:38 -04003315
3316 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003317 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003318 else {
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003319 path_list = _PyObject_GetAttrId(mod, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003320 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003321 PyErr_Clear();
3322 Py_INCREF(Py_None);
3323 return Py_None;
3324 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003325 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003326
Victor Stinner533d7832011-03-14 13:22:54 -04003327 fdp = find_module(fullname, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003328 &bufobj, &fp, &loader);
Victor Stinner533d7832011-03-14 13:22:54 -04003329 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003330 if (fdp == NULL) {
3331 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3332 return NULL;
3333 PyErr_Clear();
3334 Py_INCREF(Py_None);
3335 return Py_None;
3336 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003337 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3338 Py_XDECREF(bufobj);
Victor Stinner9599de52011-03-13 22:38:38 -04003339 Py_XDECREF(loader);
3340 if (fp)
3341 fclose(fp);
3342 if (m == NULL)
3343 return NULL;
3344 if (!add_submodule(mod, m, fullname, subname, modules)) {
3345 Py_XDECREF(m);
3346 return NULL;
3347 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003348 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003349}
3350
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003351
3352/* Re-import a module of any kind and return its module object, WITH
3353 INCREMENTED REFERENCE COUNT */
3354
Guido van Rossum79f25d91997-04-29 20:08:16 +00003355PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003356PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003357{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003358 PyInterpreterState *interp = PyThreadState_Get()->interp;
3359 PyObject *modules_reloading = interp->modules_reloading;
3360 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003361 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003362 PyObject *nameobj, *bufobj, *subnameobj;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003363 Py_UCS4 *name = NULL, *subname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003364 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003365 FILE *fp = NULL;
3366 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003367
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003368 if (modules_reloading == NULL) {
3369 Py_FatalError("PyImport_ReloadModule: "
3370 "no modules_reloading dictionary!");
3371 return NULL;
3372 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003373
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003374 if (m == NULL || !PyModule_Check(m)) {
3375 PyErr_SetString(PyExc_TypeError,
3376 "reload() argument must be module");
3377 return NULL;
3378 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003379 nameobj = PyModule_GetNameObject(m);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003380 if (nameobj == NULL || PyUnicode_READY(nameobj) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003381 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003382 if (m != PyDict_GetItem(modules, nameobj)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003383 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003384 "reload(): module %R not in sys.modules",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003385 nameobj);
3386 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003387 return NULL;
3388 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003389 existing_m = PyDict_GetItem(modules_reloading, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003390 if (existing_m != NULL) {
3391 /* Due to a recursive reload, this module is already
3392 being reloaded. */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003393 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003394 Py_INCREF(existing_m);
3395 return existing_m;
3396 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003397 if (PyDict_SetItem(modules_reloading, nameobj, m) < 0) {
3398 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003399 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003400 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003401
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003402 name = PyUnicode_AsUCS4Copy(nameobj);
3403 if (!name) {
3404 Py_DECREF(nameobj);
3405 return NULL;
3406 }
3407 subname = Py_UCS4_strrchr(name, '.');
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003408 if (subname == NULL) {
3409 Py_INCREF(nameobj);
3410 subnameobj = nameobj;
3411 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003412 else {
3413 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003414 Py_ssize_t len;
3415 len = subname - name;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003416 parentname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3417 name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003418 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003419 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003420 }
3421 parent = PyDict_GetItem(modules, parentname);
3422 if (parent == NULL) {
3423 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003424 "reload(): parent %R not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003425 parentname);
3426 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003427 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003428 }
3429 Py_DECREF(parentname);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003430 path_list = _PyObject_GetAttrId(parent, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003431 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003432 PyErr_Clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003433 subname++;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003434 len = PyUnicode_GET_LENGTH(nameobj) - (len + 1);
3435 subnameobj = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3436 subname, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003437 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003438 if (subnameobj == NULL)
3439 goto error;
Victor Stinner533d7832011-03-14 13:22:54 -04003440 fdp = find_module(nameobj, subnameobj, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003441 &bufobj, &fp, &loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003442 Py_DECREF(subnameobj);
Victor Stinner533d7832011-03-14 13:22:54 -04003443 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003445 if (fdp == NULL) {
3446 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003447 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003448 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003449
Victor Stinner2fd76e42011-03-14 15:19:39 -04003450 newm = load_module(nameobj, fp, bufobj, fdp->type, loader);
3451 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003452 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003454 if (fp)
3455 fclose(fp);
3456 if (newm == NULL) {
3457 /* load_module probably removed name from modules because of
3458 * the error. Put back the original module object. We're
3459 * going to return NULL in this case regardless of whether
3460 * replacing name succeeds, so the return value is ignored.
3461 */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003462 PyDict_SetItem(modules, nameobj, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003463 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003464
3465error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003466 imp_modules_reloading_clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003467 Py_DECREF(nameobj);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003468 PyMem_Free(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003469 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003470}
3471
3472
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003473/* Higher-level import emulator which emulates the "import" statement
3474 more accurately -- it invokes the __import__() function from the
3475 builtins of the current globals. This means that the import is
3476 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003477 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003478 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003479 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003480 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003481
3482PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003483PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003484{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003485 static PyObject *silly_list = NULL;
3486 static PyObject *builtins_str = NULL;
3487 static PyObject *import_str = NULL;
3488 PyObject *globals = NULL;
3489 PyObject *import = NULL;
3490 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003491 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003492 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003493
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003494 /* Initialize constant string objects */
3495 if (silly_list == NULL) {
3496 import_str = PyUnicode_InternFromString("__import__");
3497 if (import_str == NULL)
3498 return NULL;
3499 builtins_str = PyUnicode_InternFromString("__builtins__");
3500 if (builtins_str == NULL)
3501 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003502 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003503 if (silly_list == NULL)
3504 return NULL;
3505 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003507 /* Get the builtins from current globals */
3508 globals = PyEval_GetGlobals();
3509 if (globals != NULL) {
3510 Py_INCREF(globals);
3511 builtins = PyObject_GetItem(globals, builtins_str);
3512 if (builtins == NULL)
3513 goto err;
3514 }
3515 else {
3516 /* No globals -- use standard builtins, and fake globals */
3517 builtins = PyImport_ImportModuleLevel("builtins",
3518 NULL, NULL, NULL, 0);
3519 if (builtins == NULL)
3520 return NULL;
3521 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3522 if (globals == NULL)
3523 goto err;
3524 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003525
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003526 /* Get the __import__ function from the builtins */
3527 if (PyDict_Check(builtins)) {
3528 import = PyObject_GetItem(builtins, import_str);
3529 if (import == NULL)
3530 PyErr_SetObject(PyExc_KeyError, import_str);
3531 }
3532 else
3533 import = PyObject_GetAttr(builtins, import_str);
3534 if (import == NULL)
3535 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003537 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003538 Always use absolute import here.
3539 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003540 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3541 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003542 if (r == NULL)
3543 goto err;
3544 Py_DECREF(r);
3545
3546 modules = PyImport_GetModuleDict();
3547 r = PyDict_GetItem(modules, module_name);
3548 if (r != NULL)
3549 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003550
3551 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003552 Py_XDECREF(globals);
3553 Py_XDECREF(builtins);
3554 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003555
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003556 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003557}
3558
3559
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003560/* Module 'imp' provides Python access to the primitives used for
3561 importing modules.
3562*/
3563
Guido van Rossum79f25d91997-04-29 20:08:16 +00003564static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003565imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003566{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003567 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003568
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003569 buf[0] = (char) ((magic >> 0) & 0xff);
3570 buf[1] = (char) ((magic >> 8) & 0xff);
3571 buf[2] = (char) ((magic >> 16) & 0xff);
3572 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003573
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003574 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003575}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003576
3577static PyObject *
3578imp_get_magic(PyObject *self, PyObject *noargs)
3579{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003580 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003581}
3582
3583static PyObject *
3584imp_get_tag(PyObject *self, PyObject *noargs)
3585{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003586 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003587}
3588
Guido van Rossum79f25d91997-04-29 20:08:16 +00003589static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003590imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003591{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003592 PyObject *list;
3593 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003594
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003595 list = PyList_New(0);
3596 if (list == NULL)
3597 return NULL;
3598 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3599 PyObject *item = Py_BuildValue("ssi",
3600 fdp->suffix, fdp->mode, fdp->type);
3601 if (item == NULL) {
3602 Py_DECREF(list);
3603 return NULL;
3604 }
3605 if (PyList_Append(list, item) < 0) {
3606 Py_DECREF(list);
3607 Py_DECREF(item);
3608 return NULL;
3609 }
3610 Py_DECREF(item);
3611 }
3612 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003613}
3614
Guido van Rossum79f25d91997-04-29 20:08:16 +00003615static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003616call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003617{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003618 extern int fclose(FILE *);
3619 PyObject *fob, *ret;
3620 PyObject *pathobj;
3621 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003622 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003623 int fd = -1;
3624 char *found_encoding = NULL;
3625 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003626
Victor Stinner533d7832011-03-14 13:22:54 -04003627 if (path_list == Py_None)
3628 path_list = NULL;
3629 fdp = find_module(NULL, name, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003630 &pathobj, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003631 if (fdp == NULL)
3632 return NULL;
3633 if (fp != NULL) {
3634 fd = fileno(fp);
3635 if (fd != -1)
3636 fd = dup(fd);
3637 fclose(fp);
Victor Stinnerd417d012011-06-20 15:16:55 +02003638 if (fd == -1) {
3639 PyErr_SetFromErrno(PyExc_OSError);
3640 return NULL;
3641 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003642 fp = NULL;
3643 }
3644 if (fd != -1) {
3645 if (strchr(fdp->mode, 'b') == NULL) {
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003646 /* PyTokenizer_FindEncodingFilename() returns PyMem_MALLOC'ed
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003647 memory. */
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003648 found_encoding = PyTokenizer_FindEncodingFilename(fd, pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003649 lseek(fd, 0, 0); /* Reset position */
Victor Stinner2fd76e42011-03-14 15:19:39 -04003650 if (found_encoding == NULL && PyErr_Occurred()) {
3651 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003652 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04003653 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003654 encoding = (found_encoding != NULL) ? found_encoding :
3655 (char*)PyUnicode_GetDefaultEncoding();
3656 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003657 fob = PyFile_FromFd(fd, NULL, fdp->mode, -1,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003658 (char*)encoding, NULL, NULL, 1);
3659 if (fob == NULL) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04003660 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003661 close(fd);
3662 PyMem_FREE(found_encoding);
3663 return NULL;
3664 }
3665 }
3666 else {
3667 fob = Py_None;
3668 Py_INCREF(fob);
3669 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003670 if (pathobj == NULL) {
3671 Py_INCREF(Py_None);
3672 pathobj = Py_None;
3673 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003674 ret = Py_BuildValue("NN(ssi)",
3675 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3676 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003677
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003678 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003679}
3680
Guido van Rossum79f25d91997-04-29 20:08:16 +00003681static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003682imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003683{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003684 PyObject *name, *path_list = NULL;
3685 if (!PyArg_ParseTuple(args, "U|O:find_module",
3686 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003687 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003688 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003689}
3690
3691static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003692imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003693{
Victor Stinner95872862011-03-07 18:20:56 +01003694 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003695 int ret;
3696 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003697 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003698 return NULL;
3699 ret = init_builtin(name);
3700 if (ret < 0)
3701 return NULL;
3702 if (ret == 0) {
3703 Py_INCREF(Py_None);
3704 return Py_None;
3705 }
Victor Stinner95872862011-03-07 18:20:56 +01003706 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003707 Py_XINCREF(m);
3708 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003709}
3710
Guido van Rossum79f25d91997-04-29 20:08:16 +00003711static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003712imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003713{
Victor Stinner53dc7352011-03-20 01:50:21 +01003714 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003715 int ret;
3716 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003717 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003718 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003719 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003720 if (ret < 0)
3721 return NULL;
3722 if (ret == 0) {
3723 Py_INCREF(Py_None);
3724 return Py_None;
3725 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003726 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003727 Py_XINCREF(m);
3728 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003729}
3730
Guido van Rossum79f25d91997-04-29 20:08:16 +00003731static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003732imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003733{
Victor Stinner53dc7352011-03-20 01:50:21 +01003734 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003735
Victor Stinner53dc7352011-03-20 01:50:21 +01003736 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003737 return NULL;
3738 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003739}
3740
Guido van Rossum79f25d91997-04-29 20:08:16 +00003741static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003742imp_is_frozen_package(PyObject *self, PyObject *args)
3743{
Victor Stinner53dc7352011-03-20 01:50:21 +01003744 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003745
Victor Stinner53dc7352011-03-20 01:50:21 +01003746 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003747 return NULL;
3748 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003749}
3750
3751static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003752imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003753{
Victor Stinner95872862011-03-07 18:20:56 +01003754 PyObject *name;
3755 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003756 return NULL;
3757 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003758}
3759
Guido van Rossum79f25d91997-04-29 20:08:16 +00003760static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003761imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003762{
Victor Stinner53dc7352011-03-20 01:50:21 +01003763 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003764 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003765 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003766 return NULL;
3767 p = find_frozen(name);
3768 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003769}
3770
3771static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003772get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003773{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003774 FILE *fp;
3775 if (mode[0] == 'U')
3776 mode = "r" PY_STDIOTEXTMODE;
3777 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003778 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003779 }
3780 else {
3781 int fd = PyObject_AsFileDescriptor(fob);
3782 if (fd == -1)
3783 return NULL;
3784 if (!_PyVerify_fd(fd))
3785 goto error;
3786 /* the FILE struct gets a new fd, so that it can be closed
3787 * independently of the file descriptor given
3788 */
3789 fd = dup(fd);
3790 if (fd == -1)
3791 goto error;
3792 fp = fdopen(fd, mode);
3793 }
3794 if (fp)
3795 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003796error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003797 PyErr_SetFromErrno(PyExc_IOError);
3798 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003799}
3800
Guido van Rossum79f25d91997-04-29 20:08:16 +00003801static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003802imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003803{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003804 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003805 PyObject *fob = NULL;
3806 PyObject *m;
3807 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003808 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003809 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003810 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003811 &fob))
3812 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003813 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003814 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003815 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003816 return NULL;
3817 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003818 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003819 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003820 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003821 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003822}
3823
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003824#ifdef HAVE_DYNAMIC_LOADING
3825
Guido van Rossum79f25d91997-04-29 20:08:16 +00003826static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003827imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003828{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003829 PyObject *name, *pathname, *fob = NULL, *mod;
3830 FILE *fp;
3831
3832 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3833 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003834 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003835 if (fob != NULL) {
3836 fp = get_file(NULL, fob, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003837 if (fp == NULL) {
3838 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003839 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003840 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003841 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003842 else
3843 fp = NULL;
3844 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003845 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003846 if (fp)
3847 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003848 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003849}
3850
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003851#endif /* HAVE_DYNAMIC_LOADING */
3852
Guido van Rossum79f25d91997-04-29 20:08:16 +00003853static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003854imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003855{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003856 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003857 PyObject *fob = NULL;
3858 PyObject *m;
3859 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003860 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003861 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003862 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003863 &fob))
3864 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003865 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003866 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003867 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003868 return NULL;
3869 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003870 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003871 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003872 fclose(fp);
3873 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003874}
3875
Guido van Rossum79f25d91997-04-29 20:08:16 +00003876static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003877imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003878{
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003879 PyObject *name, *fob, *pathname, *pathname_obj, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003880 char *suffix; /* Unused */
3881 char *mode;
3882 int type;
3883 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003884
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003885 if (!PyArg_ParseTuple(args, "UOO(ssi):load_module",
3886 &name, &fob, &pathname_obj, &suffix, &mode, &type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003887 return NULL;
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003888 if (pathname_obj != Py_None) {
3889 if (!PyUnicode_FSDecoder(pathname_obj, &pathname))
3890 return NULL;
3891 }
3892 else
3893 pathname = NULL;
3894
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003895 if (*mode) {
3896 /* Mode must start with 'r' or 'U' and must not contain '+'.
3897 Implicit in this test is the assumption that the mode
3898 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003899
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003900 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3901 PyErr_Format(PyExc_ValueError,
3902 "invalid file open mode %.200s", mode);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003903 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003904 return NULL;
3905 }
3906 }
3907 if (fob == Py_None)
3908 fp = NULL;
3909 else {
3910 fp = get_file(NULL, fob, mode);
3911 if (fp == NULL) {
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003912 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003913 return NULL;
3914 }
3915 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003916 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003917 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003918 if (fp)
3919 fclose(fp);
3920 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003921}
3922
3923static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003924imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003925{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003926 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003927 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003928 if (!PyArg_ParseTuple(args, "UO&:load_package",
3929 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003930 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003931 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003932 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003933 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003934}
3935
3936static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003937imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003938{
Victor Stinnerfe19d212011-03-14 14:53:28 -04003939 PyObject *name;
3940 if (!PyArg_ParseTuple(args, "U:new_module", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003941 return NULL;
Victor Stinnerfe19d212011-03-14 14:53:28 -04003942 return PyModule_NewObject(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003943}
3944
Christian Heimes13a7a212008-01-07 17:13:09 +00003945static PyObject *
3946imp_reload(PyObject *self, PyObject *v)
3947{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003948 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003949}
3950
3951PyDoc_STRVAR(doc_reload,
3952"reload(module) -> module\n\
3953\n\
3954Reload the module. The module must have been successfully imported before.");
3955
Barry Warsaw28a691b2010-04-17 00:19:56 +00003956static PyObject *
3957imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3958{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003959 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003960
Victor Stinner2f42ae52011-03-20 00:41:24 +01003961 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003962 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003963 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003964
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003965 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003966 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003967 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003968 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003969
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003970 if (debug_override != NULL &&
3971 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003972 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003973 return NULL;
3974 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003975
Martin v. Löwis30260a72011-10-23 17:35:46 +02003976 if (PyUnicode_READY(pathname) < 0)
3977 return NULL;
3978
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003979 cpathname = make_compiled_pathname(pathname, debug);
Victor Stinner2f42ae52011-03-20 00:41:24 +01003980 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003981
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003982 if (cpathname == NULL) {
3983 PyErr_Format(PyExc_SystemError, "path buffer too short");
3984 return NULL;
3985 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003986 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003987}
3988
3989PyDoc_STRVAR(doc_cache_from_source,
3990"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3991\n\
3992The .py file does not need to exist; this simply returns the path to the\n\
3993.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3994will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3995\n\
3996If debug_override is not None, then it must be a boolean and is taken as\n\
3997the value of __debug__ instead.");
3998
3999static PyObject *
4000imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
4001{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004002 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04004003 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00004004
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004005 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00004006 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04004007 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004008 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00004009
Victor Stinnerc9abda02011-03-14 13:33:46 -04004010 source = make_source_pathname(pathname);
4011 if (source == NULL) {
4012 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004013 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04004014 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004015 return NULL;
4016 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04004017 Py_DECREF(pathname);
4018 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00004019}
4020
4021PyDoc_STRVAR(doc_source_from_cache,
4022"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
4023\n\
4024The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
4025the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
4026does not conform to PEP 3147 format, ValueError will be raised.");
4027
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004028/* Doc strings */
4029
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004030PyDoc_STRVAR(doc_imp,
4031"This module provides the components needed to build your own\n\
4032__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004033
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004034PyDoc_STRVAR(doc_find_module,
4035"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004036Search for a module. If path is omitted or None, search for a\n\
4037built-in, frozen or special module and continue search in sys.path.\n\
4038The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004039package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004040
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004041PyDoc_STRVAR(doc_load_module,
4042"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004043Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004044The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004045
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004046PyDoc_STRVAR(doc_get_magic,
4047"get_magic() -> string\n\
4048Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004049
Barry Warsaw28a691b2010-04-17 00:19:56 +00004050PyDoc_STRVAR(doc_get_tag,
4051"get_tag() -> string\n\
4052Return the magic tag for .pyc or .pyo files.");
4053
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004054PyDoc_STRVAR(doc_get_suffixes,
4055"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004056Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004057that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004058
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004059PyDoc_STRVAR(doc_new_module,
4060"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004061Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004062The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004063
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004064PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00004065"lock_held() -> boolean\n\
4066Return True if the import lock is currently held, else False.\n\
4067On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00004068
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004069PyDoc_STRVAR(doc_acquire_lock,
4070"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00004071Acquires the interpreter's import lock for the current thread.\n\
4072This lock should be used by import hooks to ensure thread-safety\n\
4073when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004074On platforms without threads, this function does nothing.");
4075
4076PyDoc_STRVAR(doc_release_lock,
4077"release_lock() -> None\n\
4078Release the interpreter's import lock.\n\
4079On platforms without threads, this function does nothing.");
4080
Guido van Rossum79f25d91997-04-29 20:08:16 +00004081static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004082 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
4083 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
4084 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
4085 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
4086 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
4087 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
4088 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
4089 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
4090 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
4091 {"reload", imp_reload, METH_O, doc_reload},
4092 {"cache_from_source", (PyCFunction)imp_cache_from_source,
4093 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
4094 {"source_from_cache", (PyCFunction)imp_source_from_cache,
4095 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
4096 /* The rest are obsolete */
4097 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
4098 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
4099 {"init_builtin", imp_init_builtin, METH_VARARGS},
4100 {"init_frozen", imp_init_frozen, METH_VARARGS},
4101 {"is_builtin", imp_is_builtin, METH_VARARGS},
4102 {"is_frozen", imp_is_frozen, METH_VARARGS},
4103 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004104#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004105 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004106#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004107 {"load_package", imp_load_package, METH_VARARGS},
4108 {"load_source", imp_load_source, METH_VARARGS},
Brett Cannon442c9b92011-03-23 16:14:42 -07004109 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004110 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004111};
4112
Guido van Rossum1a8791e1998-08-04 22:46:29 +00004113static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004114setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004115{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004116 PyObject *v;
4117 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004118
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004119 v = PyLong_FromLong((long)value);
4120 err = PyDict_SetItemString(d, name, v);
4121 Py_XDECREF(v);
4122 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004123}
4124
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004125typedef struct {
4126 PyObject_HEAD
4127} NullImporter;
4128
4129static int
4130NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4131{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004132#ifndef MS_WINDOWS
4133 PyObject *path;
4134 struct stat statbuf;
4135 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004136
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004137 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4138 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004139
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004140 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4141 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004142 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004143
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004144 if (PyBytes_GET_SIZE(path) == 0) {
4145 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004146 PyErr_SetString(PyExc_ImportError, "empty pathname");
4147 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004148 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004149
4150 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4151 Py_DECREF(path);
4152 if (rv == 0) {
4153 /* it exists */
4154 if (S_ISDIR(statbuf.st_mode)) {
4155 /* it's a directory */
4156 PyErr_SetString(PyExc_ImportError, "existing directory");
4157 return -1;
4158 }
4159 }
4160#else /* MS_WINDOWS */
4161 PyObject *pathobj;
4162 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004163 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004164
4165 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4166 return -1;
4167
4168 if (!PyArg_ParseTuple(args, "U:NullImporter",
4169 &pathobj))
4170 return -1;
4171
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02004172 if (PyUnicode_GET_LENGTH(pathobj) == 0) {
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004173 PyErr_SetString(PyExc_ImportError, "empty pathname");
4174 return -1;
4175 }
4176
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004177 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004178 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004179 return -1;
4180 /* see issue1293 and issue3677:
4181 * stat() on Windows doesn't recognise paths like
4182 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4183 */
4184 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004185 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004186 if (rv != INVALID_FILE_ATTRIBUTES) {
4187 /* it exists */
4188 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4189 /* it's a directory */
4190 PyErr_SetString(PyExc_ImportError, "existing directory");
4191 return -1;
4192 }
4193 }
4194#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004195 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004196}
4197
4198static PyObject *
4199NullImporter_find_module(NullImporter *self, PyObject *args)
4200{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004201 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004202}
4203
4204static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004205 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4206 "Always return None"
4207 },
4208 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004209};
4210
4211
Christian Heimes9cd17752007-11-18 19:35:23 +00004212PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004213 PyVarObject_HEAD_INIT(NULL, 0)
4214 "imp.NullImporter", /*tp_name*/
4215 sizeof(NullImporter), /*tp_basicsize*/
4216 0, /*tp_itemsize*/
4217 0, /*tp_dealloc*/
4218 0, /*tp_print*/
4219 0, /*tp_getattr*/
4220 0, /*tp_setattr*/
4221 0, /*tp_reserved*/
4222 0, /*tp_repr*/
4223 0, /*tp_as_number*/
4224 0, /*tp_as_sequence*/
4225 0, /*tp_as_mapping*/
4226 0, /*tp_hash */
4227 0, /*tp_call*/
4228 0, /*tp_str*/
4229 0, /*tp_getattro*/
4230 0, /*tp_setattro*/
4231 0, /*tp_as_buffer*/
4232 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4233 "Null importer object", /* tp_doc */
4234 0, /* tp_traverse */
4235 0, /* tp_clear */
4236 0, /* tp_richcompare */
4237 0, /* tp_weaklistoffset */
4238 0, /* tp_iter */
4239 0, /* tp_iternext */
4240 NullImporter_methods, /* tp_methods */
4241 0, /* tp_members */
4242 0, /* tp_getset */
4243 0, /* tp_base */
4244 0, /* tp_dict */
4245 0, /* tp_descr_get */
4246 0, /* tp_descr_set */
4247 0, /* tp_dictoffset */
4248 (initproc)NullImporter_init, /* tp_init */
4249 0, /* tp_alloc */
4250 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004251};
4252
Martin v. Löwis1a214512008-06-11 05:26:20 +00004253static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004254 PyModuleDef_HEAD_INIT,
4255 "imp",
4256 doc_imp,
4257 0,
4258 imp_methods,
4259 NULL,
4260 NULL,
4261 NULL,
4262 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004263};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004264
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004265PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004266PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004267{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004268 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004269
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004270 if (PyType_Ready(&PyNullImporter_Type) < 0)
4271 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004272
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004273 m = PyModule_Create(&impmodule);
4274 if (m == NULL)
4275 goto failure;
4276 d = PyModule_GetDict(m);
4277 if (d == NULL)
4278 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004279
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004280 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4281 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4282 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4283 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4284 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4285 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4286 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4287 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4288 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4289 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004290
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004291 Py_INCREF(&PyNullImporter_Type);
4292 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4293 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004294 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004295 Py_XDECREF(m);
4296 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004297}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004298
4299
Guido van Rossumb18618d2000-05-03 23:44:39 +00004300/* API for embedding applications that want to add their own entries
4301 to the table of built-in modules. This should normally be called
4302 *before* Py_Initialize(). When the table resize fails, -1 is
4303 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004304
4305 After a similar function by Just van Rossum. */
4306
4307int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004308PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004309{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004310 static struct _inittab *our_copy = NULL;
4311 struct _inittab *p;
4312 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004313
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004314 /* Count the number of entries in both tables */
4315 for (n = 0; newtab[n].name != NULL; n++)
4316 ;
4317 if (n == 0)
4318 return 0; /* Nothing to do */
4319 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4320 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004321
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004322 /* Allocate new memory for the combined table */
4323 p = our_copy;
4324 PyMem_RESIZE(p, struct _inittab, i+n+1);
4325 if (p == NULL)
4326 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004327
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004328 /* Copy the tables into the new memory */
4329 if (our_copy != PyImport_Inittab)
4330 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4331 PyImport_Inittab = our_copy = p;
4332 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004333
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004334 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004335}
4336
4337/* Shorthand to add a single entry given a name and a function */
4338
4339int
Brett Cannona826f322009-04-02 03:41:46 +00004340PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004341{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004342 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004343
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004344 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004345
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004346 newtab[0].name = (char *)name;
4347 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004348
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004349 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004350}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004351
4352#ifdef __cplusplus
4353}
4354#endif