blob: a20871efcc3fe76e2af25a3d27226f560fb8c6fe [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Module definition and import implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00006#include "Python-ast.h"
Guido van Rossumd8faa362007-04-27 19:54:29 +00007#undef Yield /* undefine macro conflicting with winbase.h */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00008#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +00009#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000010#include "code.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000011#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000012#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000013
Guido van Rossum55a83382000-09-20 20:31:38 +000014#ifdef HAVE_FCNTL_H
15#include <fcntl.h>
16#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000017#ifdef __cplusplus
Brett Cannon9a5b25a2010-03-01 02:09:17 +000018extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000019#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000020
Christian Heimesd3eb5a152008-02-24 00:38:49 +000021#ifdef MS_WINDOWS
22/* for stat.st_mode */
23typedef unsigned short mode_t;
Daniel Stutzbachc7937792010-09-09 21:18:04 +000024/* for _mkdir */
25#include <direct.h>
Christian Heimesd3eb5a152008-02-24 00:38:49 +000026#endif
27
Guido van Rossum21d335e1993-10-15 13:01:11 +000028
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000029/* Magic word to reject .pyc files generated by other Python versions.
30 It should change for each incompatible change to the bytecode.
31
32 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000033 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000034 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000035
Guido van Rossum45aecf42006-03-15 04:58:47 +000036 The magic numbers must be spaced apart at least 2 values, as the
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000037 -U interpeter flag will cause MAGIC+1 being used. They have been
38 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000039
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000040 There were a variety of old schemes for setting the magic number.
41 The current working scheme is to increment the previous value by
42 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000043
Barry Warsaw28a691b2010-04-17 00:19:56 +000044 Starting with the adoption of PEP 3147 in Python 3.2, every bump in magic
45 number also includes a new "magic tag", i.e. a human readable string used
46 to represent the magic number in __pycache__ directories. When you change
47 the magic number, you must also set a new unique magic tag. Generally this
48 can be named after the Python major version of the magic number bump, but
49 it can really be anything, as long as it's different than anything else
50 that's come before. The tags are included in the following table, starting
51 with Python 3.2a0.
52
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000053 Known values:
54 Python 1.5: 20121
55 Python 1.5.1: 20121
56 Python 1.5.2: 20121
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000057 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000058 Python 2.0: 50823
59 Python 2.0.1: 50823
60 Python 2.1: 60202
61 Python 2.1.1: 60202
62 Python 2.1.2: 60202
63 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000064 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000065 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000066 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000067 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000068 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000069 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000070 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000071 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000072 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000073 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000074 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
75 Python 2.5b3: 62111 (fix wrong code: x += yield)
76 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000077 storing constants that should have been removed)
Thomas Wouters89f507f2006-12-13 04:49:30 +000078 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
Christian Heimes99170a52007-12-19 02:07:34 +000079 Python 2.6a0: 62151 (peephole optimizations and STORE_MAP opcode)
Christian Heimesdd15f6c2008-03-16 00:07:10 +000080 Python 2.6a1: 62161 (WITH_CLEANUP optimization)
Guido van Rossum45aecf42006-03-15 04:58:47 +000081 Python 3000: 3000
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000082 3010 (removed UNARY_CONVERT)
83 3020 (added BUILD_SET)
84 3030 (added keyword-only parameters)
85 3040 (added signature annotations)
86 3050 (print becomes a function)
87 3060 (PEP 3115 metaclass syntax)
88 3061 (string literals become unicode)
89 3071 (PEP 3109 raise changes)
90 3081 (PEP 3137 make __file__ and __name__ unicode)
91 3091 (kill str8 interning)
92 3101 (merge from 2.6a0, see 62151)
93 3103 (__file__ points to source file)
Benjamin Peterson0f6cae02009-12-10 02:09:08 +000094 Python 3.0a4: 3111 (WITH_CLEANUP optimization).
95 Python 3.0a5: 3131 (lexical exception stacking, including POP_EXCEPT)
96 Python 3.1a0: 3141 (optimize list, set and dict comprehensions:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000097 change LIST_APPEND and SET_ADD, add MAP_ADD)
Benjamin Peterson0f6cae02009-12-10 02:09:08 +000098 Python 3.1a0: 3151 (optimize conditional branches:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000099 introduce POP_JUMP_IF_FALSE and POP_JUMP_IF_TRUE)
Benjamin Peterson876b2f22009-06-28 03:18:59 +0000100 Python 3.2a0: 3160 (add SETUP_WITH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000101 tag: cpython-32
Antoine Pitrou74a69fa2010-09-04 18:43:52 +0000102 Python 3.2a1: 3170 (add DUP_TOP_TWO, remove DUP_TOPX and ROT_FOUR)
103 tag: cpython-32
Benjamin Peterson6246d6d2010-09-10 21:51:44 +0000104 Python 3.2a2 3180 (add DELETE_DEREF)
Benjamin Petersone7c15fa2011-06-19 19:54:45 -0500105 Python 3.3a0 3190 __class__ super closure changed
Tim Peters36515e22001-11-18 04:06:29 +0000106*/
Guido van Rossum3ddee711991-12-16 13:06:34 +0000107
Nick Coghlancd419ab2010-09-11 00:39:25 +0000108/* MAGIC must change whenever the bytecode emitted by the compiler may no
109 longer be understood by older implementations of the eval loop (usually
110 due to the addition of new opcodes)
Victor Stinner2f42ae52011-03-20 00:41:24 +0100111 TAG and PYC_TAG_UNICODE must change for each major Python release. The magic
112 number will take care of any bytecode changes that occur during development.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000113*/
Benjamin Peterson48deae12011-06-03 17:50:16 -0500114#define QUOTE(arg) #arg
115#define STRIFY(name) QUOTE(name)
116#define MAJOR STRIFY(PY_MAJOR_VERSION)
117#define MINOR STRIFY(PY_MINOR_VERSION)
Benjamin Petersone7c15fa2011-06-19 19:54:45 -0500118#define MAGIC (3190 | ((long)'\r'<<16) | ((long)'\n'<<24))
Benjamin Peterson48deae12011-06-03 17:50:16 -0500119#define TAG "cpython-" MAJOR MINOR;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000120#define CACHEDIR "__pycache__"
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200121static const Py_UCS4 CACHEDIR_UNICODE[] = {
Victor Stinnerc9abda02011-03-14 13:33:46 -0400122 '_', '_', 'p', 'y', 'c', 'a', 'c', 'h', 'e', '_', '_', '\0'};
Barry Warsaw28a691b2010-04-17 00:19:56 +0000123/* Current magic word and string tag as globals. */
Guido van Rossum96774c12000-05-01 20:19:08 +0000124static long pyc_magic = MAGIC;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000125static const char *pyc_tag = TAG;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200126static const Py_UCS4 PYC_TAG_UNICODE[] = {
Benjamin Peterson48deae12011-06-03 17:50:16 -0500127 'c', 'p', 'y', 't', 'h', 'o', 'n', '-', PY_MAJOR_VERSION + 48, PY_MINOR_VERSION + 48, '\0'};
128#undef QUOTE
129#undef STRIFY
130#undef MAJOR
131#undef MINOR
Guido van Rossum96774c12000-05-01 20:19:08 +0000132
Victor Stinner95872862011-03-07 18:20:56 +0100133/* See _PyImport_FixupExtensionObject() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +0000134static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000135
Victor Stinnerfe7c5b52011-04-05 01:48:03 +0200136/* Function from Parser/tokenizer.c */
137extern char * PyTokenizer_FindEncodingFilename(int, PyObject *);
138
Guido van Rossum771c6c81997-10-31 18:37:24 +0000139/* This table is defined in config.c: */
140extern struct _inittab _PyImport_Inittab[];
141
142struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +0000143
Guido van Rossumed1170e1999-12-20 21:23:41 +0000144/* these tables define the module suffixes that Python recognizes */
145struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000146
Guido van Rossumed1170e1999-12-20 21:23:41 +0000147static const struct filedescr _PyImport_StandardFiletab[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000148 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000149#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000150 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000151#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000152 {".pyc", "rb", PY_COMPILED},
153 {0, 0}
Guido van Rossumed1170e1999-12-20 21:23:41 +0000154};
155
Victor Stinnerd0296212011-03-14 14:04:10 -0400156static PyObject *initstr = NULL;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200157_Py_IDENTIFIER(__path__);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000158
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000159/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000160
161void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000162_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000163{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000164 const struct filedescr *scan;
165 struct filedescr *filetab;
166 int countD = 0;
167 int countS = 0;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000168
Victor Stinnerd0296212011-03-14 14:04:10 -0400169 initstr = PyUnicode_InternFromString("__init__");
170 if (initstr == NULL)
171 Py_FatalError("Can't initialize import variables");
172
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000173 /* prepare _PyImport_Filetab: copy entries from
174 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
175 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000176#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000177 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
178 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000179#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000180 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
181 ++countS;
182 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
183 if (filetab == NULL)
184 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000185#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 memcpy(filetab, _PyImport_DynLoadFiletab,
187 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000188#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000189 memcpy(filetab + countD, _PyImport_StandardFiletab,
190 countS * sizeof(struct filedescr));
191 filetab[countD + countS].suffix = NULL;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000193 _PyImport_Filetab = filetab;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000194
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000195 if (Py_OptimizeFlag) {
196 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
197 for (; filetab->suffix != NULL; filetab++) {
198 if (strcmp(filetab->suffix, ".pyc") == 0)
199 filetab->suffix = ".pyo";
200 }
201 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000202}
203
Guido van Rossum25ce5661997-08-02 03:10:38 +0000204void
Just van Rossum52e14d62002-12-30 22:08:05 +0000205_PyImportHooks_Init(void)
206{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000207 PyObject *v, *path_hooks = NULL, *zimpimport;
208 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +0000209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000210 /* adding sys.path_hooks and sys.path_importer_cache, setting up
211 zipimport */
212 if (PyType_Ready(&PyNullImporter_Type) < 0)
213 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000215 if (Py_VerboseFlag)
216 PySys_WriteStderr("# installing zipimport hook\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000217
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000218 v = PyList_New(0);
219 if (v == NULL)
220 goto error;
221 err = PySys_SetObject("meta_path", v);
222 Py_DECREF(v);
223 if (err)
224 goto error;
225 v = PyDict_New();
226 if (v == NULL)
227 goto error;
228 err = PySys_SetObject("path_importer_cache", v);
229 Py_DECREF(v);
230 if (err)
231 goto error;
232 path_hooks = PyList_New(0);
233 if (path_hooks == NULL)
234 goto error;
235 err = PySys_SetObject("path_hooks", path_hooks);
236 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +0000237 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000238 PyErr_Print();
239 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
240 "path_importer_cache, or NullImporter failed"
241 );
242 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000243
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000244 zimpimport = PyImport_ImportModule("zipimport");
245 if (zimpimport == NULL) {
246 PyErr_Clear(); /* No zip import module -- okay */
247 if (Py_VerboseFlag)
248 PySys_WriteStderr("# can't import zipimport\n");
249 }
250 else {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200251 _Py_IDENTIFIER(zipimporter);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200252 PyObject *zipimporter = _PyObject_GetAttrId(zimpimport,
253 &PyId_zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000254 Py_DECREF(zimpimport);
255 if (zipimporter == NULL) {
256 PyErr_Clear(); /* No zipimporter object -- okay */
257 if (Py_VerboseFlag)
258 PySys_WriteStderr(
259 "# can't import zipimport.zipimporter\n");
260 }
261 else {
262 /* sys.path_hooks.append(zipimporter) */
263 err = PyList_Append(path_hooks, zipimporter);
264 Py_DECREF(zipimporter);
265 if (err)
266 goto error;
267 if (Py_VerboseFlag)
268 PySys_WriteStderr(
269 "# installed zipimport hook\n");
270 }
271 }
272 Py_DECREF(path_hooks);
Just van Rossum52e14d62002-12-30 22:08:05 +0000273}
274
275void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000276_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000277{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000278 Py_XDECREF(extensions);
279 extensions = NULL;
280 PyMem_DEL(_PyImport_Filetab);
281 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000282}
283
284
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000285/* Locking primitives to prevent parallel imports of the same module
286 in different threads to return with a partially loaded module.
287 These calls are serialized by the global interpreter lock. */
288
289#ifdef WITH_THREAD
290
Guido van Rossum49b56061998-10-01 20:42:43 +0000291#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000292
Guido van Rossum65d5b571998-12-21 19:32:43 +0000293static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000294static long import_lock_thread = -1;
295static int import_lock_level = 0;
296
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000297void
298_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000299{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000300 long me = PyThread_get_thread_ident();
301 if (me == -1)
302 return; /* Too bad */
303 if (import_lock == NULL) {
304 import_lock = PyThread_allocate_lock();
305 if (import_lock == NULL)
306 return; /* Nothing much we can do. */
307 }
308 if (import_lock_thread == me) {
309 import_lock_level++;
310 return;
311 }
312 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
313 {
314 PyThreadState *tstate = PyEval_SaveThread();
315 PyThread_acquire_lock(import_lock, 1);
316 PyEval_RestoreThread(tstate);
317 }
318 import_lock_thread = me;
319 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000320}
321
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000322int
323_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000324{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000325 long me = PyThread_get_thread_ident();
326 if (me == -1 || import_lock == NULL)
327 return 0; /* Too bad */
328 if (import_lock_thread != me)
329 return -1;
330 import_lock_level--;
331 if (import_lock_level == 0) {
332 import_lock_thread = -1;
333 PyThread_release_lock(import_lock);
334 }
335 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000336}
337
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000338/* This function is called from PyOS_AfterFork to ensure that newly
339 created child processes do not share locks with the parent.
340 We now acquire the import lock around fork() calls but on some platforms
341 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000342
343void
344_PyImport_ReInitLock(void)
345{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000346 if (import_lock != NULL)
347 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000348 if (import_lock_level > 1) {
349 /* Forked as a side effect of import */
350 long me = PyThread_get_thread_ident();
351 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100352 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000353 import_lock_thread = me;
354 import_lock_level--;
355 } else {
356 import_lock_thread = -1;
357 import_lock_level = 0;
358 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000359}
360
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000361#endif
362
Tim Peters69232342001-08-30 05:16:13 +0000363static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000364imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000365{
Tim Peters69232342001-08-30 05:16:13 +0000366#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000368#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000369 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000370#endif
371}
372
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000373static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000374imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000375{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000376#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000378#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000379 Py_INCREF(Py_None);
380 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000381}
382
383static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000384imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000385{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000386#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000387 if (_PyImport_ReleaseLock() < 0) {
388 PyErr_SetString(PyExc_RuntimeError,
389 "not holding the import lock");
390 return NULL;
391 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000392#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000393 Py_INCREF(Py_None);
394 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000395}
396
Guido van Rossumd8faa362007-04-27 19:54:29 +0000397static void
398imp_modules_reloading_clear(void)
399{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000400 PyInterpreterState *interp = PyThreadState_Get()->interp;
401 if (interp->modules_reloading != NULL)
402 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000403}
404
Guido van Rossum25ce5661997-08-02 03:10:38 +0000405/* Helper for sys */
406
407PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000408PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000409{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000410 PyInterpreterState *interp = PyThreadState_GET()->interp;
411 if (interp->modules == NULL)
412 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
413 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000414}
415
Guido van Rossum3f5da241990-12-20 15:06:42 +0000416
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000417/* List of names to clear in sys */
418static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000419 "path", "argv", "ps1", "ps2",
420 "last_type", "last_value", "last_traceback",
421 "path_hooks", "path_importer_cache", "meta_path",
422 /* misc stuff */
423 "flags", "float_info",
424 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000425};
426
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000427static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000428 "stdin", "__stdin__",
429 "stdout", "__stdout__",
430 "stderr", "__stderr__",
431 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000432};
433
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000434
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000435/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000436
Guido van Rossum3f5da241990-12-20 15:06:42 +0000437void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000438PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000439{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000440 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000441 PyObject *key, *value, *dict;
442 PyInterpreterState *interp = PyThreadState_GET()->interp;
443 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000445 if (modules == NULL)
446 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000448 /* Delete some special variables first. These are common
449 places where user values hide and people complain when their
450 destructors fail. Since the modules containing them are
451 deleted *last* of all, they would come too late in the normal
452 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000454 value = PyDict_GetItemString(modules, "builtins");
455 if (value != NULL && PyModule_Check(value)) {
456 dict = PyModule_GetDict(value);
457 if (Py_VerboseFlag)
458 PySys_WriteStderr("# clear builtins._\n");
459 PyDict_SetItemString(dict, "_", Py_None);
460 }
461 value = PyDict_GetItemString(modules, "sys");
462 if (value != NULL && PyModule_Check(value)) {
463 char **p;
464 PyObject *v;
465 dict = PyModule_GetDict(value);
466 for (p = sys_deletes; *p != NULL; p++) {
467 if (Py_VerboseFlag)
468 PySys_WriteStderr("# clear sys.%s\n", *p);
469 PyDict_SetItemString(dict, *p, Py_None);
470 }
471 for (p = sys_files; *p != NULL; p+=2) {
472 if (Py_VerboseFlag)
473 PySys_WriteStderr("# restore sys.%s\n", *p);
474 v = PyDict_GetItemString(dict, *(p+1));
475 if (v == NULL)
476 v = Py_None;
477 PyDict_SetItemString(dict, *p, v);
478 }
479 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000480
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000481 /* First, delete __main__ */
482 value = PyDict_GetItemString(modules, "__main__");
483 if (value != NULL && PyModule_Check(value)) {
484 if (Py_VerboseFlag)
485 PySys_WriteStderr("# cleanup __main__\n");
486 _PyModule_Clear(value);
487 PyDict_SetItemString(modules, "__main__", Py_None);
488 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000490 /* The special treatment of "builtins" here is because even
491 when it's not referenced as a module, its dictionary is
492 referenced by almost every module's __builtins__. Since
493 deleting a module clears its dictionary (even if there are
494 references left to it), we need to delete the "builtins"
495 module last. Likewise, we don't delete sys until the very
496 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000497
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000498 Also note that we 'delete' modules by replacing their entry
499 in the modules dict with None, rather than really deleting
500 them; this avoids a rehash of the modules dictionary and
501 also marks them as "non existent" so they won't be
502 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000503
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000504 /* Next, repeatedly delete modules with a reference count of
505 one (skipping builtins and sys) and delete them */
506 do {
507 ndone = 0;
508 pos = 0;
509 while (PyDict_Next(modules, &pos, &key, &value)) {
510 if (value->ob_refcnt != 1)
511 continue;
512 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100513 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100515 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000516 continue;
517 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100518 PySys_FormatStderr(
519 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000520 _PyModule_Clear(value);
521 PyDict_SetItem(modules, key, Py_None);
522 ndone++;
523 }
524 }
525 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000526
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000527 /* Next, delete all modules (still skipping builtins and sys) */
528 pos = 0;
529 while (PyDict_Next(modules, &pos, &key, &value)) {
530 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100531 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000532 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100533 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000534 continue;
535 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100536 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000537 _PyModule_Clear(value);
538 PyDict_SetItem(modules, key, Py_None);
539 }
540 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000541
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000542 /* Next, delete sys and builtins (in that order) */
543 value = PyDict_GetItemString(modules, "sys");
544 if (value != NULL && PyModule_Check(value)) {
545 if (Py_VerboseFlag)
546 PySys_WriteStderr("# cleanup sys\n");
547 _PyModule_Clear(value);
548 PyDict_SetItemString(modules, "sys", Py_None);
549 }
550 value = PyDict_GetItemString(modules, "builtins");
551 if (value != NULL && PyModule_Check(value)) {
552 if (Py_VerboseFlag)
553 PySys_WriteStderr("# cleanup builtins\n");
554 _PyModule_Clear(value);
555 PyDict_SetItemString(modules, "builtins", Py_None);
556 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000558 /* Finally, clear and delete the modules directory */
559 PyDict_Clear(modules);
560 interp->modules = NULL;
561 Py_DECREF(modules);
562 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000563}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000564
565
Barry Warsaw28a691b2010-04-17 00:19:56 +0000566/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000567
568long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000569PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000570{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000571 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000572}
573
574
Barry Warsaw28a691b2010-04-17 00:19:56 +0000575const char *
576PyImport_GetMagicTag(void)
577{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000578 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000579}
580
Guido van Rossum25ce5661997-08-02 03:10:38 +0000581/* Magic for extension modules (built-in as well as dynamically
582 loaded). To prevent initializing an extension module more than
583 once, we keep a static dictionary 'extensions' keyed by module name
584 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000585 modules), containing these modules. A copy of the module's
Victor Stinner95872862011-03-07 18:20:56 +0100586 dictionary is stored by calling _PyImport_FixupExtensionObject()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000587 immediately after the module initialization function succeeds. A
588 copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100589 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000590
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000591 Modules which do support multiple initialization set their m_size
592 field to a non-negative number (indicating the size of the
593 module-specific state). They are still recorded in the extensions
594 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000595*/
596
597int
Victor Stinner95872862011-03-07 18:20:56 +0100598_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
599 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000600{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000601 PyObject *modules, *dict;
602 struct PyModuleDef *def;
603 if (extensions == NULL) {
604 extensions = PyDict_New();
605 if (extensions == NULL)
606 return -1;
607 }
608 if (mod == NULL || !PyModule_Check(mod)) {
609 PyErr_BadInternalCall();
610 return -1;
611 }
612 def = PyModule_GetDef(mod);
613 if (!def) {
614 PyErr_BadInternalCall();
615 return -1;
616 }
617 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100618 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 return -1;
620 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100621 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000622 return -1;
623 }
624 if (def->m_size == -1) {
625 if (def->m_base.m_copy) {
626 /* Somebody already imported the module,
627 likely under a different name.
628 XXX this should really not happen. */
629 Py_DECREF(def->m_base.m_copy);
630 def->m_base.m_copy = NULL;
631 }
632 dict = PyModule_GetDict(mod);
633 if (dict == NULL)
634 return -1;
635 def->m_base.m_copy = PyDict_Copy(dict);
636 if (def->m_base.m_copy == NULL)
637 return -1;
638 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000639 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000640 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000641}
642
Victor Stinner49d3f252010-10-17 01:24:53 +0000643int
644_PyImport_FixupBuiltin(PyObject *mod, char *name)
645{
646 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100647 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100648 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100649 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000650 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100651 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
652 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000653 return res;
654}
655
Guido van Rossum25ce5661997-08-02 03:10:38 +0000656PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100657_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000658{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000659 PyObject *mod, *mdict;
660 PyModuleDef* def;
661 if (extensions == NULL)
662 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000663 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000664 if (def == NULL)
665 return NULL;
666 if (def->m_size == -1) {
667 /* Module does not support repeated initialization */
668 if (def->m_base.m_copy == NULL)
669 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100670 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000671 if (mod == NULL)
672 return NULL;
673 mdict = PyModule_GetDict(mod);
674 if (mdict == NULL)
675 return NULL;
676 if (PyDict_Update(mdict, def->m_base.m_copy))
677 return NULL;
678 }
679 else {
680 if (def->m_base.m_init == NULL)
681 return NULL;
682 mod = def->m_base.m_init();
683 if (mod == NULL)
684 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100685 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000686 Py_DECREF(mod);
687 }
688 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100689 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000690 Py_DECREF(mod);
691 return NULL;
692 }
693 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100694 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000695 name, filename);
696 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000697
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000698}
699
Victor Stinner49d3f252010-10-17 01:24:53 +0000700PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000701_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000702{
Victor Stinner95872862011-03-07 18:20:56 +0100703 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100704 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100705 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000706 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100707 res = _PyImport_FindExtensionObject(nameobj, nameobj);
708 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000709 return res;
710}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000711
712/* Get the module object corresponding to a module name.
713 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000714 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000715 Because the former action is most common, THIS DOES NOT RETURN A
716 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000717
Guido van Rossum79f25d91997-04-29 20:08:16 +0000718PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000719PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000720{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000721 PyObject *modules = PyImport_GetModuleDict();
722 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000723
Victor Stinner27ee0892011-03-04 12:57:09 +0000724 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000725 PyModule_Check(m))
726 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000727 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000728 if (m == NULL)
729 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000730 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000731 Py_DECREF(m);
732 return NULL;
733 }
734 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000735
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000737}
738
Victor Stinner27ee0892011-03-04 12:57:09 +0000739PyObject *
740PyImport_AddModule(const char *name)
741{
742 PyObject *nameobj, *module;
743 nameobj = PyUnicode_FromString(name);
744 if (nameobj == NULL)
745 return NULL;
746 module = PyImport_AddModuleObject(nameobj);
747 Py_DECREF(nameobj);
748 return module;
749}
750
751
Tim Peters1cd70172004-08-02 03:52:12 +0000752/* Remove name from sys.modules, if it's there. */
753static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000754remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000755{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000756 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000757 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000758 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000759 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000760 Py_FatalError("import: deleting existing key in"
761 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000762}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000763
Victor Stinnerc9abda02011-03-14 13:33:46 -0400764static PyObject * get_sourcefile(PyObject *filename);
765static PyObject *make_source_pathname(PyObject *pathname);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200766static PyObject* make_compiled_pathname(PyObject *pathname, int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000767
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000768/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000769 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
770 * removed from sys.modules, to avoid leaving damaged module objects
771 * in sys.modules. The caller may wish to restore the original
772 * module object (if any) in this case; PyImport_ReloadModule is an
773 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000774 *
775 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
776 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000777 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000778PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000779PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000780{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 return PyImport_ExecCodeModuleWithPathnames(
782 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000783}
784
785PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000786PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000787{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000788 return PyImport_ExecCodeModuleWithPathnames(
789 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000790}
791
792PyObject *
793PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000794 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000795{
Victor Stinner27ee0892011-03-04 12:57:09 +0000796 PyObject *m = NULL;
797 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
798
799 nameobj = PyUnicode_FromString(name);
800 if (nameobj == NULL)
801 return NULL;
802
803 if (pathname != NULL) {
804 pathobj = PyUnicode_DecodeFSDefault(pathname);
805 if (pathobj == NULL)
806 goto error;
807 } else
808 pathobj = NULL;
809 if (cpathname != NULL) {
810 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
811 if (cpathobj == NULL)
812 goto error;
813 } else
814 cpathobj = NULL;
815 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
816error:
817 Py_DECREF(nameobj);
818 Py_XDECREF(pathobj);
819 Py_XDECREF(cpathobj);
820 return m;
821}
822
823PyObject*
824PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
825 PyObject *cpathname)
826{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000827 PyObject *modules = PyImport_GetModuleDict();
828 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000829
Victor Stinner27ee0892011-03-04 12:57:09 +0000830 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000831 if (m == NULL)
832 return NULL;
833 /* If the module is being reloaded, we get the old module back
834 and re-use its dict to exec the new code. */
835 d = PyModule_GetDict(m);
836 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
837 if (PyDict_SetItemString(d, "__builtins__",
838 PyEval_GetBuiltins()) != 0)
839 goto error;
840 }
841 /* Remember the filename as the __file__ attribute */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000842 if (pathname != NULL) {
Victor Stinnerc9abda02011-03-14 13:33:46 -0400843 v = get_sourcefile(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000844 if (v == NULL)
845 PyErr_Clear();
846 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000847 else
848 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000849 if (v == NULL) {
850 v = ((PyCodeObject *)co)->co_filename;
851 Py_INCREF(v);
852 }
853 if (PyDict_SetItemString(d, "__file__", v) != 0)
854 PyErr_Clear(); /* Not important enough to report */
855 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000856
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000857 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000858 if (cpathname != NULL)
859 v = cpathname;
860 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000862 if (PyDict_SetItemString(d, "__cached__", v) != 0)
863 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000864
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000865 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000866 if (v == NULL)
867 goto error;
868 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000869
Victor Stinner27ee0892011-03-04 12:57:09 +0000870 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000871 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000872 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000873 name);
874 return NULL;
875 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000876
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000877 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000878
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000879 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000880
881 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000882 remove_module(name);
883 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000884}
885
886
Barry Warsaw28a691b2010-04-17 00:19:56 +0000887/* Like strrchr(string, '/') but searches for the rightmost of either SEP
888 or ALTSEP, if the latter is defined.
889*/
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200890static Py_UCS4*
891rightmost_sep(Py_UCS4 *s)
Victor Stinnerc9abda02011-03-14 13:33:46 -0400892{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200893 Py_UCS4 *found, c;
Victor Stinnerc9abda02011-03-14 13:33:46 -0400894 for (found = NULL; (c = *s); s++) {
895 if (c == SEP
896#ifdef ALTSEP
897 || c == ALTSEP
898#endif
899 )
900 {
901 found = s;
902 }
903 }
904 return found;
905}
906
Martin v. Löwis2db72862011-10-23 17:29:08 +0200907/* Like rightmost_sep, but operate on unicode objects. */
908static Py_ssize_t
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200909rightmost_sep_obj(PyObject* o, Py_ssize_t start, Py_ssize_t end)
Martin v. Löwis2db72862011-10-23 17:29:08 +0200910{
911 Py_ssize_t found, i;
912 Py_UCS4 c;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200913 for (found = -1, i = start; i < end; i++) {
Martin v. Löwis2db72862011-10-23 17:29:08 +0200914 c = PyUnicode_READ_CHAR(o, i);
915 if (c == SEP
916#ifdef ALTSEP
917 || c == ALTSEP
918#endif
919 )
920 {
921 found = i;
922 }
923 }
924 return found;
925}
Victor Stinnerc9abda02011-03-14 13:33:46 -0400926
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000927/* Given a pathname for a Python source file, fill a buffer with the
928 pathname for the corresponding compiled file. Return the pathname
929 for the compiled file, or NULL if there's no space in the buffer.
Victor Stinner2f42ae52011-03-20 00:41:24 +0100930 Doesn't set an exception.
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000931
Martin v. Löwis30260a72011-10-23 17:35:46 +0200932 foo.py -> __pycache__/foo.<tag>.pyc
933
934 pathstr is assumed to be "ready".
935*/
Victor Stinner2f42ae52011-03-20 00:41:24 +0100936
937static PyObject*
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200938make_compiled_pathname(PyObject *pathstr, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000939{
Martin v. Löwis2db72862011-10-23 17:29:08 +0200940 PyObject *result;
941 Py_ssize_t fname, ext, len, i, pos, taglen;
942 Py_ssize_t pycache_len = sizeof("__pycache__/") - 1;
943 int kind;
944 void *data;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000945
Martin v. Löwis2db72862011-10-23 17:29:08 +0200946 /* Compute the output string size. */
947 len = PyUnicode_GET_LENGTH(pathstr);
948 /* If there is no separator, this returns -1, so
949 lastsep will be 0. */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200950 fname = rightmost_sep_obj(pathstr, 0, len) + 1;
Martin v. Löwis2db72862011-10-23 17:29:08 +0200951 ext = fname - 1;
952 for(i = fname; i < len; i++)
953 if (PyUnicode_READ_CHAR(pathstr, i) == '.')
954 ext = i + 1;
955 if (ext < fname)
956 /* No dot in filename; use entire filename */
957 ext = len;
958
959 /* result = pathstr[:fname] + "__pycache__" + SEP +
960 pathstr[fname:ext] + tag + ".py[co]" */
961 taglen = strlen(pyc_tag);
962 result = PyUnicode_New(ext + pycache_len + taglen + 4,
963 PyUnicode_MAX_CHAR_VALUE(pathstr));
964 if (!result)
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200965 return NULL;
Martin v. Löwis2db72862011-10-23 17:29:08 +0200966 kind = PyUnicode_KIND(result);
967 data = PyUnicode_DATA(result);
968 PyUnicode_CopyCharacters(result, 0, pathstr, 0, fname);
969 pos = fname;
970 for (i = 0; i < pycache_len - 1; i++)
971 PyUnicode_WRITE(kind, data, pos++, "__pycache__"[i]);
972 PyUnicode_WRITE(kind, data, pos++, SEP);
973 PyUnicode_CopyCharacters(result, pos, pathstr,
974 fname, ext - fname);
975 pos += ext - fname;
976 for (i = 0; pyc_tag[i]; i++)
977 PyUnicode_WRITE(kind, data, pos++, pyc_tag[i]);
978 PyUnicode_WRITE(kind, data, pos++, '.');
979 PyUnicode_WRITE(kind, data, pos++, 'p');
980 PyUnicode_WRITE(kind, data, pos++, 'y');
981 PyUnicode_WRITE(kind, data, pos++, debug ? 'c' : 'o');
982 return result;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000983}
984
985
Barry Warsaw28a691b2010-04-17 00:19:56 +0000986/* Given a pathname to a Python byte compiled file, return the path to the
987 source file, if the path matches the PEP 3147 format. This does not check
988 for any file existence, however, if the pyc file name does not match PEP
989 3147 style, NULL is returned. buf must be at least as big as pathname;
Victor Stinnerc9abda02011-03-14 13:33:46 -0400990 the resulting path will always be shorter.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000991
Victor Stinnerc9abda02011-03-14 13:33:46 -0400992 (...)/__pycache__/foo.<tag>.pyc -> (...)/foo.py */
993
994static PyObject*
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200995make_source_pathname(PyObject *path)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000996{
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200997 Py_ssize_t left, right, dot0, dot1, len;
998 Py_ssize_t i, j;
999 PyObject *result;
1000 int kind;
1001 void *data;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001002
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001003 len = PyUnicode_GET_LENGTH(path);
1004 if (len > MAXPATHLEN)
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001005 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001006
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001007 /* Look back two slashes from the end. In between these two slashes
1008 must be the string __pycache__ or this is not a PEP 3147 style
1009 path. It's possible for there to be only one slash.
1010 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001011 right = rightmost_sep_obj(path, 0, len);
1012 if (right == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001013 return NULL;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001014 left = rightmost_sep_obj(path, 0, right);
1015 if (left == -1)
1016 left = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001017 else
1018 left++;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001019 if (right-left != sizeof(CACHEDIR)-1)
1020 return NULL;
1021 for (i = 0; i < sizeof(CACHEDIR)-1; i++)
1022 if (PyUnicode_READ_CHAR(path, left+i) != CACHEDIR[i])
1023 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001024
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001025 /* Now verify that the path component to the right of the last slash
1026 has two dots in it.
1027 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001028 dot0 = PyUnicode_FindChar(path, '.', right+1, len, 1);
1029 if (dot0 < 0)
1030 return NULL;
1031 dot1 = PyUnicode_FindChar(path, '.', dot0+1, len, 1);
1032 if (dot1 < 0)
1033 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001034 /* Too many dots? */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001035 if (PyUnicode_FindChar(path, '.', dot1+1, len, 1) != -1)
1036 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001037
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001038 /* This is a PEP 3147 path. Start by copying everything from the
1039 start of pathname up to and including the leftmost slash. Then
1040 copy the file's basename, removing the magic tag and adding a .py
1041 suffix.
1042 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001043 result = PyUnicode_New(left + (dot0-right) + 2,
1044 PyUnicode_MAX_CHAR_VALUE(path));
1045 if (!result)
1046 return NULL;
1047 kind = PyUnicode_KIND(result);
1048 data = PyUnicode_DATA(result);
1049 PyUnicode_CopyCharacters(result, 0, path, 0, (i = left));
1050 PyUnicode_CopyCharacters(result, left, path, right+1,
1051 (j = dot0-right));
1052 PyUnicode_WRITE(kind, data, i+j, 'p');
1053 PyUnicode_WRITE(kind, data, i+j+1, 'y');
1054 return result;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001055}
1056
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001057/* Given a pathname for a Python source file, its time of last
1058 modification, and a pathname for a compiled file, check whether the
1059 compiled file represents the same version of the source. If so,
1060 return a FILE pointer for the compiled file, positioned just after
1061 the header; if not, return NULL.
1062 Doesn't set an exception. */
1063
1064static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001065check_compiled_module(PyObject *pathname, time_t mtime, PyObject *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001066{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001067 FILE *fp;
1068 long magic;
1069 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001070
Victor Stinner2f42ae52011-03-20 00:41:24 +01001071 fp = _Py_fopen(cpathname, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001072 if (fp == NULL)
1073 return NULL;
1074 magic = PyMarshal_ReadLongFromFile(fp);
1075 if (magic != pyc_magic) {
1076 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001077 PySys_FormatStderr("# %R has bad magic\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001078 fclose(fp);
1079 return NULL;
1080 }
1081 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
1082 if (pyc_mtime != mtime) {
1083 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001084 PySys_FormatStderr("# %R has bad mtime\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001085 fclose(fp);
1086 return NULL;
1087 }
1088 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001089 PySys_FormatStderr("# %R matches %R\n", cpathname, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001090 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001091}
1092
1093
1094/* Read a code object from a file and check it for validity */
1095
Guido van Rossum79f25d91997-04-29 20:08:16 +00001096static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001097read_compiled_module(PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001098{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001099 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001100
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001101 co = PyMarshal_ReadLastObjectFromFile(fp);
1102 if (co == NULL)
1103 return NULL;
1104 if (!PyCode_Check(co)) {
1105 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001106 "Non-code object in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001107 Py_DECREF(co);
1108 return NULL;
1109 }
1110 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001111}
1112
1113
1114/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001115 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001116
Guido van Rossum79f25d91997-04-29 20:08:16 +00001117static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001118load_compiled_module(PyObject *name, PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001119{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001120 long magic;
1121 PyCodeObject *co;
1122 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001123
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001124 magic = PyMarshal_ReadLongFromFile(fp);
1125 if (magic != pyc_magic) {
1126 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001127 "Bad magic number in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001128 return NULL;
1129 }
1130 (void) PyMarshal_ReadLongFromFile(fp);
1131 co = read_compiled_module(cpathname, fp);
1132 if (co == NULL)
1133 return NULL;
1134 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001135 PySys_FormatStderr("import %U # precompiled from %R\n",
1136 name, cpathname);
1137 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1138 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001139 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001140
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001141 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001142}
1143
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001144/* Parse a source file and return the corresponding code object */
1145
Guido van Rossum79f25d91997-04-29 20:08:16 +00001146static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001147parse_source_module(PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001148{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001149 PyCodeObject *co;
1150 PyObject *pathbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001151 mod_ty mod;
1152 PyCompilerFlags flags;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001153 PyArena *arena;
1154
1155 pathbytes = PyUnicode_EncodeFSDefault(pathname);
1156 if (pathbytes == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001157 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001158
Victor Stinner2f42ae52011-03-20 00:41:24 +01001159 arena = PyArena_New();
1160 if (arena == NULL) {
1161 Py_DECREF(pathbytes);
1162 return NULL;
1163 }
1164
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001165 flags.cf_flags = 0;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001166 mod = PyParser_ASTFromFile(fp, PyBytes_AS_STRING(pathbytes), NULL,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001167 Py_file_input, 0, 0, &flags,
1168 NULL, arena);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001169 if (mod != NULL)
1170 co = PyAST_Compile(mod, PyBytes_AS_STRING(pathbytes), NULL, arena);
1171 else
1172 co = NULL;
1173 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001174 PyArena_Free(arena);
1175 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001176}
1177
Guido van Rossum55a83382000-09-20 20:31:38 +00001178/* Helper to open a bytecode file for writing in exclusive mode */
1179
Victor Stinner783c82c2011-04-20 03:27:51 +02001180#ifndef MS_WINDOWS
Guido van Rossum55a83382000-09-20 20:31:38 +00001181static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +00001182open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +00001183{
1184#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001185 /* Use O_EXCL to avoid a race condition when another process tries to
1186 write the same file. When that happens, our open() call fails,
1187 which is just fine (since it's only a cache).
1188 XXX If the file exists and is writable but the directory is not
1189 writable, the file will never be written. Oh well.
1190 */
1191 int fd;
1192 (void) unlink(filename);
1193 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +00001194#ifdef O_BINARY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001195 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +00001196#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001197#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001198 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001199#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001200 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001201#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001202 );
1203 if (fd < 0)
1204 return NULL;
1205 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001206#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001207 /* Best we can do -- on Windows this can't happen anyway */
1208 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001209#endif
1210}
Victor Stinner783c82c2011-04-20 03:27:51 +02001211#endif
Guido van Rossum55a83382000-09-20 20:31:38 +00001212
1213
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001214/* Write a compiled module to a file, placing the time of last
1215 modification of its source into the header.
1216 Errors are ignored, if a write error occurs an attempt is made to
1217 remove the file. */
1218
1219static void
Victor Stinner2f42ae52011-03-20 00:41:24 +01001220write_compiled_module(PyCodeObject *co, PyObject *cpathname,
1221 struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001222{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001223 Py_UCS4 *cpathname_ucs4;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001224 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001225 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001226#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001227 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001228#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001229 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
1230 mode_t dirmode = (srcstat->st_mode |
1231 S_IXUSR | S_IXGRP | S_IXOTH |
1232 S_IWUSR | S_IWGRP | S_IWOTH);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001233 PyObject *dirbytes;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001234#endif
Victor Stinner783c82c2011-04-20 03:27:51 +02001235#ifdef MS_WINDOWS
1236 int fd;
1237#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001238 PyObject *cpathbytes, *cpathbytes_tmp;
1239 Py_ssize_t cpathbytes_len;
Victor Stinner783c82c2011-04-20 03:27:51 +02001240#endif
1241 PyObject *dirname;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001242 Py_UCS4 *dirsep;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001243 int res, ok;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 /* Ensure that the __pycache__ directory exists. */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001246 cpathname_ucs4 = PyUnicode_AsUCS4Copy(cpathname);
1247 if (!cpathname_ucs4)
1248 return;
1249 dirsep = rightmost_sep(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001250 if (dirsep == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001251 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001252 PySys_FormatStderr("# no %s path found %R\n", CACHEDIR, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001253 return;
1254 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001255 dirname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
1256 cpathname_ucs4,
1257 dirsep - cpathname_ucs4);
1258 PyMem_Free(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001259 if (dirname == NULL) {
1260 PyErr_Clear();
1261 return;
1262 }
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001263
1264#ifdef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001265 res = CreateDirectoryW(PyUnicode_AS_UNICODE(dirname), NULL);
1266 ok = (res != 0);
1267 if (!ok && GetLastError() == ERROR_ALREADY_EXISTS)
1268 ok = 1;
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001269#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001270 dirbytes = PyUnicode_EncodeFSDefault(dirname);
1271 if (dirbytes == NULL) {
1272 PyErr_Clear();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001273 return;
1274 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001275 res = mkdir(PyBytes_AS_STRING(dirbytes), dirmode);
1276 Py_DECREF(dirbytes);
1277 if (0 <= res)
1278 ok = 1;
1279 else
1280 ok = (errno == EEXIST);
1281#endif
1282 if (!ok) {
1283 if (Py_VerboseFlag)
1284 PySys_FormatStderr("# cannot create cache dir %R\n", dirname);
1285 Py_DECREF(dirname);
1286 return;
1287 }
1288 Py_DECREF(dirname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001289
Victor Stinner783c82c2011-04-20 03:27:51 +02001290#ifdef MS_WINDOWS
1291 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1292 fd = _wopen(PyUnicode_AS_UNICODE(cpathname),
1293 O_EXCL | O_CREAT | O_WRONLY | O_TRUNC | O_BINARY,
1294 mode);
1295 if (0 <= fd)
1296 fp = fdopen(fd, "wb");
1297 else
1298 fp = NULL;
1299#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001300 /* Under POSIX, we first write to a tmp file and then take advantage
1301 of atomic renaming. */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001302 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1303 if (cpathbytes == NULL) {
1304 PyErr_Clear();
1305 return;
1306 }
Antoine Pitrou707033a2011-10-17 19:28:44 +02001307 cpathbytes_len = PyBytes_GET_SIZE(cpathbytes);
1308 cpathbytes_tmp = PyBytes_FromStringAndSize(NULL, cpathbytes_len + 4);
1309 if (cpathbytes_tmp == NULL) {
1310 Py_DECREF(cpathbytes);
1311 PyErr_Clear();
1312 return;
1313 }
1314 memcpy(PyBytes_AS_STRING(cpathbytes_tmp), PyBytes_AS_STRING(cpathbytes),
1315 cpathbytes_len);
1316 memcpy(PyBytes_AS_STRING(cpathbytes_tmp) + cpathbytes_len, ".tmp", 4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001317
Antoine Pitrou707033a2011-10-17 19:28:44 +02001318 fp = open_exclusive(PyBytes_AS_STRING(cpathbytes_tmp), mode);
Victor Stinner783c82c2011-04-20 03:27:51 +02001319#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001320 if (fp == NULL) {
1321 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001322 PySys_FormatStderr(
1323 "# can't create %R\n", cpathname);
Victor Stinner783c82c2011-04-20 03:27:51 +02001324#ifndef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001325 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001326 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001327#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001328 return;
1329 }
1330 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1331 /* First write a 0 for mtime */
1332 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1333 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001334 fflush(fp);
1335 /* Now write the true mtime */
1336 fseek(fp, 4L, 0);
1337 assert(mtime < LONG_MAX);
1338 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001339 if (fflush(fp) != 0 || ferror(fp)) {
1340 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001341 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001342 /* Don't keep partial file */
1343 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001344#ifdef MS_WINDOWS
1345 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1346#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001347 (void) unlink(PyBytes_AS_STRING(cpathbytes_tmp));
Victor Stinner2f42ae52011-03-20 00:41:24 +01001348 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001349 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001350#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001351 return;
1352 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353 fclose(fp);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001354 /* Under POSIX, do an atomic rename */
1355#ifndef MS_WINDOWS
1356 if (rename(PyBytes_AS_STRING(cpathbytes_tmp),
1357 PyBytes_AS_STRING(cpathbytes))) {
1358 if (Py_VerboseFlag)
1359 PySys_FormatStderr("# can't write %R\n", cpathname);
1360 /* Don't keep tmp file */
1361 unlink(PyBytes_AS_STRING(cpathbytes_tmp));
1362 Py_DECREF(cpathbytes);
1363 Py_DECREF(cpathbytes_tmp);
1364 return;
1365 }
1366 Py_DECREF(cpathbytes);
1367 Py_DECREF(cpathbytes_tmp);
1368#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001369 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001370 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001371}
1372
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001373static void
1374update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1375{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001376 PyObject *constants, *tmp;
1377 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 if (PyUnicode_Compare(co->co_filename, oldname))
1380 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001381
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001382 tmp = co->co_filename;
1383 co->co_filename = newname;
1384 Py_INCREF(co->co_filename);
1385 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001386
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001387 constants = co->co_consts;
1388 n = PyTuple_GET_SIZE(constants);
1389 for (i = 0; i < n; i++) {
1390 tmp = PyTuple_GET_ITEM(constants, i);
1391 if (PyCode_Check(tmp))
1392 update_code_filenames((PyCodeObject *)tmp,
1393 oldname, newname);
1394 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001395}
1396
Victor Stinner2f42ae52011-03-20 00:41:24 +01001397static void
1398update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001399{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001400 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001401
Victor Stinner2f42ae52011-03-20 00:41:24 +01001402 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1403 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001404
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001405 oldname = co->co_filename;
1406 Py_INCREF(oldname);
1407 update_code_filenames(co, oldname, newname);
1408 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001409}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001410
Brett Cannon442c9b92011-03-23 16:14:42 -07001411static PyObject *
1412imp_fix_co_filename(PyObject *self, PyObject *args)
1413{
1414 PyObject *co;
1415 PyObject *file_path;
1416
1417 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
1418 return NULL;
1419
1420 if (!PyCode_Check(co)) {
1421 PyErr_SetString(PyExc_TypeError,
1422 "first argument must be a code object");
1423 return NULL;
1424 }
1425
1426 if (!PyUnicode_Check(file_path)) {
1427 PyErr_SetString(PyExc_TypeError,
1428 "second argument must be a string");
1429 return NULL;
1430 }
1431
1432 update_compiled_module((PyCodeObject*)co, file_path);
1433
1434 Py_RETURN_NONE;
1435}
1436
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001437/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001438 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1439 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001440
Guido van Rossum79f25d91997-04-29 20:08:16 +00001441static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001442load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001443{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001444 struct stat st;
1445 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001446 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001447 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001448 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001450 if (fstat(fileno(fp), &st) != 0) {
1451 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001452 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001453 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001454 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001455 }
Fred Drake4c82b232000-06-30 16:18:57 +00001456#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001457 /* Python's .pyc timestamp handling presumes that the timestamp fits
1458 in 4 bytes. This will be fine until sometime in the year 2038,
1459 when a 4-byte signed time_t will overflow.
1460 */
1461 if (st.st_mtime >> 32) {
1462 PyErr_SetString(PyExc_OverflowError,
1463 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001464 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001465 }
Fred Drake4c82b232000-06-30 16:18:57 +00001466#endif
Martin v. Löwis30260a72011-10-23 17:35:46 +02001467 if (PyUnicode_READY(pathname) < 0)
1468 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001469 cpathname = make_compiled_pathname(pathname, !Py_OptimizeFlag);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001470
1471 if (cpathname != NULL)
1472 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1473 else
1474 fpc = NULL;
1475
1476 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001477 co = read_compiled_module(cpathname, fpc);
1478 fclose(fpc);
1479 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001480 goto error;
1481 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001482 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001483 PySys_FormatStderr("import %U # precompiled from %R\n",
1484 name, cpathname);
1485 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1486 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001487 }
1488 else {
1489 co = parse_source_module(pathname, fp);
1490 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001491 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001492 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001493 PySys_FormatStderr("import %U # from %R\n",
Victor Stinner98dbba52011-03-14 15:15:47 -04001494 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001495 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1497 if (ro == NULL || !PyObject_IsTrue(ro))
1498 write_compiled_module(co, cpathname, &st);
1499 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001500 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1501 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001502 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001503 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001504
Victor Stinner2f42ae52011-03-20 00:41:24 +01001505error:
1506 Py_XDECREF(cpathbytes);
1507 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001508 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001509}
1510
Christian Heimes3b06e532008-01-07 20:12:44 +00001511/* Get source file -> unicode or None
1512 * Returns the path to the py file if available, else the given path
1513 */
1514static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001515get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001516{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001517 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001518 Py_UCS4 *fileuni;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001519 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001520 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001521
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001522 len = PyUnicode_GET_LENGTH(filename);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001523 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001524 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001525
Victor Stinnerc9abda02011-03-14 13:33:46 -04001526 /* don't match *.pyc or *.pyo? */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001527 fileuni = PyUnicode_AsUCS4Copy(filename);
1528 if (!fileuni)
1529 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001530 if (len < 5
1531 || fileuni[len-4] != '.'
1532 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1533 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1534 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001535
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001536 /* Start by trying to turn PEP 3147 path into source path. If that
1537 * fails, just chop off the trailing character, i.e. legacy pyc path
1538 * to py.
1539 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001540 py = make_source_pathname(filename);
1541 if (py == NULL) {
1542 PyErr_Clear();
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001543 py = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001544 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001545 if (py == NULL)
1546 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001547
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001548 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode)) {
1549 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001550 return py;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001551 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001552 Py_DECREF(py);
1553 goto unchanged;
1554
1555error:
1556 PyErr_Clear();
1557unchanged:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001558 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001559 Py_INCREF(filename);
1560 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001561}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001562
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001563/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001564static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001565static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001566 PyObject **, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001567static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001568
1569/* Load a package and return its module object WITH INCREMENTED
1570 REFERENCE COUNT */
1571
1572static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001573load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001574{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001575 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001576 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001577 int err;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001578 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001579 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001580
Victor Stinnerc9abda02011-03-14 13:33:46 -04001581 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001582 if (m == NULL)
1583 return NULL;
1584 if (Py_VerboseFlag)
Victor Stinner98dbba52011-03-14 15:15:47 -04001585 PySys_FormatStderr("import %U # directory %R\n",
1586 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001587 file = get_sourcefile(pathname);
1588 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001589 return NULL;
1590 path_list = Py_BuildValue("[O]", file);
1591 if (path_list == NULL) {
1592 Py_DECREF(file);
1593 return NULL;
1594 }
1595 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001597 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001598 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001599 err = PyDict_SetItemString(d, "__path__", path_list);
1600 if (err != 0) {
1601 Py_DECREF(path_list);
1602 return NULL;
1603 }
Victor Stinner533d7832011-03-14 13:22:54 -04001604 fdp = find_module(name, initstr, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001605 &bufobj, &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001606 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001607 if (fdp == NULL) {
1608 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1609 PyErr_Clear();
1610 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001611 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 }
1613 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001614 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001616 m = load_module(name, fp, bufobj, fdp->type, NULL);
1617 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001618 if (fp != NULL)
1619 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001620 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001621}
1622
1623
1624/* Helper to test for built-in module */
1625
1626static int
Victor Stinner95872862011-03-07 18:20:56 +01001627is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001628{
Victor Stinner95872862011-03-07 18:20:56 +01001629 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001630 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001631 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1632 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001633 if (PyImport_Inittab[i].initfunc == NULL)
1634 return -1;
1635 else
1636 return 1;
1637 }
1638 }
1639 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001640}
1641
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001642
Just van Rossum52e14d62002-12-30 22:08:05 +00001643/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1644 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001645 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001646 that can handle the path item. Return None if no hook could;
1647 this tells our caller it should fall back to the builtin
1648 import mechanism. Cache the result in path_importer_cache.
1649 Returns a borrowed reference. */
1650
1651static PyObject *
1652get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001653 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001654{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001655 PyObject *importer;
1656 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001657
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001658 /* These conditions are the caller's responsibility: */
1659 assert(PyList_Check(path_hooks));
1660 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 nhooks = PyList_Size(path_hooks);
1663 if (nhooks < 0)
1664 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001665
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001666 importer = PyDict_GetItem(path_importer_cache, p);
1667 if (importer != NULL)
1668 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001669
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001670 /* set path_importer_cache[p] to None to avoid recursion */
1671 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1672 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001674 for (j = 0; j < nhooks; j++) {
1675 PyObject *hook = PyList_GetItem(path_hooks, j);
1676 if (hook == NULL)
1677 return NULL;
1678 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1679 if (importer != NULL)
1680 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001681
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001682 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1683 return NULL;
1684 }
1685 PyErr_Clear();
1686 }
1687 if (importer == NULL) {
1688 importer = PyObject_CallFunctionObjArgs(
1689 (PyObject *)&PyNullImporter_Type, p, NULL
1690 );
1691 if (importer == NULL) {
1692 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1693 PyErr_Clear();
1694 return Py_None;
1695 }
1696 }
1697 }
1698 if (importer != NULL) {
1699 int err = PyDict_SetItem(path_importer_cache, p, importer);
1700 Py_DECREF(importer);
1701 if (err != 0)
1702 return NULL;
1703 }
1704 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001705}
1706
Christian Heimes9cd17752007-11-18 19:35:23 +00001707PyAPI_FUNC(PyObject *)
1708PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001709 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001710
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001711 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1712 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1713 importer = get_path_importer(path_importer_cache,
1714 path_hooks, path);
1715 }
1716 }
1717 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1718 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001719}
1720
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001721/* Search the path (default sys.path) for a module. Return the
1722 corresponding filedescr struct, and (via return arguments) the
1723 pathname and an open file. Return NULL if the module is not found. */
1724
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001725#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001726extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1727 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001728#endif
1729
Victor Stinner547a2a62011-03-20 03:07:28 +01001730/* Forward */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001731static int case_ok(PyObject *, Py_ssize_t, PyObject *);
Victor Stinner547a2a62011-03-20 03:07:28 +01001732static int find_init_module(PyObject *);
Just van Rossum52e14d62002-12-30 22:08:05 +00001733static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001734
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001735/* Get the path of a module: get its importer and call importer.find_module()
1736 hook, or check if the module if a package (if path/__init__.py exists).
1737
1738 -1: error: a Python error occurred
1739 0: ignore: an error occurred because of invalid data, but the error is not
1740 important enough to be reported.
1741 1: get path: module not found, but *buf contains its path
1742 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1743 and *buf is the path */
1744
1745static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001746find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001747 PyObject *path_hooks, PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001748 PyObject **p_path, PyObject **p_loader, struct filedescr **p_fd)
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001749{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001750 Py_UCS4 buf[MAXPATHLEN+1];
Victor Stinner2fd76e42011-03-14 15:19:39 -04001751 PyObject *path_unicode, *filename;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001752 Py_ssize_t len;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001753 struct stat statbuf;
1754 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1755
1756 if (PyUnicode_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001757 Py_INCREF(path);
1758 path_unicode = path;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001759 }
1760 else if (PyBytes_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001761 path_unicode = PyUnicode_DecodeFSDefaultAndSize(
1762 PyBytes_AS_STRING(path), PyBytes_GET_SIZE(path));
1763 if (path_unicode == NULL)
1764 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001765 }
1766 else
1767 return 0;
1768
Victor Stinner46084ba2011-10-06 02:39:42 +02001769 if (PyUnicode_READY(path_unicode))
1770 return -1;
1771
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001772 len = PyUnicode_GET_LENGTH(path_unicode);
Georg Brandl4cb0de22011-09-28 21:49:49 +02001773 if (!PyUnicode_AsUCS4(path_unicode, buf, Py_ARRAY_LENGTH(buf), 1)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001774 Py_DECREF(path_unicode);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001775 PyErr_Clear();
1776 return 0;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001777 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001778 Py_DECREF(path_unicode);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001779
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001780 if (Py_UCS4_strlen(buf) != len)
Victor Stinner2fd76e42011-03-14 15:19:39 -04001781 return 0; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001782
1783 /* sys.path_hooks import hook */
1784 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001785 _Py_IDENTIFIER(find_module);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001786 PyObject *importer;
1787
1788 importer = get_path_importer(path_importer_cache,
1789 path_hooks, path);
1790 if (importer == NULL) {
1791 return -1;
1792 }
1793 /* Note: importer is a borrowed reference */
1794 if (importer != Py_None) {
1795 PyObject *loader;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001796 loader = _PyObject_CallMethodId(importer,
1797 &PyId_find_module, "O", fullname);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001798 if (loader == NULL)
1799 return -1; /* error */
1800 if (loader != Py_None) {
1801 /* a loader was found */
1802 *p_loader = loader;
1803 *p_fd = &importhookdescr;
1804 return 2;
1805 }
1806 Py_DECREF(loader);
1807 return 0;
1808 }
1809 }
1810 /* no hook was found, use builtin import */
1811
1812 if (len > 0 && buf[len-1] != SEP
1813#ifdef ALTSEP
1814 && buf[len-1] != ALTSEP
1815#endif
1816 )
1817 buf[len++] = SEP;
Georg Brandl4cb0de22011-09-28 21:49:49 +02001818 if (!PyUnicode_AsUCS4(name, buf+len, Py_ARRAY_LENGTH(buf)-len, 1)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001819 PyErr_Clear();
1820 return 0;
1821 }
1822 len += PyUnicode_GET_LENGTH(name);
Victor Stinner2fd76e42011-03-14 15:19:39 -04001823
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001824 filename = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
1825 buf, len);
Victor Stinner2fd76e42011-03-14 15:19:39 -04001826 if (filename == NULL)
1827 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001828
1829 /* Check for package import (buf holds a directory name,
1830 and there's an __init__ module in that directory */
1831#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001832 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001833 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1834 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001835 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001836
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001837 match = case_ok(filename, 0, name);
1838 if (match < 0) {
1839 Py_DECREF(filename);
1840 return -1;
1841 }
1842 if (match) { /* case matches */
1843 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001844 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001845 *p_fd = &fd_package;
1846 return 2;
1847 }
1848 else {
1849 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001850 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001851 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001852 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001853 if (err) {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001854 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001855 return -1;
Victor Stinner547a2a62011-03-20 03:07:28 +01001856 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001857 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001858 }
1859 }
1860#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001861 *p_path = filename;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001862 return 1;
1863}
1864
1865/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001866 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001867
1868 If the module is found, return a file descriptor, write the path in
1869 *p_filename, write the pointer to the file object into *p_fp, and (if
1870 p_loader is not NULL) the loader into *p_loader.
1871
1872 Otherwise, raise an exception and return NULL. */
1873
Victor Stinner37580282011-03-20 01:34:43 +01001874static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001875find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001876 PyObject *search_path_list, PyObject *path_hooks,
1877 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001878 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001879{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001880 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001881 struct filedescr *fdp = NULL;
1882 char *filemode;
1883 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001884 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001885 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001886
Victor Stinner37580282011-03-20 01:34:43 +01001887 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001888 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001889 PyObject *path;
1890 int ok;
1891
1892 path = PyList_GetItem(search_path_list, i);
1893 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001894 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001895
Victor Stinner2fd76e42011-03-14 15:19:39 -04001896 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001897 ok = find_module_path(fullname, name, path,
1898 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001899 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001900 if (ok < 0)
1901 return NULL;
1902 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001903 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001904 if (ok == 2) {
1905 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001906 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001907 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001909 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001910 struct stat statbuf;
1911
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001912 filemode = fdp->mode;
1913 if (filemode[0] == 'U')
1914 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001915
Victor Stinner2fd76e42011-03-14 15:19:39 -04001916 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1917 if (filename == NULL) {
1918 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001919 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001920 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001921
1922 if (Py_VerboseFlag > 1)
1923 PySys_FormatStderr("# trying %R\n", filename);
1924
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001925 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
1926 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1927 {
1928 Py_DECREF(filename);
1929 continue;
1930 }
1931
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001932 fp = _Py_fopen(filename, filemode);
1933 if (fp == NULL) {
1934 Py_DECREF(filename);
Victor Stinner925ef392011-06-20 15:01:10 +02001935 if (PyErr_Occurred()) {
1936 Py_DECREF(prefix);
1937 return NULL;
1938 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001939 continue;
1940 }
1941 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1942 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001943 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001944 Py_DECREF(filename);
1945 return NULL;
1946 }
1947 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001948 Py_DECREF(prefix);
1949 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001950 *p_fp = fp;
1951 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001952 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001953 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001954
1955 fclose(fp);
1956 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001957 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001958 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001959 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001960 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04001961 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04001962 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001963}
1964
Victor Stinner37580282011-03-20 01:34:43 +01001965/* Find a module:
1966
1967 - try find_module() of each sys.meta_path hook
1968 - try find_frozen()
1969 - try is_builtin()
1970 - try _PyWin_FindRegisteredModule() (Windows only)
1971 - otherwise, call find_module_path_list() with search_path_list (if not
1972 NULL) or sys.path
1973
Victor Stinner2fd76e42011-03-14 15:19:39 -04001974 fullname can be NULL, but only if p_loader is NULL.
1975
Victor Stinner37580282011-03-20 01:34:43 +01001976 Return:
1977
1978 - &fd_builtin (C_BUILTIN) if it is a builtin
1979 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04001980 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01001981 if it is a package
1982 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1983 importer loader was found
1984 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1985 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04001986 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01001987 - NULL on error
1988
Victor Stinner2fd76e42011-03-14 15:19:39 -04001989 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
1990 Eg. *p_path is set to NULL for a builtin package.
1991*/
Victor Stinner37580282011-03-20 01:34:43 +01001992
1993static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001994find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001995 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01001996{
1997 Py_ssize_t i, npath;
1998 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1999 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
2000 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01002001
Victor Stinner2fd76e42011-03-14 15:19:39 -04002002 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01002003 *p_fp = NULL;
2004 if (p_loader != NULL)
2005 *p_loader = NULL;
2006
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002007 if (PyUnicode_GET_LENGTH(name) > MAXPATHLEN) {
2008 PyErr_SetString(PyExc_OverflowError,
2009 "module name is too long");
2010 return NULL;
2011 }
2012
Victor Stinner37580282011-03-20 01:34:43 +01002013 /* sys.meta_path import hook */
2014 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002015 _Py_IDENTIFIER(find_module);
Victor Stinner37580282011-03-20 01:34:43 +01002016 PyObject *meta_path;
2017
2018 meta_path = PySys_GetObject("meta_path");
2019 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02002020 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002021 "sys.meta_path must be a list of "
2022 "import hooks");
2023 return NULL;
2024 }
2025 Py_INCREF(meta_path); /* zap guard */
2026 npath = PyList_Size(meta_path);
2027 for (i = 0; i < npath; i++) {
2028 PyObject *loader;
2029 PyObject *hook = PyList_GetItem(meta_path, i);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002030 loader = _PyObject_CallMethodId(hook, &PyId_find_module,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002031 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01002032 search_path_list != NULL ?
2033 search_path_list : Py_None);
2034 if (loader == NULL) {
2035 Py_DECREF(meta_path);
2036 return NULL; /* true error */
2037 }
2038 if (loader != Py_None) {
2039 /* a loader was found */
2040 *p_loader = loader;
2041 Py_DECREF(meta_path);
2042 return &importhookdescr;
2043 }
2044 Py_DECREF(loader);
2045 }
2046 Py_DECREF(meta_path);
2047 }
2048
Victor Stinnerdf75a022011-03-14 13:40:04 -04002049 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002050 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01002051
2052 if (search_path_list == NULL) {
2053#ifdef MS_COREDLL
2054 FILE *fp;
2055 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01002056#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04002057 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01002058 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01002059#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04002060 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01002061 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01002062 *p_fp = fp;
2063 return fdp;
2064 }
2065 else if (PyErr_Occurred())
2066 return NULL;
2067#endif
Victor Stinner37580282011-03-20 01:34:43 +01002068 search_path_list = PySys_GetObject("path");
2069 }
2070
2071 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
Victor Stinner16191322011-09-15 19:28:05 +02002072 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002073 "sys.path must be a list of directory names");
2074 return NULL;
2075 }
2076
2077 path_hooks = PySys_GetObject("path_hooks");
2078 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02002079 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002080 "sys.path_hooks must be a list of "
2081 "import hooks");
2082 return NULL;
2083 }
2084 path_importer_cache = PySys_GetObject("path_importer_cache");
2085 if (path_importer_cache == NULL ||
2086 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02002087 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002088 "sys.path_importer_cache must be a dict");
2089 return NULL;
2090 }
2091
2092 return find_module_path_list(fullname, name,
2093 search_path_list, path_hooks,
2094 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002095 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002096}
2097
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002098/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002099 * The arguments here are tricky, best shown by example:
2100 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2101 * ^ ^ ^ ^
2102 * |--------------------- buf ---------------------|
2103 * |------------------- len ------------------|
2104 * |------ name -------|
2105 * |----- namelen -----|
2106 * buf is the full path, but len only counts up to (& exclusive of) the
2107 * extension. name is the module name, also exclusive of extension.
2108 *
2109 * We've already done a successful stat() or fopen() on buf, so know that
2110 * there's some match, possibly case-insensitive.
2111 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002112 * case_bytes() is to return 1 if there's a case-sensitive match for
2113 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002114 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002115 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002116 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002117 * on platforms with case-insensitive filesystems. It's trivial to implement
2118 * for case-sensitive filesystems. It's pretty much a cross-platform
2119 * nightmare for systems with case-insensitive filesystems.
2120 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002121
Tim Peters50d8d372001-02-28 05:34:27 +00002122/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002123 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002124 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002125#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002126#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002127
Tim Peters50d8d372001-02-28 05:34:27 +00002128#elif defined(DJGPP)
2129#include <dir.h>
2130
Jason Tishler7961aa62005-05-20 00:56:54 +00002131#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002132#include <sys/types.h>
2133#include <dirent.h>
2134
Andrew MacIntyred9400542002-02-26 11:41:34 +00002135#elif defined(PYOS_OS2)
2136#define INCL_DOS
2137#define INCL_DOSERRORS
2138#define INCL_NOPMAPI
2139#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002140#endif
2141
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002142#if defined(DJGPP) \
2143 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2144 && defined(HAVE_DIRENT_H)) \
2145 || defined(PYOS_OS2)
2146# define USE_CASE_OK_BYTES
2147#endif
2148
2149
2150#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002151static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002152case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002153{
Tim Peters50d8d372001-02-28 05:34:27 +00002154/* Pick a platform-specific implementation; the sequence of #if's here should
2155 * match the sequence just above.
2156 */
2157
Tim Peters50d8d372001-02-28 05:34:27 +00002158/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002159#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002160 struct ffblk ffblk;
2161 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002162
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002163 if (Py_GETENV("PYTHONCASEOK") != NULL)
2164 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002165
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002166 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2167 if (done) {
2168 PyErr_Format(PyExc_NameError,
2169 "Can't find file for module %.100s\n(filename %.300s)",
2170 name, buf);
Victor Stinner9c61e242011-03-22 01:22:27 +01002171 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002172 }
2173 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002174
Jason Tishler7961aa62005-05-20 00:56:54 +00002175/* new-fangled macintosh (macosx) or Cygwin */
2176#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002177 DIR *dirp;
2178 struct dirent *dp;
2179 char dirname[MAXPATHLEN + 1];
2180 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002181
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002182 if (Py_GETENV("PYTHONCASEOK") != NULL)
2183 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002184
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002185 /* Copy the dir component into dirname; substitute "." if empty */
2186 if (dirlen <= 0) {
2187 dirname[0] = '.';
2188 dirname[1] = '\0';
2189 }
2190 else {
2191 assert(dirlen <= MAXPATHLEN);
2192 memcpy(dirname, buf, dirlen);
2193 dirname[dirlen] = '\0';
2194 }
2195 /* Open the directory and search the entries for an exact match. */
2196 dirp = opendir(dirname);
2197 if (dirp) {
2198 char *nameWithExt = buf + len - namelen;
2199 while ((dp = readdir(dirp)) != NULL) {
2200 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002201#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002202 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002203#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002204 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002205#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002206 if (thislen >= namelen &&
2207 strcmp(dp->d_name, nameWithExt) == 0) {
2208 (void)closedir(dirp);
2209 return 1; /* Found */
2210 }
2211 }
2212 (void)closedir(dirp);
2213 }
2214 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002215
Andrew MacIntyred9400542002-02-26 11:41:34 +00002216/* OS/2 */
2217#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002218 HDIR hdir = 1;
2219 ULONG srchcnt = 1;
2220 FILEFINDBUF3 ffbuf;
2221 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002222
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002223 if (Py_GETENV("PYTHONCASEOK") != NULL)
2224 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002225
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002226 rc = DosFindFirst(buf,
2227 &hdir,
2228 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2229 &ffbuf, sizeof(ffbuf),
2230 &srchcnt,
2231 FIL_STANDARD);
2232 if (rc != NO_ERROR)
2233 return 0;
2234 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002235
Tim Peters50d8d372001-02-28 05:34:27 +00002236/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2237#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002238# error "USE_CASE_OK_BYTES is not correctly defined"
2239#endif
2240}
2241#endif
2242
2243/*
2244 * Check if a filename case matchs the name case. We've already done a
2245 * successful stat() or fopen() on buf, so know that there's some match,
2246 * possibly case-insensitive.
2247 *
2248 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2249 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2250 * if envar PYTHONCASEOK exists.
2251 *
2252 * case_ok() is used to implement case-sensitive import semantics even
2253 * on platforms with case-insensitive filesystems. It's trivial to implement
2254 * for case-sensitive filesystems. It's pretty much a cross-platform
2255 * nightmare for systems with case-insensitive filesystems.
2256 */
2257
2258static int
2259case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2260{
2261#ifdef MS_WINDOWS
2262 WIN32_FIND_DATAW data;
2263 HANDLE h;
2264 int cmp;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002265 wchar_t *wname;
Victor Stinner8c981892011-10-11 22:27:13 +02002266 Py_ssize_t wname_len;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002267
2268 if (Py_GETENV("PYTHONCASEOK") != NULL)
2269 return 1;
2270
2271 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2272 if (h == INVALID_HANDLE_VALUE) {
2273 PyErr_Format(PyExc_NameError,
2274 "Can't find file for module %R\n(filename %R)",
2275 name, filename);
2276 return 0;
2277 }
2278 FindClose(h);
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002279
2280 wname = PyUnicode_AsUnicodeAndSize(name, &wname_len);
2281 if (wname == NULL)
2282 return -1;
2283
2284 cmp = wcsncmp(data.cFileName, wname, wname_len);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002285 return cmp == 0;
2286#elif defined(USE_CASE_OK_BYTES)
2287 int match;
2288 PyObject *filebytes, *namebytes;
2289 filebytes = PyUnicode_EncodeFSDefault(filename);
2290 if (filebytes == NULL)
2291 return -1;
2292 namebytes = PyUnicode_EncodeFSDefault(name);
2293 if (namebytes == NULL) {
2294 Py_DECREF(filebytes);
2295 return -1;
2296 }
2297 match = case_bytes(
2298 PyBytes_AS_STRING(filebytes),
2299 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002300 PyBytes_GET_SIZE(namebytes),
2301 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002302 Py_DECREF(filebytes);
2303 Py_DECREF(namebytes);
2304 return match;
2305#else
2306 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002307 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002308
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002309#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002310}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002311
Guido van Rossum197346f1997-10-31 18:38:52 +00002312#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002313
Victor Stinner547a2a62011-03-20 03:07:28 +01002314/* Helper to look for __init__.py or __init__.py[co] in potential package.
2315 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002316static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002317find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002318{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002319 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002320 PyObject *filename;
2321 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002322
Victor Stinner547a2a62011-03-20 03:07:28 +01002323 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2324 if (filename == NULL)
2325 return -1;
2326 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002327 /* 3=len(".py") */
2328 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002329 if (match < 0) {
2330 Py_DECREF(filename);
2331 return -1;
2332 }
2333 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002334 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002335 return 1;
2336 }
2337 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002338 Py_DECREF(filename);
2339
2340 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2341 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2342 if (filename == NULL)
2343 return -1;
2344 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002345 /* 4=len(".pyc") */
2346 match = case_ok(filename, -4, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002347 if (match < 0) {
2348 Py_DECREF(filename);
2349 return -1;
2350 }
2351 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002352 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002353 return 1;
2354 }
2355 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002356 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002357 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002358}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002359
Guido van Rossum197346f1997-10-31 18:38:52 +00002360#endif /* HAVE_STAT */
2361
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002362
Victor Stinner95872862011-03-07 18:20:56 +01002363static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002364
Victor Stinner44c6c152010-08-09 00:59:10 +00002365static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002366load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002367{
2368 PyObject *m, *modules;
2369 int err;
2370
Victor Stinner44c6c152010-08-09 00:59:10 +00002371 if (type == C_BUILTIN)
2372 err = init_builtin(name);
2373 else
Victor Stinner95872862011-03-07 18:20:56 +01002374 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002375 if (err < 0)
2376 return NULL;
2377 if (err == 0) {
2378 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002379 "Purported %s module %R not found",
2380 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002381 name);
2382 return NULL;
2383 }
2384
2385 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002386 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002387 if (m == NULL) {
2388 PyErr_Format(
2389 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002390 "%s module %R not properly initialized",
2391 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002392 name);
2393 return NULL;
2394 }
2395 Py_INCREF(m);
2396 return m;
2397}
2398
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002399/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002400 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002401
Guido van Rossum79f25d91997-04-29 20:08:16 +00002402static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002403load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002404{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002405 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002406
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002407 /* First check that there's an open file (if we need one) */
2408 switch (type) {
2409 case PY_SOURCE:
2410 case PY_COMPILED:
2411 if (fp == NULL) {
2412 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002413 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002414 type);
2415 return NULL;
2416 }
2417 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002418
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002419 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002420
Victor Stinner41c5fec2011-03-13 21:46:30 -04002421 case PY_SOURCE:
2422 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002423 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002424
Victor Stinner41c5fec2011-03-13 21:46:30 -04002425 case PY_COMPILED:
2426 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002427 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002428
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002429#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002430 case C_EXTENSION:
2431 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002432 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002433#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002434
Victor Stinner41c5fec2011-03-13 21:46:30 -04002435 case PKG_DIRECTORY:
2436 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002437 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002439 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002440 case PY_FROZEN:
2441 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002442 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 case IMP_HOOK: {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002445 _Py_IDENTIFIER(load_module);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002446 if (loader == NULL) {
2447 PyErr_SetString(PyExc_ImportError,
2448 "import hook without loader");
2449 return NULL;
2450 }
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002451 m = _PyObject_CallMethodId(loader, &PyId_load_module, "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002452 break;
2453 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002454
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002455 default:
2456 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002457 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002458 name, type);
2459 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002460
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002461 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002462
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002463 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002464}
2465
2466
2467/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002468 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002469 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002470
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002471static int
Victor Stinner95872862011-03-07 18:20:56 +01002472init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002473{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002474 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002475
Victor Stinner95872862011-03-07 18:20:56 +01002476 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002477 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002478
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002479 for (p = PyImport_Inittab; p->name != NULL; p++) {
2480 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002481 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002482 if (p->initfunc == NULL) {
2483 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002484 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002485 name);
2486 return -1;
2487 }
2488 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002489 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002490 mod = (*p->initfunc)();
2491 if (mod == 0)
2492 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002493 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002494 return -1;
2495 /* FixupExtension has put the module into sys.modules,
2496 so we can release our own reference. */
2497 Py_DECREF(mod);
2498 return 1;
2499 }
2500 }
2501 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002502}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002503
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002504
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002505/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002506
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002507static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002508find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002509{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002510 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002511
Victor Stinner53dc7352011-03-20 01:50:21 +01002512 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002513 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002514
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002515 for (p = PyImport_FrozenModules; ; p++) {
2516 if (p->name == NULL)
2517 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002518 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002519 break;
2520 }
2521 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002522}
2523
Guido van Rossum79f25d91997-04-29 20:08:16 +00002524static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002525get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002526{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002527 struct _frozen *p = find_frozen(name);
2528 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002529
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002530 if (p == NULL) {
2531 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002532 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002533 name);
2534 return NULL;
2535 }
2536 if (p->code == NULL) {
2537 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002538 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002539 name);
2540 return NULL;
2541 }
2542 size = p->size;
2543 if (size < 0)
2544 size = -size;
2545 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002546}
2547
Brett Cannon8d110132009-03-15 02:20:16 +00002548static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002549is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002550{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002551 struct _frozen *p = find_frozen(name);
2552 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002553
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002554 if (p == NULL) {
2555 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002556 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002557 name);
2558 return NULL;
2559 }
Brett Cannon8d110132009-03-15 02:20:16 +00002560
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002561 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002562
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002563 if (size < 0)
2564 Py_RETURN_TRUE;
2565 else
2566 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002567}
2568
2569
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002570/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002571 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002572 an exception set if the initialization failed.
2573 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002574
2575int
Victor Stinner53dc7352011-03-20 01:50:21 +01002576PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002577{
Victor Stinner53dc7352011-03-20 01:50:21 +01002578 struct _frozen *p;
2579 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002580 int ispackage;
2581 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002582
Victor Stinner53dc7352011-03-20 01:50:21 +01002583 p = find_frozen(name);
2584
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002585 if (p == NULL)
2586 return 0;
2587 if (p->code == NULL) {
2588 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002589 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002590 name);
2591 return -1;
2592 }
2593 size = p->size;
2594 ispackage = (size < 0);
2595 if (ispackage)
2596 size = -size;
2597 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002598 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002599 name, ispackage ? " package" : "");
2600 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2601 if (co == NULL)
2602 return -1;
2603 if (!PyCode_Check(co)) {
2604 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002605 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002606 name);
2607 goto err_return;
2608 }
2609 if (ispackage) {
2610 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002611 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002612 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002613 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002614 if (m == NULL)
2615 goto err_return;
2616 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002617 l = PyList_New(1);
2618 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002619 goto err_return;
2620 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002621 Py_INCREF(name);
2622 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002623 err = PyDict_SetItemString(d, "__path__", l);
2624 Py_DECREF(l);
2625 if (err != 0)
2626 goto err_return;
2627 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002628 path = PyUnicode_FromString("<frozen>");
2629 if (path == NULL)
2630 goto err_return;
2631 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2632 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002633 if (m == NULL)
2634 goto err_return;
2635 Py_DECREF(co);
2636 Py_DECREF(m);
2637 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002638err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002639 Py_DECREF(co);
2640 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002641}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002642
Victor Stinner53dc7352011-03-20 01:50:21 +01002643int
2644PyImport_ImportFrozenModule(char *name)
2645{
2646 PyObject *nameobj;
2647 int ret;
2648 nameobj = PyUnicode_InternFromString(name);
2649 if (nameobj == NULL)
2650 return -1;
2651 ret = PyImport_ImportFrozenModuleObject(nameobj);
2652 Py_DECREF(nameobj);
2653 return ret;
2654}
2655
Guido van Rossum74e6a111994-08-29 12:54:38 +00002656
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002657/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002658 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002659
Guido van Rossum79f25d91997-04-29 20:08:16 +00002660PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002661PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002662{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002663 PyObject *pname;
2664 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002665
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002666 pname = PyUnicode_FromString(name);
2667 if (pname == NULL)
2668 return NULL;
2669 result = PyImport_Import(pname);
2670 Py_DECREF(pname);
2671 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002672}
2673
Christian Heimes072c0f12008-01-03 23:01:04 +00002674/* Import a module without blocking
2675 *
2676 * At first it tries to fetch the module from sys.modules. If the module was
2677 * never loaded before it loads it with PyImport_ImportModule() unless another
2678 * thread holds the import lock. In the latter case the function raises an
2679 * ImportError instead of blocking.
2680 *
2681 * Returns the module object with incremented ref count.
2682 */
2683PyObject *
2684PyImport_ImportModuleNoBlock(const char *name)
2685{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002686 PyObject *nameobj, *modules, *result;
Victor Stinner0af03062011-09-02 00:11:43 +02002687#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002688 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002689#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002691 /* Try to get the module from sys.modules[name] */
2692 modules = PyImport_GetModuleDict();
2693 if (modules == NULL)
2694 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002695
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002696 nameobj = PyUnicode_FromString(name);
2697 if (nameobj == NULL)
2698 return NULL;
2699 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002700 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002701 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002702 Py_INCREF(result);
2703 return result;
2704 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002705 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002706#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002707 /* check the import lock
2708 * me might be -1 but I ignore the error here, the lock function
2709 * takes care of the problem */
2710 me = PyThread_get_thread_ident();
2711 if (import_lock_thread == -1 || import_lock_thread == me) {
2712 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002713 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002714 }
2715 else {
2716 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002717 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002718 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002719 nameobj);
2720 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002721 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002722#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002723 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002724#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002725 Py_DECREF(nameobj);
2726 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002727}
2728
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002729/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002730static PyObject *get_parent(PyObject *globals,
2731 PyObject **p_name,
2732 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002733static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002734 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002735 Py_UCS4 *buf, Py_ssize_t *p_buflen,
Victor Stinner974389d2011-03-15 09:33:57 +01002736 Py_ssize_t bufsize);
2737static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002738static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002739 PyObject *buf, int recursive);
2740static PyObject * import_submodule(PyObject *mod, PyObject *name,
2741 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002742
2743/* The Magnum Opus of dotted-name import :-) */
2744
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002745static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002746import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002747 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002748{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002749 Py_UCS4 buf[MAXPATHLEN+1];
Victor Stinner974389d2011-03-15 09:33:57 +01002750 Py_ssize_t buflen;
2751 Py_ssize_t bufsize = MAXPATHLEN+1;
2752 PyObject *parent, *head, *next, *tail, *inputname, *outputname;
2753 PyObject *parent_name, *ensure_name;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002754 Py_ssize_t sep, altsep;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002755
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002756 if (PyUnicode_READY(name))
2757 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002758
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002759 sep = PyUnicode_FindChar(name, SEP, 0, PyUnicode_GET_LENGTH(name), 1);
2760 if (sep == -2)
2761 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002762#ifdef ALTSEP
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002763 altsep = PyUnicode_FindChar(name, ALTSEP, 0, PyUnicode_GET_LENGTH(name), 1);
2764 if (altsep == -2)
2765 return NULL;
2766#else
2767 altsep = -1;
Christian Heimes454f37b2008-01-10 00:10:02 +00002768#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002769 if (sep != -1 || altsep != -1)
2770 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002771 PyErr_SetString(PyExc_ImportError,
2772 "Import by filename is not supported.");
2773 return NULL;
2774 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002775
Victor Stinner974389d2011-03-15 09:33:57 +01002776 parent = get_parent(globals, &parent_name, level);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002777 if (parent == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002778 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002779 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002780
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002781 if (PyUnicode_READY(parent_name))
2782 return NULL;
2783 buflen = PyUnicode_GET_LENGTH(parent_name);
Georg Brandl4cb0de22011-09-28 21:49:49 +02002784 if (!PyUnicode_AsUCS4(parent_name, buf, Py_ARRAY_LENGTH(buf), 1)) {
Victor Stinner974389d2011-03-15 09:33:57 +01002785 Py_DECREF(parent_name);
2786 PyErr_SetString(PyExc_ValueError,
2787 "Module name too long");
2788 return NULL;
2789 }
Victor Stinner974389d2011-03-15 09:33:57 +01002790 Py_DECREF(parent_name);
2791
2792 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
2793 buf, &buflen, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002794 if (head == NULL)
2795 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002796
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002797 tail = head;
2798 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002799
2800 if (outputname != NULL) {
2801 while (1) {
2802 inputname = outputname;
2803 next = load_next(tail, tail, inputname, &outputname,
2804 buf, &buflen, bufsize);
2805 Py_DECREF(tail);
2806 Py_DECREF(inputname);
2807 if (next == NULL) {
2808 Py_DECREF(head);
2809 return NULL;
2810 }
2811 tail = next;
2812
2813 if (outputname == NULL) {
2814 break;
2815 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002816 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002817 }
2818 if (tail == Py_None) {
2819 /* If tail is Py_None, both get_parent and load_next found
2820 an empty module name: someone called __import__("") or
2821 doctored faulty bytecode */
2822 Py_DECREF(tail);
2823 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002824 PyErr_SetString(PyExc_ValueError, "Empty module name");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002825 return NULL;
2826 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002827
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002828 if (fromlist != NULL) {
2829 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2830 fromlist = NULL;
2831 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002832
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002833 if (fromlist == NULL) {
2834 Py_DECREF(tail);
2835 return head;
2836 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002837
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002838 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002839
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002840 ensure_name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
2841 buf, Py_UCS4_strlen(buf));
Victor Stinner974389d2011-03-15 09:33:57 +01002842 if (ensure_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002843 Py_DECREF(tail);
2844 return NULL;
2845 }
Victor Stinner974389d2011-03-15 09:33:57 +01002846 if (!ensure_fromlist(tail, fromlist, ensure_name, 0)) {
2847 Py_DECREF(tail);
2848 Py_DECREF(ensure_name);
2849 return NULL;
2850 }
2851 Py_DECREF(ensure_name);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002852
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002853 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002854}
2855
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002856PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002857PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2858 PyObject *locals, PyObject *fromlist,
2859 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002860{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002861 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002862 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002863 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002864 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002865 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002866 PyErr_SetString(PyExc_RuntimeError,
2867 "not holding the import lock");
2868 return NULL;
2869 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002870 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002871}
2872
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002873PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05002874PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002875 PyObject *fromlist, int level)
2876{
2877 PyObject *nameobj, *mod;
2878 nameobj = PyUnicode_FromString(name);
2879 if (nameobj == NULL)
2880 return NULL;
2881 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2882 fromlist, level);
2883 Py_DECREF(nameobj);
2884 return mod;
2885}
2886
2887
Fred Drake87590902004-05-28 20:21:36 +00002888/* Return the package that an import is being performed in. If globals comes
2889 from the module foo.bar.bat (not itself a package), this returns the
2890 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002891 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002892
Victor Stinner974389d2011-03-15 09:33:57 +01002893 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002894
2895 If globals doesn't come from a package or a module in a package, or a
2896 corresponding entry is not found in sys.modules, Py_None is returned.
2897*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002898static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002899get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002900{
Victor Stinner974389d2011-03-15 09:33:57 +01002901 PyObject *nameobj;
2902
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002903 static PyObject *namestr = NULL;
2904 static PyObject *pathstr = NULL;
2905 static PyObject *pkgstr = NULL;
2906 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2907 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002909 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002910 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002911
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002912 if (namestr == NULL) {
2913 namestr = PyUnicode_InternFromString("__name__");
2914 if (namestr == NULL)
2915 return NULL;
2916 }
2917 if (pathstr == NULL) {
2918 pathstr = PyUnicode_InternFromString("__path__");
2919 if (pathstr == NULL)
2920 return NULL;
2921 }
2922 if (pkgstr == NULL) {
2923 pkgstr = PyUnicode_InternFromString("__package__");
2924 if (pkgstr == NULL)
2925 return NULL;
2926 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002927
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002928 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002929
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002930 if ((pkgname != NULL) && (pkgname != Py_None)) {
2931 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002932 if (!PyUnicode_Check(pkgname)) {
2933 PyErr_SetString(PyExc_ValueError,
2934 "__package__ set to non-string");
2935 return NULL;
2936 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002937 if (PyUnicode_GET_LENGTH(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002938 if (level > 0) {
2939 PyErr_SetString(PyExc_ValueError,
2940 "Attempted relative import in non-package");
2941 return NULL;
2942 }
Victor Stinner974389d2011-03-15 09:33:57 +01002943 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002944 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002945 Py_INCREF(pkgname);
2946 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002947 } else {
2948 /* __package__ not set, so figure it out and set it */
2949 modname = PyDict_GetItem(globals, namestr);
2950 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002951 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002952
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002953 modpath = PyDict_GetItem(globals, pathstr);
2954 if (modpath != NULL) {
2955 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002956 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002957
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002958 error = PyDict_SetItem(globals, pkgstr, modname);
2959 if (error) {
2960 PyErr_SetString(PyExc_ValueError,
2961 "Could not set __package__");
2962 return NULL;
2963 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002964 Py_INCREF(modname);
2965 nameobj = modname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002966 } else {
2967 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002968 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002969 len = PyUnicode_FindChar(modname, '.',
2970 0, PyUnicode_GET_LENGTH(modname), -1);
2971 if (len == -2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002972 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002973 if (len < 0) {
2974 if (level > 0) {
2975 PyErr_SetString(PyExc_ValueError,
2976 "Attempted relative import in non-package");
2977 return NULL;
2978 }
2979 if (PyDict_SetItem(globals, pkgstr, Py_None)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002980 PyErr_SetString(PyExc_ValueError,
2981 "Could not set __package__");
2982 return NULL;
2983 }
Victor Stinner974389d2011-03-15 09:33:57 +01002984 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002985 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002986 pkgname = PyUnicode_Substring(modname, 0, len);
2987 if (pkgname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002988 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002989 if (PyDict_SetItem(globals, pkgstr, pkgname)) {
2990 Py_DECREF(pkgname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002991 PyErr_SetString(PyExc_ValueError,
2992 "Could not set __package__");
2993 return NULL;
2994 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002995 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002996 }
2997 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002998 if (level > 1) {
2999 Py_ssize_t dot, end = PyUnicode_GET_LENGTH(nameobj);
3000 PyObject *newname;
3001 while (--level > 0) {
3002 dot = PyUnicode_FindChar(nameobj, '.', 0, end, -1);
3003 if (dot == -2) {
3004 Py_DECREF(nameobj);
3005 return NULL;
3006 }
3007 if (dot < 0) {
3008 Py_DECREF(nameobj);
3009 PyErr_SetString(PyExc_ValueError,
3010 "Attempted relative import beyond "
3011 "toplevel package");
3012 return NULL;
3013 }
3014 end = dot;
3015 }
3016 newname = PyUnicode_Substring(nameobj, 0, end);
3017 Py_DECREF(nameobj);
3018 if (newname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003019 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003020 nameobj = newname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003021 }
Victor Stinner974389d2011-03-15 09:33:57 +01003022
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003023 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003024 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003025 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003026 int err;
3027
3028 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003029 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01003030 "Parent module %R not loaded, "
3031 "cannot perform relative import", nameobj);
3032 Py_DECREF(nameobj);
3033 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003034 }
Victor Stinner974389d2011-03-15 09:33:57 +01003035
3036 err = PyErr_WarnFormat(
3037 PyExc_RuntimeWarning, 1,
3038 "Parent module %R not found while handling absolute import",
3039 nameobj);
3040 Py_DECREF(nameobj);
3041 if (err)
3042 return NULL;
3043
3044 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003045 }
Victor Stinner974389d2011-03-15 09:33:57 +01003046 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003047 return parent;
3048 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01003049 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003050 - parent.__dict__ is globals
3051 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01003052
3053return_none:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003054 nameobj = PyUnicode_New(0, 0);
Victor Stinner974389d2011-03-15 09:33:57 +01003055 if (nameobj == NULL)
3056 return NULL;
3057 *p_name = nameobj;
3058 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003059}
3060
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003061/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003062static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003063load_next(PyObject *mod, PyObject *altmod,
3064 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003065 Py_UCS4 *buf, Py_ssize_t *p_buflen, Py_ssize_t bufsize)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003066{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003067 Py_UCS4 *dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003068 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003069 Py_UCS4 *p;
Victor Stinner974389d2011-03-15 09:33:57 +01003070 PyObject *fullname, *name, *result, *mark_name;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003071 Py_UCS4 *nameuni;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003072
Victor Stinner974389d2011-03-15 09:33:57 +01003073 *p_outputname = NULL;
3074
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003075 if (PyUnicode_GET_LENGTH(inputname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003076 /* completely empty module name should only happen in
3077 'from . import' (or '__import__("")')*/
3078 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003079 return mod;
3080 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00003081
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003082 nameuni = PyUnicode_AsUCS4Copy(inputname);
Victor Stinner974389d2011-03-15 09:33:57 +01003083 if (nameuni == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003084 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003085
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003086 dot = Py_UCS4_strchr(nameuni, '.');
Victor Stinner974389d2011-03-15 09:33:57 +01003087 if (dot != NULL) {
3088 len = dot - nameuni;
3089 if (len == 0) {
3090 PyErr_SetString(PyExc_ValueError,
3091 "Empty module name");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003092 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003093 }
3094 }
3095 else
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003096 len = PyUnicode_GET_LENGTH(inputname);
Victor Stinner974389d2011-03-15 09:33:57 +01003097
3098 if (*p_buflen+len+1 >= bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003099 PyErr_SetString(PyExc_ValueError,
3100 "Module name too long");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003101 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003102 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003103
Victor Stinner974389d2011-03-15 09:33:57 +01003104 p = buf + *p_buflen;
3105 if (p != buf) {
3106 *p++ = '.';
3107 *p_buflen += 1;
3108 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003109 Py_UCS4_strncpy(p, nameuni, len);
Victor Stinner974389d2011-03-15 09:33:57 +01003110 p[len] = '\0';
3111 *p_buflen += len;
3112
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003113 fullname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3114 buf, *p_buflen);
Victor Stinner974389d2011-03-15 09:33:57 +01003115 if (fullname == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003116 goto error;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003117 name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3118 p, len);
Victor Stinner974389d2011-03-15 09:33:57 +01003119 if (name == NULL) {
3120 Py_DECREF(fullname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003121 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003122 }
3123 result = import_submodule(mod, name, fullname);
3124 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003125 if (result == Py_None && altmod != mod) {
3126 Py_DECREF(result);
3127 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003128 result = import_submodule(altmod, name, name);
3129 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003130 if (result != NULL && result != Py_None) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003131 mark_name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3132 buf, *p_buflen);
Victor Stinner974389d2011-03-15 09:33:57 +01003133 if (mark_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003134 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003135 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003136 }
Victor Stinner974389d2011-03-15 09:33:57 +01003137 if (mark_miss(mark_name) != 0) {
3138 Py_DECREF(result);
3139 Py_DECREF(mark_name);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003140 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003141 }
3142 Py_DECREF(mark_name);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003143 Py_UCS4_strncpy(buf, nameuni, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003144 buf[len] = '\0';
3145 *p_buflen = len;
3146 }
3147 }
Victor Stinner974389d2011-03-15 09:33:57 +01003148 else
3149 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003150 if (result == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003151 goto error;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003152
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003153 if (result == Py_None) {
3154 Py_DECREF(result);
3155 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003156 "No module named %R", inputname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003157 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003158 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003159
Victor Stinner974389d2011-03-15 09:33:57 +01003160 if (dot != NULL) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003161 *p_outputname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3162 dot+1, Py_UCS4_strlen(dot+1));
Victor Stinner974389d2011-03-15 09:33:57 +01003163 if (*p_outputname == NULL) {
3164 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003165 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003166 }
3167 }
3168
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003169 PyMem_Free(nameuni);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003170 return result;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003171
3172error:
3173 PyMem_Free(nameuni);
3174 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003175}
3176
3177static int
Victor Stinner974389d2011-03-15 09:33:57 +01003178mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003179{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003180 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003181 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003182}
3183
3184static int
Victor Stinner974389d2011-03-15 09:33:57 +01003185ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003186 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003187{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003188 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003189 PyObject *fullname;
3190 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003191
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003192 if (!_PyObject_HasAttrId(mod, &PyId___path__))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003193 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003194
Victor Stinner974389d2011-03-15 09:33:57 +01003195 fromlist_len = PySequence_Size(fromlist);
3196
3197 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003198 PyObject *item = PySequence_GetItem(fromlist, i);
3199 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003200 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003201 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003202 if (!PyUnicode_Check(item)) {
3203 PyErr_SetString(PyExc_TypeError,
3204 "Item in ``from list'' not a string");
3205 Py_DECREF(item);
3206 return 0;
3207 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003208 if (PyUnicode_READ_CHAR(item, 0) == '*') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003209 PyObject *all;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02003210 _Py_IDENTIFIER(__all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003211 Py_DECREF(item);
3212 /* See if the package defines __all__ */
3213 if (recursive)
3214 continue; /* Avoid endless recursion */
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003215 all = _PyObject_GetAttrId(mod, &PyId___all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003216 if (all == NULL)
3217 PyErr_Clear();
3218 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003219 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003220 Py_DECREF(all);
3221 if (!ret)
3222 return 0;
3223 }
3224 continue;
3225 }
3226 hasit = PyObject_HasAttr(mod, item);
3227 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003228 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003229 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3230 if (fullname != NULL) {
3231 submod = import_submodule(mod, item, fullname);
3232 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003233 }
Victor Stinner974389d2011-03-15 09:33:57 +01003234 else
3235 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003236 Py_XDECREF(submod);
3237 if (submod == NULL) {
3238 Py_DECREF(item);
3239 return 0;
3240 }
3241 }
3242 Py_DECREF(item);
3243 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003244
Victor Stinner974389d2011-03-15 09:33:57 +01003245 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003246}
3247
Neil Schemenauer00b09662003-06-16 21:03:07 +00003248static int
Victor Stinner974389d2011-03-15 09:33:57 +01003249add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3250 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003251{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003252 if (mod == Py_None)
3253 return 1;
3254 /* Irrespective of the success of this load, make a
3255 reference to it in the parent package module. A copy gets
3256 saved in the modules dictionary under the full name, so get a
3257 reference from there, if need be. (The exception is when the
3258 load failed with a SyntaxError -- then there's no trace in
3259 sys.modules. In that case, of course, do nothing extra.) */
3260 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003261 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003262 if (submod == NULL)
3263 return 1;
3264 }
3265 if (PyModule_Check(mod)) {
3266 /* We can't use setattr here since it can give a
3267 * spurious warning if the submodule name shadows a
3268 * builtin name */
3269 PyObject *dict = PyModule_GetDict(mod);
3270 if (!dict)
3271 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003272 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003273 return 0;
3274 }
3275 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003276 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003277 return 0;
3278 }
3279 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003280}
3281
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003282static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003283import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003284{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003285 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003286 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003287 struct filedescr *fdp;
3288 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003289
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003290 /* Require:
3291 if mod == None: subname == fullname
3292 else: mod.__name__ + "." + subname == fullname
3293 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003294
Victor Stinner974389d2011-03-15 09:33:57 +01003295 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003296 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003297 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003298 }
Victor Stinner9599de52011-03-13 22:38:38 -04003299
3300 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003301 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003302 else {
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003303 path_list = _PyObject_GetAttrId(mod, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003304 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003305 PyErr_Clear();
3306 Py_INCREF(Py_None);
3307 return Py_None;
3308 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003309 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003310
Victor Stinner533d7832011-03-14 13:22:54 -04003311 fdp = find_module(fullname, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003312 &bufobj, &fp, &loader);
Victor Stinner533d7832011-03-14 13:22:54 -04003313 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003314 if (fdp == NULL) {
3315 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3316 return NULL;
3317 PyErr_Clear();
3318 Py_INCREF(Py_None);
3319 return Py_None;
3320 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003321 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3322 Py_XDECREF(bufobj);
Victor Stinner9599de52011-03-13 22:38:38 -04003323 Py_XDECREF(loader);
3324 if (fp)
3325 fclose(fp);
3326 if (m == NULL)
3327 return NULL;
3328 if (!add_submodule(mod, m, fullname, subname, modules)) {
3329 Py_XDECREF(m);
3330 return NULL;
3331 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003332 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003333}
3334
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003335
3336/* Re-import a module of any kind and return its module object, WITH
3337 INCREMENTED REFERENCE COUNT */
3338
Guido van Rossum79f25d91997-04-29 20:08:16 +00003339PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003340PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003341{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003342 PyInterpreterState *interp = PyThreadState_Get()->interp;
3343 PyObject *modules_reloading = interp->modules_reloading;
3344 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003345 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003346 PyObject *nameobj, *bufobj, *subnameobj;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003347 Py_UCS4 *name = NULL, *subname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003348 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003349 FILE *fp = NULL;
3350 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003351
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003352 if (modules_reloading == NULL) {
3353 Py_FatalError("PyImport_ReloadModule: "
3354 "no modules_reloading dictionary!");
3355 return NULL;
3356 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003357
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003358 if (m == NULL || !PyModule_Check(m)) {
3359 PyErr_SetString(PyExc_TypeError,
3360 "reload() argument must be module");
3361 return NULL;
3362 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003363 nameobj = PyModule_GetNameObject(m);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003364 if (nameobj == NULL || PyUnicode_READY(nameobj) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003365 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003366 if (m != PyDict_GetItem(modules, nameobj)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003367 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003368 "reload(): module %R not in sys.modules",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003369 nameobj);
3370 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003371 return NULL;
3372 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003373 existing_m = PyDict_GetItem(modules_reloading, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003374 if (existing_m != NULL) {
3375 /* Due to a recursive reload, this module is already
3376 being reloaded. */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003377 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003378 Py_INCREF(existing_m);
3379 return existing_m;
3380 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003381 if (PyDict_SetItem(modules_reloading, nameobj, m) < 0) {
3382 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003383 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003384 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003385
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003386 name = PyUnicode_AsUCS4Copy(nameobj);
3387 if (!name) {
3388 Py_DECREF(nameobj);
3389 return NULL;
3390 }
3391 subname = Py_UCS4_strrchr(name, '.');
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003392 if (subname == NULL) {
3393 Py_INCREF(nameobj);
3394 subnameobj = nameobj;
3395 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003396 else {
3397 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003398 Py_ssize_t len;
3399 len = subname - name;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003400 parentname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3401 name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003402 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003403 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003404 }
3405 parent = PyDict_GetItem(modules, parentname);
3406 if (parent == NULL) {
3407 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003408 "reload(): parent %R not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003409 parentname);
3410 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003411 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003412 }
3413 Py_DECREF(parentname);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003414 path_list = _PyObject_GetAttrId(parent, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003415 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003416 PyErr_Clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003417 subname++;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003418 len = PyUnicode_GET_LENGTH(nameobj) - (len + 1);
3419 subnameobj = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3420 subname, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003421 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003422 if (subnameobj == NULL)
3423 goto error;
Victor Stinner533d7832011-03-14 13:22:54 -04003424 fdp = find_module(nameobj, subnameobj, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003425 &bufobj, &fp, &loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003426 Py_DECREF(subnameobj);
Victor Stinner533d7832011-03-14 13:22:54 -04003427 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003428
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003429 if (fdp == NULL) {
3430 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003431 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003432 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003433
Victor Stinner2fd76e42011-03-14 15:19:39 -04003434 newm = load_module(nameobj, fp, bufobj, fdp->type, loader);
3435 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003436 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003438 if (fp)
3439 fclose(fp);
3440 if (newm == NULL) {
3441 /* load_module probably removed name from modules because of
3442 * the error. Put back the original module object. We're
3443 * going to return NULL in this case regardless of whether
3444 * replacing name succeeds, so the return value is ignored.
3445 */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003446 PyDict_SetItem(modules, nameobj, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003447 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003448
3449error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003450 imp_modules_reloading_clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003451 Py_DECREF(nameobj);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003452 PyMem_Free(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003453 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003454}
3455
3456
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003457/* Higher-level import emulator which emulates the "import" statement
3458 more accurately -- it invokes the __import__() function from the
3459 builtins of the current globals. This means that the import is
3460 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003461 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003462 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003463 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003464 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003465
3466PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003467PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003468{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003469 static PyObject *silly_list = NULL;
3470 static PyObject *builtins_str = NULL;
3471 static PyObject *import_str = NULL;
3472 PyObject *globals = NULL;
3473 PyObject *import = NULL;
3474 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003475 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003476 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003477
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003478 /* Initialize constant string objects */
3479 if (silly_list == NULL) {
3480 import_str = PyUnicode_InternFromString("__import__");
3481 if (import_str == NULL)
3482 return NULL;
3483 builtins_str = PyUnicode_InternFromString("__builtins__");
3484 if (builtins_str == NULL)
3485 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003486 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003487 if (silly_list == NULL)
3488 return NULL;
3489 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003490
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003491 /* Get the builtins from current globals */
3492 globals = PyEval_GetGlobals();
3493 if (globals != NULL) {
3494 Py_INCREF(globals);
3495 builtins = PyObject_GetItem(globals, builtins_str);
3496 if (builtins == NULL)
3497 goto err;
3498 }
3499 else {
3500 /* No globals -- use standard builtins, and fake globals */
3501 builtins = PyImport_ImportModuleLevel("builtins",
3502 NULL, NULL, NULL, 0);
3503 if (builtins == NULL)
3504 return NULL;
3505 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3506 if (globals == NULL)
3507 goto err;
3508 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003510 /* Get the __import__ function from the builtins */
3511 if (PyDict_Check(builtins)) {
3512 import = PyObject_GetItem(builtins, import_str);
3513 if (import == NULL)
3514 PyErr_SetObject(PyExc_KeyError, import_str);
3515 }
3516 else
3517 import = PyObject_GetAttr(builtins, import_str);
3518 if (import == NULL)
3519 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003520
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003521 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003522 Always use absolute import here.
3523 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003524 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3525 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003526 if (r == NULL)
3527 goto err;
3528 Py_DECREF(r);
3529
3530 modules = PyImport_GetModuleDict();
3531 r = PyDict_GetItem(modules, module_name);
3532 if (r != NULL)
3533 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003534
3535 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003536 Py_XDECREF(globals);
3537 Py_XDECREF(builtins);
3538 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003539
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003540 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003541}
3542
3543
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003544/* Module 'imp' provides Python access to the primitives used for
3545 importing modules.
3546*/
3547
Guido van Rossum79f25d91997-04-29 20:08:16 +00003548static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003549imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003550{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003551 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003552
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003553 buf[0] = (char) ((magic >> 0) & 0xff);
3554 buf[1] = (char) ((magic >> 8) & 0xff);
3555 buf[2] = (char) ((magic >> 16) & 0xff);
3556 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003558 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003559}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003560
3561static PyObject *
3562imp_get_magic(PyObject *self, PyObject *noargs)
3563{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003564 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003565}
3566
3567static PyObject *
3568imp_get_tag(PyObject *self, PyObject *noargs)
3569{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003570 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003571}
3572
Guido van Rossum79f25d91997-04-29 20:08:16 +00003573static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003574imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003575{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003576 PyObject *list;
3577 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003578
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003579 list = PyList_New(0);
3580 if (list == NULL)
3581 return NULL;
3582 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3583 PyObject *item = Py_BuildValue("ssi",
3584 fdp->suffix, fdp->mode, fdp->type);
3585 if (item == NULL) {
3586 Py_DECREF(list);
3587 return NULL;
3588 }
3589 if (PyList_Append(list, item) < 0) {
3590 Py_DECREF(list);
3591 Py_DECREF(item);
3592 return NULL;
3593 }
3594 Py_DECREF(item);
3595 }
3596 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003597}
3598
Guido van Rossum79f25d91997-04-29 20:08:16 +00003599static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003600call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003601{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003602 extern int fclose(FILE *);
3603 PyObject *fob, *ret;
3604 PyObject *pathobj;
3605 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003606 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003607 int fd = -1;
3608 char *found_encoding = NULL;
3609 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003610
Victor Stinner533d7832011-03-14 13:22:54 -04003611 if (path_list == Py_None)
3612 path_list = NULL;
3613 fdp = find_module(NULL, name, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003614 &pathobj, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003615 if (fdp == NULL)
3616 return NULL;
3617 if (fp != NULL) {
3618 fd = fileno(fp);
3619 if (fd != -1)
3620 fd = dup(fd);
3621 fclose(fp);
Victor Stinnerd417d012011-06-20 15:16:55 +02003622 if (fd == -1) {
3623 PyErr_SetFromErrno(PyExc_OSError);
3624 return NULL;
3625 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003626 fp = NULL;
3627 }
3628 if (fd != -1) {
3629 if (strchr(fdp->mode, 'b') == NULL) {
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003630 /* PyTokenizer_FindEncodingFilename() returns PyMem_MALLOC'ed
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003631 memory. */
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003632 found_encoding = PyTokenizer_FindEncodingFilename(fd, pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003633 lseek(fd, 0, 0); /* Reset position */
Victor Stinner2fd76e42011-03-14 15:19:39 -04003634 if (found_encoding == NULL && PyErr_Occurred()) {
3635 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003636 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04003637 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003638 encoding = (found_encoding != NULL) ? found_encoding :
3639 (char*)PyUnicode_GetDefaultEncoding();
3640 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003641 fob = PyFile_FromFd(fd, NULL, fdp->mode, -1,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003642 (char*)encoding, NULL, NULL, 1);
3643 if (fob == NULL) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04003644 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003645 close(fd);
3646 PyMem_FREE(found_encoding);
3647 return NULL;
3648 }
3649 }
3650 else {
3651 fob = Py_None;
3652 Py_INCREF(fob);
3653 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003654 if (pathobj == NULL) {
3655 Py_INCREF(Py_None);
3656 pathobj = Py_None;
3657 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003658 ret = Py_BuildValue("NN(ssi)",
3659 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3660 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003662 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003663}
3664
Guido van Rossum79f25d91997-04-29 20:08:16 +00003665static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003666imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003667{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003668 PyObject *name, *path_list = NULL;
3669 if (!PyArg_ParseTuple(args, "U|O:find_module",
3670 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003671 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003672 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003673}
3674
3675static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003676imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003677{
Victor Stinner95872862011-03-07 18:20:56 +01003678 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003679 int ret;
3680 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003681 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003682 return NULL;
3683 ret = init_builtin(name);
3684 if (ret < 0)
3685 return NULL;
3686 if (ret == 0) {
3687 Py_INCREF(Py_None);
3688 return Py_None;
3689 }
Victor Stinner95872862011-03-07 18:20:56 +01003690 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003691 Py_XINCREF(m);
3692 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003693}
3694
Guido van Rossum79f25d91997-04-29 20:08:16 +00003695static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003696imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003697{
Victor Stinner53dc7352011-03-20 01:50:21 +01003698 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003699 int ret;
3700 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003701 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003702 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003703 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003704 if (ret < 0)
3705 return NULL;
3706 if (ret == 0) {
3707 Py_INCREF(Py_None);
3708 return Py_None;
3709 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003710 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003711 Py_XINCREF(m);
3712 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003713}
3714
Guido van Rossum79f25d91997-04-29 20:08:16 +00003715static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003716imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003717{
Victor Stinner53dc7352011-03-20 01:50:21 +01003718 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003719
Victor Stinner53dc7352011-03-20 01:50:21 +01003720 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003721 return NULL;
3722 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003723}
3724
Guido van Rossum79f25d91997-04-29 20:08:16 +00003725static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003726imp_is_frozen_package(PyObject *self, PyObject *args)
3727{
Victor Stinner53dc7352011-03-20 01:50:21 +01003728 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003729
Victor Stinner53dc7352011-03-20 01:50:21 +01003730 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003731 return NULL;
3732 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003733}
3734
3735static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003736imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003737{
Victor Stinner95872862011-03-07 18:20:56 +01003738 PyObject *name;
3739 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003740 return NULL;
3741 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003742}
3743
Guido van Rossum79f25d91997-04-29 20:08:16 +00003744static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003745imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003746{
Victor Stinner53dc7352011-03-20 01:50:21 +01003747 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003748 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003749 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003750 return NULL;
3751 p = find_frozen(name);
3752 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003753}
3754
3755static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003756get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003757{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003758 FILE *fp;
3759 if (mode[0] == 'U')
3760 mode = "r" PY_STDIOTEXTMODE;
3761 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003762 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003763 }
3764 else {
3765 int fd = PyObject_AsFileDescriptor(fob);
3766 if (fd == -1)
3767 return NULL;
3768 if (!_PyVerify_fd(fd))
3769 goto error;
3770 /* the FILE struct gets a new fd, so that it can be closed
3771 * independently of the file descriptor given
3772 */
3773 fd = dup(fd);
3774 if (fd == -1)
3775 goto error;
3776 fp = fdopen(fd, mode);
3777 }
3778 if (fp)
3779 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003780error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003781 PyErr_SetFromErrno(PyExc_IOError);
3782 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003783}
3784
Guido van Rossum79f25d91997-04-29 20:08:16 +00003785static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003786imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003787{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003788 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003789 PyObject *fob = NULL;
3790 PyObject *m;
3791 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003792 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003793 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003794 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003795 &fob))
3796 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003797 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003798 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003799 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003800 return NULL;
3801 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003802 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003803 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003804 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003805 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003806}
3807
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003808#ifdef HAVE_DYNAMIC_LOADING
3809
Guido van Rossum79f25d91997-04-29 20:08:16 +00003810static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003811imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003812{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003813 PyObject *name, *pathname, *fob = NULL, *mod;
3814 FILE *fp;
3815
3816 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3817 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003818 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003819 if (fob != NULL) {
3820 fp = get_file(NULL, fob, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003821 if (fp == NULL) {
3822 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003823 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003824 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003825 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003826 else
3827 fp = NULL;
3828 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003829 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003830 if (fp)
3831 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003832 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003833}
3834
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003835#endif /* HAVE_DYNAMIC_LOADING */
3836
Guido van Rossum79f25d91997-04-29 20:08:16 +00003837static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003838imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003839{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003840 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003841 PyObject *fob = NULL;
3842 PyObject *m;
3843 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003844 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003845 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003846 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003847 &fob))
3848 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003849 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003850 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003851 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003852 return NULL;
3853 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003854 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003855 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003856 fclose(fp);
3857 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003858}
3859
Guido van Rossum79f25d91997-04-29 20:08:16 +00003860static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003861imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003862{
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003863 PyObject *name, *fob, *pathname, *pathname_obj, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003864 char *suffix; /* Unused */
3865 char *mode;
3866 int type;
3867 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003868
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003869 if (!PyArg_ParseTuple(args, "UOO(ssi):load_module",
3870 &name, &fob, &pathname_obj, &suffix, &mode, &type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003871 return NULL;
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003872 if (pathname_obj != Py_None) {
3873 if (!PyUnicode_FSDecoder(pathname_obj, &pathname))
3874 return NULL;
3875 }
3876 else
3877 pathname = NULL;
3878
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003879 if (*mode) {
3880 /* Mode must start with 'r' or 'U' and must not contain '+'.
3881 Implicit in this test is the assumption that the mode
3882 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003884 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3885 PyErr_Format(PyExc_ValueError,
3886 "invalid file open mode %.200s", mode);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003887 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003888 return NULL;
3889 }
3890 }
3891 if (fob == Py_None)
3892 fp = NULL;
3893 else {
3894 fp = get_file(NULL, fob, mode);
3895 if (fp == NULL) {
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003896 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003897 return NULL;
3898 }
3899 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003900 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003901 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003902 if (fp)
3903 fclose(fp);
3904 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003905}
3906
3907static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003908imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003909{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003910 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003911 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003912 if (!PyArg_ParseTuple(args, "UO&:load_package",
3913 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003914 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003915 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003916 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003917 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003918}
3919
3920static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003921imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003922{
Victor Stinnerfe19d212011-03-14 14:53:28 -04003923 PyObject *name;
3924 if (!PyArg_ParseTuple(args, "U:new_module", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003925 return NULL;
Victor Stinnerfe19d212011-03-14 14:53:28 -04003926 return PyModule_NewObject(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003927}
3928
Christian Heimes13a7a212008-01-07 17:13:09 +00003929static PyObject *
3930imp_reload(PyObject *self, PyObject *v)
3931{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003932 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003933}
3934
3935PyDoc_STRVAR(doc_reload,
3936"reload(module) -> module\n\
3937\n\
3938Reload the module. The module must have been successfully imported before.");
3939
Barry Warsaw28a691b2010-04-17 00:19:56 +00003940static PyObject *
3941imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3942{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003943 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003944
Victor Stinner2f42ae52011-03-20 00:41:24 +01003945 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003946 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003947 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003948
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003949 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003950 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003951 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003952 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003953
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003954 if (debug_override != NULL &&
3955 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003956 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003957 return NULL;
3958 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003959
Martin v. Löwis30260a72011-10-23 17:35:46 +02003960 if (PyUnicode_READY(pathname) < 0)
3961 return NULL;
3962
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003963 cpathname = make_compiled_pathname(pathname, debug);
Victor Stinner2f42ae52011-03-20 00:41:24 +01003964 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003965
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003966 if (cpathname == NULL) {
3967 PyErr_Format(PyExc_SystemError, "path buffer too short");
3968 return NULL;
3969 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003970 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003971}
3972
3973PyDoc_STRVAR(doc_cache_from_source,
3974"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3975\n\
3976The .py file does not need to exist; this simply returns the path to the\n\
3977.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3978will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3979\n\
3980If debug_override is not None, then it must be a boolean and is taken as\n\
3981the value of __debug__ instead.");
3982
3983static PyObject *
3984imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3985{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003986 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003987 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003988
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003989 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003990 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003991 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003992 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003993
Victor Stinnerc9abda02011-03-14 13:33:46 -04003994 source = make_source_pathname(pathname);
3995 if (source == NULL) {
3996 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003997 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003998 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003999 return NULL;
4000 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04004001 Py_DECREF(pathname);
4002 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00004003}
4004
4005PyDoc_STRVAR(doc_source_from_cache,
4006"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
4007\n\
4008The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
4009the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
4010does not conform to PEP 3147 format, ValueError will be raised.");
4011
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004012/* Doc strings */
4013
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004014PyDoc_STRVAR(doc_imp,
4015"This module provides the components needed to build your own\n\
4016__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004017
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004018PyDoc_STRVAR(doc_find_module,
4019"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004020Search for a module. If path is omitted or None, search for a\n\
4021built-in, frozen or special module and continue search in sys.path.\n\
4022The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004023package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004024
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004025PyDoc_STRVAR(doc_load_module,
4026"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004027Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004028The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004029
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004030PyDoc_STRVAR(doc_get_magic,
4031"get_magic() -> string\n\
4032Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004033
Barry Warsaw28a691b2010-04-17 00:19:56 +00004034PyDoc_STRVAR(doc_get_tag,
4035"get_tag() -> string\n\
4036Return the magic tag for .pyc or .pyo files.");
4037
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004038PyDoc_STRVAR(doc_get_suffixes,
4039"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004040Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004041that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004042
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004043PyDoc_STRVAR(doc_new_module,
4044"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004045Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004046The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004047
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004048PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00004049"lock_held() -> boolean\n\
4050Return True if the import lock is currently held, else False.\n\
4051On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00004052
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004053PyDoc_STRVAR(doc_acquire_lock,
4054"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00004055Acquires the interpreter's import lock for the current thread.\n\
4056This lock should be used by import hooks to ensure thread-safety\n\
4057when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004058On platforms without threads, this function does nothing.");
4059
4060PyDoc_STRVAR(doc_release_lock,
4061"release_lock() -> None\n\
4062Release the interpreter's import lock.\n\
4063On platforms without threads, this function does nothing.");
4064
Guido van Rossum79f25d91997-04-29 20:08:16 +00004065static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004066 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
4067 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
4068 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
4069 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
4070 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
4071 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
4072 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
4073 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
4074 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
4075 {"reload", imp_reload, METH_O, doc_reload},
4076 {"cache_from_source", (PyCFunction)imp_cache_from_source,
4077 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
4078 {"source_from_cache", (PyCFunction)imp_source_from_cache,
4079 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
4080 /* The rest are obsolete */
4081 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
4082 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
4083 {"init_builtin", imp_init_builtin, METH_VARARGS},
4084 {"init_frozen", imp_init_frozen, METH_VARARGS},
4085 {"is_builtin", imp_is_builtin, METH_VARARGS},
4086 {"is_frozen", imp_is_frozen, METH_VARARGS},
4087 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004088#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004089 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004090#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004091 {"load_package", imp_load_package, METH_VARARGS},
4092 {"load_source", imp_load_source, METH_VARARGS},
Brett Cannon442c9b92011-03-23 16:14:42 -07004093 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004094 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004095};
4096
Guido van Rossum1a8791e1998-08-04 22:46:29 +00004097static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004098setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004099{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004100 PyObject *v;
4101 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004103 v = PyLong_FromLong((long)value);
4104 err = PyDict_SetItemString(d, name, v);
4105 Py_XDECREF(v);
4106 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004107}
4108
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004109typedef struct {
4110 PyObject_HEAD
4111} NullImporter;
4112
4113static int
4114NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4115{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004116#ifndef MS_WINDOWS
4117 PyObject *path;
4118 struct stat statbuf;
4119 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004120
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004121 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4122 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004123
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004124 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4125 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004126 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004127
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004128 if (PyBytes_GET_SIZE(path) == 0) {
4129 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004130 PyErr_SetString(PyExc_ImportError, "empty pathname");
4131 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004132 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004133
4134 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4135 Py_DECREF(path);
4136 if (rv == 0) {
4137 /* it exists */
4138 if (S_ISDIR(statbuf.st_mode)) {
4139 /* it's a directory */
4140 PyErr_SetString(PyExc_ImportError, "existing directory");
4141 return -1;
4142 }
4143 }
4144#else /* MS_WINDOWS */
4145 PyObject *pathobj;
4146 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004147 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004148
4149 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4150 return -1;
4151
4152 if (!PyArg_ParseTuple(args, "U:NullImporter",
4153 &pathobj))
4154 return -1;
4155
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02004156 if (PyUnicode_GET_LENGTH(pathobj) == 0) {
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004157 PyErr_SetString(PyExc_ImportError, "empty pathname");
4158 return -1;
4159 }
4160
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004161 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004162 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004163 return -1;
4164 /* see issue1293 and issue3677:
4165 * stat() on Windows doesn't recognise paths like
4166 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4167 */
4168 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004169 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004170 if (rv != INVALID_FILE_ATTRIBUTES) {
4171 /* it exists */
4172 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4173 /* it's a directory */
4174 PyErr_SetString(PyExc_ImportError, "existing directory");
4175 return -1;
4176 }
4177 }
4178#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004179 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004180}
4181
4182static PyObject *
4183NullImporter_find_module(NullImporter *self, PyObject *args)
4184{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004185 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004186}
4187
4188static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004189 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4190 "Always return None"
4191 },
4192 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004193};
4194
4195
Christian Heimes9cd17752007-11-18 19:35:23 +00004196PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004197 PyVarObject_HEAD_INIT(NULL, 0)
4198 "imp.NullImporter", /*tp_name*/
4199 sizeof(NullImporter), /*tp_basicsize*/
4200 0, /*tp_itemsize*/
4201 0, /*tp_dealloc*/
4202 0, /*tp_print*/
4203 0, /*tp_getattr*/
4204 0, /*tp_setattr*/
4205 0, /*tp_reserved*/
4206 0, /*tp_repr*/
4207 0, /*tp_as_number*/
4208 0, /*tp_as_sequence*/
4209 0, /*tp_as_mapping*/
4210 0, /*tp_hash */
4211 0, /*tp_call*/
4212 0, /*tp_str*/
4213 0, /*tp_getattro*/
4214 0, /*tp_setattro*/
4215 0, /*tp_as_buffer*/
4216 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4217 "Null importer object", /* tp_doc */
4218 0, /* tp_traverse */
4219 0, /* tp_clear */
4220 0, /* tp_richcompare */
4221 0, /* tp_weaklistoffset */
4222 0, /* tp_iter */
4223 0, /* tp_iternext */
4224 NullImporter_methods, /* tp_methods */
4225 0, /* tp_members */
4226 0, /* tp_getset */
4227 0, /* tp_base */
4228 0, /* tp_dict */
4229 0, /* tp_descr_get */
4230 0, /* tp_descr_set */
4231 0, /* tp_dictoffset */
4232 (initproc)NullImporter_init, /* tp_init */
4233 0, /* tp_alloc */
4234 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004235};
4236
Martin v. Löwis1a214512008-06-11 05:26:20 +00004237static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004238 PyModuleDef_HEAD_INIT,
4239 "imp",
4240 doc_imp,
4241 0,
4242 imp_methods,
4243 NULL,
4244 NULL,
4245 NULL,
4246 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004247};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004248
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004249PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004250PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004251{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004252 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004253
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004254 if (PyType_Ready(&PyNullImporter_Type) < 0)
4255 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004256
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004257 m = PyModule_Create(&impmodule);
4258 if (m == NULL)
4259 goto failure;
4260 d = PyModule_GetDict(m);
4261 if (d == NULL)
4262 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004263
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004264 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4265 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4266 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4267 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4268 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4269 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4270 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4271 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4272 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4273 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004274
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004275 Py_INCREF(&PyNullImporter_Type);
4276 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4277 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004278 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004279 Py_XDECREF(m);
4280 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004281}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004282
4283
Guido van Rossumb18618d2000-05-03 23:44:39 +00004284/* API for embedding applications that want to add their own entries
4285 to the table of built-in modules. This should normally be called
4286 *before* Py_Initialize(). When the table resize fails, -1 is
4287 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004288
4289 After a similar function by Just van Rossum. */
4290
4291int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004292PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004293{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004294 static struct _inittab *our_copy = NULL;
4295 struct _inittab *p;
4296 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004297
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004298 /* Count the number of entries in both tables */
4299 for (n = 0; newtab[n].name != NULL; n++)
4300 ;
4301 if (n == 0)
4302 return 0; /* Nothing to do */
4303 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4304 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004305
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004306 /* Allocate new memory for the combined table */
4307 p = our_copy;
4308 PyMem_RESIZE(p, struct _inittab, i+n+1);
4309 if (p == NULL)
4310 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004311
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004312 /* Copy the tables into the new memory */
4313 if (our_copy != PyImport_Inittab)
4314 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4315 PyImport_Inittab = our_copy = p;
4316 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004317
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004318 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004319}
4320
4321/* Shorthand to add a single entry given a name and a function */
4322
4323int
Brett Cannona826f322009-04-02 03:41:46 +00004324PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004325{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004326 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004327
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004328 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004329
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004330 newtab[0].name = (char *)name;
4331 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004332
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004333 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004334}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004335
4336#ifdef __cplusplus
4337}
4338#endif