blob: 9f094c0da08bf04593d52ca55724cf4523788e5b [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
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001567 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode)) {
1568 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001569 return py;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001570 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001571 Py_DECREF(py);
1572 goto unchanged;
1573
1574error:
1575 PyErr_Clear();
1576unchanged:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001577 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001578 Py_INCREF(filename);
1579 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001580}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001581
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001582/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001583static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001584static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001585 PyObject **, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001586static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001587
1588/* Load a package and return its module object WITH INCREMENTED
1589 REFERENCE COUNT */
1590
1591static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001592load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001593{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001594 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001595 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 int err;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001597 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001598 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001599
Victor Stinnerc9abda02011-03-14 13:33:46 -04001600 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001601 if (m == NULL)
1602 return NULL;
1603 if (Py_VerboseFlag)
Victor Stinner98dbba52011-03-14 15:15:47 -04001604 PySys_FormatStderr("import %U # directory %R\n",
1605 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001606 file = get_sourcefile(pathname);
1607 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001608 return NULL;
1609 path_list = Py_BuildValue("[O]", file);
1610 if (path_list == NULL) {
1611 Py_DECREF(file);
1612 return NULL;
1613 }
1614 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001616 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001617 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001618 err = PyDict_SetItemString(d, "__path__", path_list);
1619 if (err != 0) {
1620 Py_DECREF(path_list);
1621 return NULL;
1622 }
Victor Stinner533d7832011-03-14 13:22:54 -04001623 fdp = find_module(name, initstr, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001624 &bufobj, &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001625 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001626 if (fdp == NULL) {
1627 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1628 PyErr_Clear();
1629 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001630 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001631 }
1632 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001633 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001634 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001635 m = load_module(name, fp, bufobj, fdp->type, NULL);
1636 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001637 if (fp != NULL)
1638 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001639 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001640}
1641
1642
1643/* Helper to test for built-in module */
1644
1645static int
Victor Stinner95872862011-03-07 18:20:56 +01001646is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001647{
Victor Stinner95872862011-03-07 18:20:56 +01001648 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001649 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001650 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1651 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001652 if (PyImport_Inittab[i].initfunc == NULL)
1653 return -1;
1654 else
1655 return 1;
1656 }
1657 }
1658 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001659}
1660
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001661
Just van Rossum52e14d62002-12-30 22:08:05 +00001662/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1663 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001664 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001665 that can handle the path item. Return None if no hook could;
1666 this tells our caller it should fall back to the builtin
1667 import mechanism. Cache the result in path_importer_cache.
1668 Returns a borrowed reference. */
1669
1670static PyObject *
1671get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001672 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001673{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001674 PyObject *importer;
1675 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001676
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 /* These conditions are the caller's responsibility: */
1678 assert(PyList_Check(path_hooks));
1679 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001680
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001681 nhooks = PyList_Size(path_hooks);
1682 if (nhooks < 0)
1683 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001684
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 importer = PyDict_GetItem(path_importer_cache, p);
1686 if (importer != NULL)
1687 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001688
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001689 /* set path_importer_cache[p] to None to avoid recursion */
1690 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1691 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001693 for (j = 0; j < nhooks; j++) {
1694 PyObject *hook = PyList_GetItem(path_hooks, j);
1695 if (hook == NULL)
1696 return NULL;
1697 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1698 if (importer != NULL)
1699 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001700
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001701 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1702 return NULL;
1703 }
1704 PyErr_Clear();
1705 }
1706 if (importer == NULL) {
1707 importer = PyObject_CallFunctionObjArgs(
1708 (PyObject *)&PyNullImporter_Type, p, NULL
1709 );
1710 if (importer == NULL) {
1711 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1712 PyErr_Clear();
1713 return Py_None;
1714 }
1715 }
1716 }
1717 if (importer != NULL) {
1718 int err = PyDict_SetItem(path_importer_cache, p, importer);
1719 Py_DECREF(importer);
1720 if (err != 0)
1721 return NULL;
1722 }
1723 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001724}
1725
Christian Heimes9cd17752007-11-18 19:35:23 +00001726PyAPI_FUNC(PyObject *)
1727PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001728 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001729
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001730 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1731 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1732 importer = get_path_importer(path_importer_cache,
1733 path_hooks, path);
1734 }
1735 }
1736 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1737 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001738}
1739
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001740/* Search the path (default sys.path) for a module. Return the
1741 corresponding filedescr struct, and (via return arguments) the
1742 pathname and an open file. Return NULL if the module is not found. */
1743
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001744#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001745extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1746 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001747#endif
1748
Victor Stinner547a2a62011-03-20 03:07:28 +01001749/* Forward */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001750static int case_ok(PyObject *, Py_ssize_t, PyObject *);
Victor Stinner547a2a62011-03-20 03:07:28 +01001751static int find_init_module(PyObject *);
Just van Rossum52e14d62002-12-30 22:08:05 +00001752static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001753
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001754/* Get the path of a module: get its importer and call importer.find_module()
1755 hook, or check if the module if a package (if path/__init__.py exists).
1756
1757 -1: error: a Python error occurred
1758 0: ignore: an error occurred because of invalid data, but the error is not
1759 important enough to be reported.
1760 1: get path: module not found, but *buf contains its path
1761 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1762 and *buf is the path */
1763
1764static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001765find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001766 PyObject *path_hooks, PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001767 PyObject **p_path, PyObject **p_loader, struct filedescr **p_fd)
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001768{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001769 Py_UCS4 buf[MAXPATHLEN+1];
Victor Stinner2fd76e42011-03-14 15:19:39 -04001770 PyObject *path_unicode, *filename;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001771 Py_ssize_t len;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001772 struct stat statbuf;
1773 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1774
1775 if (PyUnicode_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001776 Py_INCREF(path);
1777 path_unicode = path;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001778 }
1779 else if (PyBytes_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001780 path_unicode = PyUnicode_DecodeFSDefaultAndSize(
1781 PyBytes_AS_STRING(path), PyBytes_GET_SIZE(path));
1782 if (path_unicode == NULL)
1783 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001784 }
1785 else
1786 return 0;
1787
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001788 len = PyUnicode_GET_LENGTH(path_unicode);
Georg Brandl4cb0de22011-09-28 21:49:49 +02001789 if (!PyUnicode_AsUCS4(path_unicode, buf, Py_ARRAY_LENGTH(buf), 1)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001790 Py_DECREF(path_unicode);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001791 PyErr_Clear();
1792 return 0;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001793 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001794 Py_DECREF(path_unicode);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001795
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001796 if (Py_UCS4_strlen(buf) != len)
Victor Stinner2fd76e42011-03-14 15:19:39 -04001797 return 0; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001798
1799 /* sys.path_hooks import hook */
1800 if (p_loader != NULL) {
1801 PyObject *importer;
1802
1803 importer = get_path_importer(path_importer_cache,
1804 path_hooks, path);
1805 if (importer == NULL) {
1806 return -1;
1807 }
1808 /* Note: importer is a borrowed reference */
1809 if (importer != Py_None) {
1810 PyObject *loader;
1811 loader = PyObject_CallMethod(importer,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001812 "find_module", "O", fullname);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001813 if (loader == NULL)
1814 return -1; /* error */
1815 if (loader != Py_None) {
1816 /* a loader was found */
1817 *p_loader = loader;
1818 *p_fd = &importhookdescr;
1819 return 2;
1820 }
1821 Py_DECREF(loader);
1822 return 0;
1823 }
1824 }
1825 /* no hook was found, use builtin import */
1826
1827 if (len > 0 && buf[len-1] != SEP
1828#ifdef ALTSEP
1829 && buf[len-1] != ALTSEP
1830#endif
1831 )
1832 buf[len++] = SEP;
Georg Brandl4cb0de22011-09-28 21:49:49 +02001833 if (!PyUnicode_AsUCS4(name, buf+len, Py_ARRAY_LENGTH(buf)-len, 1)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001834 PyErr_Clear();
1835 return 0;
1836 }
1837 len += PyUnicode_GET_LENGTH(name);
Victor Stinner2fd76e42011-03-14 15:19:39 -04001838
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001839 filename = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
1840 buf, len);
Victor Stinner2fd76e42011-03-14 15:19:39 -04001841 if (filename == NULL)
1842 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001843
1844 /* Check for package import (buf holds a directory name,
1845 and there's an __init__ module in that directory */
1846#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001847 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001848 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1849 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001850 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001851
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001852 match = case_ok(filename, 0, name);
1853 if (match < 0) {
1854 Py_DECREF(filename);
1855 return -1;
1856 }
1857 if (match) { /* case matches */
1858 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001859 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001860 *p_fd = &fd_package;
1861 return 2;
1862 }
1863 else {
1864 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001865 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001866 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001867 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001868 if (err) {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001869 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001870 return -1;
Victor Stinner547a2a62011-03-20 03:07:28 +01001871 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001872 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001873 }
1874 }
1875#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001876 *p_path = filename;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001877 return 1;
1878}
1879
1880/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001881 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001882
1883 If the module is found, return a file descriptor, write the path in
1884 *p_filename, write the pointer to the file object into *p_fp, and (if
1885 p_loader is not NULL) the loader into *p_loader.
1886
1887 Otherwise, raise an exception and return NULL. */
1888
Victor Stinner37580282011-03-20 01:34:43 +01001889static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001890find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001891 PyObject *search_path_list, PyObject *path_hooks,
1892 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001893 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001894{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001895 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001896 struct filedescr *fdp = NULL;
1897 char *filemode;
1898 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001899 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001900 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001901
Victor Stinner37580282011-03-20 01:34:43 +01001902 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001903 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001904 PyObject *path;
1905 int ok;
1906
1907 path = PyList_GetItem(search_path_list, i);
1908 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001909 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001910
Victor Stinner2fd76e42011-03-14 15:19:39 -04001911 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001912 ok = find_module_path(fullname, name, path,
1913 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001914 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001915 if (ok < 0)
1916 return NULL;
1917 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001918 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001919 if (ok == 2) {
1920 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001921 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001922 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001923
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001924 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001925 struct stat statbuf;
1926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001927 filemode = fdp->mode;
1928 if (filemode[0] == 'U')
1929 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001930
Victor Stinner2fd76e42011-03-14 15:19:39 -04001931 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1932 if (filename == NULL) {
1933 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001934 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001935 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001936
1937 if (Py_VerboseFlag > 1)
1938 PySys_FormatStderr("# trying %R\n", filename);
1939
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001940 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
1941 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1942 {
1943 Py_DECREF(filename);
1944 continue;
1945 }
1946
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001947 fp = _Py_fopen(filename, filemode);
1948 if (fp == NULL) {
1949 Py_DECREF(filename);
Victor Stinner925ef392011-06-20 15:01:10 +02001950 if (PyErr_Occurred()) {
1951 Py_DECREF(prefix);
1952 return NULL;
1953 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001954 continue;
1955 }
1956 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1957 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001958 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001959 Py_DECREF(filename);
1960 return NULL;
1961 }
1962 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001963 Py_DECREF(prefix);
1964 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001965 *p_fp = fp;
1966 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001967 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001968 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001969
1970 fclose(fp);
1971 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001972 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001973 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001974 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001975 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04001976 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04001977 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001978}
1979
Victor Stinner37580282011-03-20 01:34:43 +01001980/* Find a module:
1981
1982 - try find_module() of each sys.meta_path hook
1983 - try find_frozen()
1984 - try is_builtin()
1985 - try _PyWin_FindRegisteredModule() (Windows only)
1986 - otherwise, call find_module_path_list() with search_path_list (if not
1987 NULL) or sys.path
1988
Victor Stinner2fd76e42011-03-14 15:19:39 -04001989 fullname can be NULL, but only if p_loader is NULL.
1990
Victor Stinner37580282011-03-20 01:34:43 +01001991 Return:
1992
1993 - &fd_builtin (C_BUILTIN) if it is a builtin
1994 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04001995 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01001996 if it is a package
1997 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1998 importer loader was found
1999 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
2000 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04002001 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01002002 - NULL on error
2003
Victor Stinner2fd76e42011-03-14 15:19:39 -04002004 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
2005 Eg. *p_path is set to NULL for a builtin package.
2006*/
Victor Stinner37580282011-03-20 01:34:43 +01002007
2008static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002009find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002010 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01002011{
2012 Py_ssize_t i, npath;
2013 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
2014 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
2015 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01002016
Victor Stinner2fd76e42011-03-14 15:19:39 -04002017 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01002018 *p_fp = NULL;
2019 if (p_loader != NULL)
2020 *p_loader = NULL;
2021
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002022 if (PyUnicode_GET_LENGTH(name) > MAXPATHLEN) {
2023 PyErr_SetString(PyExc_OverflowError,
2024 "module name is too long");
2025 return NULL;
2026 }
2027
Victor Stinner37580282011-03-20 01:34:43 +01002028 /* sys.meta_path import hook */
2029 if (p_loader != NULL) {
2030 PyObject *meta_path;
2031
2032 meta_path = PySys_GetObject("meta_path");
2033 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02002034 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002035 "sys.meta_path must be a list of "
2036 "import hooks");
2037 return NULL;
2038 }
2039 Py_INCREF(meta_path); /* zap guard */
2040 npath = PyList_Size(meta_path);
2041 for (i = 0; i < npath; i++) {
2042 PyObject *loader;
2043 PyObject *hook = PyList_GetItem(meta_path, i);
2044 loader = PyObject_CallMethod(hook, "find_module",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002045 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01002046 search_path_list != NULL ?
2047 search_path_list : Py_None);
2048 if (loader == NULL) {
2049 Py_DECREF(meta_path);
2050 return NULL; /* true error */
2051 }
2052 if (loader != Py_None) {
2053 /* a loader was found */
2054 *p_loader = loader;
2055 Py_DECREF(meta_path);
2056 return &importhookdescr;
2057 }
2058 Py_DECREF(loader);
2059 }
2060 Py_DECREF(meta_path);
2061 }
2062
Victor Stinnerdf75a022011-03-14 13:40:04 -04002063 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002064 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01002065
2066 if (search_path_list == NULL) {
2067#ifdef MS_COREDLL
2068 FILE *fp;
2069 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01002070#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04002071 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01002072 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01002073#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04002074 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01002075 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01002076 *p_fp = fp;
2077 return fdp;
2078 }
2079 else if (PyErr_Occurred())
2080 return NULL;
2081#endif
Victor Stinner37580282011-03-20 01:34:43 +01002082 search_path_list = PySys_GetObject("path");
2083 }
2084
2085 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
Victor Stinner16191322011-09-15 19:28:05 +02002086 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002087 "sys.path must be a list of directory names");
2088 return NULL;
2089 }
2090
2091 path_hooks = PySys_GetObject("path_hooks");
2092 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02002093 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002094 "sys.path_hooks must be a list of "
2095 "import hooks");
2096 return NULL;
2097 }
2098 path_importer_cache = PySys_GetObject("path_importer_cache");
2099 if (path_importer_cache == NULL ||
2100 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02002101 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002102 "sys.path_importer_cache must be a dict");
2103 return NULL;
2104 }
2105
2106 return find_module_path_list(fullname, name,
2107 search_path_list, path_hooks,
2108 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002109 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002110}
2111
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002112/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002113 * The arguments here are tricky, best shown by example:
2114 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2115 * ^ ^ ^ ^
2116 * |--------------------- buf ---------------------|
2117 * |------------------- len ------------------|
2118 * |------ name -------|
2119 * |----- namelen -----|
2120 * buf is the full path, but len only counts up to (& exclusive of) the
2121 * extension. name is the module name, also exclusive of extension.
2122 *
2123 * We've already done a successful stat() or fopen() on buf, so know that
2124 * there's some match, possibly case-insensitive.
2125 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002126 * case_bytes() is to return 1 if there's a case-sensitive match for
2127 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002128 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002129 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002130 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002131 * on platforms with case-insensitive filesystems. It's trivial to implement
2132 * for case-sensitive filesystems. It's pretty much a cross-platform
2133 * nightmare for systems with case-insensitive filesystems.
2134 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002135
Tim Peters50d8d372001-02-28 05:34:27 +00002136/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002137 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002138 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002139#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002140#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002141
Tim Peters50d8d372001-02-28 05:34:27 +00002142#elif defined(DJGPP)
2143#include <dir.h>
2144
Jason Tishler7961aa62005-05-20 00:56:54 +00002145#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002146#include <sys/types.h>
2147#include <dirent.h>
2148
Andrew MacIntyred9400542002-02-26 11:41:34 +00002149#elif defined(PYOS_OS2)
2150#define INCL_DOS
2151#define INCL_DOSERRORS
2152#define INCL_NOPMAPI
2153#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002154#endif
2155
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002156#if defined(DJGPP) \
2157 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2158 && defined(HAVE_DIRENT_H)) \
2159 || defined(PYOS_OS2)
2160# define USE_CASE_OK_BYTES
2161#endif
2162
2163
2164#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002165static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002166case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002167{
Tim Peters50d8d372001-02-28 05:34:27 +00002168/* Pick a platform-specific implementation; the sequence of #if's here should
2169 * match the sequence just above.
2170 */
2171
Tim Peters50d8d372001-02-28 05:34:27 +00002172/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002173#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002174 struct ffblk ffblk;
2175 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002176
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002177 if (Py_GETENV("PYTHONCASEOK") != NULL)
2178 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002179
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002180 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2181 if (done) {
2182 PyErr_Format(PyExc_NameError,
2183 "Can't find file for module %.100s\n(filename %.300s)",
2184 name, buf);
Victor Stinner9c61e242011-03-22 01:22:27 +01002185 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002186 }
2187 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002188
Jason Tishler7961aa62005-05-20 00:56:54 +00002189/* new-fangled macintosh (macosx) or Cygwin */
2190#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002191 DIR *dirp;
2192 struct dirent *dp;
2193 char dirname[MAXPATHLEN + 1];
2194 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002195
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002196 if (Py_GETENV("PYTHONCASEOK") != NULL)
2197 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002198
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002199 /* Copy the dir component into dirname; substitute "." if empty */
2200 if (dirlen <= 0) {
2201 dirname[0] = '.';
2202 dirname[1] = '\0';
2203 }
2204 else {
2205 assert(dirlen <= MAXPATHLEN);
2206 memcpy(dirname, buf, dirlen);
2207 dirname[dirlen] = '\0';
2208 }
2209 /* Open the directory and search the entries for an exact match. */
2210 dirp = opendir(dirname);
2211 if (dirp) {
2212 char *nameWithExt = buf + len - namelen;
2213 while ((dp = readdir(dirp)) != NULL) {
2214 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002215#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002216 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002217#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002218 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002219#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002220 if (thislen >= namelen &&
2221 strcmp(dp->d_name, nameWithExt) == 0) {
2222 (void)closedir(dirp);
2223 return 1; /* Found */
2224 }
2225 }
2226 (void)closedir(dirp);
2227 }
2228 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002229
Andrew MacIntyred9400542002-02-26 11:41:34 +00002230/* OS/2 */
2231#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002232 HDIR hdir = 1;
2233 ULONG srchcnt = 1;
2234 FILEFINDBUF3 ffbuf;
2235 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002236
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002237 if (Py_GETENV("PYTHONCASEOK") != NULL)
2238 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002239
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002240 rc = DosFindFirst(buf,
2241 &hdir,
2242 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2243 &ffbuf, sizeof(ffbuf),
2244 &srchcnt,
2245 FIL_STANDARD);
2246 if (rc != NO_ERROR)
2247 return 0;
2248 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002249
Tim Peters50d8d372001-02-28 05:34:27 +00002250/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2251#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002252# error "USE_CASE_OK_BYTES is not correctly defined"
2253#endif
2254}
2255#endif
2256
2257/*
2258 * Check if a filename case matchs the name case. We've already done a
2259 * successful stat() or fopen() on buf, so know that there's some match,
2260 * possibly case-insensitive.
2261 *
2262 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2263 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2264 * if envar PYTHONCASEOK exists.
2265 *
2266 * case_ok() is used to implement case-sensitive import semantics even
2267 * on platforms with case-insensitive filesystems. It's trivial to implement
2268 * for case-sensitive filesystems. It's pretty much a cross-platform
2269 * nightmare for systems with case-insensitive filesystems.
2270 */
2271
2272static int
2273case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2274{
2275#ifdef MS_WINDOWS
2276 WIN32_FIND_DATAW data;
2277 HANDLE h;
2278 int cmp;
2279
2280 if (Py_GETENV("PYTHONCASEOK") != NULL)
2281 return 1;
2282
2283 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2284 if (h == INVALID_HANDLE_VALUE) {
2285 PyErr_Format(PyExc_NameError,
2286 "Can't find file for module %R\n(filename %R)",
2287 name, filename);
2288 return 0;
2289 }
2290 FindClose(h);
2291 cmp = wcsncmp(data.cFileName,
2292 PyUnicode_AS_UNICODE(name),
2293 PyUnicode_GET_SIZE(name));
2294 return cmp == 0;
2295#elif defined(USE_CASE_OK_BYTES)
2296 int match;
2297 PyObject *filebytes, *namebytes;
2298 filebytes = PyUnicode_EncodeFSDefault(filename);
2299 if (filebytes == NULL)
2300 return -1;
2301 namebytes = PyUnicode_EncodeFSDefault(name);
2302 if (namebytes == NULL) {
2303 Py_DECREF(filebytes);
2304 return -1;
2305 }
2306 match = case_bytes(
2307 PyBytes_AS_STRING(filebytes),
2308 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002309 PyBytes_GET_SIZE(namebytes),
2310 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002311 Py_DECREF(filebytes);
2312 Py_DECREF(namebytes);
2313 return match;
2314#else
2315 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002316 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002317
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002318#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002319}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002320
Guido van Rossum197346f1997-10-31 18:38:52 +00002321#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002322
Victor Stinner547a2a62011-03-20 03:07:28 +01002323/* Helper to look for __init__.py or __init__.py[co] in potential package.
2324 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002325static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002326find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002327{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002328 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002329 PyObject *filename;
2330 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002331
Victor Stinner547a2a62011-03-20 03:07:28 +01002332 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2333 if (filename == NULL)
2334 return -1;
2335 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002336 /* 3=len(".py") */
2337 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002338 if (match < 0) {
2339 Py_DECREF(filename);
2340 return -1;
2341 }
2342 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002343 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002344 return 1;
2345 }
2346 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002347 Py_DECREF(filename);
2348
2349 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2350 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2351 if (filename == NULL)
2352 return -1;
2353 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002354 /* 4=len(".pyc") */
2355 match = case_ok(filename, -4, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002356 if (match < 0) {
2357 Py_DECREF(filename);
2358 return -1;
2359 }
2360 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002361 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002362 return 1;
2363 }
2364 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002365 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002366 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002367}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002368
Guido van Rossum197346f1997-10-31 18:38:52 +00002369#endif /* HAVE_STAT */
2370
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002371
Victor Stinner95872862011-03-07 18:20:56 +01002372static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002373
Victor Stinner44c6c152010-08-09 00:59:10 +00002374static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002375load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002376{
2377 PyObject *m, *modules;
2378 int err;
2379
Victor Stinner44c6c152010-08-09 00:59:10 +00002380 if (type == C_BUILTIN)
2381 err = init_builtin(name);
2382 else
Victor Stinner95872862011-03-07 18:20:56 +01002383 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002384 if (err < 0)
2385 return NULL;
2386 if (err == 0) {
2387 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002388 "Purported %s module %R not found",
2389 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002390 name);
2391 return NULL;
2392 }
2393
2394 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002395 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002396 if (m == NULL) {
2397 PyErr_Format(
2398 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002399 "%s module %R not properly initialized",
2400 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002401 name);
2402 return NULL;
2403 }
2404 Py_INCREF(m);
2405 return m;
2406}
2407
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002408/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002409 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002410
Guido van Rossum79f25d91997-04-29 20:08:16 +00002411static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002412load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002413{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002414 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002415
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002416 /* First check that there's an open file (if we need one) */
2417 switch (type) {
2418 case PY_SOURCE:
2419 case PY_COMPILED:
2420 if (fp == NULL) {
2421 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002422 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002423 type);
2424 return NULL;
2425 }
2426 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002428 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002429
Victor Stinner41c5fec2011-03-13 21:46:30 -04002430 case PY_SOURCE:
2431 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002432 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002433
Victor Stinner41c5fec2011-03-13 21:46:30 -04002434 case PY_COMPILED:
2435 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002436 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002437
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002438#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002439 case C_EXTENSION:
2440 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002441 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002442#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002443
Victor Stinner41c5fec2011-03-13 21:46:30 -04002444 case PKG_DIRECTORY:
2445 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002446 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002448 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002449 case PY_FROZEN:
2450 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002451 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002452
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002453 case IMP_HOOK: {
2454 if (loader == NULL) {
2455 PyErr_SetString(PyExc_ImportError,
2456 "import hook without loader");
2457 return NULL;
2458 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04002459 m = PyObject_CallMethod(loader, "load_module", "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002460 break;
2461 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002462
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002463 default:
2464 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002465 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 name, type);
2467 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002471 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002472}
2473
2474
2475/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002476 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002477 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002478
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002479static int
Victor Stinner95872862011-03-07 18:20:56 +01002480init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002481{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002482 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002483
Victor Stinner95872862011-03-07 18:20:56 +01002484 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002485 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002486
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002487 for (p = PyImport_Inittab; p->name != NULL; p++) {
2488 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002489 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002490 if (p->initfunc == NULL) {
2491 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002492 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002493 name);
2494 return -1;
2495 }
2496 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002497 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002498 mod = (*p->initfunc)();
2499 if (mod == 0)
2500 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002501 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002502 return -1;
2503 /* FixupExtension has put the module into sys.modules,
2504 so we can release our own reference. */
2505 Py_DECREF(mod);
2506 return 1;
2507 }
2508 }
2509 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002510}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002511
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002512
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002513/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002514
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002515static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002516find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002517{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002518 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002519
Victor Stinner53dc7352011-03-20 01:50:21 +01002520 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002521 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002522
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002523 for (p = PyImport_FrozenModules; ; p++) {
2524 if (p->name == NULL)
2525 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002526 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002527 break;
2528 }
2529 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002530}
2531
Guido van Rossum79f25d91997-04-29 20:08:16 +00002532static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002533get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002534{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002535 struct _frozen *p = find_frozen(name);
2536 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002538 if (p == NULL) {
2539 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002540 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 name);
2542 return NULL;
2543 }
2544 if (p->code == NULL) {
2545 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002546 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002547 name);
2548 return NULL;
2549 }
2550 size = p->size;
2551 if (size < 0)
2552 size = -size;
2553 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002554}
2555
Brett Cannon8d110132009-03-15 02:20:16 +00002556static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002557is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002558{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002559 struct _frozen *p = find_frozen(name);
2560 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002561
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002562 if (p == NULL) {
2563 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002564 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002565 name);
2566 return NULL;
2567 }
Brett Cannon8d110132009-03-15 02:20:16 +00002568
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002569 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002570
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002571 if (size < 0)
2572 Py_RETURN_TRUE;
2573 else
2574 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002575}
2576
2577
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002578/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002579 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002580 an exception set if the initialization failed.
2581 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002582
2583int
Victor Stinner53dc7352011-03-20 01:50:21 +01002584PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002585{
Victor Stinner53dc7352011-03-20 01:50:21 +01002586 struct _frozen *p;
2587 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002588 int ispackage;
2589 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002590
Victor Stinner53dc7352011-03-20 01:50:21 +01002591 p = find_frozen(name);
2592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002593 if (p == NULL)
2594 return 0;
2595 if (p->code == NULL) {
2596 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002597 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002598 name);
2599 return -1;
2600 }
2601 size = p->size;
2602 ispackage = (size < 0);
2603 if (ispackage)
2604 size = -size;
2605 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002606 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002607 name, ispackage ? " package" : "");
2608 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2609 if (co == NULL)
2610 return -1;
2611 if (!PyCode_Check(co)) {
2612 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002613 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002614 name);
2615 goto err_return;
2616 }
2617 if (ispackage) {
2618 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002619 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002620 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002621 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002622 if (m == NULL)
2623 goto err_return;
2624 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002625 l = PyList_New(1);
2626 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002627 goto err_return;
2628 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002629 Py_INCREF(name);
2630 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002631 err = PyDict_SetItemString(d, "__path__", l);
2632 Py_DECREF(l);
2633 if (err != 0)
2634 goto err_return;
2635 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002636 path = PyUnicode_FromString("<frozen>");
2637 if (path == NULL)
2638 goto err_return;
2639 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2640 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002641 if (m == NULL)
2642 goto err_return;
2643 Py_DECREF(co);
2644 Py_DECREF(m);
2645 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002646err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002647 Py_DECREF(co);
2648 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002649}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002650
Victor Stinner53dc7352011-03-20 01:50:21 +01002651int
2652PyImport_ImportFrozenModule(char *name)
2653{
2654 PyObject *nameobj;
2655 int ret;
2656 nameobj = PyUnicode_InternFromString(name);
2657 if (nameobj == NULL)
2658 return -1;
2659 ret = PyImport_ImportFrozenModuleObject(nameobj);
2660 Py_DECREF(nameobj);
2661 return ret;
2662}
2663
Guido van Rossum74e6a111994-08-29 12:54:38 +00002664
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002665/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002666 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002667
Guido van Rossum79f25d91997-04-29 20:08:16 +00002668PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002669PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002670{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002671 PyObject *pname;
2672 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002674 pname = PyUnicode_FromString(name);
2675 if (pname == NULL)
2676 return NULL;
2677 result = PyImport_Import(pname);
2678 Py_DECREF(pname);
2679 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002680}
2681
Christian Heimes072c0f12008-01-03 23:01:04 +00002682/* Import a module without blocking
2683 *
2684 * At first it tries to fetch the module from sys.modules. If the module was
2685 * never loaded before it loads it with PyImport_ImportModule() unless another
2686 * thread holds the import lock. In the latter case the function raises an
2687 * ImportError instead of blocking.
2688 *
2689 * Returns the module object with incremented ref count.
2690 */
2691PyObject *
2692PyImport_ImportModuleNoBlock(const char *name)
2693{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002694 PyObject *nameobj, *modules, *result;
Victor Stinner0af03062011-09-02 00:11:43 +02002695#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002696 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002697#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002699 /* Try to get the module from sys.modules[name] */
2700 modules = PyImport_GetModuleDict();
2701 if (modules == NULL)
2702 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002703
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002704 nameobj = PyUnicode_FromString(name);
2705 if (nameobj == NULL)
2706 return NULL;
2707 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002708 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002709 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002710 Py_INCREF(result);
2711 return result;
2712 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002713 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002714#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002715 /* check the import lock
2716 * me might be -1 but I ignore the error here, the lock function
2717 * takes care of the problem */
2718 me = PyThread_get_thread_ident();
2719 if (import_lock_thread == -1 || import_lock_thread == me) {
2720 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002721 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002722 }
2723 else {
2724 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002725 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002726 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002727 nameobj);
2728 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002729 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002730#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002731 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002732#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002733 Py_DECREF(nameobj);
2734 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002735}
2736
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002737/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002738static PyObject *get_parent(PyObject *globals,
2739 PyObject **p_name,
2740 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002741static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002742 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002743 Py_UCS4 *buf, Py_ssize_t *p_buflen,
Victor Stinner974389d2011-03-15 09:33:57 +01002744 Py_ssize_t bufsize);
2745static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002746static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002747 PyObject *buf, int recursive);
2748static PyObject * import_submodule(PyObject *mod, PyObject *name,
2749 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002750
2751/* The Magnum Opus of dotted-name import :-) */
2752
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002753static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002754import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002755 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002756{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002757 Py_UCS4 buf[MAXPATHLEN+1];
Victor Stinner974389d2011-03-15 09:33:57 +01002758 Py_ssize_t buflen;
2759 Py_ssize_t bufsize = MAXPATHLEN+1;
2760 PyObject *parent, *head, *next, *tail, *inputname, *outputname;
2761 PyObject *parent_name, *ensure_name;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002762 Py_ssize_t sep, altsep;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002763
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002764 if (PyUnicode_READY(name))
2765 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002766
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002767 sep = PyUnicode_FindChar(name, SEP, 0, PyUnicode_GET_LENGTH(name), 1);
2768 if (sep == -2)
2769 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002770#ifdef ALTSEP
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002771 altsep = PyUnicode_FindChar(name, ALTSEP, 0, PyUnicode_GET_LENGTH(name), 1);
2772 if (altsep == -2)
2773 return NULL;
2774#else
2775 altsep = -1;
Christian Heimes454f37b2008-01-10 00:10:02 +00002776#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002777 if (sep != -1 || altsep != -1)
2778 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002779 PyErr_SetString(PyExc_ImportError,
2780 "Import by filename is not supported.");
2781 return NULL;
2782 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002783
Victor Stinner974389d2011-03-15 09:33:57 +01002784 parent = get_parent(globals, &parent_name, level);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002785 if (parent == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002786 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002787 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002788
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002789 if (PyUnicode_READY(parent_name))
2790 return NULL;
2791 buflen = PyUnicode_GET_LENGTH(parent_name);
Georg Brandl4cb0de22011-09-28 21:49:49 +02002792 if (!PyUnicode_AsUCS4(parent_name, buf, Py_ARRAY_LENGTH(buf), 1)) {
Victor Stinner974389d2011-03-15 09:33:57 +01002793 Py_DECREF(parent_name);
2794 PyErr_SetString(PyExc_ValueError,
2795 "Module name too long");
2796 return NULL;
2797 }
Victor Stinner974389d2011-03-15 09:33:57 +01002798 Py_DECREF(parent_name);
2799
2800 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
2801 buf, &buflen, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002802 if (head == NULL)
2803 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002804
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002805 tail = head;
2806 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002807
2808 if (outputname != NULL) {
2809 while (1) {
2810 inputname = outputname;
2811 next = load_next(tail, tail, inputname, &outputname,
2812 buf, &buflen, bufsize);
2813 Py_DECREF(tail);
2814 Py_DECREF(inputname);
2815 if (next == NULL) {
2816 Py_DECREF(head);
2817 return NULL;
2818 }
2819 tail = next;
2820
2821 if (outputname == NULL) {
2822 break;
2823 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002824 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002825 }
2826 if (tail == Py_None) {
2827 /* If tail is Py_None, both get_parent and load_next found
2828 an empty module name: someone called __import__("") or
2829 doctored faulty bytecode */
2830 Py_DECREF(tail);
2831 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002832 PyErr_SetString(PyExc_ValueError, "Empty module name");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002833 return NULL;
2834 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002835
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002836 if (fromlist != NULL) {
2837 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2838 fromlist = NULL;
2839 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002840
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002841 if (fromlist == NULL) {
2842 Py_DECREF(tail);
2843 return head;
2844 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002845
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002846 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002847
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002848 ensure_name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
2849 buf, Py_UCS4_strlen(buf));
Victor Stinner974389d2011-03-15 09:33:57 +01002850 if (ensure_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002851 Py_DECREF(tail);
2852 return NULL;
2853 }
Victor Stinner974389d2011-03-15 09:33:57 +01002854 if (!ensure_fromlist(tail, fromlist, ensure_name, 0)) {
2855 Py_DECREF(tail);
2856 Py_DECREF(ensure_name);
2857 return NULL;
2858 }
2859 Py_DECREF(ensure_name);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002860
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002861 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002862}
2863
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002864PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002865PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2866 PyObject *locals, PyObject *fromlist,
2867 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002868{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002869 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002870 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002871 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002872 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002873 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002874 PyErr_SetString(PyExc_RuntimeError,
2875 "not holding the import lock");
2876 return NULL;
2877 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002878 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002879}
2880
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002881PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05002882PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002883 PyObject *fromlist, int level)
2884{
2885 PyObject *nameobj, *mod;
2886 nameobj = PyUnicode_FromString(name);
2887 if (nameobj == NULL)
2888 return NULL;
2889 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2890 fromlist, level);
2891 Py_DECREF(nameobj);
2892 return mod;
2893}
2894
2895
Fred Drake87590902004-05-28 20:21:36 +00002896/* Return the package that an import is being performed in. If globals comes
2897 from the module foo.bar.bat (not itself a package), this returns the
2898 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002899 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002900
Victor Stinner974389d2011-03-15 09:33:57 +01002901 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002902
2903 If globals doesn't come from a package or a module in a package, or a
2904 corresponding entry is not found in sys.modules, Py_None is returned.
2905*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002906static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002907get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002908{
Victor Stinner974389d2011-03-15 09:33:57 +01002909 PyObject *nameobj;
2910
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002911 static PyObject *namestr = NULL;
2912 static PyObject *pathstr = NULL;
2913 static PyObject *pkgstr = NULL;
2914 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2915 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002916
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002917 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002918 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002919
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002920 if (namestr == NULL) {
2921 namestr = PyUnicode_InternFromString("__name__");
2922 if (namestr == NULL)
2923 return NULL;
2924 }
2925 if (pathstr == NULL) {
2926 pathstr = PyUnicode_InternFromString("__path__");
2927 if (pathstr == NULL)
2928 return NULL;
2929 }
2930 if (pkgstr == NULL) {
2931 pkgstr = PyUnicode_InternFromString("__package__");
2932 if (pkgstr == NULL)
2933 return NULL;
2934 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002935
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002936 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002937
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002938 if ((pkgname != NULL) && (pkgname != Py_None)) {
2939 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002940 if (!PyUnicode_Check(pkgname)) {
2941 PyErr_SetString(PyExc_ValueError,
2942 "__package__ set to non-string");
2943 return NULL;
2944 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002945 if (PyUnicode_GET_LENGTH(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002946 if (level > 0) {
2947 PyErr_SetString(PyExc_ValueError,
2948 "Attempted relative import in non-package");
2949 return NULL;
2950 }
Victor Stinner974389d2011-03-15 09:33:57 +01002951 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002952 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002953 Py_INCREF(pkgname);
2954 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002955 } else {
2956 /* __package__ not set, so figure it out and set it */
2957 modname = PyDict_GetItem(globals, namestr);
2958 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002959 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002960
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002961 modpath = PyDict_GetItem(globals, pathstr);
2962 if (modpath != NULL) {
2963 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002964 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002965
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002966 error = PyDict_SetItem(globals, pkgstr, modname);
2967 if (error) {
2968 PyErr_SetString(PyExc_ValueError,
2969 "Could not set __package__");
2970 return NULL;
2971 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002972 Py_INCREF(modname);
2973 nameobj = modname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002974 } else {
2975 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002976 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002977 len = PyUnicode_FindChar(modname, '.',
2978 0, PyUnicode_GET_LENGTH(modname), -1);
2979 if (len == -2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002980 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002981 if (len < 0) {
2982 if (level > 0) {
2983 PyErr_SetString(PyExc_ValueError,
2984 "Attempted relative import in non-package");
2985 return NULL;
2986 }
2987 if (PyDict_SetItem(globals, pkgstr, Py_None)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002988 PyErr_SetString(PyExc_ValueError,
2989 "Could not set __package__");
2990 return NULL;
2991 }
Victor Stinner974389d2011-03-15 09:33:57 +01002992 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002993 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002994 pkgname = PyUnicode_Substring(modname, 0, len);
2995 if (pkgname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002996 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002997 if (PyDict_SetItem(globals, pkgstr, pkgname)) {
2998 Py_DECREF(pkgname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002999 PyErr_SetString(PyExc_ValueError,
3000 "Could not set __package__");
3001 return NULL;
3002 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003003 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003004 }
3005 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003006 if (level > 1) {
3007 Py_ssize_t dot, end = PyUnicode_GET_LENGTH(nameobj);
3008 PyObject *newname;
3009 while (--level > 0) {
3010 dot = PyUnicode_FindChar(nameobj, '.', 0, end, -1);
3011 if (dot == -2) {
3012 Py_DECREF(nameobj);
3013 return NULL;
3014 }
3015 if (dot < 0) {
3016 Py_DECREF(nameobj);
3017 PyErr_SetString(PyExc_ValueError,
3018 "Attempted relative import beyond "
3019 "toplevel package");
3020 return NULL;
3021 }
3022 end = dot;
3023 }
3024 newname = PyUnicode_Substring(nameobj, 0, end);
3025 Py_DECREF(nameobj);
3026 if (newname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003027 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003028 nameobj = newname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003029 }
Victor Stinner974389d2011-03-15 09:33:57 +01003030
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003031 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003032 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003033 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003034 int err;
3035
3036 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003037 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01003038 "Parent module %R not loaded, "
3039 "cannot perform relative import", nameobj);
3040 Py_DECREF(nameobj);
3041 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003042 }
Victor Stinner974389d2011-03-15 09:33:57 +01003043
3044 err = PyErr_WarnFormat(
3045 PyExc_RuntimeWarning, 1,
3046 "Parent module %R not found while handling absolute import",
3047 nameobj);
3048 Py_DECREF(nameobj);
3049 if (err)
3050 return NULL;
3051
3052 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003053 }
Victor Stinner974389d2011-03-15 09:33:57 +01003054 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003055 return parent;
3056 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01003057 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003058 - parent.__dict__ is globals
3059 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01003060
3061return_none:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003062 nameobj = PyUnicode_New(0, 0);
Victor Stinner974389d2011-03-15 09:33:57 +01003063 if (nameobj == NULL)
3064 return NULL;
3065 *p_name = nameobj;
3066 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003067}
3068
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003069/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003070static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003071load_next(PyObject *mod, PyObject *altmod,
3072 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003073 Py_UCS4 *buf, Py_ssize_t *p_buflen, Py_ssize_t bufsize)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003074{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003075 Py_UCS4 *dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003076 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003077 Py_UCS4 *p;
Victor Stinner974389d2011-03-15 09:33:57 +01003078 PyObject *fullname, *name, *result, *mark_name;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003079 Py_UCS4 *nameuni;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003080
Victor Stinner974389d2011-03-15 09:33:57 +01003081 *p_outputname = NULL;
3082
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003083 if (PyUnicode_GET_LENGTH(inputname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003084 /* completely empty module name should only happen in
3085 'from . import' (or '__import__("")')*/
3086 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003087 return mod;
3088 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00003089
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003090 nameuni = PyUnicode_AsUCS4Copy(inputname);
Victor Stinner974389d2011-03-15 09:33:57 +01003091 if (nameuni == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003092 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003093
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003094 dot = Py_UCS4_strchr(nameuni, '.');
Victor Stinner974389d2011-03-15 09:33:57 +01003095 if (dot != NULL) {
3096 len = dot - nameuni;
3097 if (len == 0) {
3098 PyErr_SetString(PyExc_ValueError,
3099 "Empty module name");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003100 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003101 }
3102 }
3103 else
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003104 len = PyUnicode_GET_LENGTH(inputname);
Victor Stinner974389d2011-03-15 09:33:57 +01003105
3106 if (*p_buflen+len+1 >= bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003107 PyErr_SetString(PyExc_ValueError,
3108 "Module name too long");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003109 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003110 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003111
Victor Stinner974389d2011-03-15 09:33:57 +01003112 p = buf + *p_buflen;
3113 if (p != buf) {
3114 *p++ = '.';
3115 *p_buflen += 1;
3116 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003117 Py_UCS4_strncpy(p, nameuni, len);
Victor Stinner974389d2011-03-15 09:33:57 +01003118 p[len] = '\0';
3119 *p_buflen += len;
3120
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003121 fullname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3122 buf, *p_buflen);
Victor Stinner974389d2011-03-15 09:33:57 +01003123 if (fullname == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003124 goto error;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003125 name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3126 p, len);
Victor Stinner974389d2011-03-15 09:33:57 +01003127 if (name == NULL) {
3128 Py_DECREF(fullname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003129 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003130 }
3131 result = import_submodule(mod, name, fullname);
3132 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003133 if (result == Py_None && altmod != mod) {
3134 Py_DECREF(result);
3135 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003136 result = import_submodule(altmod, name, name);
3137 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003138 if (result != NULL && result != Py_None) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003139 mark_name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3140 buf, *p_buflen);
Victor Stinner974389d2011-03-15 09:33:57 +01003141 if (mark_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003142 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003143 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003144 }
Victor Stinner974389d2011-03-15 09:33:57 +01003145 if (mark_miss(mark_name) != 0) {
3146 Py_DECREF(result);
3147 Py_DECREF(mark_name);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003148 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003149 }
3150 Py_DECREF(mark_name);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003151 Py_UCS4_strncpy(buf, nameuni, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003152 buf[len] = '\0';
3153 *p_buflen = len;
3154 }
3155 }
Victor Stinner974389d2011-03-15 09:33:57 +01003156 else
3157 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003158 if (result == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003159 goto error;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003160
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003161 if (result == Py_None) {
3162 Py_DECREF(result);
3163 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003164 "No module named %R", inputname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003165 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003166 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003167
Victor Stinner974389d2011-03-15 09:33:57 +01003168 if (dot != NULL) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003169 *p_outputname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3170 dot+1, Py_UCS4_strlen(dot+1));
Victor Stinner974389d2011-03-15 09:33:57 +01003171 if (*p_outputname == NULL) {
3172 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003173 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003174 }
3175 }
3176
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003177 PyMem_Free(nameuni);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003178 return result;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003179
3180error:
3181 PyMem_Free(nameuni);
3182 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003183}
3184
3185static int
Victor Stinner974389d2011-03-15 09:33:57 +01003186mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003187{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003188 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003189 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003190}
3191
3192static int
Victor Stinner974389d2011-03-15 09:33:57 +01003193ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003194 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003195{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003196 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003197 PyObject *fullname;
3198 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003199
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003200 if (!PyObject_HasAttrString(mod, "__path__"))
3201 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003202
Victor Stinner974389d2011-03-15 09:33:57 +01003203 fromlist_len = PySequence_Size(fromlist);
3204
3205 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003206 PyObject *item = PySequence_GetItem(fromlist, i);
3207 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003208 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003209 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003210 if (!PyUnicode_Check(item)) {
3211 PyErr_SetString(PyExc_TypeError,
3212 "Item in ``from list'' not a string");
3213 Py_DECREF(item);
3214 return 0;
3215 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003216 if (PyUnicode_READ_CHAR(item, 0) == '*') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003217 PyObject *all;
3218 Py_DECREF(item);
3219 /* See if the package defines __all__ */
3220 if (recursive)
3221 continue; /* Avoid endless recursion */
3222 all = PyObject_GetAttrString(mod, "__all__");
3223 if (all == NULL)
3224 PyErr_Clear();
3225 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003226 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003227 Py_DECREF(all);
3228 if (!ret)
3229 return 0;
3230 }
3231 continue;
3232 }
3233 hasit = PyObject_HasAttr(mod, item);
3234 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003235 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003236 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3237 if (fullname != NULL) {
3238 submod = import_submodule(mod, item, fullname);
3239 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003240 }
Victor Stinner974389d2011-03-15 09:33:57 +01003241 else
3242 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003243 Py_XDECREF(submod);
3244 if (submod == NULL) {
3245 Py_DECREF(item);
3246 return 0;
3247 }
3248 }
3249 Py_DECREF(item);
3250 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003251
Victor Stinner974389d2011-03-15 09:33:57 +01003252 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003253}
3254
Neil Schemenauer00b09662003-06-16 21:03:07 +00003255static int
Victor Stinner974389d2011-03-15 09:33:57 +01003256add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3257 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003258{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003259 if (mod == Py_None)
3260 return 1;
3261 /* Irrespective of the success of this load, make a
3262 reference to it in the parent package module. A copy gets
3263 saved in the modules dictionary under the full name, so get a
3264 reference from there, if need be. (The exception is when the
3265 load failed with a SyntaxError -- then there's no trace in
3266 sys.modules. In that case, of course, do nothing extra.) */
3267 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003268 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003269 if (submod == NULL)
3270 return 1;
3271 }
3272 if (PyModule_Check(mod)) {
3273 /* We can't use setattr here since it can give a
3274 * spurious warning if the submodule name shadows a
3275 * builtin name */
3276 PyObject *dict = PyModule_GetDict(mod);
3277 if (!dict)
3278 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003279 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003280 return 0;
3281 }
3282 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003283 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003284 return 0;
3285 }
3286 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003287}
3288
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003289static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003290import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003291{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003292 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003293 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003294 struct filedescr *fdp;
3295 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003296
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003297 /* Require:
3298 if mod == None: subname == fullname
3299 else: mod.__name__ + "." + subname == fullname
3300 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003301
Victor Stinner974389d2011-03-15 09:33:57 +01003302 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003303 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003304 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003305 }
Victor Stinner9599de52011-03-13 22:38:38 -04003306
3307 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003308 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003309 else {
Victor Stinner533d7832011-03-14 13:22:54 -04003310 path_list = PyObject_GetAttrString(mod, "__path__");
3311 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003312 PyErr_Clear();
3313 Py_INCREF(Py_None);
3314 return Py_None;
3315 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003316 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003317
Victor Stinner533d7832011-03-14 13:22:54 -04003318 fdp = find_module(fullname, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003319 &bufobj, &fp, &loader);
Victor Stinner533d7832011-03-14 13:22:54 -04003320 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003321 if (fdp == NULL) {
3322 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3323 return NULL;
3324 PyErr_Clear();
3325 Py_INCREF(Py_None);
3326 return Py_None;
3327 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003328 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3329 Py_XDECREF(bufobj);
Victor Stinner9599de52011-03-13 22:38:38 -04003330 Py_XDECREF(loader);
3331 if (fp)
3332 fclose(fp);
3333 if (m == NULL)
3334 return NULL;
3335 if (!add_submodule(mod, m, fullname, subname, modules)) {
3336 Py_XDECREF(m);
3337 return NULL;
3338 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003339 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003340}
3341
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003342
3343/* Re-import a module of any kind and return its module object, WITH
3344 INCREMENTED REFERENCE COUNT */
3345
Guido van Rossum79f25d91997-04-29 20:08:16 +00003346PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003347PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003348{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003349 PyInterpreterState *interp = PyThreadState_Get()->interp;
3350 PyObject *modules_reloading = interp->modules_reloading;
3351 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003352 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003353 PyObject *nameobj, *bufobj, *subnameobj;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003354 Py_UCS4 *name = NULL, *subname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003355 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003356 FILE *fp = NULL;
3357 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003358
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003359 if (modules_reloading == NULL) {
3360 Py_FatalError("PyImport_ReloadModule: "
3361 "no modules_reloading dictionary!");
3362 return NULL;
3363 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003364
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003365 if (m == NULL || !PyModule_Check(m)) {
3366 PyErr_SetString(PyExc_TypeError,
3367 "reload() argument must be module");
3368 return NULL;
3369 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003370 nameobj = PyModule_GetNameObject(m);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003371 if (nameobj == NULL || PyUnicode_READY(nameobj) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003372 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003373 if (m != PyDict_GetItem(modules, nameobj)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003374 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003375 "reload(): module %R not in sys.modules",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003376 nameobj);
3377 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003378 return NULL;
3379 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003380 existing_m = PyDict_GetItem(modules_reloading, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003381 if (existing_m != NULL) {
3382 /* Due to a recursive reload, this module is already
3383 being reloaded. */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003384 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003385 Py_INCREF(existing_m);
3386 return existing_m;
3387 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003388 if (PyDict_SetItem(modules_reloading, nameobj, m) < 0) {
3389 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003390 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003391 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003392
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003393 name = PyUnicode_AsUCS4Copy(nameobj);
3394 if (!name) {
3395 Py_DECREF(nameobj);
3396 return NULL;
3397 }
3398 subname = Py_UCS4_strrchr(name, '.');
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003399 if (subname == NULL) {
3400 Py_INCREF(nameobj);
3401 subnameobj = nameobj;
3402 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003403 else {
3404 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003405 Py_ssize_t len;
3406 len = subname - name;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003407 parentname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3408 name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003409 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003410 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003411 }
3412 parent = PyDict_GetItem(modules, parentname);
3413 if (parent == NULL) {
3414 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003415 "reload(): parent %R not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003416 parentname);
3417 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003418 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003419 }
3420 Py_DECREF(parentname);
Victor Stinner533d7832011-03-14 13:22:54 -04003421 path_list = PyObject_GetAttrString(parent, "__path__");
3422 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003423 PyErr_Clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003424 subname++;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003425 len = PyUnicode_GET_LENGTH(nameobj) - (len + 1);
3426 subnameobj = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3427 subname, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003428 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003429 if (subnameobj == NULL)
3430 goto error;
Victor Stinner533d7832011-03-14 13:22:54 -04003431 fdp = find_module(nameobj, subnameobj, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003432 &bufobj, &fp, &loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003433 Py_DECREF(subnameobj);
Victor Stinner533d7832011-03-14 13:22:54 -04003434 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003436 if (fdp == NULL) {
3437 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003438 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003439 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003440
Victor Stinner2fd76e42011-03-14 15:19:39 -04003441 newm = load_module(nameobj, fp, bufobj, fdp->type, loader);
3442 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003443 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003445 if (fp)
3446 fclose(fp);
3447 if (newm == NULL) {
3448 /* load_module probably removed name from modules because of
3449 * the error. Put back the original module object. We're
3450 * going to return NULL in this case regardless of whether
3451 * replacing name succeeds, so the return value is ignored.
3452 */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003453 PyDict_SetItem(modules, nameobj, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003454 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003455
3456error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003457 imp_modules_reloading_clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003458 Py_DECREF(nameobj);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003459 PyMem_Free(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003460 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003461}
3462
3463
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003464/* Higher-level import emulator which emulates the "import" statement
3465 more accurately -- it invokes the __import__() function from the
3466 builtins of the current globals. This means that the import is
3467 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003468 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003469 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003470 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003471 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003472
3473PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003474PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003475{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003476 static PyObject *silly_list = NULL;
3477 static PyObject *builtins_str = NULL;
3478 static PyObject *import_str = NULL;
3479 PyObject *globals = NULL;
3480 PyObject *import = NULL;
3481 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003482 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003483 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003484
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003485 /* Initialize constant string objects */
3486 if (silly_list == NULL) {
3487 import_str = PyUnicode_InternFromString("__import__");
3488 if (import_str == NULL)
3489 return NULL;
3490 builtins_str = PyUnicode_InternFromString("__builtins__");
3491 if (builtins_str == NULL)
3492 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003493 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003494 if (silly_list == NULL)
3495 return NULL;
3496 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003497
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003498 /* Get the builtins from current globals */
3499 globals = PyEval_GetGlobals();
3500 if (globals != NULL) {
3501 Py_INCREF(globals);
3502 builtins = PyObject_GetItem(globals, builtins_str);
3503 if (builtins == NULL)
3504 goto err;
3505 }
3506 else {
3507 /* No globals -- use standard builtins, and fake globals */
3508 builtins = PyImport_ImportModuleLevel("builtins",
3509 NULL, NULL, NULL, 0);
3510 if (builtins == NULL)
3511 return NULL;
3512 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3513 if (globals == NULL)
3514 goto err;
3515 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003516
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003517 /* Get the __import__ function from the builtins */
3518 if (PyDict_Check(builtins)) {
3519 import = PyObject_GetItem(builtins, import_str);
3520 if (import == NULL)
3521 PyErr_SetObject(PyExc_KeyError, import_str);
3522 }
3523 else
3524 import = PyObject_GetAttr(builtins, import_str);
3525 if (import == NULL)
3526 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003528 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003529 Always use absolute import here.
3530 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003531 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3532 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003533 if (r == NULL)
3534 goto err;
3535 Py_DECREF(r);
3536
3537 modules = PyImport_GetModuleDict();
3538 r = PyDict_GetItem(modules, module_name);
3539 if (r != NULL)
3540 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003541
3542 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003543 Py_XDECREF(globals);
3544 Py_XDECREF(builtins);
3545 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003546
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003547 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003548}
3549
3550
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003551/* Module 'imp' provides Python access to the primitives used for
3552 importing modules.
3553*/
3554
Guido van Rossum79f25d91997-04-29 20:08:16 +00003555static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003556imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003557{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003558 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003559
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003560 buf[0] = (char) ((magic >> 0) & 0xff);
3561 buf[1] = (char) ((magic >> 8) & 0xff);
3562 buf[2] = (char) ((magic >> 16) & 0xff);
3563 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003564
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003565 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003566}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003567
3568static PyObject *
3569imp_get_magic(PyObject *self, PyObject *noargs)
3570{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003571 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003572}
3573
3574static PyObject *
3575imp_get_tag(PyObject *self, PyObject *noargs)
3576{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003577 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003578}
3579
Guido van Rossum79f25d91997-04-29 20:08:16 +00003580static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003581imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003582{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003583 PyObject *list;
3584 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003585
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003586 list = PyList_New(0);
3587 if (list == NULL)
3588 return NULL;
3589 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3590 PyObject *item = Py_BuildValue("ssi",
3591 fdp->suffix, fdp->mode, fdp->type);
3592 if (item == NULL) {
3593 Py_DECREF(list);
3594 return NULL;
3595 }
3596 if (PyList_Append(list, item) < 0) {
3597 Py_DECREF(list);
3598 Py_DECREF(item);
3599 return NULL;
3600 }
3601 Py_DECREF(item);
3602 }
3603 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003604}
3605
Guido van Rossum79f25d91997-04-29 20:08:16 +00003606static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003607call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003608{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003609 extern int fclose(FILE *);
3610 PyObject *fob, *ret;
3611 PyObject *pathobj;
3612 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003613 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003614 int fd = -1;
3615 char *found_encoding = NULL;
3616 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003617
Victor Stinner533d7832011-03-14 13:22:54 -04003618 if (path_list == Py_None)
3619 path_list = NULL;
3620 fdp = find_module(NULL, name, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003621 &pathobj, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003622 if (fdp == NULL)
3623 return NULL;
3624 if (fp != NULL) {
3625 fd = fileno(fp);
3626 if (fd != -1)
3627 fd = dup(fd);
3628 fclose(fp);
Victor Stinnerd417d012011-06-20 15:16:55 +02003629 if (fd == -1) {
3630 PyErr_SetFromErrno(PyExc_OSError);
3631 return NULL;
3632 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003633 fp = NULL;
3634 }
3635 if (fd != -1) {
3636 if (strchr(fdp->mode, 'b') == NULL) {
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003637 /* PyTokenizer_FindEncodingFilename() returns PyMem_MALLOC'ed
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003638 memory. */
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003639 found_encoding = PyTokenizer_FindEncodingFilename(fd, pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003640 lseek(fd, 0, 0); /* Reset position */
Victor Stinner2fd76e42011-03-14 15:19:39 -04003641 if (found_encoding == NULL && PyErr_Occurred()) {
3642 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003643 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04003644 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003645 encoding = (found_encoding != NULL) ? found_encoding :
3646 (char*)PyUnicode_GetDefaultEncoding();
3647 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003648 fob = PyFile_FromFd(fd, NULL, fdp->mode, -1,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003649 (char*)encoding, NULL, NULL, 1);
3650 if (fob == NULL) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04003651 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003652 close(fd);
3653 PyMem_FREE(found_encoding);
3654 return NULL;
3655 }
3656 }
3657 else {
3658 fob = Py_None;
3659 Py_INCREF(fob);
3660 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003661 if (pathobj == NULL) {
3662 Py_INCREF(Py_None);
3663 pathobj = Py_None;
3664 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003665 ret = Py_BuildValue("NN(ssi)",
3666 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3667 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003668
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003669 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003670}
3671
Guido van Rossum79f25d91997-04-29 20:08:16 +00003672static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003673imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003674{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003675 PyObject *name, *path_list = NULL;
3676 if (!PyArg_ParseTuple(args, "U|O:find_module",
3677 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003678 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003679 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003680}
3681
3682static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003683imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003684{
Victor Stinner95872862011-03-07 18:20:56 +01003685 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003686 int ret;
3687 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003688 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003689 return NULL;
3690 ret = init_builtin(name);
3691 if (ret < 0)
3692 return NULL;
3693 if (ret == 0) {
3694 Py_INCREF(Py_None);
3695 return Py_None;
3696 }
Victor Stinner95872862011-03-07 18:20:56 +01003697 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003698 Py_XINCREF(m);
3699 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003700}
3701
Guido van Rossum79f25d91997-04-29 20:08:16 +00003702static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003703imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003704{
Victor Stinner53dc7352011-03-20 01:50:21 +01003705 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003706 int ret;
3707 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003708 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003709 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003710 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003711 if (ret < 0)
3712 return NULL;
3713 if (ret == 0) {
3714 Py_INCREF(Py_None);
3715 return Py_None;
3716 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003717 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003718 Py_XINCREF(m);
3719 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003720}
3721
Guido van Rossum79f25d91997-04-29 20:08:16 +00003722static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003723imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003724{
Victor Stinner53dc7352011-03-20 01:50:21 +01003725 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003726
Victor Stinner53dc7352011-03-20 01:50:21 +01003727 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003728 return NULL;
3729 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003730}
3731
Guido van Rossum79f25d91997-04-29 20:08:16 +00003732static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003733imp_is_frozen_package(PyObject *self, PyObject *args)
3734{
Victor Stinner53dc7352011-03-20 01:50:21 +01003735 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003736
Victor Stinner53dc7352011-03-20 01:50:21 +01003737 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003738 return NULL;
3739 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003740}
3741
3742static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003743imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003744{
Victor Stinner95872862011-03-07 18:20:56 +01003745 PyObject *name;
3746 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003747 return NULL;
3748 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003749}
3750
Guido van Rossum79f25d91997-04-29 20:08:16 +00003751static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003752imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003753{
Victor Stinner53dc7352011-03-20 01:50:21 +01003754 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003755 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003756 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003757 return NULL;
3758 p = find_frozen(name);
3759 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003760}
3761
3762static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003763get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003764{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003765 FILE *fp;
3766 if (mode[0] == 'U')
3767 mode = "r" PY_STDIOTEXTMODE;
3768 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003769 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003770 }
3771 else {
3772 int fd = PyObject_AsFileDescriptor(fob);
3773 if (fd == -1)
3774 return NULL;
3775 if (!_PyVerify_fd(fd))
3776 goto error;
3777 /* the FILE struct gets a new fd, so that it can be closed
3778 * independently of the file descriptor given
3779 */
3780 fd = dup(fd);
3781 if (fd == -1)
3782 goto error;
3783 fp = fdopen(fd, mode);
3784 }
3785 if (fp)
3786 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003787error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003788 PyErr_SetFromErrno(PyExc_IOError);
3789 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003790}
3791
Guido van Rossum79f25d91997-04-29 20:08:16 +00003792static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003793imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003794{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003795 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003796 PyObject *fob = NULL;
3797 PyObject *m;
3798 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003799 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003800 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003801 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003802 &fob))
3803 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003804 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003805 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003806 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003807 return NULL;
3808 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003809 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003810 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003811 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003812 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003813}
3814
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003815#ifdef HAVE_DYNAMIC_LOADING
3816
Guido van Rossum79f25d91997-04-29 20:08:16 +00003817static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003818imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003819{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003820 PyObject *name, *pathname, *fob = NULL, *mod;
3821 FILE *fp;
3822
3823 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3824 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003825 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003826 if (fob != NULL) {
3827 fp = get_file(NULL, fob, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003828 if (fp == NULL) {
3829 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003830 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003831 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003832 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003833 else
3834 fp = NULL;
3835 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003836 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003837 if (fp)
3838 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003839 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003840}
3841
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003842#endif /* HAVE_DYNAMIC_LOADING */
3843
Guido van Rossum79f25d91997-04-29 20:08:16 +00003844static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003845imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003846{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003847 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003848 PyObject *fob = NULL;
3849 PyObject *m;
3850 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003851 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003852 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003853 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003854 &fob))
3855 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003856 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003857 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003858 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003859 return NULL;
3860 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003861 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003862 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003863 fclose(fp);
3864 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003865}
3866
Guido van Rossum79f25d91997-04-29 20:08:16 +00003867static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003868imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003869{
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003870 PyObject *name, *fob, *pathname, *pathname_obj, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003871 char *suffix; /* Unused */
3872 char *mode;
3873 int type;
3874 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003875
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003876 if (!PyArg_ParseTuple(args, "UOO(ssi):load_module",
3877 &name, &fob, &pathname_obj, &suffix, &mode, &type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003878 return NULL;
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003879 if (pathname_obj != Py_None) {
3880 if (!PyUnicode_FSDecoder(pathname_obj, &pathname))
3881 return NULL;
3882 }
3883 else
3884 pathname = NULL;
3885
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003886 if (*mode) {
3887 /* Mode must start with 'r' or 'U' and must not contain '+'.
3888 Implicit in this test is the assumption that the mode
3889 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003890
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003891 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3892 PyErr_Format(PyExc_ValueError,
3893 "invalid file open mode %.200s", mode);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003894 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003895 return NULL;
3896 }
3897 }
3898 if (fob == Py_None)
3899 fp = NULL;
3900 else {
3901 fp = get_file(NULL, fob, mode);
3902 if (fp == NULL) {
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003903 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003904 return NULL;
3905 }
3906 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003907 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003908 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003909 if (fp)
3910 fclose(fp);
3911 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003912}
3913
3914static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003915imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003916{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003917 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003918 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003919 if (!PyArg_ParseTuple(args, "UO&:load_package",
3920 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003921 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003922 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003923 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003924 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003925}
3926
3927static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003928imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003929{
Victor Stinnerfe19d212011-03-14 14:53:28 -04003930 PyObject *name;
3931 if (!PyArg_ParseTuple(args, "U:new_module", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003932 return NULL;
Victor Stinnerfe19d212011-03-14 14:53:28 -04003933 return PyModule_NewObject(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003934}
3935
Christian Heimes13a7a212008-01-07 17:13:09 +00003936static PyObject *
3937imp_reload(PyObject *self, PyObject *v)
3938{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003939 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003940}
3941
3942PyDoc_STRVAR(doc_reload,
3943"reload(module) -> module\n\
3944\n\
3945Reload the module. The module must have been successfully imported before.");
3946
Barry Warsaw28a691b2010-04-17 00:19:56 +00003947static PyObject *
3948imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3949{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003950 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003951
Victor Stinner2f42ae52011-03-20 00:41:24 +01003952 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003953 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003954 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003955
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003956 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003957 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003958 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003959 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003960
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003961 if (debug_override != NULL &&
3962 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003963 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003964 return NULL;
3965 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003966
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003967 cpathname = make_compiled_pathname(pathname, debug);
Victor Stinner2f42ae52011-03-20 00:41:24 +01003968 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003969
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003970 if (cpathname == NULL) {
3971 PyErr_Format(PyExc_SystemError, "path buffer too short");
3972 return NULL;
3973 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003974 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003975}
3976
3977PyDoc_STRVAR(doc_cache_from_source,
3978"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3979\n\
3980The .py file does not need to exist; this simply returns the path to the\n\
3981.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3982will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3983\n\
3984If debug_override is not None, then it must be a boolean and is taken as\n\
3985the value of __debug__ instead.");
3986
3987static PyObject *
3988imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3989{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003990 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003991 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003992
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003993 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003994 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003995 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003996 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003997
Victor Stinnerc9abda02011-03-14 13:33:46 -04003998 source = make_source_pathname(pathname);
3999 if (source == NULL) {
4000 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004001 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04004002 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004003 return NULL;
4004 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04004005 Py_DECREF(pathname);
4006 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00004007}
4008
4009PyDoc_STRVAR(doc_source_from_cache,
4010"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
4011\n\
4012The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
4013the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
4014does not conform to PEP 3147 format, ValueError will be raised.");
4015
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004016/* Doc strings */
4017
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004018PyDoc_STRVAR(doc_imp,
4019"This module provides the components needed to build your own\n\
4020__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004021
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004022PyDoc_STRVAR(doc_find_module,
4023"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004024Search for a module. If path is omitted or None, search for a\n\
4025built-in, frozen or special module and continue search in sys.path.\n\
4026The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004027package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004028
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004029PyDoc_STRVAR(doc_load_module,
4030"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004031Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004032The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004033
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004034PyDoc_STRVAR(doc_get_magic,
4035"get_magic() -> string\n\
4036Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004037
Barry Warsaw28a691b2010-04-17 00:19:56 +00004038PyDoc_STRVAR(doc_get_tag,
4039"get_tag() -> string\n\
4040Return the magic tag for .pyc or .pyo files.");
4041
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004042PyDoc_STRVAR(doc_get_suffixes,
4043"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004044Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004045that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004046
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004047PyDoc_STRVAR(doc_new_module,
4048"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004049Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004050The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004051
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004052PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00004053"lock_held() -> boolean\n\
4054Return True if the import lock is currently held, else False.\n\
4055On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00004056
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004057PyDoc_STRVAR(doc_acquire_lock,
4058"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00004059Acquires the interpreter's import lock for the current thread.\n\
4060This lock should be used by import hooks to ensure thread-safety\n\
4061when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004062On platforms without threads, this function does nothing.");
4063
4064PyDoc_STRVAR(doc_release_lock,
4065"release_lock() -> None\n\
4066Release the interpreter's import lock.\n\
4067On platforms without threads, this function does nothing.");
4068
Guido van Rossum79f25d91997-04-29 20:08:16 +00004069static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004070 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
4071 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
4072 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
4073 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
4074 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
4075 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
4076 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
4077 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
4078 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
4079 {"reload", imp_reload, METH_O, doc_reload},
4080 {"cache_from_source", (PyCFunction)imp_cache_from_source,
4081 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
4082 {"source_from_cache", (PyCFunction)imp_source_from_cache,
4083 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
4084 /* The rest are obsolete */
4085 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
4086 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
4087 {"init_builtin", imp_init_builtin, METH_VARARGS},
4088 {"init_frozen", imp_init_frozen, METH_VARARGS},
4089 {"is_builtin", imp_is_builtin, METH_VARARGS},
4090 {"is_frozen", imp_is_frozen, METH_VARARGS},
4091 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004092#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004093 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004094#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004095 {"load_package", imp_load_package, METH_VARARGS},
4096 {"load_source", imp_load_source, METH_VARARGS},
Brett Cannon442c9b92011-03-23 16:14:42 -07004097 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004098 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004099};
4100
Guido van Rossum1a8791e1998-08-04 22:46:29 +00004101static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004102setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004103{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004104 PyObject *v;
4105 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004106
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004107 v = PyLong_FromLong((long)value);
4108 err = PyDict_SetItemString(d, name, v);
4109 Py_XDECREF(v);
4110 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004111}
4112
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004113typedef struct {
4114 PyObject_HEAD
4115} NullImporter;
4116
4117static int
4118NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4119{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004120#ifndef MS_WINDOWS
4121 PyObject *path;
4122 struct stat statbuf;
4123 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004124
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004125 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4126 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004127
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004128 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4129 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004130 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004131
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004132 if (PyBytes_GET_SIZE(path) == 0) {
4133 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004134 PyErr_SetString(PyExc_ImportError, "empty pathname");
4135 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004136 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004137
4138 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4139 Py_DECREF(path);
4140 if (rv == 0) {
4141 /* it exists */
4142 if (S_ISDIR(statbuf.st_mode)) {
4143 /* it's a directory */
4144 PyErr_SetString(PyExc_ImportError, "existing directory");
4145 return -1;
4146 }
4147 }
4148#else /* MS_WINDOWS */
4149 PyObject *pathobj;
4150 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004151 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004152
4153 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4154 return -1;
4155
4156 if (!PyArg_ParseTuple(args, "U:NullImporter",
4157 &pathobj))
4158 return -1;
4159
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02004160 if (PyUnicode_GET_LENGTH(pathobj) == 0) {
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004161 PyErr_SetString(PyExc_ImportError, "empty pathname");
4162 return -1;
4163 }
4164
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004165 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004166 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004167 return -1;
4168 /* see issue1293 and issue3677:
4169 * stat() on Windows doesn't recognise paths like
4170 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4171 */
4172 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004173 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004174 if (rv != INVALID_FILE_ATTRIBUTES) {
4175 /* it exists */
4176 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4177 /* it's a directory */
4178 PyErr_SetString(PyExc_ImportError, "existing directory");
4179 return -1;
4180 }
4181 }
4182#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004183 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004184}
4185
4186static PyObject *
4187NullImporter_find_module(NullImporter *self, PyObject *args)
4188{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004189 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004190}
4191
4192static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004193 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4194 "Always return None"
4195 },
4196 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004197};
4198
4199
Christian Heimes9cd17752007-11-18 19:35:23 +00004200PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004201 PyVarObject_HEAD_INIT(NULL, 0)
4202 "imp.NullImporter", /*tp_name*/
4203 sizeof(NullImporter), /*tp_basicsize*/
4204 0, /*tp_itemsize*/
4205 0, /*tp_dealloc*/
4206 0, /*tp_print*/
4207 0, /*tp_getattr*/
4208 0, /*tp_setattr*/
4209 0, /*tp_reserved*/
4210 0, /*tp_repr*/
4211 0, /*tp_as_number*/
4212 0, /*tp_as_sequence*/
4213 0, /*tp_as_mapping*/
4214 0, /*tp_hash */
4215 0, /*tp_call*/
4216 0, /*tp_str*/
4217 0, /*tp_getattro*/
4218 0, /*tp_setattro*/
4219 0, /*tp_as_buffer*/
4220 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4221 "Null importer object", /* tp_doc */
4222 0, /* tp_traverse */
4223 0, /* tp_clear */
4224 0, /* tp_richcompare */
4225 0, /* tp_weaklistoffset */
4226 0, /* tp_iter */
4227 0, /* tp_iternext */
4228 NullImporter_methods, /* tp_methods */
4229 0, /* tp_members */
4230 0, /* tp_getset */
4231 0, /* tp_base */
4232 0, /* tp_dict */
4233 0, /* tp_descr_get */
4234 0, /* tp_descr_set */
4235 0, /* tp_dictoffset */
4236 (initproc)NullImporter_init, /* tp_init */
4237 0, /* tp_alloc */
4238 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004239};
4240
Martin v. Löwis1a214512008-06-11 05:26:20 +00004241static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004242 PyModuleDef_HEAD_INIT,
4243 "imp",
4244 doc_imp,
4245 0,
4246 imp_methods,
4247 NULL,
4248 NULL,
4249 NULL,
4250 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004251};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004252
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004253PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004254PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004255{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004256 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004257
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004258 if (PyType_Ready(&PyNullImporter_Type) < 0)
4259 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004260
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004261 m = PyModule_Create(&impmodule);
4262 if (m == NULL)
4263 goto failure;
4264 d = PyModule_GetDict(m);
4265 if (d == NULL)
4266 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004267
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004268 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4269 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4270 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4271 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4272 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4273 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4274 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4275 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4276 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4277 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004279 Py_INCREF(&PyNullImporter_Type);
4280 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4281 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004282 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004283 Py_XDECREF(m);
4284 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004285}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004286
4287
Guido van Rossumb18618d2000-05-03 23:44:39 +00004288/* API for embedding applications that want to add their own entries
4289 to the table of built-in modules. This should normally be called
4290 *before* Py_Initialize(). When the table resize fails, -1 is
4291 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004292
4293 After a similar function by Just van Rossum. */
4294
4295int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004296PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004297{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004298 static struct _inittab *our_copy = NULL;
4299 struct _inittab *p;
4300 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004301
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004302 /* Count the number of entries in both tables */
4303 for (n = 0; newtab[n].name != NULL; n++)
4304 ;
4305 if (n == 0)
4306 return 0; /* Nothing to do */
4307 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4308 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004309
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004310 /* Allocate new memory for the combined table */
4311 p = our_copy;
4312 PyMem_RESIZE(p, struct _inittab, i+n+1);
4313 if (p == NULL)
4314 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004315
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004316 /* Copy the tables into the new memory */
4317 if (our_copy != PyImport_Inittab)
4318 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4319 PyImport_Inittab = our_copy = p;
4320 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004321
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004322 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004323}
4324
4325/* Shorthand to add a single entry given a name and a function */
4326
4327int
Brett Cannona826f322009-04-02 03:41:46 +00004328PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004329{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004330 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004331
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004332 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004333
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004334 newtab[0].name = (char *)name;
4335 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004336
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004337 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004338}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004339
4340#ifdef __cplusplus
4341}
4342#endif