blob: 9f3806172355da8b7e9de8171715798f0bd93333 [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;
157
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 {
251 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
252 "zipimporter");
253 Py_DECREF(zimpimport);
254 if (zipimporter == NULL) {
255 PyErr_Clear(); /* No zipimporter object -- okay */
256 if (Py_VerboseFlag)
257 PySys_WriteStderr(
258 "# can't import zipimport.zipimporter\n");
259 }
260 else {
261 /* sys.path_hooks.append(zipimporter) */
262 err = PyList_Append(path_hooks, zipimporter);
263 Py_DECREF(zipimporter);
264 if (err)
265 goto error;
266 if (Py_VerboseFlag)
267 PySys_WriteStderr(
268 "# installed zipimport hook\n");
269 }
270 }
271 Py_DECREF(path_hooks);
Just van Rossum52e14d62002-12-30 22:08:05 +0000272}
273
274void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000275_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000276{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000277 Py_XDECREF(extensions);
278 extensions = NULL;
279 PyMem_DEL(_PyImport_Filetab);
280 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000281}
282
283
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000284/* Locking primitives to prevent parallel imports of the same module
285 in different threads to return with a partially loaded module.
286 These calls are serialized by the global interpreter lock. */
287
288#ifdef WITH_THREAD
289
Guido van Rossum49b56061998-10-01 20:42:43 +0000290#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000291
Guido van Rossum65d5b571998-12-21 19:32:43 +0000292static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000293static long import_lock_thread = -1;
294static int import_lock_level = 0;
295
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000296void
297_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000298{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000299 long me = PyThread_get_thread_ident();
300 if (me == -1)
301 return; /* Too bad */
302 if (import_lock == NULL) {
303 import_lock = PyThread_allocate_lock();
304 if (import_lock == NULL)
305 return; /* Nothing much we can do. */
306 }
307 if (import_lock_thread == me) {
308 import_lock_level++;
309 return;
310 }
311 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
312 {
313 PyThreadState *tstate = PyEval_SaveThread();
314 PyThread_acquire_lock(import_lock, 1);
315 PyEval_RestoreThread(tstate);
316 }
317 import_lock_thread = me;
318 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000319}
320
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000321int
322_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000323{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000324 long me = PyThread_get_thread_ident();
325 if (me == -1 || import_lock == NULL)
326 return 0; /* Too bad */
327 if (import_lock_thread != me)
328 return -1;
329 import_lock_level--;
330 if (import_lock_level == 0) {
331 import_lock_thread = -1;
332 PyThread_release_lock(import_lock);
333 }
334 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000335}
336
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000337/* This function is called from PyOS_AfterFork to ensure that newly
338 created child processes do not share locks with the parent.
339 We now acquire the import lock around fork() calls but on some platforms
340 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000341
342void
343_PyImport_ReInitLock(void)
344{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000345 if (import_lock != NULL)
346 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000347 if (import_lock_level > 1) {
348 /* Forked as a side effect of import */
349 long me = PyThread_get_thread_ident();
350 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100351 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000352 import_lock_thread = me;
353 import_lock_level--;
354 } else {
355 import_lock_thread = -1;
356 import_lock_level = 0;
357 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000358}
359
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000360#endif
361
Tim Peters69232342001-08-30 05:16:13 +0000362static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000363imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000364{
Tim Peters69232342001-08-30 05:16:13 +0000365#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000366 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000367#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000368 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000369#endif
370}
371
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000372static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000373imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000374{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000375#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000376 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000377#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000378 Py_INCREF(Py_None);
379 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000380}
381
382static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000383imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000384{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000385#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000386 if (_PyImport_ReleaseLock() < 0) {
387 PyErr_SetString(PyExc_RuntimeError,
388 "not holding the import lock");
389 return NULL;
390 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000391#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000392 Py_INCREF(Py_None);
393 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000394}
395
Guido van Rossumd8faa362007-04-27 19:54:29 +0000396static void
397imp_modules_reloading_clear(void)
398{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000399 PyInterpreterState *interp = PyThreadState_Get()->interp;
400 if (interp->modules_reloading != NULL)
401 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000402}
403
Guido van Rossum25ce5661997-08-02 03:10:38 +0000404/* Helper for sys */
405
406PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000407PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000408{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000409 PyInterpreterState *interp = PyThreadState_GET()->interp;
410 if (interp->modules == NULL)
411 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
412 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000413}
414
Guido van Rossum3f5da241990-12-20 15:06:42 +0000415
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000416/* List of names to clear in sys */
417static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000418 "path", "argv", "ps1", "ps2",
419 "last_type", "last_value", "last_traceback",
420 "path_hooks", "path_importer_cache", "meta_path",
421 /* misc stuff */
422 "flags", "float_info",
423 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000424};
425
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000426static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000427 "stdin", "__stdin__",
428 "stdout", "__stdout__",
429 "stderr", "__stderr__",
430 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000431};
432
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000433
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000434/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000435
Guido van Rossum3f5da241990-12-20 15:06:42 +0000436void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000437PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000438{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000439 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000440 PyObject *key, *value, *dict;
441 PyInterpreterState *interp = PyThreadState_GET()->interp;
442 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000444 if (modules == NULL)
445 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000447 /* Delete some special variables first. These are common
448 places where user values hide and people complain when their
449 destructors fail. Since the modules containing them are
450 deleted *last* of all, they would come too late in the normal
451 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000452
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000453 value = PyDict_GetItemString(modules, "builtins");
454 if (value != NULL && PyModule_Check(value)) {
455 dict = PyModule_GetDict(value);
456 if (Py_VerboseFlag)
457 PySys_WriteStderr("# clear builtins._\n");
458 PyDict_SetItemString(dict, "_", Py_None);
459 }
460 value = PyDict_GetItemString(modules, "sys");
461 if (value != NULL && PyModule_Check(value)) {
462 char **p;
463 PyObject *v;
464 dict = PyModule_GetDict(value);
465 for (p = sys_deletes; *p != NULL; p++) {
466 if (Py_VerboseFlag)
467 PySys_WriteStderr("# clear sys.%s\n", *p);
468 PyDict_SetItemString(dict, *p, Py_None);
469 }
470 for (p = sys_files; *p != NULL; p+=2) {
471 if (Py_VerboseFlag)
472 PySys_WriteStderr("# restore sys.%s\n", *p);
473 v = PyDict_GetItemString(dict, *(p+1));
474 if (v == NULL)
475 v = Py_None;
476 PyDict_SetItemString(dict, *p, v);
477 }
478 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000479
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000480 /* First, delete __main__ */
481 value = PyDict_GetItemString(modules, "__main__");
482 if (value != NULL && PyModule_Check(value)) {
483 if (Py_VerboseFlag)
484 PySys_WriteStderr("# cleanup __main__\n");
485 _PyModule_Clear(value);
486 PyDict_SetItemString(modules, "__main__", Py_None);
487 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000488
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000489 /* The special treatment of "builtins" here is because even
490 when it's not referenced as a module, its dictionary is
491 referenced by almost every module's __builtins__. Since
492 deleting a module clears its dictionary (even if there are
493 references left to it), we need to delete the "builtins"
494 module last. Likewise, we don't delete sys until the very
495 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000496
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000497 Also note that we 'delete' modules by replacing their entry
498 in the modules dict with None, rather than really deleting
499 them; this avoids a rehash of the modules dictionary and
500 also marks them as "non existent" so they won't be
501 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000502
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000503 /* Next, repeatedly delete modules with a reference count of
504 one (skipping builtins and sys) and delete them */
505 do {
506 ndone = 0;
507 pos = 0;
508 while (PyDict_Next(modules, &pos, &key, &value)) {
509 if (value->ob_refcnt != 1)
510 continue;
511 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100512 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000513 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100514 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000515 continue;
516 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100517 PySys_FormatStderr(
518 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000519 _PyModule_Clear(value);
520 PyDict_SetItem(modules, key, Py_None);
521 ndone++;
522 }
523 }
524 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000525
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000526 /* Next, delete all modules (still skipping builtins and sys) */
527 pos = 0;
528 while (PyDict_Next(modules, &pos, &key, &value)) {
529 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100530 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000531 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100532 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000533 continue;
534 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100535 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000536 _PyModule_Clear(value);
537 PyDict_SetItem(modules, key, Py_None);
538 }
539 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000541 /* Next, delete sys and builtins (in that order) */
542 value = PyDict_GetItemString(modules, "sys");
543 if (value != NULL && PyModule_Check(value)) {
544 if (Py_VerboseFlag)
545 PySys_WriteStderr("# cleanup sys\n");
546 _PyModule_Clear(value);
547 PyDict_SetItemString(modules, "sys", Py_None);
548 }
549 value = PyDict_GetItemString(modules, "builtins");
550 if (value != NULL && PyModule_Check(value)) {
551 if (Py_VerboseFlag)
552 PySys_WriteStderr("# cleanup builtins\n");
553 _PyModule_Clear(value);
554 PyDict_SetItemString(modules, "builtins", Py_None);
555 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000556
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000557 /* Finally, clear and delete the modules directory */
558 PyDict_Clear(modules);
559 interp->modules = NULL;
560 Py_DECREF(modules);
561 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000562}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000563
564
Barry Warsaw28a691b2010-04-17 00:19:56 +0000565/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000566
567long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000568PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000569{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000570 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000571}
572
573
Barry Warsaw28a691b2010-04-17 00:19:56 +0000574const char *
575PyImport_GetMagicTag(void)
576{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000577 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000578}
579
Guido van Rossum25ce5661997-08-02 03:10:38 +0000580/* Magic for extension modules (built-in as well as dynamically
581 loaded). To prevent initializing an extension module more than
582 once, we keep a static dictionary 'extensions' keyed by module name
583 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000584 modules), containing these modules. A copy of the module's
Victor Stinner95872862011-03-07 18:20:56 +0100585 dictionary is stored by calling _PyImport_FixupExtensionObject()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000586 immediately after the module initialization function succeeds. A
587 copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100588 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000589
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000590 Modules which do support multiple initialization set their m_size
591 field to a non-negative number (indicating the size of the
592 module-specific state). They are still recorded in the extensions
593 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000594*/
595
596int
Victor Stinner95872862011-03-07 18:20:56 +0100597_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
598 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000599{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000600 PyObject *modules, *dict;
601 struct PyModuleDef *def;
602 if (extensions == NULL) {
603 extensions = PyDict_New();
604 if (extensions == NULL)
605 return -1;
606 }
607 if (mod == NULL || !PyModule_Check(mod)) {
608 PyErr_BadInternalCall();
609 return -1;
610 }
611 def = PyModule_GetDef(mod);
612 if (!def) {
613 PyErr_BadInternalCall();
614 return -1;
615 }
616 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100617 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000618 return -1;
619 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100620 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000621 return -1;
622 }
623 if (def->m_size == -1) {
624 if (def->m_base.m_copy) {
625 /* Somebody already imported the module,
626 likely under a different name.
627 XXX this should really not happen. */
628 Py_DECREF(def->m_base.m_copy);
629 def->m_base.m_copy = NULL;
630 }
631 dict = PyModule_GetDict(mod);
632 if (dict == NULL)
633 return -1;
634 def->m_base.m_copy = PyDict_Copy(dict);
635 if (def->m_base.m_copy == NULL)
636 return -1;
637 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000638 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000639 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000640}
641
Victor Stinner49d3f252010-10-17 01:24:53 +0000642int
643_PyImport_FixupBuiltin(PyObject *mod, char *name)
644{
645 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100646 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100647 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100648 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000649 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100650 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
651 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000652 return res;
653}
654
Guido van Rossum25ce5661997-08-02 03:10:38 +0000655PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100656_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000657{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000658 PyObject *mod, *mdict;
659 PyModuleDef* def;
660 if (extensions == NULL)
661 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000662 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000663 if (def == NULL)
664 return NULL;
665 if (def->m_size == -1) {
666 /* Module does not support repeated initialization */
667 if (def->m_base.m_copy == NULL)
668 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100669 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000670 if (mod == NULL)
671 return NULL;
672 mdict = PyModule_GetDict(mod);
673 if (mdict == NULL)
674 return NULL;
675 if (PyDict_Update(mdict, def->m_base.m_copy))
676 return NULL;
677 }
678 else {
679 if (def->m_base.m_init == NULL)
680 return NULL;
681 mod = def->m_base.m_init();
682 if (mod == NULL)
683 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100684 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000685 Py_DECREF(mod);
686 }
687 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100688 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000689 Py_DECREF(mod);
690 return NULL;
691 }
692 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100693 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000694 name, filename);
695 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000696
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000697}
698
Victor Stinner49d3f252010-10-17 01:24:53 +0000699PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000700_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000701{
Victor Stinner95872862011-03-07 18:20:56 +0100702 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100703 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100704 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000705 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100706 res = _PyImport_FindExtensionObject(nameobj, nameobj);
707 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000708 return res;
709}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000710
711/* Get the module object corresponding to a module name.
712 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000713 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000714 Because the former action is most common, THIS DOES NOT RETURN A
715 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000716
Guido van Rossum79f25d91997-04-29 20:08:16 +0000717PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000718PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000719{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000720 PyObject *modules = PyImport_GetModuleDict();
721 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000722
Victor Stinner27ee0892011-03-04 12:57:09 +0000723 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000724 PyModule_Check(m))
725 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000726 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000727 if (m == NULL)
728 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000729 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000730 Py_DECREF(m);
731 return NULL;
732 }
733 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000734
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000735 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000736}
737
Victor Stinner27ee0892011-03-04 12:57:09 +0000738PyObject *
739PyImport_AddModule(const char *name)
740{
741 PyObject *nameobj, *module;
742 nameobj = PyUnicode_FromString(name);
743 if (nameobj == NULL)
744 return NULL;
745 module = PyImport_AddModuleObject(nameobj);
746 Py_DECREF(nameobj);
747 return module;
748}
749
750
Tim Peters1cd70172004-08-02 03:52:12 +0000751/* Remove name from sys.modules, if it's there. */
752static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000753remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000754{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000755 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000756 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000757 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000758 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000759 Py_FatalError("import: deleting existing key in"
760 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000761}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000762
Victor Stinnerc9abda02011-03-14 13:33:46 -0400763static PyObject * get_sourcefile(PyObject *filename);
764static PyObject *make_source_pathname(PyObject *pathname);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200765static PyObject* make_compiled_pathname(PyObject *pathname, int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000766
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000767/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000768 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
769 * removed from sys.modules, to avoid leaving damaged module objects
770 * in sys.modules. The caller may wish to restore the original
771 * module object (if any) in this case; PyImport_ReloadModule is an
772 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000773 *
774 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
775 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000776 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000777PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000778PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000779{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000780 return PyImport_ExecCodeModuleWithPathnames(
781 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000782}
783
784PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000785PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000786{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 return PyImport_ExecCodeModuleWithPathnames(
788 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000789}
790
791PyObject *
792PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000793 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000794{
Victor Stinner27ee0892011-03-04 12:57:09 +0000795 PyObject *m = NULL;
796 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
797
798 nameobj = PyUnicode_FromString(name);
799 if (nameobj == NULL)
800 return NULL;
801
802 if (pathname != NULL) {
803 pathobj = PyUnicode_DecodeFSDefault(pathname);
804 if (pathobj == NULL)
805 goto error;
806 } else
807 pathobj = NULL;
808 if (cpathname != NULL) {
809 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
810 if (cpathobj == NULL)
811 goto error;
812 } else
813 cpathobj = NULL;
814 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
815error:
816 Py_DECREF(nameobj);
817 Py_XDECREF(pathobj);
818 Py_XDECREF(cpathobj);
819 return m;
820}
821
822PyObject*
823PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
824 PyObject *cpathname)
825{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000826 PyObject *modules = PyImport_GetModuleDict();
827 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000828
Victor Stinner27ee0892011-03-04 12:57:09 +0000829 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000830 if (m == NULL)
831 return NULL;
832 /* If the module is being reloaded, we get the old module back
833 and re-use its dict to exec the new code. */
834 d = PyModule_GetDict(m);
835 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
836 if (PyDict_SetItemString(d, "__builtins__",
837 PyEval_GetBuiltins()) != 0)
838 goto error;
839 }
840 /* Remember the filename as the __file__ attribute */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000841 if (pathname != NULL) {
Victor Stinnerc9abda02011-03-14 13:33:46 -0400842 v = get_sourcefile(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 if (v == NULL)
844 PyErr_Clear();
845 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000846 else
847 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000848 if (v == NULL) {
849 v = ((PyCodeObject *)co)->co_filename;
850 Py_INCREF(v);
851 }
852 if (PyDict_SetItemString(d, "__file__", v) != 0)
853 PyErr_Clear(); /* Not important enough to report */
854 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000855
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000856 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000857 if (cpathname != NULL)
858 v = cpathname;
859 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000860 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 if (PyDict_SetItemString(d, "__cached__", v) != 0)
862 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000863
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000864 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000865 if (v == NULL)
866 goto error;
867 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000868
Victor Stinner27ee0892011-03-04 12:57:09 +0000869 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000870 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000871 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000872 name);
873 return NULL;
874 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000875
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000876 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000877
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000878 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000879
880 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000881 remove_module(name);
882 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000883}
884
885
Barry Warsaw28a691b2010-04-17 00:19:56 +0000886/* Like strrchr(string, '/') but searches for the rightmost of either SEP
887 or ALTSEP, if the latter is defined.
888*/
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200889static Py_UCS4*
890rightmost_sep(Py_UCS4 *s)
Victor Stinnerc9abda02011-03-14 13:33:46 -0400891{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200892 Py_UCS4 *found, c;
Victor Stinnerc9abda02011-03-14 13:33:46 -0400893 for (found = NULL; (c = *s); s++) {
894 if (c == SEP
895#ifdef ALTSEP
896 || c == ALTSEP
897#endif
898 )
899 {
900 found = s;
901 }
902 }
903 return found;
904}
905
906
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000907/* Given a pathname for a Python source file, fill a buffer with the
908 pathname for the corresponding compiled file. Return the pathname
909 for the compiled file, or NULL if there's no space in the buffer.
Victor Stinner2f42ae52011-03-20 00:41:24 +0100910 Doesn't set an exception.
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000911
Victor Stinner2f42ae52011-03-20 00:41:24 +0100912 foo.py -> __pycache__/foo.<tag>.pyc */
913
914static PyObject*
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200915make_compiled_pathname(PyObject *pathstr, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000916{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200917 Py_UCS4 *pathname;
918 Py_UCS4 buf[MAXPATHLEN];
Victor Stinner2f42ae52011-03-20 00:41:24 +0100919 size_t buflen = (size_t)MAXPATHLEN;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200920 size_t len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000921 size_t i, save;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200922 Py_UCS4 *pos;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000923 int sep = SEP;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000924
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200925 pathname = PyUnicode_AsUCS4Copy(pathstr);
926 if (!pathname)
927 return NULL;
928 len = Py_UCS4_strlen(pathname);
929
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000930 /* Sanity check that the buffer has roughly enough space to hold what
931 will eventually be the full path to the compiled file. The 5 extra
932 bytes include the slash afer __pycache__, the two extra dots, the
933 extra trailing character ('c' or 'o') and null. This isn't exact
934 because the contents of the buffer can affect how many actual
935 characters of the string get into the buffer. We'll do a final
936 sanity check before writing the extension to ensure we do not
937 overflow the buffer.
938 */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200939 if (len + Py_UCS4_strlen(CACHEDIR_UNICODE) + Py_UCS4_strlen(PYC_TAG_UNICODE) + 5 > buflen) {
940 PyMem_Free(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000941 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200942 }
Tim Petersc1731372001-08-04 08:12:36 +0000943
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000944 /* Find the last path separator and copy everything from the start of
945 the source string up to and including the separator.
946 */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100947 pos = rightmost_sep(pathname);
948 if (pos == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000949 i = 0;
950 }
951 else {
952 sep = *pos;
953 i = pos - pathname + 1;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200954 Py_UCS4_strncpy(buf, pathname, i);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000956
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000957 save = i;
958 buf[i++] = '\0';
959 /* Add __pycache__/ */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200960 Py_UCS4_strcat(buf, CACHEDIR_UNICODE);
961 i += Py_UCS4_strlen(CACHEDIR_UNICODE) - 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000962 buf[i++] = sep;
Victor Stinnerccbf4752011-03-14 15:05:12 -0400963 buf[i] = '\0';
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000964 /* Add the base filename, but remove the .py or .pyw extension, since
965 the tag name must go before the extension.
966 */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200967 Py_UCS4_strcat(buf, pathname + save);
968 pos = Py_UCS4_strrchr(buf + i, '.');
Victor Stinner2f42ae52011-03-20 00:41:24 +0100969 if (pos != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 *++pos = '\0';
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200971
972 /* pathname is not used from here on. */
973 PyMem_Free(pathname);
974
975 Py_UCS4_strcat(buf, PYC_TAG_UNICODE);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000976 /* The length test above assumes that we're only adding one character
977 to the end of what would normally be the extension. What if there
978 is no extension, or the string ends in '.' or '.p', and otherwise
979 fills the buffer? By appending 4 more characters onto the string
980 here, we could overrun the buffer.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000981
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 As a simple example, let's say buflen=32 and the input string is
983 'xxx.py'. strlen() would be 6 and the test above would yield:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000984
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000985 (6 + 11 + 10 + 5 == 32) > 32
Barry Warsaw28a691b2010-04-17 00:19:56 +0000986
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000987 which is false and so the name mangling would continue. This would
988 be fine because we'd end up with this string in buf:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000989
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000990 __pycache__/xxx.cpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000991
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000992 strlen(of that) == 30 + the nul fits inside a 32 character buffer.
993 We can even handle an input string of say 'xxxxx' above because
994 that's (5 + 11 + 10 + 5 == 31) > 32 which is also false. Name
995 mangling that yields:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000996
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000997 __pycache__/xxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000998
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000999 which is 32 characters including the nul, and thus fits in the
1000 buffer. However, an input string of 'xxxxxx' would yield a result
1001 string of:
Barry Warsaw28a691b2010-04-17 00:19:56 +00001002
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001003 __pycache__/xxxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +00001004
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001005 which is 33 characters long (including the nul), thus overflowing
1006 the buffer, even though the first test would fail, i.e.: the input
1007 string is also 6 characters long, so 32 > 32 is false.
Barry Warsaw28a691b2010-04-17 00:19:56 +00001008
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001009 The reason the first test fails but we still overflow the buffer is
1010 that the test above only expects to add one extra character to be
1011 added to the extension, and here we're adding three (pyc). We
1012 don't add the first dot, so that reclaims one of expected
1013 positions, leaving us overflowing by 1 byte (3 extra - 1 reclaimed
1014 dot - 1 expected extra == 1 overflowed).
Barry Warsaw28a691b2010-04-17 00:19:56 +00001015
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001016 The best we can do is ensure that we still have enough room in the
1017 target buffer before we write the extension. Because it's always
1018 only the extension that can cause the overflow, and never the other
1019 path bytes we've written, it's sufficient to just do one more test
1020 here. Still, the assertion that follows can't hurt.
1021 */
Barry Warsaw28a691b2010-04-17 00:19:56 +00001022#if 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001023 printf("strlen(buf): %d; buflen: %d\n", (int)strlen(buf), (int)buflen);
Barry Warsaw28a691b2010-04-17 00:19:56 +00001024#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001025 len = Py_UCS4_strlen(buf);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001026 if (len + 5 > buflen)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001028 buf[len] = '.'; len++;
1029 buf[len] = 'p'; len++;
1030 buf[len] = 'y'; len++;
1031 buf[len] = debug ? 'c' : 'o'; len++;
1032 assert(len <= buflen);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001033 return PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, buf, len);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001034}
1035
1036
Barry Warsaw28a691b2010-04-17 00:19:56 +00001037/* Given a pathname to a Python byte compiled file, return the path to the
1038 source file, if the path matches the PEP 3147 format. This does not check
1039 for any file existence, however, if the pyc file name does not match PEP
1040 3147 style, NULL is returned. buf must be at least as big as pathname;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001041 the resulting path will always be shorter.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001042
Victor Stinnerc9abda02011-03-14 13:33:46 -04001043 (...)/__pycache__/foo.<tag>.pyc -> (...)/foo.py */
1044
1045static PyObject*
1046make_source_pathname(PyObject *pathobj)
Barry Warsaw28a691b2010-04-17 00:19:56 +00001047{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001048 Py_UCS4 buf[MAXPATHLEN];
1049 Py_UCS4 *pathname;
1050 Py_UCS4 *left, *right, *dot0, *dot1, sep;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001051 size_t i, j;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001052
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001053 if (PyUnicode_GET_LENGTH(pathobj) > MAXPATHLEN)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001054 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001055 pathname = PyUnicode_AsUCS4Copy(pathobj);
1056 if (!pathname)
1057 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001058
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001059 /* Look back two slashes from the end. In between these two slashes
1060 must be the string __pycache__ or this is not a PEP 3147 style
1061 path. It's possible for there to be only one slash.
1062 */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001063 right = rightmost_sep(pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001064 if (right == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001065 return NULL;
1066 sep = *right;
1067 *right = '\0';
Victor Stinner2f42ae52011-03-20 00:41:24 +01001068 left = rightmost_sep(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001069 *right = sep;
1070 if (left == NULL)
1071 left = pathname;
1072 else
1073 left++;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001074 if (right-left != Py_UCS4_strlen(CACHEDIR_UNICODE) ||
1075 Py_UCS4_strncmp(left, CACHEDIR_UNICODE, right-left) != 0)
1076 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001077
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001078 /* Now verify that the path component to the right of the last slash
1079 has two dots in it.
1080 */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001081 if ((dot0 = Py_UCS4_strchr(right + 1, '.')) == NULL)
1082 goto error;
1083 if ((dot1 = Py_UCS4_strchr(dot0 + 1, '.')) == NULL)
1084 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001085 /* Too many dots? */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001086 if (Py_UCS4_strchr(dot1 + 1, '.') != NULL)
1087 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001088
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001089 /* This is a PEP 3147 path. Start by copying everything from the
1090 start of pathname up to and including the leftmost slash. Then
1091 copy the file's basename, removing the magic tag and adding a .py
1092 suffix.
1093 */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001094 Py_UCS4_strncpy(buf, pathname, (i=left-pathname));
1095 Py_UCS4_strncpy(buf+i, right+1, (j=dot0-right));
Victor Stinnerc9abda02011-03-14 13:33:46 -04001096 buf[i+j] = 'p';
1097 buf[i+j+1] = 'y';
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001098 PyMem_Free(pathname);
1099 return PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, buf, i+j+2);
1100 error:
1101 PyMem_Free(pathname);
1102 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001103}
1104
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001105/* Given a pathname for a Python source file, its time of last
1106 modification, and a pathname for a compiled file, check whether the
1107 compiled file represents the same version of the source. If so,
1108 return a FILE pointer for the compiled file, positioned just after
1109 the header; if not, return NULL.
1110 Doesn't set an exception. */
1111
1112static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001113check_compiled_module(PyObject *pathname, time_t mtime, PyObject *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001114{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001115 FILE *fp;
1116 long magic;
1117 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001118
Victor Stinner2f42ae52011-03-20 00:41:24 +01001119 fp = _Py_fopen(cpathname, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001120 if (fp == NULL)
1121 return NULL;
1122 magic = PyMarshal_ReadLongFromFile(fp);
1123 if (magic != pyc_magic) {
1124 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001125 PySys_FormatStderr("# %R has bad magic\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001126 fclose(fp);
1127 return NULL;
1128 }
1129 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
1130 if (pyc_mtime != mtime) {
1131 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001132 PySys_FormatStderr("# %R has bad mtime\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001133 fclose(fp);
1134 return NULL;
1135 }
1136 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001137 PySys_FormatStderr("# %R matches %R\n", cpathname, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001138 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001139}
1140
1141
1142/* Read a code object from a file and check it for validity */
1143
Guido van Rossum79f25d91997-04-29 20:08:16 +00001144static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001145read_compiled_module(PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001146{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001147 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001148
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001149 co = PyMarshal_ReadLastObjectFromFile(fp);
1150 if (co == NULL)
1151 return NULL;
1152 if (!PyCode_Check(co)) {
1153 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001154 "Non-code object in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001155 Py_DECREF(co);
1156 return NULL;
1157 }
1158 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001159}
1160
1161
1162/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001163 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001164
Guido van Rossum79f25d91997-04-29 20:08:16 +00001165static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001166load_compiled_module(PyObject *name, PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001167{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001168 long magic;
1169 PyCodeObject *co;
1170 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001171
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001172 magic = PyMarshal_ReadLongFromFile(fp);
1173 if (magic != pyc_magic) {
1174 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001175 "Bad magic number in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001176 return NULL;
1177 }
1178 (void) PyMarshal_ReadLongFromFile(fp);
1179 co = read_compiled_module(cpathname, fp);
1180 if (co == NULL)
1181 return NULL;
1182 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001183 PySys_FormatStderr("import %U # precompiled from %R\n",
1184 name, cpathname);
1185 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1186 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001187 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001188
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001190}
1191
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001192/* Parse a source file and return the corresponding code object */
1193
Guido van Rossum79f25d91997-04-29 20:08:16 +00001194static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001195parse_source_module(PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001196{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001197 PyCodeObject *co;
1198 PyObject *pathbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001199 mod_ty mod;
1200 PyCompilerFlags flags;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001201 PyArena *arena;
1202
1203 pathbytes = PyUnicode_EncodeFSDefault(pathname);
1204 if (pathbytes == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001205 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001206
Victor Stinner2f42ae52011-03-20 00:41:24 +01001207 arena = PyArena_New();
1208 if (arena == NULL) {
1209 Py_DECREF(pathbytes);
1210 return NULL;
1211 }
1212
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001213 flags.cf_flags = 0;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001214 mod = PyParser_ASTFromFile(fp, PyBytes_AS_STRING(pathbytes), NULL,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 Py_file_input, 0, 0, &flags,
1216 NULL, arena);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001217 if (mod != NULL)
1218 co = PyAST_Compile(mod, PyBytes_AS_STRING(pathbytes), NULL, arena);
1219 else
1220 co = NULL;
1221 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001222 PyArena_Free(arena);
1223 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001224}
1225
Guido van Rossum55a83382000-09-20 20:31:38 +00001226/* Helper to open a bytecode file for writing in exclusive mode */
1227
Victor Stinner783c82c2011-04-20 03:27:51 +02001228#ifndef MS_WINDOWS
Guido van Rossum55a83382000-09-20 20:31:38 +00001229static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +00001230open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +00001231{
1232#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001233 /* Use O_EXCL to avoid a race condition when another process tries to
1234 write the same file. When that happens, our open() call fails,
1235 which is just fine (since it's only a cache).
1236 XXX If the file exists and is writable but the directory is not
1237 writable, the file will never be written. Oh well.
1238 */
1239 int fd;
1240 (void) unlink(filename);
1241 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +00001242#ifdef O_BINARY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001243 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +00001244#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001245#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001246 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001247#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001249#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001250 );
1251 if (fd < 0)
1252 return NULL;
1253 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001254#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001255 /* Best we can do -- on Windows this can't happen anyway */
1256 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001257#endif
1258}
Victor Stinner783c82c2011-04-20 03:27:51 +02001259#endif
Guido van Rossum55a83382000-09-20 20:31:38 +00001260
1261
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001262/* Write a compiled module to a file, placing the time of last
1263 modification of its source into the header.
1264 Errors are ignored, if a write error occurs an attempt is made to
1265 remove the file. */
1266
1267static void
Victor Stinner2f42ae52011-03-20 00:41:24 +01001268write_compiled_module(PyCodeObject *co, PyObject *cpathname,
1269 struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001270{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001271 Py_UCS4 *cpathname_ucs4;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001272 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001273 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001274#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001275 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001276#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001277 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
1278 mode_t dirmode = (srcstat->st_mode |
1279 S_IXUSR | S_IXGRP | S_IXOTH |
1280 S_IWUSR | S_IWGRP | S_IWOTH);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001281 PyObject *dirbytes;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001282#endif
Victor Stinner783c82c2011-04-20 03:27:51 +02001283#ifdef MS_WINDOWS
1284 int fd;
1285#else
1286 PyObject *cpathbytes;
1287#endif
1288 PyObject *dirname;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001289 Py_UCS4 *dirsep;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001290 int res, ok;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001291
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001292 /* Ensure that the __pycache__ directory exists. */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001293 cpathname_ucs4 = PyUnicode_AsUCS4Copy(cpathname);
1294 if (!cpathname_ucs4)
1295 return;
1296 dirsep = rightmost_sep(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001297 if (dirsep == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001298 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001299 PySys_FormatStderr("# no %s path found %R\n", CACHEDIR, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001300 return;
1301 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001302 dirname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
1303 cpathname_ucs4,
1304 dirsep - cpathname_ucs4);
1305 PyMem_Free(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001306 if (dirname == NULL) {
1307 PyErr_Clear();
1308 return;
1309 }
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001310
1311#ifdef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001312 res = CreateDirectoryW(PyUnicode_AS_UNICODE(dirname), NULL);
1313 ok = (res != 0);
1314 if (!ok && GetLastError() == ERROR_ALREADY_EXISTS)
1315 ok = 1;
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001316#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001317 dirbytes = PyUnicode_EncodeFSDefault(dirname);
1318 if (dirbytes == NULL) {
1319 PyErr_Clear();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001320 return;
1321 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001322 res = mkdir(PyBytes_AS_STRING(dirbytes), dirmode);
1323 Py_DECREF(dirbytes);
1324 if (0 <= res)
1325 ok = 1;
1326 else
1327 ok = (errno == EEXIST);
1328#endif
1329 if (!ok) {
1330 if (Py_VerboseFlag)
1331 PySys_FormatStderr("# cannot create cache dir %R\n", dirname);
1332 Py_DECREF(dirname);
1333 return;
1334 }
1335 Py_DECREF(dirname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001336
Victor Stinner783c82c2011-04-20 03:27:51 +02001337#ifdef MS_WINDOWS
1338 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1339 fd = _wopen(PyUnicode_AS_UNICODE(cpathname),
1340 O_EXCL | O_CREAT | O_WRONLY | O_TRUNC | O_BINARY,
1341 mode);
1342 if (0 <= fd)
1343 fp = fdopen(fd, "wb");
1344 else
1345 fp = NULL;
1346#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001347 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1348 if (cpathbytes == NULL) {
1349 PyErr_Clear();
1350 return;
1351 }
1352
1353 fp = open_exclusive(PyBytes_AS_STRING(cpathbytes), mode);
Victor Stinner783c82c2011-04-20 03:27:51 +02001354#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001355 if (fp == NULL) {
1356 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001357 PySys_FormatStderr(
1358 "# can't create %R\n", cpathname);
Victor Stinner783c82c2011-04-20 03:27:51 +02001359#ifndef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001360 Py_DECREF(cpathbytes);
Victor Stinner783c82c2011-04-20 03:27:51 +02001361#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001362 return;
1363 }
1364 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1365 /* First write a 0 for mtime */
1366 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1367 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
1368 if (fflush(fp) != 0 || ferror(fp)) {
1369 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001370 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001371 /* Don't keep partial file */
1372 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001373#ifdef MS_WINDOWS
1374 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1375#else
1376 (void) unlink(PyBytes_AS_STRING(cpathbytes));
Victor Stinner2f42ae52011-03-20 00:41:24 +01001377 Py_DECREF(cpathbytes);
Victor Stinner783c82c2011-04-20 03:27:51 +02001378#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 return;
1380 }
Victor Stinner783c82c2011-04-20 03:27:51 +02001381#ifndef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001382 Py_DECREF(cpathbytes);
Victor Stinner783c82c2011-04-20 03:27:51 +02001383#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001384 /* Now write the true mtime */
1385 fseek(fp, 4L, 0);
1386 assert(mtime < LONG_MAX);
1387 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
1388 fflush(fp);
1389 fclose(fp);
1390 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001391 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001392}
1393
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001394static void
1395update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1396{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001397 PyObject *constants, *tmp;
1398 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001399
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001400 if (PyUnicode_Compare(co->co_filename, oldname))
1401 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001403 tmp = co->co_filename;
1404 co->co_filename = newname;
1405 Py_INCREF(co->co_filename);
1406 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001407
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001408 constants = co->co_consts;
1409 n = PyTuple_GET_SIZE(constants);
1410 for (i = 0; i < n; i++) {
1411 tmp = PyTuple_GET_ITEM(constants, i);
1412 if (PyCode_Check(tmp))
1413 update_code_filenames((PyCodeObject *)tmp,
1414 oldname, newname);
1415 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001416}
1417
Victor Stinner2f42ae52011-03-20 00:41:24 +01001418static void
1419update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001420{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001421 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001422
Victor Stinner2f42ae52011-03-20 00:41:24 +01001423 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1424 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001425
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001426 oldname = co->co_filename;
1427 Py_INCREF(oldname);
1428 update_code_filenames(co, oldname, newname);
1429 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001430}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001431
Brett Cannon442c9b92011-03-23 16:14:42 -07001432static PyObject *
1433imp_fix_co_filename(PyObject *self, PyObject *args)
1434{
1435 PyObject *co;
1436 PyObject *file_path;
1437
1438 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
1439 return NULL;
1440
1441 if (!PyCode_Check(co)) {
1442 PyErr_SetString(PyExc_TypeError,
1443 "first argument must be a code object");
1444 return NULL;
1445 }
1446
1447 if (!PyUnicode_Check(file_path)) {
1448 PyErr_SetString(PyExc_TypeError,
1449 "second argument must be a string");
1450 return NULL;
1451 }
1452
1453 update_compiled_module((PyCodeObject*)co, file_path);
1454
1455 Py_RETURN_NONE;
1456}
1457
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001458/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001459 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1460 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001461
Guido van Rossum79f25d91997-04-29 20:08:16 +00001462static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001463load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001464{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001465 struct stat st;
1466 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001467 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001468 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001469 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001471 if (fstat(fileno(fp), &st) != 0) {
1472 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001473 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001475 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001476 }
Fred Drake4c82b232000-06-30 16:18:57 +00001477#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001478 /* Python's .pyc timestamp handling presumes that the timestamp fits
1479 in 4 bytes. This will be fine until sometime in the year 2038,
1480 when a 4-byte signed time_t will overflow.
1481 */
1482 if (st.st_mtime >> 32) {
1483 PyErr_SetString(PyExc_OverflowError,
1484 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001485 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001486 }
Fred Drake4c82b232000-06-30 16:18:57 +00001487#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001488 cpathname = make_compiled_pathname(pathname, !Py_OptimizeFlag);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001489
1490 if (cpathname != NULL)
1491 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1492 else
1493 fpc = NULL;
1494
1495 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 co = read_compiled_module(cpathname, fpc);
1497 fclose(fpc);
1498 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001499 goto error;
1500 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001501 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001502 PySys_FormatStderr("import %U # precompiled from %R\n",
1503 name, cpathname);
1504 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1505 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001506 }
1507 else {
1508 co = parse_source_module(pathname, fp);
1509 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001510 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001511 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001512 PySys_FormatStderr("import %U # from %R\n",
Victor Stinner98dbba52011-03-14 15:15:47 -04001513 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001514 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001515 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1516 if (ro == NULL || !PyObject_IsTrue(ro))
1517 write_compiled_module(co, cpathname, &st);
1518 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001519 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1520 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001521 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001522 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001523
Victor Stinner2f42ae52011-03-20 00:41:24 +01001524error:
1525 Py_XDECREF(cpathbytes);
1526 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001527 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001528}
1529
Christian Heimes3b06e532008-01-07 20:12:44 +00001530/* Get source file -> unicode or None
1531 * Returns the path to the py file if available, else the given path
1532 */
1533static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001534get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001535{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001536 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001537 Py_UCS4 *fileuni;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001538 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001539 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001540
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001541 len = PyUnicode_GET_LENGTH(filename);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001542 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001543 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001544
Victor Stinnerc9abda02011-03-14 13:33:46 -04001545 /* don't match *.pyc or *.pyo? */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001546 fileuni = PyUnicode_AsUCS4Copy(filename);
1547 if (!fileuni)
1548 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001549 if (len < 5
1550 || fileuni[len-4] != '.'
1551 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1552 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1553 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001554
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001555 /* Start by trying to turn PEP 3147 path into source path. If that
1556 * fails, just chop off the trailing character, i.e. legacy pyc path
1557 * to py.
1558 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001559 py = make_source_pathname(filename);
1560 if (py == NULL) {
1561 PyErr_Clear();
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001562 py = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001563 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001564 if (py == NULL)
1565 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001566
Victor Stinnerc9abda02011-03-14 13:33:46 -04001567 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode))
1568 return py;
1569 Py_DECREF(py);
1570 goto unchanged;
1571
1572error:
1573 PyErr_Clear();
1574unchanged:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001575 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001576 Py_INCREF(filename);
1577 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001578}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001579
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001580/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001581static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001582static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001583 PyObject **, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001584static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001585
1586/* Load a package and return its module object WITH INCREMENTED
1587 REFERENCE COUNT */
1588
1589static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001590load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001591{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001592 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001593 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001594 int err;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001595 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001597
Victor Stinnerc9abda02011-03-14 13:33:46 -04001598 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001599 if (m == NULL)
1600 return NULL;
1601 if (Py_VerboseFlag)
Victor Stinner98dbba52011-03-14 15:15:47 -04001602 PySys_FormatStderr("import %U # directory %R\n",
1603 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 file = get_sourcefile(pathname);
1605 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001606 return NULL;
1607 path_list = Py_BuildValue("[O]", file);
1608 if (path_list == NULL) {
1609 Py_DECREF(file);
1610 return NULL;
1611 }
1612 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001614 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001616 err = PyDict_SetItemString(d, "__path__", path_list);
1617 if (err != 0) {
1618 Py_DECREF(path_list);
1619 return NULL;
1620 }
Victor Stinner533d7832011-03-14 13:22:54 -04001621 fdp = find_module(name, initstr, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001622 &bufobj, &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001623 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 if (fdp == NULL) {
1625 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1626 PyErr_Clear();
1627 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001628 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 }
1630 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001631 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001632 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001633 m = load_module(name, fp, bufobj, fdp->type, NULL);
1634 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001635 if (fp != NULL)
1636 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001637 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001638}
1639
1640
1641/* Helper to test for built-in module */
1642
1643static int
Victor Stinner95872862011-03-07 18:20:56 +01001644is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001645{
Victor Stinner95872862011-03-07 18:20:56 +01001646 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001647 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001648 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1649 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 if (PyImport_Inittab[i].initfunc == NULL)
1651 return -1;
1652 else
1653 return 1;
1654 }
1655 }
1656 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001657}
1658
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001659
Just van Rossum52e14d62002-12-30 22:08:05 +00001660/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1661 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001662 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001663 that can handle the path item. Return None if no hook could;
1664 this tells our caller it should fall back to the builtin
1665 import mechanism. Cache the result in path_importer_cache.
1666 Returns a borrowed reference. */
1667
1668static PyObject *
1669get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001670 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001671{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001672 PyObject *importer;
1673 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001674
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001675 /* These conditions are the caller's responsibility: */
1676 assert(PyList_Check(path_hooks));
1677 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001678
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001679 nhooks = PyList_Size(path_hooks);
1680 if (nhooks < 0)
1681 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001682
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001683 importer = PyDict_GetItem(path_importer_cache, p);
1684 if (importer != NULL)
1685 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001686
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001687 /* set path_importer_cache[p] to None to avoid recursion */
1688 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1689 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001691 for (j = 0; j < nhooks; j++) {
1692 PyObject *hook = PyList_GetItem(path_hooks, j);
1693 if (hook == NULL)
1694 return NULL;
1695 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1696 if (importer != NULL)
1697 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001699 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1700 return NULL;
1701 }
1702 PyErr_Clear();
1703 }
1704 if (importer == NULL) {
1705 importer = PyObject_CallFunctionObjArgs(
1706 (PyObject *)&PyNullImporter_Type, p, NULL
1707 );
1708 if (importer == NULL) {
1709 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1710 PyErr_Clear();
1711 return Py_None;
1712 }
1713 }
1714 }
1715 if (importer != NULL) {
1716 int err = PyDict_SetItem(path_importer_cache, p, importer);
1717 Py_DECREF(importer);
1718 if (err != 0)
1719 return NULL;
1720 }
1721 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001722}
1723
Christian Heimes9cd17752007-11-18 19:35:23 +00001724PyAPI_FUNC(PyObject *)
1725PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001726 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001727
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001728 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1729 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1730 importer = get_path_importer(path_importer_cache,
1731 path_hooks, path);
1732 }
1733 }
1734 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1735 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001736}
1737
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001738/* Search the path (default sys.path) for a module. Return the
1739 corresponding filedescr struct, and (via return arguments) the
1740 pathname and an open file. Return NULL if the module is not found. */
1741
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001742#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001743extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1744 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001745#endif
1746
Victor Stinner547a2a62011-03-20 03:07:28 +01001747/* Forward */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001748static int case_ok(PyObject *, Py_ssize_t, PyObject *);
Victor Stinner547a2a62011-03-20 03:07:28 +01001749static int find_init_module(PyObject *);
Just van Rossum52e14d62002-12-30 22:08:05 +00001750static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001751
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001752/* Get the path of a module: get its importer and call importer.find_module()
1753 hook, or check if the module if a package (if path/__init__.py exists).
1754
1755 -1: error: a Python error occurred
1756 0: ignore: an error occurred because of invalid data, but the error is not
1757 important enough to be reported.
1758 1: get path: module not found, but *buf contains its path
1759 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1760 and *buf is the path */
1761
1762static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001763find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001764 PyObject *path_hooks, PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001765 PyObject **p_path, PyObject **p_loader, struct filedescr **p_fd)
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001766{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001767 Py_UCS4 buf[MAXPATHLEN+1];
Victor Stinner2fd76e42011-03-14 15:19:39 -04001768 PyObject *path_unicode, *filename;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001769 Py_ssize_t len;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001770 struct stat statbuf;
1771 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1772
1773 if (PyUnicode_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001774 Py_INCREF(path);
1775 path_unicode = path;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001776 }
1777 else if (PyBytes_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001778 path_unicode = PyUnicode_DecodeFSDefaultAndSize(
1779 PyBytes_AS_STRING(path), PyBytes_GET_SIZE(path));
1780 if (path_unicode == NULL)
1781 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001782 }
1783 else
1784 return 0;
1785
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001786 len = PyUnicode_GET_LENGTH(path_unicode);
Georg Brandl4cb0de22011-09-28 21:49:49 +02001787 if (!PyUnicode_AsUCS4(path_unicode, buf, Py_ARRAY_LENGTH(buf), 1)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001788 Py_DECREF(path_unicode);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001789 PyErr_Clear();
1790 return 0;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001791 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001792 Py_DECREF(path_unicode);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001793
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001794 if (Py_UCS4_strlen(buf) != len)
Victor Stinner2fd76e42011-03-14 15:19:39 -04001795 return 0; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001796
1797 /* sys.path_hooks import hook */
1798 if (p_loader != NULL) {
1799 PyObject *importer;
1800
1801 importer = get_path_importer(path_importer_cache,
1802 path_hooks, path);
1803 if (importer == NULL) {
1804 return -1;
1805 }
1806 /* Note: importer is a borrowed reference */
1807 if (importer != Py_None) {
1808 PyObject *loader;
1809 loader = PyObject_CallMethod(importer,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001810 "find_module", "O", fullname);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001811 if (loader == NULL)
1812 return -1; /* error */
1813 if (loader != Py_None) {
1814 /* a loader was found */
1815 *p_loader = loader;
1816 *p_fd = &importhookdescr;
1817 return 2;
1818 }
1819 Py_DECREF(loader);
1820 return 0;
1821 }
1822 }
1823 /* no hook was found, use builtin import */
1824
1825 if (len > 0 && buf[len-1] != SEP
1826#ifdef ALTSEP
1827 && buf[len-1] != ALTSEP
1828#endif
1829 )
1830 buf[len++] = SEP;
Georg Brandl4cb0de22011-09-28 21:49:49 +02001831 if (!PyUnicode_AsUCS4(name, buf+len, Py_ARRAY_LENGTH(buf)-len, 1)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001832 PyErr_Clear();
1833 return 0;
1834 }
1835 len += PyUnicode_GET_LENGTH(name);
Victor Stinner2fd76e42011-03-14 15:19:39 -04001836
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001837 filename = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
1838 buf, len);
Victor Stinner2fd76e42011-03-14 15:19:39 -04001839 if (filename == NULL)
1840 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001841
1842 /* Check for package import (buf holds a directory name,
1843 and there's an __init__ module in that directory */
1844#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001845 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001846 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1847 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001848 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001849
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001850 match = case_ok(filename, 0, name);
1851 if (match < 0) {
1852 Py_DECREF(filename);
1853 return -1;
1854 }
1855 if (match) { /* case matches */
1856 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001857 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001858 *p_fd = &fd_package;
1859 return 2;
1860 }
1861 else {
1862 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001863 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001864 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001865 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001866 if (err) {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001867 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001868 return -1;
Victor Stinner547a2a62011-03-20 03:07:28 +01001869 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001870 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001871 }
1872 }
1873#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001874 *p_path = filename;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001875 return 1;
1876}
1877
1878/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001879 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001880
1881 If the module is found, return a file descriptor, write the path in
1882 *p_filename, write the pointer to the file object into *p_fp, and (if
1883 p_loader is not NULL) the loader into *p_loader.
1884
1885 Otherwise, raise an exception and return NULL. */
1886
Victor Stinner37580282011-03-20 01:34:43 +01001887static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001888find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001889 PyObject *search_path_list, PyObject *path_hooks,
1890 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001891 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001892{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001893 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001894 struct filedescr *fdp = NULL;
1895 char *filemode;
1896 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001897 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001898 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001899
Victor Stinner37580282011-03-20 01:34:43 +01001900 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001901 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001902 PyObject *path;
1903 int ok;
1904
1905 path = PyList_GetItem(search_path_list, i);
1906 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001907 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001908
Victor Stinner2fd76e42011-03-14 15:19:39 -04001909 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001910 ok = find_module_path(fullname, name, path,
1911 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001912 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001913 if (ok < 0)
1914 return NULL;
1915 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001916 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001917 if (ok == 2) {
1918 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001919 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001920 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001921
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001922 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001923 struct stat statbuf;
1924
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001925 filemode = fdp->mode;
1926 if (filemode[0] == 'U')
1927 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001928
Victor Stinner2fd76e42011-03-14 15:19:39 -04001929 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1930 if (filename == NULL) {
1931 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001932 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001933 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001934
1935 if (Py_VerboseFlag > 1)
1936 PySys_FormatStderr("# trying %R\n", filename);
1937
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001938 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
1939 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1940 {
1941 Py_DECREF(filename);
1942 continue;
1943 }
1944
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001945 fp = _Py_fopen(filename, filemode);
1946 if (fp == NULL) {
1947 Py_DECREF(filename);
Victor Stinner925ef392011-06-20 15:01:10 +02001948 if (PyErr_Occurred()) {
1949 Py_DECREF(prefix);
1950 return NULL;
1951 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001952 continue;
1953 }
1954 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1955 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001956 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001957 Py_DECREF(filename);
1958 return NULL;
1959 }
1960 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001961 Py_DECREF(prefix);
1962 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001963 *p_fp = fp;
1964 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001965 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001966 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001967
1968 fclose(fp);
1969 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001970 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001971 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001972 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001973 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04001974 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04001975 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001976}
1977
Victor Stinner37580282011-03-20 01:34:43 +01001978/* Find a module:
1979
1980 - try find_module() of each sys.meta_path hook
1981 - try find_frozen()
1982 - try is_builtin()
1983 - try _PyWin_FindRegisteredModule() (Windows only)
1984 - otherwise, call find_module_path_list() with search_path_list (if not
1985 NULL) or sys.path
1986
Victor Stinner2fd76e42011-03-14 15:19:39 -04001987 fullname can be NULL, but only if p_loader is NULL.
1988
Victor Stinner37580282011-03-20 01:34:43 +01001989 Return:
1990
1991 - &fd_builtin (C_BUILTIN) if it is a builtin
1992 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04001993 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01001994 if it is a package
1995 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1996 importer loader was found
1997 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1998 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04001999 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01002000 - NULL on error
2001
Victor Stinner2fd76e42011-03-14 15:19:39 -04002002 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
2003 Eg. *p_path is set to NULL for a builtin package.
2004*/
Victor Stinner37580282011-03-20 01:34:43 +01002005
2006static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002007find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002008 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01002009{
2010 Py_ssize_t i, npath;
2011 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
2012 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
2013 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01002014
Victor Stinner2fd76e42011-03-14 15:19:39 -04002015 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01002016 *p_fp = NULL;
2017 if (p_loader != NULL)
2018 *p_loader = NULL;
2019
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002020 if (PyUnicode_GET_LENGTH(name) > MAXPATHLEN) {
2021 PyErr_SetString(PyExc_OverflowError,
2022 "module name is too long");
2023 return NULL;
2024 }
2025
Victor Stinner37580282011-03-20 01:34:43 +01002026 /* sys.meta_path import hook */
2027 if (p_loader != NULL) {
2028 PyObject *meta_path;
2029
2030 meta_path = PySys_GetObject("meta_path");
2031 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02002032 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002033 "sys.meta_path must be a list of "
2034 "import hooks");
2035 return NULL;
2036 }
2037 Py_INCREF(meta_path); /* zap guard */
2038 npath = PyList_Size(meta_path);
2039 for (i = 0; i < npath; i++) {
2040 PyObject *loader;
2041 PyObject *hook = PyList_GetItem(meta_path, i);
2042 loader = PyObject_CallMethod(hook, "find_module",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002043 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01002044 search_path_list != NULL ?
2045 search_path_list : Py_None);
2046 if (loader == NULL) {
2047 Py_DECREF(meta_path);
2048 return NULL; /* true error */
2049 }
2050 if (loader != Py_None) {
2051 /* a loader was found */
2052 *p_loader = loader;
2053 Py_DECREF(meta_path);
2054 return &importhookdescr;
2055 }
2056 Py_DECREF(loader);
2057 }
2058 Py_DECREF(meta_path);
2059 }
2060
Victor Stinnerdf75a022011-03-14 13:40:04 -04002061 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002062 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01002063
2064 if (search_path_list == NULL) {
2065#ifdef MS_COREDLL
2066 FILE *fp;
2067 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01002068#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04002069 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01002070 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01002071#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04002072 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01002073 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01002074 *p_fp = fp;
2075 return fdp;
2076 }
2077 else if (PyErr_Occurred())
2078 return NULL;
2079#endif
Victor Stinner37580282011-03-20 01:34:43 +01002080 search_path_list = PySys_GetObject("path");
2081 }
2082
2083 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
Victor Stinner16191322011-09-15 19:28:05 +02002084 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002085 "sys.path must be a list of directory names");
2086 return NULL;
2087 }
2088
2089 path_hooks = PySys_GetObject("path_hooks");
2090 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02002091 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002092 "sys.path_hooks must be a list of "
2093 "import hooks");
2094 return NULL;
2095 }
2096 path_importer_cache = PySys_GetObject("path_importer_cache");
2097 if (path_importer_cache == NULL ||
2098 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02002099 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002100 "sys.path_importer_cache must be a dict");
2101 return NULL;
2102 }
2103
2104 return find_module_path_list(fullname, name,
2105 search_path_list, path_hooks,
2106 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002107 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002108}
2109
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002110/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002111 * The arguments here are tricky, best shown by example:
2112 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2113 * ^ ^ ^ ^
2114 * |--------------------- buf ---------------------|
2115 * |------------------- len ------------------|
2116 * |------ name -------|
2117 * |----- namelen -----|
2118 * buf is the full path, but len only counts up to (& exclusive of) the
2119 * extension. name is the module name, also exclusive of extension.
2120 *
2121 * We've already done a successful stat() or fopen() on buf, so know that
2122 * there's some match, possibly case-insensitive.
2123 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002124 * case_bytes() is to return 1 if there's a case-sensitive match for
2125 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002126 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002127 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002128 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002129 * on platforms with case-insensitive filesystems. It's trivial to implement
2130 * for case-sensitive filesystems. It's pretty much a cross-platform
2131 * nightmare for systems with case-insensitive filesystems.
2132 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002133
Tim Peters50d8d372001-02-28 05:34:27 +00002134/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002135 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002136 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002137#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002138#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002139
Tim Peters50d8d372001-02-28 05:34:27 +00002140#elif defined(DJGPP)
2141#include <dir.h>
2142
Jason Tishler7961aa62005-05-20 00:56:54 +00002143#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002144#include <sys/types.h>
2145#include <dirent.h>
2146
Andrew MacIntyred9400542002-02-26 11:41:34 +00002147#elif defined(PYOS_OS2)
2148#define INCL_DOS
2149#define INCL_DOSERRORS
2150#define INCL_NOPMAPI
2151#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002152#endif
2153
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002154#if defined(DJGPP) \
2155 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2156 && defined(HAVE_DIRENT_H)) \
2157 || defined(PYOS_OS2)
2158# define USE_CASE_OK_BYTES
2159#endif
2160
2161
2162#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002163static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002164case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002165{
Tim Peters50d8d372001-02-28 05:34:27 +00002166/* Pick a platform-specific implementation; the sequence of #if's here should
2167 * match the sequence just above.
2168 */
2169
Tim Peters50d8d372001-02-28 05:34:27 +00002170/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002171#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002172 struct ffblk ffblk;
2173 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002174
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002175 if (Py_GETENV("PYTHONCASEOK") != NULL)
2176 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002177
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002178 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2179 if (done) {
2180 PyErr_Format(PyExc_NameError,
2181 "Can't find file for module %.100s\n(filename %.300s)",
2182 name, buf);
Victor Stinner9c61e242011-03-22 01:22:27 +01002183 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002184 }
2185 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002186
Jason Tishler7961aa62005-05-20 00:56:54 +00002187/* new-fangled macintosh (macosx) or Cygwin */
2188#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002189 DIR *dirp;
2190 struct dirent *dp;
2191 char dirname[MAXPATHLEN + 1];
2192 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002193
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002194 if (Py_GETENV("PYTHONCASEOK") != NULL)
2195 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002196
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002197 /* Copy the dir component into dirname; substitute "." if empty */
2198 if (dirlen <= 0) {
2199 dirname[0] = '.';
2200 dirname[1] = '\0';
2201 }
2202 else {
2203 assert(dirlen <= MAXPATHLEN);
2204 memcpy(dirname, buf, dirlen);
2205 dirname[dirlen] = '\0';
2206 }
2207 /* Open the directory and search the entries for an exact match. */
2208 dirp = opendir(dirname);
2209 if (dirp) {
2210 char *nameWithExt = buf + len - namelen;
2211 while ((dp = readdir(dirp)) != NULL) {
2212 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002213#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002214 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002215#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002216 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002217#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002218 if (thislen >= namelen &&
2219 strcmp(dp->d_name, nameWithExt) == 0) {
2220 (void)closedir(dirp);
2221 return 1; /* Found */
2222 }
2223 }
2224 (void)closedir(dirp);
2225 }
2226 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002227
Andrew MacIntyred9400542002-02-26 11:41:34 +00002228/* OS/2 */
2229#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002230 HDIR hdir = 1;
2231 ULONG srchcnt = 1;
2232 FILEFINDBUF3 ffbuf;
2233 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002235 if (Py_GETENV("PYTHONCASEOK") != NULL)
2236 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002237
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002238 rc = DosFindFirst(buf,
2239 &hdir,
2240 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2241 &ffbuf, sizeof(ffbuf),
2242 &srchcnt,
2243 FIL_STANDARD);
2244 if (rc != NO_ERROR)
2245 return 0;
2246 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002247
Tim Peters50d8d372001-02-28 05:34:27 +00002248/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2249#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002250# error "USE_CASE_OK_BYTES is not correctly defined"
2251#endif
2252}
2253#endif
2254
2255/*
2256 * Check if a filename case matchs the name case. We've already done a
2257 * successful stat() or fopen() on buf, so know that there's some match,
2258 * possibly case-insensitive.
2259 *
2260 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2261 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2262 * if envar PYTHONCASEOK exists.
2263 *
2264 * case_ok() is used to implement case-sensitive import semantics even
2265 * on platforms with case-insensitive filesystems. It's trivial to implement
2266 * for case-sensitive filesystems. It's pretty much a cross-platform
2267 * nightmare for systems with case-insensitive filesystems.
2268 */
2269
2270static int
2271case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2272{
2273#ifdef MS_WINDOWS
2274 WIN32_FIND_DATAW data;
2275 HANDLE h;
2276 int cmp;
2277
2278 if (Py_GETENV("PYTHONCASEOK") != NULL)
2279 return 1;
2280
2281 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2282 if (h == INVALID_HANDLE_VALUE) {
2283 PyErr_Format(PyExc_NameError,
2284 "Can't find file for module %R\n(filename %R)",
2285 name, filename);
2286 return 0;
2287 }
2288 FindClose(h);
2289 cmp = wcsncmp(data.cFileName,
2290 PyUnicode_AS_UNICODE(name),
2291 PyUnicode_GET_SIZE(name));
2292 return cmp == 0;
2293#elif defined(USE_CASE_OK_BYTES)
2294 int match;
2295 PyObject *filebytes, *namebytes;
2296 filebytes = PyUnicode_EncodeFSDefault(filename);
2297 if (filebytes == NULL)
2298 return -1;
2299 namebytes = PyUnicode_EncodeFSDefault(name);
2300 if (namebytes == NULL) {
2301 Py_DECREF(filebytes);
2302 return -1;
2303 }
2304 match = case_bytes(
2305 PyBytes_AS_STRING(filebytes),
2306 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002307 PyBytes_GET_SIZE(namebytes),
2308 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002309 Py_DECREF(filebytes);
2310 Py_DECREF(namebytes);
2311 return match;
2312#else
2313 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002314 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002315
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002316#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002317}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002318
Guido van Rossum197346f1997-10-31 18:38:52 +00002319#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002320
Victor Stinner547a2a62011-03-20 03:07:28 +01002321/* Helper to look for __init__.py or __init__.py[co] in potential package.
2322 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002323static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002324find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002325{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002326 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002327 PyObject *filename;
2328 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002329
Victor Stinner547a2a62011-03-20 03:07:28 +01002330 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2331 if (filename == NULL)
2332 return -1;
2333 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002334 /* 3=len(".py") */
2335 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002336 if (match < 0) {
2337 Py_DECREF(filename);
2338 return -1;
2339 }
2340 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002341 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002342 return 1;
2343 }
2344 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002345 Py_DECREF(filename);
2346
2347 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2348 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2349 if (filename == NULL)
2350 return -1;
2351 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002352 /* 4=len(".pyc") */
2353 match = case_ok(filename, -4, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002354 if (match < 0) {
2355 Py_DECREF(filename);
2356 return -1;
2357 }
2358 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002359 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002360 return 1;
2361 }
2362 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002363 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002364 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002365}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002366
Guido van Rossum197346f1997-10-31 18:38:52 +00002367#endif /* HAVE_STAT */
2368
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002369
Victor Stinner95872862011-03-07 18:20:56 +01002370static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002371
Victor Stinner44c6c152010-08-09 00:59:10 +00002372static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002373load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002374{
2375 PyObject *m, *modules;
2376 int err;
2377
Victor Stinner44c6c152010-08-09 00:59:10 +00002378 if (type == C_BUILTIN)
2379 err = init_builtin(name);
2380 else
Victor Stinner95872862011-03-07 18:20:56 +01002381 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002382 if (err < 0)
2383 return NULL;
2384 if (err == 0) {
2385 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002386 "Purported %s module %R not found",
2387 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002388 name);
2389 return NULL;
2390 }
2391
2392 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002393 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002394 if (m == NULL) {
2395 PyErr_Format(
2396 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002397 "%s module %R not properly initialized",
2398 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002399 name);
2400 return NULL;
2401 }
2402 Py_INCREF(m);
2403 return m;
2404}
2405
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002406/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002407 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002408
Guido van Rossum79f25d91997-04-29 20:08:16 +00002409static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002410load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002411{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002412 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002413
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002414 /* First check that there's an open file (if we need one) */
2415 switch (type) {
2416 case PY_SOURCE:
2417 case PY_COMPILED:
2418 if (fp == NULL) {
2419 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002420 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002421 type);
2422 return NULL;
2423 }
2424 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002425
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002426 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002427
Victor Stinner41c5fec2011-03-13 21:46:30 -04002428 case PY_SOURCE:
2429 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002430 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002431
Victor Stinner41c5fec2011-03-13 21:46:30 -04002432 case PY_COMPILED:
2433 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002434 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002435
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002436#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002437 case C_EXTENSION:
2438 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002439 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002440#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002441
Victor Stinner41c5fec2011-03-13 21:46:30 -04002442 case PKG_DIRECTORY:
2443 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002446 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002447 case PY_FROZEN:
2448 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002449 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002450
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002451 case IMP_HOOK: {
2452 if (loader == NULL) {
2453 PyErr_SetString(PyExc_ImportError,
2454 "import hook without loader");
2455 return NULL;
2456 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04002457 m = PyObject_CallMethod(loader, "load_module", "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002458 break;
2459 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002460
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002461 default:
2462 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002463 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002464 name, type);
2465 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002466
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002467 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002470}
2471
2472
2473/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002474 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002475 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002476
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002477static int
Victor Stinner95872862011-03-07 18:20:56 +01002478init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002479{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002480 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002481
Victor Stinner95872862011-03-07 18:20:56 +01002482 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002483 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002484
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002485 for (p = PyImport_Inittab; p->name != NULL; p++) {
2486 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002487 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002488 if (p->initfunc == NULL) {
2489 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002490 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002491 name);
2492 return -1;
2493 }
2494 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002495 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002496 mod = (*p->initfunc)();
2497 if (mod == 0)
2498 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002499 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002500 return -1;
2501 /* FixupExtension has put the module into sys.modules,
2502 so we can release our own reference. */
2503 Py_DECREF(mod);
2504 return 1;
2505 }
2506 }
2507 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002508}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002509
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002510
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002511/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002512
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002513static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002514find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002515{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002516 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002517
Victor Stinner53dc7352011-03-20 01:50:21 +01002518 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002519 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002520
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002521 for (p = PyImport_FrozenModules; ; p++) {
2522 if (p->name == NULL)
2523 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002524 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002525 break;
2526 }
2527 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002528}
2529
Guido van Rossum79f25d91997-04-29 20:08:16 +00002530static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002531get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002532{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002533 struct _frozen *p = find_frozen(name);
2534 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002535
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002536 if (p == NULL) {
2537 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002538 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002539 name);
2540 return NULL;
2541 }
2542 if (p->code == NULL) {
2543 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002544 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002545 name);
2546 return NULL;
2547 }
2548 size = p->size;
2549 if (size < 0)
2550 size = -size;
2551 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002552}
2553
Brett Cannon8d110132009-03-15 02:20:16 +00002554static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002555is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002556{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002557 struct _frozen *p = find_frozen(name);
2558 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002559
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002560 if (p == NULL) {
2561 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002562 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002563 name);
2564 return NULL;
2565 }
Brett Cannon8d110132009-03-15 02:20:16 +00002566
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002567 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002568
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002569 if (size < 0)
2570 Py_RETURN_TRUE;
2571 else
2572 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002573}
2574
2575
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002576/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002577 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002578 an exception set if the initialization failed.
2579 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002580
2581int
Victor Stinner53dc7352011-03-20 01:50:21 +01002582PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002583{
Victor Stinner53dc7352011-03-20 01:50:21 +01002584 struct _frozen *p;
2585 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002586 int ispackage;
2587 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002588
Victor Stinner53dc7352011-03-20 01:50:21 +01002589 p = find_frozen(name);
2590
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002591 if (p == NULL)
2592 return 0;
2593 if (p->code == NULL) {
2594 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002595 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002596 name);
2597 return -1;
2598 }
2599 size = p->size;
2600 ispackage = (size < 0);
2601 if (ispackage)
2602 size = -size;
2603 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002604 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002605 name, ispackage ? " package" : "");
2606 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2607 if (co == NULL)
2608 return -1;
2609 if (!PyCode_Check(co)) {
2610 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002611 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002612 name);
2613 goto err_return;
2614 }
2615 if (ispackage) {
2616 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002617 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002618 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002619 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002620 if (m == NULL)
2621 goto err_return;
2622 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002623 l = PyList_New(1);
2624 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002625 goto err_return;
2626 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002627 Py_INCREF(name);
2628 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002629 err = PyDict_SetItemString(d, "__path__", l);
2630 Py_DECREF(l);
2631 if (err != 0)
2632 goto err_return;
2633 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002634 path = PyUnicode_FromString("<frozen>");
2635 if (path == NULL)
2636 goto err_return;
2637 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2638 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002639 if (m == NULL)
2640 goto err_return;
2641 Py_DECREF(co);
2642 Py_DECREF(m);
2643 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002644err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002645 Py_DECREF(co);
2646 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002647}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002648
Victor Stinner53dc7352011-03-20 01:50:21 +01002649int
2650PyImport_ImportFrozenModule(char *name)
2651{
2652 PyObject *nameobj;
2653 int ret;
2654 nameobj = PyUnicode_InternFromString(name);
2655 if (nameobj == NULL)
2656 return -1;
2657 ret = PyImport_ImportFrozenModuleObject(nameobj);
2658 Py_DECREF(nameobj);
2659 return ret;
2660}
2661
Guido van Rossum74e6a111994-08-29 12:54:38 +00002662
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002663/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002664 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002665
Guido van Rossum79f25d91997-04-29 20:08:16 +00002666PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002667PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002668{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002669 PyObject *pname;
2670 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002671
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002672 pname = PyUnicode_FromString(name);
2673 if (pname == NULL)
2674 return NULL;
2675 result = PyImport_Import(pname);
2676 Py_DECREF(pname);
2677 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002678}
2679
Christian Heimes072c0f12008-01-03 23:01:04 +00002680/* Import a module without blocking
2681 *
2682 * At first it tries to fetch the module from sys.modules. If the module was
2683 * never loaded before it loads it with PyImport_ImportModule() unless another
2684 * thread holds the import lock. In the latter case the function raises an
2685 * ImportError instead of blocking.
2686 *
2687 * Returns the module object with incremented ref count.
2688 */
2689PyObject *
2690PyImport_ImportModuleNoBlock(const char *name)
2691{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002692 PyObject *nameobj, *modules, *result;
Victor Stinner0af03062011-09-02 00:11:43 +02002693#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002694 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002695#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002696
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002697 /* Try to get the module from sys.modules[name] */
2698 modules = PyImport_GetModuleDict();
2699 if (modules == NULL)
2700 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002701
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002702 nameobj = PyUnicode_FromString(name);
2703 if (nameobj == NULL)
2704 return NULL;
2705 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002706 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002707 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002708 Py_INCREF(result);
2709 return result;
2710 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002711 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002712#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002713 /* check the import lock
2714 * me might be -1 but I ignore the error here, the lock function
2715 * takes care of the problem */
2716 me = PyThread_get_thread_ident();
2717 if (import_lock_thread == -1 || import_lock_thread == me) {
2718 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002719 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002720 }
2721 else {
2722 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002723 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002724 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002725 nameobj);
2726 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002727 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002728#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002729 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002730#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002731 Py_DECREF(nameobj);
2732 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002733}
2734
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002735/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002736static PyObject *get_parent(PyObject *globals,
2737 PyObject **p_name,
2738 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002739static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002740 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002741 Py_UCS4 *buf, Py_ssize_t *p_buflen,
Victor Stinner974389d2011-03-15 09:33:57 +01002742 Py_ssize_t bufsize);
2743static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002744static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002745 PyObject *buf, int recursive);
2746static PyObject * import_submodule(PyObject *mod, PyObject *name,
2747 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002748
2749/* The Magnum Opus of dotted-name import :-) */
2750
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002751static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002752import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002753 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002754{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002755 Py_UCS4 buf[MAXPATHLEN+1];
Victor Stinner974389d2011-03-15 09:33:57 +01002756 Py_ssize_t buflen;
2757 Py_ssize_t bufsize = MAXPATHLEN+1;
2758 PyObject *parent, *head, *next, *tail, *inputname, *outputname;
2759 PyObject *parent_name, *ensure_name;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002760 Py_ssize_t sep, altsep;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002761
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002762 if (PyUnicode_READY(name))
2763 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002764
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002765 sep = PyUnicode_FindChar(name, SEP, 0, PyUnicode_GET_LENGTH(name), 1);
2766 if (sep == -2)
2767 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002768#ifdef ALTSEP
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002769 altsep = PyUnicode_FindChar(name, ALTSEP, 0, PyUnicode_GET_LENGTH(name), 1);
2770 if (altsep == -2)
2771 return NULL;
2772#else
2773 altsep = -1;
Christian Heimes454f37b2008-01-10 00:10:02 +00002774#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002775 if (sep != -1 || altsep != -1)
2776 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002777 PyErr_SetString(PyExc_ImportError,
2778 "Import by filename is not supported.");
2779 return NULL;
2780 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002781
Victor Stinner974389d2011-03-15 09:33:57 +01002782 parent = get_parent(globals, &parent_name, level);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002783 if (parent == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002784 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002785 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002786
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002787 if (PyUnicode_READY(parent_name))
2788 return NULL;
2789 buflen = PyUnicode_GET_LENGTH(parent_name);
Georg Brandl4cb0de22011-09-28 21:49:49 +02002790 if (!PyUnicode_AsUCS4(parent_name, buf, Py_ARRAY_LENGTH(buf), 1)) {
Victor Stinner974389d2011-03-15 09:33:57 +01002791 Py_DECREF(parent_name);
2792 PyErr_SetString(PyExc_ValueError,
2793 "Module name too long");
2794 return NULL;
2795 }
Victor Stinner974389d2011-03-15 09:33:57 +01002796 Py_DECREF(parent_name);
2797
2798 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
2799 buf, &buflen, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002800 if (head == NULL)
2801 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002802
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002803 tail = head;
2804 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002805
2806 if (outputname != NULL) {
2807 while (1) {
2808 inputname = outputname;
2809 next = load_next(tail, tail, inputname, &outputname,
2810 buf, &buflen, bufsize);
2811 Py_DECREF(tail);
2812 Py_DECREF(inputname);
2813 if (next == NULL) {
2814 Py_DECREF(head);
2815 return NULL;
2816 }
2817 tail = next;
2818
2819 if (outputname == NULL) {
2820 break;
2821 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002822 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002823 }
2824 if (tail == Py_None) {
2825 /* If tail is Py_None, both get_parent and load_next found
2826 an empty module name: someone called __import__("") or
2827 doctored faulty bytecode */
2828 Py_DECREF(tail);
2829 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002830 PyErr_SetString(PyExc_ValueError, "Empty module name");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002831 return NULL;
2832 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002833
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002834 if (fromlist != NULL) {
2835 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2836 fromlist = NULL;
2837 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002838
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002839 if (fromlist == NULL) {
2840 Py_DECREF(tail);
2841 return head;
2842 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002843
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002844 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002845
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002846 ensure_name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
2847 buf, Py_UCS4_strlen(buf));
Victor Stinner974389d2011-03-15 09:33:57 +01002848 if (ensure_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002849 Py_DECREF(tail);
2850 return NULL;
2851 }
Victor Stinner974389d2011-03-15 09:33:57 +01002852 if (!ensure_fromlist(tail, fromlist, ensure_name, 0)) {
2853 Py_DECREF(tail);
2854 Py_DECREF(ensure_name);
2855 return NULL;
2856 }
2857 Py_DECREF(ensure_name);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002858
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002859 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002860}
2861
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002862PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002863PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2864 PyObject *locals, PyObject *fromlist,
2865 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002866{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002867 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002868 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002869 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002870 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002871 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002872 PyErr_SetString(PyExc_RuntimeError,
2873 "not holding the import lock");
2874 return NULL;
2875 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002876 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002877}
2878
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002879PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05002880PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002881 PyObject *fromlist, int level)
2882{
2883 PyObject *nameobj, *mod;
2884 nameobj = PyUnicode_FromString(name);
2885 if (nameobj == NULL)
2886 return NULL;
2887 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2888 fromlist, level);
2889 Py_DECREF(nameobj);
2890 return mod;
2891}
2892
2893
Fred Drake87590902004-05-28 20:21:36 +00002894/* Return the package that an import is being performed in. If globals comes
2895 from the module foo.bar.bat (not itself a package), this returns the
2896 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002897 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002898
Victor Stinner974389d2011-03-15 09:33:57 +01002899 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002900
2901 If globals doesn't come from a package or a module in a package, or a
2902 corresponding entry is not found in sys.modules, Py_None is returned.
2903*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002904static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002905get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002906{
Victor Stinner974389d2011-03-15 09:33:57 +01002907 PyObject *nameobj;
2908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002909 static PyObject *namestr = NULL;
2910 static PyObject *pathstr = NULL;
2911 static PyObject *pkgstr = NULL;
2912 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2913 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002914
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002915 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002916 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002918 if (namestr == NULL) {
2919 namestr = PyUnicode_InternFromString("__name__");
2920 if (namestr == NULL)
2921 return NULL;
2922 }
2923 if (pathstr == NULL) {
2924 pathstr = PyUnicode_InternFromString("__path__");
2925 if (pathstr == NULL)
2926 return NULL;
2927 }
2928 if (pkgstr == NULL) {
2929 pkgstr = PyUnicode_InternFromString("__package__");
2930 if (pkgstr == NULL)
2931 return NULL;
2932 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002933
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002934 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002935
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002936 if ((pkgname != NULL) && (pkgname != Py_None)) {
2937 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002938 if (!PyUnicode_Check(pkgname)) {
2939 PyErr_SetString(PyExc_ValueError,
2940 "__package__ set to non-string");
2941 return NULL;
2942 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002943 if (PyUnicode_GET_LENGTH(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002944 if (level > 0) {
2945 PyErr_SetString(PyExc_ValueError,
2946 "Attempted relative import in non-package");
2947 return NULL;
2948 }
Victor Stinner974389d2011-03-15 09:33:57 +01002949 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002950 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002951 Py_INCREF(pkgname);
2952 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002953 } else {
2954 /* __package__ not set, so figure it out and set it */
2955 modname = PyDict_GetItem(globals, namestr);
2956 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002957 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002958
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002959 modpath = PyDict_GetItem(globals, pathstr);
2960 if (modpath != NULL) {
2961 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002962 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002963
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002964 error = PyDict_SetItem(globals, pkgstr, modname);
2965 if (error) {
2966 PyErr_SetString(PyExc_ValueError,
2967 "Could not set __package__");
2968 return NULL;
2969 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002970 Py_INCREF(modname);
2971 nameobj = modname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002972 } else {
2973 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002974 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002975 len = PyUnicode_FindChar(modname, '.',
2976 0, PyUnicode_GET_LENGTH(modname), -1);
2977 if (len == -2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002978 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002979 if (len < 0) {
2980 if (level > 0) {
2981 PyErr_SetString(PyExc_ValueError,
2982 "Attempted relative import in non-package");
2983 return NULL;
2984 }
2985 if (PyDict_SetItem(globals, pkgstr, Py_None)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002986 PyErr_SetString(PyExc_ValueError,
2987 "Could not set __package__");
2988 return NULL;
2989 }
Victor Stinner974389d2011-03-15 09:33:57 +01002990 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002991 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002992 pkgname = PyUnicode_Substring(modname, 0, len);
2993 if (pkgname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002994 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002995 if (PyDict_SetItem(globals, pkgstr, pkgname)) {
2996 Py_DECREF(pkgname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002997 PyErr_SetString(PyExc_ValueError,
2998 "Could not set __package__");
2999 return NULL;
3000 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003001 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003002 }
3003 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003004 if (level > 1) {
3005 Py_ssize_t dot, end = PyUnicode_GET_LENGTH(nameobj);
3006 PyObject *newname;
3007 while (--level > 0) {
3008 dot = PyUnicode_FindChar(nameobj, '.', 0, end, -1);
3009 if (dot == -2) {
3010 Py_DECREF(nameobj);
3011 return NULL;
3012 }
3013 if (dot < 0) {
3014 Py_DECREF(nameobj);
3015 PyErr_SetString(PyExc_ValueError,
3016 "Attempted relative import beyond "
3017 "toplevel package");
3018 return NULL;
3019 }
3020 end = dot;
3021 }
3022 newname = PyUnicode_Substring(nameobj, 0, end);
3023 Py_DECREF(nameobj);
3024 if (newname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003025 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003026 nameobj = newname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003027 }
Victor Stinner974389d2011-03-15 09:33:57 +01003028
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003029 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003030 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003031 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003032 int err;
3033
3034 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003035 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01003036 "Parent module %R not loaded, "
3037 "cannot perform relative import", nameobj);
3038 Py_DECREF(nameobj);
3039 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003040 }
Victor Stinner974389d2011-03-15 09:33:57 +01003041
3042 err = PyErr_WarnFormat(
3043 PyExc_RuntimeWarning, 1,
3044 "Parent module %R not found while handling absolute import",
3045 nameobj);
3046 Py_DECREF(nameobj);
3047 if (err)
3048 return NULL;
3049
3050 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003051 }
Victor Stinner974389d2011-03-15 09:33:57 +01003052 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003053 return parent;
3054 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01003055 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003056 - parent.__dict__ is globals
3057 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01003058
3059return_none:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003060 nameobj = PyUnicode_New(0, 0);
Victor Stinner974389d2011-03-15 09:33:57 +01003061 if (nameobj == NULL)
3062 return NULL;
3063 *p_name = nameobj;
3064 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003065}
3066
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003067/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003068static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003069load_next(PyObject *mod, PyObject *altmod,
3070 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003071 Py_UCS4 *buf, Py_ssize_t *p_buflen, Py_ssize_t bufsize)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003072{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003073 Py_UCS4 *dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003074 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003075 Py_UCS4 *p;
Victor Stinner974389d2011-03-15 09:33:57 +01003076 PyObject *fullname, *name, *result, *mark_name;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003077 const Py_UCS4 *nameuni;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003078
Victor Stinner974389d2011-03-15 09:33:57 +01003079 *p_outputname = NULL;
3080
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003081 if (PyUnicode_GET_LENGTH(inputname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003082 /* completely empty module name should only happen in
3083 'from . import' (or '__import__("")')*/
3084 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003085 return mod;
3086 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00003087
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003088 nameuni = PyUnicode_AsUCS4Copy(inputname);
Victor Stinner974389d2011-03-15 09:33:57 +01003089 if (nameuni == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003090 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003091
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003092 dot = Py_UCS4_strchr(nameuni, '.');
Victor Stinner974389d2011-03-15 09:33:57 +01003093 if (dot != NULL) {
3094 len = dot - nameuni;
3095 if (len == 0) {
3096 PyErr_SetString(PyExc_ValueError,
3097 "Empty module name");
3098 return NULL;
3099 }
3100 }
3101 else
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003102 len = PyUnicode_GET_LENGTH(inputname);
Victor Stinner974389d2011-03-15 09:33:57 +01003103
3104 if (*p_buflen+len+1 >= bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003105 PyErr_SetString(PyExc_ValueError,
3106 "Module name too long");
3107 return NULL;
3108 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003109
Victor Stinner974389d2011-03-15 09:33:57 +01003110 p = buf + *p_buflen;
3111 if (p != buf) {
3112 *p++ = '.';
3113 *p_buflen += 1;
3114 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003115 Py_UCS4_strncpy(p, nameuni, len);
Victor Stinner974389d2011-03-15 09:33:57 +01003116 p[len] = '\0';
3117 *p_buflen += len;
3118
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003119 fullname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3120 buf, *p_buflen);
Victor Stinner974389d2011-03-15 09:33:57 +01003121 if (fullname == NULL)
3122 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003123 name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3124 p, len);
Victor Stinner974389d2011-03-15 09:33:57 +01003125 if (name == NULL) {
3126 Py_DECREF(fullname);
3127 return NULL;
3128 }
3129 result = import_submodule(mod, name, fullname);
3130 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003131 if (result == Py_None && altmod != mod) {
3132 Py_DECREF(result);
3133 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003134 result = import_submodule(altmod, name, name);
3135 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003136 if (result != NULL && result != Py_None) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003137 mark_name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3138 buf, *p_buflen);
Victor Stinner974389d2011-03-15 09:33:57 +01003139 if (mark_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003140 Py_DECREF(result);
3141 return NULL;
3142 }
Victor Stinner974389d2011-03-15 09:33:57 +01003143 if (mark_miss(mark_name) != 0) {
3144 Py_DECREF(result);
3145 Py_DECREF(mark_name);
3146 return NULL;
3147 }
3148 Py_DECREF(mark_name);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003149 Py_UCS4_strncpy(buf, nameuni, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003150 buf[len] = '\0';
3151 *p_buflen = len;
3152 }
3153 }
Victor Stinner974389d2011-03-15 09:33:57 +01003154 else
3155 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003156 if (result == NULL)
3157 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003158
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003159 if (result == Py_None) {
3160 Py_DECREF(result);
3161 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003162 "No module named %R", inputname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003163 return NULL;
3164 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003165
Victor Stinner974389d2011-03-15 09:33:57 +01003166 if (dot != NULL) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003167 *p_outputname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3168 dot+1, Py_UCS4_strlen(dot+1));
Victor Stinner974389d2011-03-15 09:33:57 +01003169 if (*p_outputname == NULL) {
3170 Py_DECREF(result);
3171 return NULL;
3172 }
3173 }
3174
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003175 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003176}
3177
3178static int
Victor Stinner974389d2011-03-15 09:33:57 +01003179mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003180{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003181 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003182 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003183}
3184
3185static int
Victor Stinner974389d2011-03-15 09:33:57 +01003186ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003187 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003188{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003189 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003190 PyObject *fullname;
3191 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003193 if (!PyObject_HasAttrString(mod, "__path__"))
3194 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003195
Victor Stinner974389d2011-03-15 09:33:57 +01003196 fromlist_len = PySequence_Size(fromlist);
3197
3198 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003199 PyObject *item = PySequence_GetItem(fromlist, i);
3200 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003201 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003202 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003203 if (!PyUnicode_Check(item)) {
3204 PyErr_SetString(PyExc_TypeError,
3205 "Item in ``from list'' not a string");
3206 Py_DECREF(item);
3207 return 0;
3208 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003209 if (PyUnicode_READ_CHAR(item, 0) == '*') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003210 PyObject *all;
3211 Py_DECREF(item);
3212 /* See if the package defines __all__ */
3213 if (recursive)
3214 continue; /* Avoid endless recursion */
3215 all = PyObject_GetAttrString(mod, "__all__");
3216 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 {
Victor Stinner533d7832011-03-14 13:22:54 -04003303 path_list = PyObject_GetAttrString(mod, "__path__");
3304 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);
Victor Stinner533d7832011-03-14 13:22:54 -04003414 path_list = PyObject_GetAttrString(parent, "__path__");
3415 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öwisd63a3b82011-09-28 07:41:54 +02003960 cpathname = make_compiled_pathname(pathname, debug);
Victor Stinner2f42ae52011-03-20 00:41:24 +01003961 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003962
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003963 if (cpathname == NULL) {
3964 PyErr_Format(PyExc_SystemError, "path buffer too short");
3965 return NULL;
3966 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003967 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003968}
3969
3970PyDoc_STRVAR(doc_cache_from_source,
3971"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3972\n\
3973The .py file does not need to exist; this simply returns the path to the\n\
3974.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3975will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3976\n\
3977If debug_override is not None, then it must be a boolean and is taken as\n\
3978the value of __debug__ instead.");
3979
3980static PyObject *
3981imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3982{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003983 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003984 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003985
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003986 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003987 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003988 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003989 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003990
Victor Stinnerc9abda02011-03-14 13:33:46 -04003991 source = make_source_pathname(pathname);
3992 if (source == NULL) {
3993 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003994 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003995 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003996 return NULL;
3997 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003998 Py_DECREF(pathname);
3999 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00004000}
4001
4002PyDoc_STRVAR(doc_source_from_cache,
4003"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
4004\n\
4005The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
4006the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
4007does not conform to PEP 3147 format, ValueError will be raised.");
4008
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004009/* Doc strings */
4010
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004011PyDoc_STRVAR(doc_imp,
4012"This module provides the components needed to build your own\n\
4013__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004014
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004015PyDoc_STRVAR(doc_find_module,
4016"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004017Search for a module. If path is omitted or None, search for a\n\
4018built-in, frozen or special module and continue search in sys.path.\n\
4019The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004020package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004021
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004022PyDoc_STRVAR(doc_load_module,
4023"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004024Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004025The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004026
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004027PyDoc_STRVAR(doc_get_magic,
4028"get_magic() -> string\n\
4029Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004030
Barry Warsaw28a691b2010-04-17 00:19:56 +00004031PyDoc_STRVAR(doc_get_tag,
4032"get_tag() -> string\n\
4033Return the magic tag for .pyc or .pyo files.");
4034
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004035PyDoc_STRVAR(doc_get_suffixes,
4036"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004037Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004038that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004039
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004040PyDoc_STRVAR(doc_new_module,
4041"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004042Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004043The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004044
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004045PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00004046"lock_held() -> boolean\n\
4047Return True if the import lock is currently held, else False.\n\
4048On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00004049
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004050PyDoc_STRVAR(doc_acquire_lock,
4051"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00004052Acquires the interpreter's import lock for the current thread.\n\
4053This lock should be used by import hooks to ensure thread-safety\n\
4054when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004055On platforms without threads, this function does nothing.");
4056
4057PyDoc_STRVAR(doc_release_lock,
4058"release_lock() -> None\n\
4059Release the interpreter's import lock.\n\
4060On platforms without threads, this function does nothing.");
4061
Guido van Rossum79f25d91997-04-29 20:08:16 +00004062static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004063 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
4064 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
4065 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
4066 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
4067 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
4068 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
4069 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
4070 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
4071 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
4072 {"reload", imp_reload, METH_O, doc_reload},
4073 {"cache_from_source", (PyCFunction)imp_cache_from_source,
4074 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
4075 {"source_from_cache", (PyCFunction)imp_source_from_cache,
4076 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
4077 /* The rest are obsolete */
4078 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
4079 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
4080 {"init_builtin", imp_init_builtin, METH_VARARGS},
4081 {"init_frozen", imp_init_frozen, METH_VARARGS},
4082 {"is_builtin", imp_is_builtin, METH_VARARGS},
4083 {"is_frozen", imp_is_frozen, METH_VARARGS},
4084 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004085#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004086 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004087#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004088 {"load_package", imp_load_package, METH_VARARGS},
4089 {"load_source", imp_load_source, METH_VARARGS},
Brett Cannon442c9b92011-03-23 16:14:42 -07004090 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004091 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004092};
4093
Guido van Rossum1a8791e1998-08-04 22:46:29 +00004094static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004095setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004096{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004097 PyObject *v;
4098 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004099
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004100 v = PyLong_FromLong((long)value);
4101 err = PyDict_SetItemString(d, name, v);
4102 Py_XDECREF(v);
4103 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004104}
4105
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004106typedef struct {
4107 PyObject_HEAD
4108} NullImporter;
4109
4110static int
4111NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4112{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004113#ifndef MS_WINDOWS
4114 PyObject *path;
4115 struct stat statbuf;
4116 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004117
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004118 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4119 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004120
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004121 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4122 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004123 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004124
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004125 if (PyBytes_GET_SIZE(path) == 0) {
4126 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004127 PyErr_SetString(PyExc_ImportError, "empty pathname");
4128 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004129 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004130
4131 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4132 Py_DECREF(path);
4133 if (rv == 0) {
4134 /* it exists */
4135 if (S_ISDIR(statbuf.st_mode)) {
4136 /* it's a directory */
4137 PyErr_SetString(PyExc_ImportError, "existing directory");
4138 return -1;
4139 }
4140 }
4141#else /* MS_WINDOWS */
4142 PyObject *pathobj;
4143 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004144 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004145
4146 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4147 return -1;
4148
4149 if (!PyArg_ParseTuple(args, "U:NullImporter",
4150 &pathobj))
4151 return -1;
4152
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02004153 if (PyUnicode_GET_LENGTH(pathobj) == 0) {
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004154 PyErr_SetString(PyExc_ImportError, "empty pathname");
4155 return -1;
4156 }
4157
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004158 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004159 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004160 return -1;
4161 /* see issue1293 and issue3677:
4162 * stat() on Windows doesn't recognise paths like
4163 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4164 */
4165 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004166 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004167 if (rv != INVALID_FILE_ATTRIBUTES) {
4168 /* it exists */
4169 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4170 /* it's a directory */
4171 PyErr_SetString(PyExc_ImportError, "existing directory");
4172 return -1;
4173 }
4174 }
4175#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004176 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004177}
4178
4179static PyObject *
4180NullImporter_find_module(NullImporter *self, PyObject *args)
4181{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004182 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004183}
4184
4185static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004186 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4187 "Always return None"
4188 },
4189 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004190};
4191
4192
Christian Heimes9cd17752007-11-18 19:35:23 +00004193PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004194 PyVarObject_HEAD_INIT(NULL, 0)
4195 "imp.NullImporter", /*tp_name*/
4196 sizeof(NullImporter), /*tp_basicsize*/
4197 0, /*tp_itemsize*/
4198 0, /*tp_dealloc*/
4199 0, /*tp_print*/
4200 0, /*tp_getattr*/
4201 0, /*tp_setattr*/
4202 0, /*tp_reserved*/
4203 0, /*tp_repr*/
4204 0, /*tp_as_number*/
4205 0, /*tp_as_sequence*/
4206 0, /*tp_as_mapping*/
4207 0, /*tp_hash */
4208 0, /*tp_call*/
4209 0, /*tp_str*/
4210 0, /*tp_getattro*/
4211 0, /*tp_setattro*/
4212 0, /*tp_as_buffer*/
4213 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4214 "Null importer object", /* tp_doc */
4215 0, /* tp_traverse */
4216 0, /* tp_clear */
4217 0, /* tp_richcompare */
4218 0, /* tp_weaklistoffset */
4219 0, /* tp_iter */
4220 0, /* tp_iternext */
4221 NullImporter_methods, /* tp_methods */
4222 0, /* tp_members */
4223 0, /* tp_getset */
4224 0, /* tp_base */
4225 0, /* tp_dict */
4226 0, /* tp_descr_get */
4227 0, /* tp_descr_set */
4228 0, /* tp_dictoffset */
4229 (initproc)NullImporter_init, /* tp_init */
4230 0, /* tp_alloc */
4231 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004232};
4233
Martin v. Löwis1a214512008-06-11 05:26:20 +00004234static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004235 PyModuleDef_HEAD_INIT,
4236 "imp",
4237 doc_imp,
4238 0,
4239 imp_methods,
4240 NULL,
4241 NULL,
4242 NULL,
4243 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004244};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004245
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004246PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004247PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004248{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004249 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004250
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004251 if (PyType_Ready(&PyNullImporter_Type) < 0)
4252 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004253
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004254 m = PyModule_Create(&impmodule);
4255 if (m == NULL)
4256 goto failure;
4257 d = PyModule_GetDict(m);
4258 if (d == NULL)
4259 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004260
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004261 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4262 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4263 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4264 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4265 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4266 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4267 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4268 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4269 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4270 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004271
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004272 Py_INCREF(&PyNullImporter_Type);
4273 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4274 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004275 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004276 Py_XDECREF(m);
4277 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004278}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004279
4280
Guido van Rossumb18618d2000-05-03 23:44:39 +00004281/* API for embedding applications that want to add their own entries
4282 to the table of built-in modules. This should normally be called
4283 *before* Py_Initialize(). When the table resize fails, -1 is
4284 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004285
4286 After a similar function by Just van Rossum. */
4287
4288int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004289PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004290{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004291 static struct _inittab *our_copy = NULL;
4292 struct _inittab *p;
4293 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004294
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004295 /* Count the number of entries in both tables */
4296 for (n = 0; newtab[n].name != NULL; n++)
4297 ;
4298 if (n == 0)
4299 return 0; /* Nothing to do */
4300 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4301 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004302
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004303 /* Allocate new memory for the combined table */
4304 p = our_copy;
4305 PyMem_RESIZE(p, struct _inittab, i+n+1);
4306 if (p == NULL)
4307 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004308
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004309 /* Copy the tables into the new memory */
4310 if (our_copy != PyImport_Inittab)
4311 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4312 PyImport_Inittab = our_copy = p;
4313 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004314
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004315 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004316}
4317
4318/* Shorthand to add a single entry given a name and a function */
4319
4320int
Brett Cannona826f322009-04-02 03:41:46 +00004321PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004322{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004323 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004324
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004325 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004326
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004327 newtab[0].name = (char *)name;
4328 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004329
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004330 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004331}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004332
4333#ifdef __cplusplus
4334}
4335#endif