blob: 5f84ac2f745a7a0e6817c35e66863dabf1e68cd1 [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
Victor Stinner46084ba2011-10-06 02:39:42 +02001788 if (PyUnicode_READY(path_unicode))
1789 return -1;
1790
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001791 len = PyUnicode_GET_LENGTH(path_unicode);
Georg Brandl4cb0de22011-09-28 21:49:49 +02001792 if (!PyUnicode_AsUCS4(path_unicode, buf, Py_ARRAY_LENGTH(buf), 1)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001793 Py_DECREF(path_unicode);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001794 PyErr_Clear();
1795 return 0;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001796 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001797 Py_DECREF(path_unicode);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001798
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001799 if (Py_UCS4_strlen(buf) != len)
Victor Stinner2fd76e42011-03-14 15:19:39 -04001800 return 0; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001801
1802 /* sys.path_hooks import hook */
1803 if (p_loader != NULL) {
1804 PyObject *importer;
1805
1806 importer = get_path_importer(path_importer_cache,
1807 path_hooks, path);
1808 if (importer == NULL) {
1809 return -1;
1810 }
1811 /* Note: importer is a borrowed reference */
1812 if (importer != Py_None) {
1813 PyObject *loader;
1814 loader = PyObject_CallMethod(importer,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001815 "find_module", "O", fullname);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001816 if (loader == NULL)
1817 return -1; /* error */
1818 if (loader != Py_None) {
1819 /* a loader was found */
1820 *p_loader = loader;
1821 *p_fd = &importhookdescr;
1822 return 2;
1823 }
1824 Py_DECREF(loader);
1825 return 0;
1826 }
1827 }
1828 /* no hook was found, use builtin import */
1829
1830 if (len > 0 && buf[len-1] != SEP
1831#ifdef ALTSEP
1832 && buf[len-1] != ALTSEP
1833#endif
1834 )
1835 buf[len++] = SEP;
Georg Brandl4cb0de22011-09-28 21:49:49 +02001836 if (!PyUnicode_AsUCS4(name, buf+len, Py_ARRAY_LENGTH(buf)-len, 1)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001837 PyErr_Clear();
1838 return 0;
1839 }
1840 len += PyUnicode_GET_LENGTH(name);
Victor Stinner2fd76e42011-03-14 15:19:39 -04001841
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001842 filename = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
1843 buf, len);
Victor Stinner2fd76e42011-03-14 15:19:39 -04001844 if (filename == NULL)
1845 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001846
1847 /* Check for package import (buf holds a directory name,
1848 and there's an __init__ module in that directory */
1849#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001850 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001851 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1852 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001853 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001854
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001855 match = case_ok(filename, 0, name);
1856 if (match < 0) {
1857 Py_DECREF(filename);
1858 return -1;
1859 }
1860 if (match) { /* case matches */
1861 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001862 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001863 *p_fd = &fd_package;
1864 return 2;
1865 }
1866 else {
1867 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001868 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001869 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001870 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001871 if (err) {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001872 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001873 return -1;
Victor Stinner547a2a62011-03-20 03:07:28 +01001874 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001875 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001876 }
1877 }
1878#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001879 *p_path = filename;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001880 return 1;
1881}
1882
1883/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001884 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001885
1886 If the module is found, return a file descriptor, write the path in
1887 *p_filename, write the pointer to the file object into *p_fp, and (if
1888 p_loader is not NULL) the loader into *p_loader.
1889
1890 Otherwise, raise an exception and return NULL. */
1891
Victor Stinner37580282011-03-20 01:34:43 +01001892static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001893find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001894 PyObject *search_path_list, PyObject *path_hooks,
1895 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001896 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001897{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001898 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001899 struct filedescr *fdp = NULL;
1900 char *filemode;
1901 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001902 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001903 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001904
Victor Stinner37580282011-03-20 01:34:43 +01001905 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001906 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001907 PyObject *path;
1908 int ok;
1909
1910 path = PyList_GetItem(search_path_list, i);
1911 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001912 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001913
Victor Stinner2fd76e42011-03-14 15:19:39 -04001914 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001915 ok = find_module_path(fullname, name, path,
1916 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001917 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001918 if (ok < 0)
1919 return NULL;
1920 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001921 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001922 if (ok == 2) {
1923 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001924 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001925 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001927 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001928 struct stat statbuf;
1929
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001930 filemode = fdp->mode;
1931 if (filemode[0] == 'U')
1932 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001933
Victor Stinner2fd76e42011-03-14 15:19:39 -04001934 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1935 if (filename == NULL) {
1936 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001937 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001938 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001939
1940 if (Py_VerboseFlag > 1)
1941 PySys_FormatStderr("# trying %R\n", filename);
1942
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001943 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
1944 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1945 {
1946 Py_DECREF(filename);
1947 continue;
1948 }
1949
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001950 fp = _Py_fopen(filename, filemode);
1951 if (fp == NULL) {
1952 Py_DECREF(filename);
Victor Stinner925ef392011-06-20 15:01:10 +02001953 if (PyErr_Occurred()) {
1954 Py_DECREF(prefix);
1955 return NULL;
1956 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001957 continue;
1958 }
1959 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1960 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001961 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001962 Py_DECREF(filename);
1963 return NULL;
1964 }
1965 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001966 Py_DECREF(prefix);
1967 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001968 *p_fp = fp;
1969 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001970 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001971 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001972
1973 fclose(fp);
1974 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001975 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001976 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001977 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001978 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04001979 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04001980 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001981}
1982
Victor Stinner37580282011-03-20 01:34:43 +01001983/* Find a module:
1984
1985 - try find_module() of each sys.meta_path hook
1986 - try find_frozen()
1987 - try is_builtin()
1988 - try _PyWin_FindRegisteredModule() (Windows only)
1989 - otherwise, call find_module_path_list() with search_path_list (if not
1990 NULL) or sys.path
1991
Victor Stinner2fd76e42011-03-14 15:19:39 -04001992 fullname can be NULL, but only if p_loader is NULL.
1993
Victor Stinner37580282011-03-20 01:34:43 +01001994 Return:
1995
1996 - &fd_builtin (C_BUILTIN) if it is a builtin
1997 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04001998 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01001999 if it is a package
2000 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
2001 importer loader was found
2002 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
2003 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04002004 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01002005 - NULL on error
2006
Victor Stinner2fd76e42011-03-14 15:19:39 -04002007 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
2008 Eg. *p_path is set to NULL for a builtin package.
2009*/
Victor Stinner37580282011-03-20 01:34:43 +01002010
2011static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002012find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002013 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01002014{
2015 Py_ssize_t i, npath;
2016 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
2017 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
2018 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01002019
Victor Stinner2fd76e42011-03-14 15:19:39 -04002020 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01002021 *p_fp = NULL;
2022 if (p_loader != NULL)
2023 *p_loader = NULL;
2024
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002025 if (PyUnicode_GET_LENGTH(name) > MAXPATHLEN) {
2026 PyErr_SetString(PyExc_OverflowError,
2027 "module name is too long");
2028 return NULL;
2029 }
2030
Victor Stinner37580282011-03-20 01:34:43 +01002031 /* sys.meta_path import hook */
2032 if (p_loader != NULL) {
2033 PyObject *meta_path;
2034
2035 meta_path = PySys_GetObject("meta_path");
2036 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02002037 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002038 "sys.meta_path must be a list of "
2039 "import hooks");
2040 return NULL;
2041 }
2042 Py_INCREF(meta_path); /* zap guard */
2043 npath = PyList_Size(meta_path);
2044 for (i = 0; i < npath; i++) {
2045 PyObject *loader;
2046 PyObject *hook = PyList_GetItem(meta_path, i);
2047 loader = PyObject_CallMethod(hook, "find_module",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002048 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01002049 search_path_list != NULL ?
2050 search_path_list : Py_None);
2051 if (loader == NULL) {
2052 Py_DECREF(meta_path);
2053 return NULL; /* true error */
2054 }
2055 if (loader != Py_None) {
2056 /* a loader was found */
2057 *p_loader = loader;
2058 Py_DECREF(meta_path);
2059 return &importhookdescr;
2060 }
2061 Py_DECREF(loader);
2062 }
2063 Py_DECREF(meta_path);
2064 }
2065
Victor Stinnerdf75a022011-03-14 13:40:04 -04002066 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002067 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01002068
2069 if (search_path_list == NULL) {
2070#ifdef MS_COREDLL
2071 FILE *fp;
2072 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01002073#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04002074 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01002075 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01002076#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04002077 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01002078 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01002079 *p_fp = fp;
2080 return fdp;
2081 }
2082 else if (PyErr_Occurred())
2083 return NULL;
2084#endif
Victor Stinner37580282011-03-20 01:34:43 +01002085 search_path_list = PySys_GetObject("path");
2086 }
2087
2088 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
Victor Stinner16191322011-09-15 19:28:05 +02002089 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002090 "sys.path must be a list of directory names");
2091 return NULL;
2092 }
2093
2094 path_hooks = PySys_GetObject("path_hooks");
2095 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02002096 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002097 "sys.path_hooks must be a list of "
2098 "import hooks");
2099 return NULL;
2100 }
2101 path_importer_cache = PySys_GetObject("path_importer_cache");
2102 if (path_importer_cache == NULL ||
2103 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02002104 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002105 "sys.path_importer_cache must be a dict");
2106 return NULL;
2107 }
2108
2109 return find_module_path_list(fullname, name,
2110 search_path_list, path_hooks,
2111 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002112 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002113}
2114
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002115/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002116 * The arguments here are tricky, best shown by example:
2117 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2118 * ^ ^ ^ ^
2119 * |--------------------- buf ---------------------|
2120 * |------------------- len ------------------|
2121 * |------ name -------|
2122 * |----- namelen -----|
2123 * buf is the full path, but len only counts up to (& exclusive of) the
2124 * extension. name is the module name, also exclusive of extension.
2125 *
2126 * We've already done a successful stat() or fopen() on buf, so know that
2127 * there's some match, possibly case-insensitive.
2128 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002129 * case_bytes() is to return 1 if there's a case-sensitive match for
2130 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002131 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002132 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002133 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002134 * on platforms with case-insensitive filesystems. It's trivial to implement
2135 * for case-sensitive filesystems. It's pretty much a cross-platform
2136 * nightmare for systems with case-insensitive filesystems.
2137 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002138
Tim Peters50d8d372001-02-28 05:34:27 +00002139/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002140 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002141 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002142#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002143#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002144
Tim Peters50d8d372001-02-28 05:34:27 +00002145#elif defined(DJGPP)
2146#include <dir.h>
2147
Jason Tishler7961aa62005-05-20 00:56:54 +00002148#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002149#include <sys/types.h>
2150#include <dirent.h>
2151
Andrew MacIntyred9400542002-02-26 11:41:34 +00002152#elif defined(PYOS_OS2)
2153#define INCL_DOS
2154#define INCL_DOSERRORS
2155#define INCL_NOPMAPI
2156#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002157#endif
2158
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002159#if defined(DJGPP) \
2160 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2161 && defined(HAVE_DIRENT_H)) \
2162 || defined(PYOS_OS2)
2163# define USE_CASE_OK_BYTES
2164#endif
2165
2166
2167#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002168static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002169case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002170{
Tim Peters50d8d372001-02-28 05:34:27 +00002171/* Pick a platform-specific implementation; the sequence of #if's here should
2172 * match the sequence just above.
2173 */
2174
Tim Peters50d8d372001-02-28 05:34:27 +00002175/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002176#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002177 struct ffblk ffblk;
2178 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002179
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002180 if (Py_GETENV("PYTHONCASEOK") != NULL)
2181 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002182
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002183 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2184 if (done) {
2185 PyErr_Format(PyExc_NameError,
2186 "Can't find file for module %.100s\n(filename %.300s)",
2187 name, buf);
Victor Stinner9c61e242011-03-22 01:22:27 +01002188 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002189 }
2190 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002191
Jason Tishler7961aa62005-05-20 00:56:54 +00002192/* new-fangled macintosh (macosx) or Cygwin */
2193#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002194 DIR *dirp;
2195 struct dirent *dp;
2196 char dirname[MAXPATHLEN + 1];
2197 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002198
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002199 if (Py_GETENV("PYTHONCASEOK") != NULL)
2200 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002201
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002202 /* Copy the dir component into dirname; substitute "." if empty */
2203 if (dirlen <= 0) {
2204 dirname[0] = '.';
2205 dirname[1] = '\0';
2206 }
2207 else {
2208 assert(dirlen <= MAXPATHLEN);
2209 memcpy(dirname, buf, dirlen);
2210 dirname[dirlen] = '\0';
2211 }
2212 /* Open the directory and search the entries for an exact match. */
2213 dirp = opendir(dirname);
2214 if (dirp) {
2215 char *nameWithExt = buf + len - namelen;
2216 while ((dp = readdir(dirp)) != NULL) {
2217 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002218#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002219 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002220#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002221 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002222#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002223 if (thislen >= namelen &&
2224 strcmp(dp->d_name, nameWithExt) == 0) {
2225 (void)closedir(dirp);
2226 return 1; /* Found */
2227 }
2228 }
2229 (void)closedir(dirp);
2230 }
2231 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002232
Andrew MacIntyred9400542002-02-26 11:41:34 +00002233/* OS/2 */
2234#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002235 HDIR hdir = 1;
2236 ULONG srchcnt = 1;
2237 FILEFINDBUF3 ffbuf;
2238 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002239
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002240 if (Py_GETENV("PYTHONCASEOK") != NULL)
2241 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002242
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002243 rc = DosFindFirst(buf,
2244 &hdir,
2245 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2246 &ffbuf, sizeof(ffbuf),
2247 &srchcnt,
2248 FIL_STANDARD);
2249 if (rc != NO_ERROR)
2250 return 0;
2251 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002252
Tim Peters50d8d372001-02-28 05:34:27 +00002253/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2254#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002255# error "USE_CASE_OK_BYTES is not correctly defined"
2256#endif
2257}
2258#endif
2259
2260/*
2261 * Check if a filename case matchs the name case. We've already done a
2262 * successful stat() or fopen() on buf, so know that there's some match,
2263 * possibly case-insensitive.
2264 *
2265 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2266 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2267 * if envar PYTHONCASEOK exists.
2268 *
2269 * case_ok() is used to implement case-sensitive import semantics even
2270 * on platforms with case-insensitive filesystems. It's trivial to implement
2271 * for case-sensitive filesystems. It's pretty much a cross-platform
2272 * nightmare for systems with case-insensitive filesystems.
2273 */
2274
2275static int
2276case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2277{
2278#ifdef MS_WINDOWS
2279 WIN32_FIND_DATAW data;
2280 HANDLE h;
2281 int cmp;
2282
2283 if (Py_GETENV("PYTHONCASEOK") != NULL)
2284 return 1;
2285
2286 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2287 if (h == INVALID_HANDLE_VALUE) {
2288 PyErr_Format(PyExc_NameError,
2289 "Can't find file for module %R\n(filename %R)",
2290 name, filename);
2291 return 0;
2292 }
2293 FindClose(h);
2294 cmp = wcsncmp(data.cFileName,
2295 PyUnicode_AS_UNICODE(name),
2296 PyUnicode_GET_SIZE(name));
2297 return cmp == 0;
2298#elif defined(USE_CASE_OK_BYTES)
2299 int match;
2300 PyObject *filebytes, *namebytes;
2301 filebytes = PyUnicode_EncodeFSDefault(filename);
2302 if (filebytes == NULL)
2303 return -1;
2304 namebytes = PyUnicode_EncodeFSDefault(name);
2305 if (namebytes == NULL) {
2306 Py_DECREF(filebytes);
2307 return -1;
2308 }
2309 match = case_bytes(
2310 PyBytes_AS_STRING(filebytes),
2311 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002312 PyBytes_GET_SIZE(namebytes),
2313 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002314 Py_DECREF(filebytes);
2315 Py_DECREF(namebytes);
2316 return match;
2317#else
2318 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002319 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002320
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002321#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002322}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002323
Guido van Rossum197346f1997-10-31 18:38:52 +00002324#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002325
Victor Stinner547a2a62011-03-20 03:07:28 +01002326/* Helper to look for __init__.py or __init__.py[co] in potential package.
2327 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002328static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002329find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002330{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002331 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002332 PyObject *filename;
2333 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002334
Victor Stinner547a2a62011-03-20 03:07:28 +01002335 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2336 if (filename == NULL)
2337 return -1;
2338 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002339 /* 3=len(".py") */
2340 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002341 if (match < 0) {
2342 Py_DECREF(filename);
2343 return -1;
2344 }
2345 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002346 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002347 return 1;
2348 }
2349 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002350 Py_DECREF(filename);
2351
2352 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2353 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2354 if (filename == NULL)
2355 return -1;
2356 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002357 /* 4=len(".pyc") */
2358 match = case_ok(filename, -4, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002359 if (match < 0) {
2360 Py_DECREF(filename);
2361 return -1;
2362 }
2363 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002364 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002365 return 1;
2366 }
2367 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002368 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002369 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002370}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002371
Guido van Rossum197346f1997-10-31 18:38:52 +00002372#endif /* HAVE_STAT */
2373
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002374
Victor Stinner95872862011-03-07 18:20:56 +01002375static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002376
Victor Stinner44c6c152010-08-09 00:59:10 +00002377static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002378load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002379{
2380 PyObject *m, *modules;
2381 int err;
2382
Victor Stinner44c6c152010-08-09 00:59:10 +00002383 if (type == C_BUILTIN)
2384 err = init_builtin(name);
2385 else
Victor Stinner95872862011-03-07 18:20:56 +01002386 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002387 if (err < 0)
2388 return NULL;
2389 if (err == 0) {
2390 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002391 "Purported %s module %R not found",
2392 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002393 name);
2394 return NULL;
2395 }
2396
2397 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002398 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002399 if (m == NULL) {
2400 PyErr_Format(
2401 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002402 "%s module %R not properly initialized",
2403 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002404 name);
2405 return NULL;
2406 }
2407 Py_INCREF(m);
2408 return m;
2409}
2410
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002411/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002412 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002413
Guido van Rossum79f25d91997-04-29 20:08:16 +00002414static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002415load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002416{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002417 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002418
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002419 /* First check that there's an open file (if we need one) */
2420 switch (type) {
2421 case PY_SOURCE:
2422 case PY_COMPILED:
2423 if (fp == NULL) {
2424 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002425 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002426 type);
2427 return NULL;
2428 }
2429 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002430
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002431 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002432
Victor Stinner41c5fec2011-03-13 21:46:30 -04002433 case PY_SOURCE:
2434 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002435 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002436
Victor Stinner41c5fec2011-03-13 21:46:30 -04002437 case PY_COMPILED:
2438 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002439 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002440
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002441#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002442 case C_EXTENSION:
2443 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002445#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002446
Victor Stinner41c5fec2011-03-13 21:46:30 -04002447 case PKG_DIRECTORY:
2448 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002449 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002450
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002451 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002452 case PY_FROZEN:
2453 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002454 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002456 case IMP_HOOK: {
2457 if (loader == NULL) {
2458 PyErr_SetString(PyExc_ImportError,
2459 "import hook without loader");
2460 return NULL;
2461 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04002462 m = PyObject_CallMethod(loader, "load_module", "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002463 break;
2464 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 default:
2467 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002468 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 name, type);
2470 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002471
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002472 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002474 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002475}
2476
2477
2478/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002479 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002480 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002481
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002482static int
Victor Stinner95872862011-03-07 18:20:56 +01002483init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002484{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002485 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002486
Victor Stinner95872862011-03-07 18:20:56 +01002487 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002488 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002490 for (p = PyImport_Inittab; p->name != NULL; p++) {
2491 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002492 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002493 if (p->initfunc == NULL) {
2494 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002495 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002496 name);
2497 return -1;
2498 }
2499 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002500 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002501 mod = (*p->initfunc)();
2502 if (mod == 0)
2503 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002504 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002505 return -1;
2506 /* FixupExtension has put the module into sys.modules,
2507 so we can release our own reference. */
2508 Py_DECREF(mod);
2509 return 1;
2510 }
2511 }
2512 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002513}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002514
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002515
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002516/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002517
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002518static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002519find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002520{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002521 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002522
Victor Stinner53dc7352011-03-20 01:50:21 +01002523 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002524 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002525
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002526 for (p = PyImport_FrozenModules; ; p++) {
2527 if (p->name == NULL)
2528 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002529 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002530 break;
2531 }
2532 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002533}
2534
Guido van Rossum79f25d91997-04-29 20:08:16 +00002535static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002536get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002537{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002538 struct _frozen *p = find_frozen(name);
2539 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 if (p == NULL) {
2542 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002543 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002544 name);
2545 return NULL;
2546 }
2547 if (p->code == NULL) {
2548 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002549 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002550 name);
2551 return NULL;
2552 }
2553 size = p->size;
2554 if (size < 0)
2555 size = -size;
2556 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002557}
2558
Brett Cannon8d110132009-03-15 02:20:16 +00002559static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002560is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002561{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002562 struct _frozen *p = find_frozen(name);
2563 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002564
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002565 if (p == NULL) {
2566 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002567 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002568 name);
2569 return NULL;
2570 }
Brett Cannon8d110132009-03-15 02:20:16 +00002571
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002572 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002573
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002574 if (size < 0)
2575 Py_RETURN_TRUE;
2576 else
2577 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002578}
2579
2580
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002581/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002582 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002583 an exception set if the initialization failed.
2584 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002585
2586int
Victor Stinner53dc7352011-03-20 01:50:21 +01002587PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002588{
Victor Stinner53dc7352011-03-20 01:50:21 +01002589 struct _frozen *p;
2590 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002591 int ispackage;
2592 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002593
Victor Stinner53dc7352011-03-20 01:50:21 +01002594 p = find_frozen(name);
2595
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002596 if (p == NULL)
2597 return 0;
2598 if (p->code == NULL) {
2599 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002600 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002601 name);
2602 return -1;
2603 }
2604 size = p->size;
2605 ispackage = (size < 0);
2606 if (ispackage)
2607 size = -size;
2608 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002609 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002610 name, ispackage ? " package" : "");
2611 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2612 if (co == NULL)
2613 return -1;
2614 if (!PyCode_Check(co)) {
2615 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002616 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002617 name);
2618 goto err_return;
2619 }
2620 if (ispackage) {
2621 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002622 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002623 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002624 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002625 if (m == NULL)
2626 goto err_return;
2627 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002628 l = PyList_New(1);
2629 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002630 goto err_return;
2631 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002632 Py_INCREF(name);
2633 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002634 err = PyDict_SetItemString(d, "__path__", l);
2635 Py_DECREF(l);
2636 if (err != 0)
2637 goto err_return;
2638 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002639 path = PyUnicode_FromString("<frozen>");
2640 if (path == NULL)
2641 goto err_return;
2642 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2643 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002644 if (m == NULL)
2645 goto err_return;
2646 Py_DECREF(co);
2647 Py_DECREF(m);
2648 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002649err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002650 Py_DECREF(co);
2651 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002652}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002653
Victor Stinner53dc7352011-03-20 01:50:21 +01002654int
2655PyImport_ImportFrozenModule(char *name)
2656{
2657 PyObject *nameobj;
2658 int ret;
2659 nameobj = PyUnicode_InternFromString(name);
2660 if (nameobj == NULL)
2661 return -1;
2662 ret = PyImport_ImportFrozenModuleObject(nameobj);
2663 Py_DECREF(nameobj);
2664 return ret;
2665}
2666
Guido van Rossum74e6a111994-08-29 12:54:38 +00002667
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002668/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002669 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002670
Guido van Rossum79f25d91997-04-29 20:08:16 +00002671PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002672PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002673{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002674 PyObject *pname;
2675 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002676
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002677 pname = PyUnicode_FromString(name);
2678 if (pname == NULL)
2679 return NULL;
2680 result = PyImport_Import(pname);
2681 Py_DECREF(pname);
2682 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002683}
2684
Christian Heimes072c0f12008-01-03 23:01:04 +00002685/* Import a module without blocking
2686 *
2687 * At first it tries to fetch the module from sys.modules. If the module was
2688 * never loaded before it loads it with PyImport_ImportModule() unless another
2689 * thread holds the import lock. In the latter case the function raises an
2690 * ImportError instead of blocking.
2691 *
2692 * Returns the module object with incremented ref count.
2693 */
2694PyObject *
2695PyImport_ImportModuleNoBlock(const char *name)
2696{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002697 PyObject *nameobj, *modules, *result;
Victor Stinner0af03062011-09-02 00:11:43 +02002698#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002699 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002700#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002701
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002702 /* Try to get the module from sys.modules[name] */
2703 modules = PyImport_GetModuleDict();
2704 if (modules == NULL)
2705 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002706
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002707 nameobj = PyUnicode_FromString(name);
2708 if (nameobj == NULL)
2709 return NULL;
2710 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002711 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002712 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002713 Py_INCREF(result);
2714 return result;
2715 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002716 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002717#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002718 /* check the import lock
2719 * me might be -1 but I ignore the error here, the lock function
2720 * takes care of the problem */
2721 me = PyThread_get_thread_ident();
2722 if (import_lock_thread == -1 || import_lock_thread == me) {
2723 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002724 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002725 }
2726 else {
2727 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002728 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002729 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002730 nameobj);
2731 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002732 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002733#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002734 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002735#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002736 Py_DECREF(nameobj);
2737 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002738}
2739
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002740/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002741static PyObject *get_parent(PyObject *globals,
2742 PyObject **p_name,
2743 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002744static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002745 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002746 Py_UCS4 *buf, Py_ssize_t *p_buflen,
Victor Stinner974389d2011-03-15 09:33:57 +01002747 Py_ssize_t bufsize);
2748static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002749static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002750 PyObject *buf, int recursive);
2751static PyObject * import_submodule(PyObject *mod, PyObject *name,
2752 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002753
2754/* The Magnum Opus of dotted-name import :-) */
2755
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002756static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002757import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002758 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002759{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002760 Py_UCS4 buf[MAXPATHLEN+1];
Victor Stinner974389d2011-03-15 09:33:57 +01002761 Py_ssize_t buflen;
2762 Py_ssize_t bufsize = MAXPATHLEN+1;
2763 PyObject *parent, *head, *next, *tail, *inputname, *outputname;
2764 PyObject *parent_name, *ensure_name;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002765 Py_ssize_t sep, altsep;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002766
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002767 if (PyUnicode_READY(name))
2768 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002769
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002770 sep = PyUnicode_FindChar(name, SEP, 0, PyUnicode_GET_LENGTH(name), 1);
2771 if (sep == -2)
2772 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002773#ifdef ALTSEP
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002774 altsep = PyUnicode_FindChar(name, ALTSEP, 0, PyUnicode_GET_LENGTH(name), 1);
2775 if (altsep == -2)
2776 return NULL;
2777#else
2778 altsep = -1;
Christian Heimes454f37b2008-01-10 00:10:02 +00002779#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002780 if (sep != -1 || altsep != -1)
2781 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002782 PyErr_SetString(PyExc_ImportError,
2783 "Import by filename is not supported.");
2784 return NULL;
2785 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002786
Victor Stinner974389d2011-03-15 09:33:57 +01002787 parent = get_parent(globals, &parent_name, level);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002788 if (parent == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002789 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002790 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002791
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002792 if (PyUnicode_READY(parent_name))
2793 return NULL;
2794 buflen = PyUnicode_GET_LENGTH(parent_name);
Georg Brandl4cb0de22011-09-28 21:49:49 +02002795 if (!PyUnicode_AsUCS4(parent_name, buf, Py_ARRAY_LENGTH(buf), 1)) {
Victor Stinner974389d2011-03-15 09:33:57 +01002796 Py_DECREF(parent_name);
2797 PyErr_SetString(PyExc_ValueError,
2798 "Module name too long");
2799 return NULL;
2800 }
Victor Stinner974389d2011-03-15 09:33:57 +01002801 Py_DECREF(parent_name);
2802
2803 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
2804 buf, &buflen, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002805 if (head == NULL)
2806 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002807
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002808 tail = head;
2809 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002810
2811 if (outputname != NULL) {
2812 while (1) {
2813 inputname = outputname;
2814 next = load_next(tail, tail, inputname, &outputname,
2815 buf, &buflen, bufsize);
2816 Py_DECREF(tail);
2817 Py_DECREF(inputname);
2818 if (next == NULL) {
2819 Py_DECREF(head);
2820 return NULL;
2821 }
2822 tail = next;
2823
2824 if (outputname == NULL) {
2825 break;
2826 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002827 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002828 }
2829 if (tail == Py_None) {
2830 /* If tail is Py_None, both get_parent and load_next found
2831 an empty module name: someone called __import__("") or
2832 doctored faulty bytecode */
2833 Py_DECREF(tail);
2834 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002835 PyErr_SetString(PyExc_ValueError, "Empty module name");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002836 return NULL;
2837 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002838
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002839 if (fromlist != NULL) {
2840 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2841 fromlist = NULL;
2842 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002843
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002844 if (fromlist == NULL) {
2845 Py_DECREF(tail);
2846 return head;
2847 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002848
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002849 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002850
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002851 ensure_name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
2852 buf, Py_UCS4_strlen(buf));
Victor Stinner974389d2011-03-15 09:33:57 +01002853 if (ensure_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002854 Py_DECREF(tail);
2855 return NULL;
2856 }
Victor Stinner974389d2011-03-15 09:33:57 +01002857 if (!ensure_fromlist(tail, fromlist, ensure_name, 0)) {
2858 Py_DECREF(tail);
2859 Py_DECREF(ensure_name);
2860 return NULL;
2861 }
2862 Py_DECREF(ensure_name);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002863
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002864 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002865}
2866
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002867PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002868PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2869 PyObject *locals, PyObject *fromlist,
2870 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002871{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002872 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002873 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002874 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002875 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002876 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002877 PyErr_SetString(PyExc_RuntimeError,
2878 "not holding the import lock");
2879 return NULL;
2880 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002881 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002882}
2883
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002884PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05002885PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002886 PyObject *fromlist, int level)
2887{
2888 PyObject *nameobj, *mod;
2889 nameobj = PyUnicode_FromString(name);
2890 if (nameobj == NULL)
2891 return NULL;
2892 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2893 fromlist, level);
2894 Py_DECREF(nameobj);
2895 return mod;
2896}
2897
2898
Fred Drake87590902004-05-28 20:21:36 +00002899/* Return the package that an import is being performed in. If globals comes
2900 from the module foo.bar.bat (not itself a package), this returns the
2901 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002902 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002903
Victor Stinner974389d2011-03-15 09:33:57 +01002904 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002905
2906 If globals doesn't come from a package or a module in a package, or a
2907 corresponding entry is not found in sys.modules, Py_None is returned.
2908*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002909static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002910get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002911{
Victor Stinner974389d2011-03-15 09:33:57 +01002912 PyObject *nameobj;
2913
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002914 static PyObject *namestr = NULL;
2915 static PyObject *pathstr = NULL;
2916 static PyObject *pkgstr = NULL;
2917 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2918 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002919
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002920 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002921 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002922
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002923 if (namestr == NULL) {
2924 namestr = PyUnicode_InternFromString("__name__");
2925 if (namestr == NULL)
2926 return NULL;
2927 }
2928 if (pathstr == NULL) {
2929 pathstr = PyUnicode_InternFromString("__path__");
2930 if (pathstr == NULL)
2931 return NULL;
2932 }
2933 if (pkgstr == NULL) {
2934 pkgstr = PyUnicode_InternFromString("__package__");
2935 if (pkgstr == NULL)
2936 return NULL;
2937 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002938
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002939 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002940
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002941 if ((pkgname != NULL) && (pkgname != Py_None)) {
2942 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002943 if (!PyUnicode_Check(pkgname)) {
2944 PyErr_SetString(PyExc_ValueError,
2945 "__package__ set to non-string");
2946 return NULL;
2947 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002948 if (PyUnicode_GET_LENGTH(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002949 if (level > 0) {
2950 PyErr_SetString(PyExc_ValueError,
2951 "Attempted relative import in non-package");
2952 return NULL;
2953 }
Victor Stinner974389d2011-03-15 09:33:57 +01002954 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002955 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002956 Py_INCREF(pkgname);
2957 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002958 } else {
2959 /* __package__ not set, so figure it out and set it */
2960 modname = PyDict_GetItem(globals, namestr);
2961 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002962 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002963
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002964 modpath = PyDict_GetItem(globals, pathstr);
2965 if (modpath != NULL) {
2966 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002967 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002968
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002969 error = PyDict_SetItem(globals, pkgstr, modname);
2970 if (error) {
2971 PyErr_SetString(PyExc_ValueError,
2972 "Could not set __package__");
2973 return NULL;
2974 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002975 Py_INCREF(modname);
2976 nameobj = modname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002977 } else {
2978 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002979 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002980 len = PyUnicode_FindChar(modname, '.',
2981 0, PyUnicode_GET_LENGTH(modname), -1);
2982 if (len == -2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002983 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002984 if (len < 0) {
2985 if (level > 0) {
2986 PyErr_SetString(PyExc_ValueError,
2987 "Attempted relative import in non-package");
2988 return NULL;
2989 }
2990 if (PyDict_SetItem(globals, pkgstr, Py_None)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002991 PyErr_SetString(PyExc_ValueError,
2992 "Could not set __package__");
2993 return NULL;
2994 }
Victor Stinner974389d2011-03-15 09:33:57 +01002995 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002996 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002997 pkgname = PyUnicode_Substring(modname, 0, len);
2998 if (pkgname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002999 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003000 if (PyDict_SetItem(globals, pkgstr, pkgname)) {
3001 Py_DECREF(pkgname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003002 PyErr_SetString(PyExc_ValueError,
3003 "Could not set __package__");
3004 return NULL;
3005 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003006 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003007 }
3008 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003009 if (level > 1) {
3010 Py_ssize_t dot, end = PyUnicode_GET_LENGTH(nameobj);
3011 PyObject *newname;
3012 while (--level > 0) {
3013 dot = PyUnicode_FindChar(nameobj, '.', 0, end, -1);
3014 if (dot == -2) {
3015 Py_DECREF(nameobj);
3016 return NULL;
3017 }
3018 if (dot < 0) {
3019 Py_DECREF(nameobj);
3020 PyErr_SetString(PyExc_ValueError,
3021 "Attempted relative import beyond "
3022 "toplevel package");
3023 return NULL;
3024 }
3025 end = dot;
3026 }
3027 newname = PyUnicode_Substring(nameobj, 0, end);
3028 Py_DECREF(nameobj);
3029 if (newname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003030 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003031 nameobj = newname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003032 }
Victor Stinner974389d2011-03-15 09:33:57 +01003033
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003034 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003035 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003036 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003037 int err;
3038
3039 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003040 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01003041 "Parent module %R not loaded, "
3042 "cannot perform relative import", nameobj);
3043 Py_DECREF(nameobj);
3044 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003045 }
Victor Stinner974389d2011-03-15 09:33:57 +01003046
3047 err = PyErr_WarnFormat(
3048 PyExc_RuntimeWarning, 1,
3049 "Parent module %R not found while handling absolute import",
3050 nameobj);
3051 Py_DECREF(nameobj);
3052 if (err)
3053 return NULL;
3054
3055 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003056 }
Victor Stinner974389d2011-03-15 09:33:57 +01003057 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003058 return parent;
3059 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01003060 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003061 - parent.__dict__ is globals
3062 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01003063
3064return_none:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003065 nameobj = PyUnicode_New(0, 0);
Victor Stinner974389d2011-03-15 09:33:57 +01003066 if (nameobj == NULL)
3067 return NULL;
3068 *p_name = nameobj;
3069 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003070}
3071
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003072/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003073static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003074load_next(PyObject *mod, PyObject *altmod,
3075 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003076 Py_UCS4 *buf, Py_ssize_t *p_buflen, Py_ssize_t bufsize)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003077{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003078 Py_UCS4 *dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003079 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003080 Py_UCS4 *p;
Victor Stinner974389d2011-03-15 09:33:57 +01003081 PyObject *fullname, *name, *result, *mark_name;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003082 Py_UCS4 *nameuni;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003083
Victor Stinner974389d2011-03-15 09:33:57 +01003084 *p_outputname = NULL;
3085
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003086 if (PyUnicode_GET_LENGTH(inputname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003087 /* completely empty module name should only happen in
3088 'from . import' (or '__import__("")')*/
3089 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003090 return mod;
3091 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00003092
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003093 nameuni = PyUnicode_AsUCS4Copy(inputname);
Victor Stinner974389d2011-03-15 09:33:57 +01003094 if (nameuni == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003095 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003096
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003097 dot = Py_UCS4_strchr(nameuni, '.');
Victor Stinner974389d2011-03-15 09:33:57 +01003098 if (dot != NULL) {
3099 len = dot - nameuni;
3100 if (len == 0) {
3101 PyErr_SetString(PyExc_ValueError,
3102 "Empty module name");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003103 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003104 }
3105 }
3106 else
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003107 len = PyUnicode_GET_LENGTH(inputname);
Victor Stinner974389d2011-03-15 09:33:57 +01003108
3109 if (*p_buflen+len+1 >= bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003110 PyErr_SetString(PyExc_ValueError,
3111 "Module name too long");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003112 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003113 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003114
Victor Stinner974389d2011-03-15 09:33:57 +01003115 p = buf + *p_buflen;
3116 if (p != buf) {
3117 *p++ = '.';
3118 *p_buflen += 1;
3119 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003120 Py_UCS4_strncpy(p, nameuni, len);
Victor Stinner974389d2011-03-15 09:33:57 +01003121 p[len] = '\0';
3122 *p_buflen += len;
3123
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003124 fullname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3125 buf, *p_buflen);
Victor Stinner974389d2011-03-15 09:33:57 +01003126 if (fullname == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003127 goto error;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003128 name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3129 p, len);
Victor Stinner974389d2011-03-15 09:33:57 +01003130 if (name == NULL) {
3131 Py_DECREF(fullname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003132 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003133 }
3134 result = import_submodule(mod, name, fullname);
3135 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003136 if (result == Py_None && altmod != mod) {
3137 Py_DECREF(result);
3138 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003139 result = import_submodule(altmod, name, name);
3140 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003141 if (result != NULL && result != Py_None) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003142 mark_name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3143 buf, *p_buflen);
Victor Stinner974389d2011-03-15 09:33:57 +01003144 if (mark_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003145 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003146 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003147 }
Victor Stinner974389d2011-03-15 09:33:57 +01003148 if (mark_miss(mark_name) != 0) {
3149 Py_DECREF(result);
3150 Py_DECREF(mark_name);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003151 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003152 }
3153 Py_DECREF(mark_name);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003154 Py_UCS4_strncpy(buf, nameuni, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003155 buf[len] = '\0';
3156 *p_buflen = len;
3157 }
3158 }
Victor Stinner974389d2011-03-15 09:33:57 +01003159 else
3160 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003161 if (result == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003162 goto error;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003163
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003164 if (result == Py_None) {
3165 Py_DECREF(result);
3166 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003167 "No module named %R", inputname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003168 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003169 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003170
Victor Stinner974389d2011-03-15 09:33:57 +01003171 if (dot != NULL) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003172 *p_outputname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3173 dot+1, Py_UCS4_strlen(dot+1));
Victor Stinner974389d2011-03-15 09:33:57 +01003174 if (*p_outputname == NULL) {
3175 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003176 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003177 }
3178 }
3179
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003180 PyMem_Free(nameuni);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003181 return result;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003182
3183error:
3184 PyMem_Free(nameuni);
3185 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003186}
3187
3188static int
Victor Stinner974389d2011-03-15 09:33:57 +01003189mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003190{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003191 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003192 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003193}
3194
3195static int
Victor Stinner974389d2011-03-15 09:33:57 +01003196ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003197 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003198{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003199 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003200 PyObject *fullname;
3201 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003202
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003203 if (!PyObject_HasAttrString(mod, "__path__"))
3204 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003205
Victor Stinner974389d2011-03-15 09:33:57 +01003206 fromlist_len = PySequence_Size(fromlist);
3207
3208 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003209 PyObject *item = PySequence_GetItem(fromlist, i);
3210 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003211 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003212 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003213 if (!PyUnicode_Check(item)) {
3214 PyErr_SetString(PyExc_TypeError,
3215 "Item in ``from list'' not a string");
3216 Py_DECREF(item);
3217 return 0;
3218 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003219 if (PyUnicode_READ_CHAR(item, 0) == '*') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003220 PyObject *all;
3221 Py_DECREF(item);
3222 /* See if the package defines __all__ */
3223 if (recursive)
3224 continue; /* Avoid endless recursion */
3225 all = PyObject_GetAttrString(mod, "__all__");
3226 if (all == NULL)
3227 PyErr_Clear();
3228 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003229 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003230 Py_DECREF(all);
3231 if (!ret)
3232 return 0;
3233 }
3234 continue;
3235 }
3236 hasit = PyObject_HasAttr(mod, item);
3237 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003238 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003239 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3240 if (fullname != NULL) {
3241 submod = import_submodule(mod, item, fullname);
3242 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003243 }
Victor Stinner974389d2011-03-15 09:33:57 +01003244 else
3245 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003246 Py_XDECREF(submod);
3247 if (submod == NULL) {
3248 Py_DECREF(item);
3249 return 0;
3250 }
3251 }
3252 Py_DECREF(item);
3253 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003254
Victor Stinner974389d2011-03-15 09:33:57 +01003255 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003256}
3257
Neil Schemenauer00b09662003-06-16 21:03:07 +00003258static int
Victor Stinner974389d2011-03-15 09:33:57 +01003259add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3260 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003261{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003262 if (mod == Py_None)
3263 return 1;
3264 /* Irrespective of the success of this load, make a
3265 reference to it in the parent package module. A copy gets
3266 saved in the modules dictionary under the full name, so get a
3267 reference from there, if need be. (The exception is when the
3268 load failed with a SyntaxError -- then there's no trace in
3269 sys.modules. In that case, of course, do nothing extra.) */
3270 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003271 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003272 if (submod == NULL)
3273 return 1;
3274 }
3275 if (PyModule_Check(mod)) {
3276 /* We can't use setattr here since it can give a
3277 * spurious warning if the submodule name shadows a
3278 * builtin name */
3279 PyObject *dict = PyModule_GetDict(mod);
3280 if (!dict)
3281 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003282 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003283 return 0;
3284 }
3285 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003286 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003287 return 0;
3288 }
3289 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003290}
3291
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003292static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003293import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003294{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003295 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003296 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003297 struct filedescr *fdp;
3298 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003299
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003300 /* Require:
3301 if mod == None: subname == fullname
3302 else: mod.__name__ + "." + subname == fullname
3303 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003304
Victor Stinner974389d2011-03-15 09:33:57 +01003305 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003306 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003307 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003308 }
Victor Stinner9599de52011-03-13 22:38:38 -04003309
3310 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003311 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003312 else {
Victor Stinner533d7832011-03-14 13:22:54 -04003313 path_list = PyObject_GetAttrString(mod, "__path__");
3314 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003315 PyErr_Clear();
3316 Py_INCREF(Py_None);
3317 return Py_None;
3318 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003319 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003320
Victor Stinner533d7832011-03-14 13:22:54 -04003321 fdp = find_module(fullname, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003322 &bufobj, &fp, &loader);
Victor Stinner533d7832011-03-14 13:22:54 -04003323 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003324 if (fdp == NULL) {
3325 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3326 return NULL;
3327 PyErr_Clear();
3328 Py_INCREF(Py_None);
3329 return Py_None;
3330 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003331 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3332 Py_XDECREF(bufobj);
Victor Stinner9599de52011-03-13 22:38:38 -04003333 Py_XDECREF(loader);
3334 if (fp)
3335 fclose(fp);
3336 if (m == NULL)
3337 return NULL;
3338 if (!add_submodule(mod, m, fullname, subname, modules)) {
3339 Py_XDECREF(m);
3340 return NULL;
3341 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003342 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003343}
3344
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003345
3346/* Re-import a module of any kind and return its module object, WITH
3347 INCREMENTED REFERENCE COUNT */
3348
Guido van Rossum79f25d91997-04-29 20:08:16 +00003349PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003350PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003351{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003352 PyInterpreterState *interp = PyThreadState_Get()->interp;
3353 PyObject *modules_reloading = interp->modules_reloading;
3354 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003355 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003356 PyObject *nameobj, *bufobj, *subnameobj;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003357 Py_UCS4 *name = NULL, *subname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003358 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003359 FILE *fp = NULL;
3360 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003361
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003362 if (modules_reloading == NULL) {
3363 Py_FatalError("PyImport_ReloadModule: "
3364 "no modules_reloading dictionary!");
3365 return NULL;
3366 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003367
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003368 if (m == NULL || !PyModule_Check(m)) {
3369 PyErr_SetString(PyExc_TypeError,
3370 "reload() argument must be module");
3371 return NULL;
3372 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003373 nameobj = PyModule_GetNameObject(m);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003374 if (nameobj == NULL || PyUnicode_READY(nameobj) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003375 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003376 if (m != PyDict_GetItem(modules, nameobj)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003377 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003378 "reload(): module %R not in sys.modules",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003379 nameobj);
3380 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003381 return NULL;
3382 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003383 existing_m = PyDict_GetItem(modules_reloading, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003384 if (existing_m != NULL) {
3385 /* Due to a recursive reload, this module is already
3386 being reloaded. */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003387 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003388 Py_INCREF(existing_m);
3389 return existing_m;
3390 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003391 if (PyDict_SetItem(modules_reloading, nameobj, m) < 0) {
3392 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003393 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003394 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003395
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003396 name = PyUnicode_AsUCS4Copy(nameobj);
3397 if (!name) {
3398 Py_DECREF(nameobj);
3399 return NULL;
3400 }
3401 subname = Py_UCS4_strrchr(name, '.');
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003402 if (subname == NULL) {
3403 Py_INCREF(nameobj);
3404 subnameobj = nameobj;
3405 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003406 else {
3407 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003408 Py_ssize_t len;
3409 len = subname - name;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003410 parentname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3411 name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003412 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003413 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003414 }
3415 parent = PyDict_GetItem(modules, parentname);
3416 if (parent == NULL) {
3417 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003418 "reload(): parent %R not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003419 parentname);
3420 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003421 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003422 }
3423 Py_DECREF(parentname);
Victor Stinner533d7832011-03-14 13:22:54 -04003424 path_list = PyObject_GetAttrString(parent, "__path__");
3425 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003426 PyErr_Clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003427 subname++;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003428 len = PyUnicode_GET_LENGTH(nameobj) - (len + 1);
3429 subnameobj = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3430 subname, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003431 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003432 if (subnameobj == NULL)
3433 goto error;
Victor Stinner533d7832011-03-14 13:22:54 -04003434 fdp = find_module(nameobj, subnameobj, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003435 &bufobj, &fp, &loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003436 Py_DECREF(subnameobj);
Victor Stinner533d7832011-03-14 13:22:54 -04003437 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003439 if (fdp == NULL) {
3440 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003441 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003442 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003443
Victor Stinner2fd76e42011-03-14 15:19:39 -04003444 newm = load_module(nameobj, fp, bufobj, fdp->type, loader);
3445 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003446 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003448 if (fp)
3449 fclose(fp);
3450 if (newm == NULL) {
3451 /* load_module probably removed name from modules because of
3452 * the error. Put back the original module object. We're
3453 * going to return NULL in this case regardless of whether
3454 * replacing name succeeds, so the return value is ignored.
3455 */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003456 PyDict_SetItem(modules, nameobj, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003457 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003458
3459error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003460 imp_modules_reloading_clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003461 Py_DECREF(nameobj);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003462 PyMem_Free(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003463 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003464}
3465
3466
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003467/* Higher-level import emulator which emulates the "import" statement
3468 more accurately -- it invokes the __import__() function from the
3469 builtins of the current globals. This means that the import is
3470 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003471 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003472 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003473 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003474 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003475
3476PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003477PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003478{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003479 static PyObject *silly_list = NULL;
3480 static PyObject *builtins_str = NULL;
3481 static PyObject *import_str = NULL;
3482 PyObject *globals = NULL;
3483 PyObject *import = NULL;
3484 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003485 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003486 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003488 /* Initialize constant string objects */
3489 if (silly_list == NULL) {
3490 import_str = PyUnicode_InternFromString("__import__");
3491 if (import_str == NULL)
3492 return NULL;
3493 builtins_str = PyUnicode_InternFromString("__builtins__");
3494 if (builtins_str == NULL)
3495 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003496 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003497 if (silly_list == NULL)
3498 return NULL;
3499 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003500
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003501 /* Get the builtins from current globals */
3502 globals = PyEval_GetGlobals();
3503 if (globals != NULL) {
3504 Py_INCREF(globals);
3505 builtins = PyObject_GetItem(globals, builtins_str);
3506 if (builtins == NULL)
3507 goto err;
3508 }
3509 else {
3510 /* No globals -- use standard builtins, and fake globals */
3511 builtins = PyImport_ImportModuleLevel("builtins",
3512 NULL, NULL, NULL, 0);
3513 if (builtins == NULL)
3514 return NULL;
3515 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3516 if (globals == NULL)
3517 goto err;
3518 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003519
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003520 /* Get the __import__ function from the builtins */
3521 if (PyDict_Check(builtins)) {
3522 import = PyObject_GetItem(builtins, import_str);
3523 if (import == NULL)
3524 PyErr_SetObject(PyExc_KeyError, import_str);
3525 }
3526 else
3527 import = PyObject_GetAttr(builtins, import_str);
3528 if (import == NULL)
3529 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003530
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003531 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003532 Always use absolute import here.
3533 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003534 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3535 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003536 if (r == NULL)
3537 goto err;
3538 Py_DECREF(r);
3539
3540 modules = PyImport_GetModuleDict();
3541 r = PyDict_GetItem(modules, module_name);
3542 if (r != NULL)
3543 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003544
3545 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003546 Py_XDECREF(globals);
3547 Py_XDECREF(builtins);
3548 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003549
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003550 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003551}
3552
3553
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003554/* Module 'imp' provides Python access to the primitives used for
3555 importing modules.
3556*/
3557
Guido van Rossum79f25d91997-04-29 20:08:16 +00003558static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003559imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003560{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003561 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003562
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003563 buf[0] = (char) ((magic >> 0) & 0xff);
3564 buf[1] = (char) ((magic >> 8) & 0xff);
3565 buf[2] = (char) ((magic >> 16) & 0xff);
3566 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003567
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003568 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003569}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003570
3571static PyObject *
3572imp_get_magic(PyObject *self, PyObject *noargs)
3573{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003574 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003575}
3576
3577static PyObject *
3578imp_get_tag(PyObject *self, PyObject *noargs)
3579{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003580 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003581}
3582
Guido van Rossum79f25d91997-04-29 20:08:16 +00003583static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003584imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003585{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003586 PyObject *list;
3587 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003589 list = PyList_New(0);
3590 if (list == NULL)
3591 return NULL;
3592 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3593 PyObject *item = Py_BuildValue("ssi",
3594 fdp->suffix, fdp->mode, fdp->type);
3595 if (item == NULL) {
3596 Py_DECREF(list);
3597 return NULL;
3598 }
3599 if (PyList_Append(list, item) < 0) {
3600 Py_DECREF(list);
3601 Py_DECREF(item);
3602 return NULL;
3603 }
3604 Py_DECREF(item);
3605 }
3606 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003607}
3608
Guido van Rossum79f25d91997-04-29 20:08:16 +00003609static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003610call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003611{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003612 extern int fclose(FILE *);
3613 PyObject *fob, *ret;
3614 PyObject *pathobj;
3615 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003616 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003617 int fd = -1;
3618 char *found_encoding = NULL;
3619 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003620
Victor Stinner533d7832011-03-14 13:22:54 -04003621 if (path_list == Py_None)
3622 path_list = NULL;
3623 fdp = find_module(NULL, name, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003624 &pathobj, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003625 if (fdp == NULL)
3626 return NULL;
3627 if (fp != NULL) {
3628 fd = fileno(fp);
3629 if (fd != -1)
3630 fd = dup(fd);
3631 fclose(fp);
Victor Stinnerd417d012011-06-20 15:16:55 +02003632 if (fd == -1) {
3633 PyErr_SetFromErrno(PyExc_OSError);
3634 return NULL;
3635 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003636 fp = NULL;
3637 }
3638 if (fd != -1) {
3639 if (strchr(fdp->mode, 'b') == NULL) {
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003640 /* PyTokenizer_FindEncodingFilename() returns PyMem_MALLOC'ed
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003641 memory. */
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003642 found_encoding = PyTokenizer_FindEncodingFilename(fd, pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003643 lseek(fd, 0, 0); /* Reset position */
Victor Stinner2fd76e42011-03-14 15:19:39 -04003644 if (found_encoding == NULL && PyErr_Occurred()) {
3645 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003646 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04003647 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003648 encoding = (found_encoding != NULL) ? found_encoding :
3649 (char*)PyUnicode_GetDefaultEncoding();
3650 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003651 fob = PyFile_FromFd(fd, NULL, fdp->mode, -1,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003652 (char*)encoding, NULL, NULL, 1);
3653 if (fob == NULL) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04003654 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003655 close(fd);
3656 PyMem_FREE(found_encoding);
3657 return NULL;
3658 }
3659 }
3660 else {
3661 fob = Py_None;
3662 Py_INCREF(fob);
3663 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003664 if (pathobj == NULL) {
3665 Py_INCREF(Py_None);
3666 pathobj = Py_None;
3667 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003668 ret = Py_BuildValue("NN(ssi)",
3669 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3670 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003671
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003672 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003673}
3674
Guido van Rossum79f25d91997-04-29 20:08:16 +00003675static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003676imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003677{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003678 PyObject *name, *path_list = NULL;
3679 if (!PyArg_ParseTuple(args, "U|O:find_module",
3680 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003681 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003682 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003683}
3684
3685static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003686imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003687{
Victor Stinner95872862011-03-07 18:20:56 +01003688 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003689 int ret;
3690 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003691 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003692 return NULL;
3693 ret = init_builtin(name);
3694 if (ret < 0)
3695 return NULL;
3696 if (ret == 0) {
3697 Py_INCREF(Py_None);
3698 return Py_None;
3699 }
Victor Stinner95872862011-03-07 18:20:56 +01003700 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003701 Py_XINCREF(m);
3702 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003703}
3704
Guido van Rossum79f25d91997-04-29 20:08:16 +00003705static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003706imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003707{
Victor Stinner53dc7352011-03-20 01:50:21 +01003708 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003709 int ret;
3710 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003711 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003712 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003713 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003714 if (ret < 0)
3715 return NULL;
3716 if (ret == 0) {
3717 Py_INCREF(Py_None);
3718 return Py_None;
3719 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003720 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003721 Py_XINCREF(m);
3722 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003723}
3724
Guido van Rossum79f25d91997-04-29 20:08:16 +00003725static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003726imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003727{
Victor Stinner53dc7352011-03-20 01:50:21 +01003728 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003729
Victor Stinner53dc7352011-03-20 01:50:21 +01003730 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003731 return NULL;
3732 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003733}
3734
Guido van Rossum79f25d91997-04-29 20:08:16 +00003735static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003736imp_is_frozen_package(PyObject *self, PyObject *args)
3737{
Victor Stinner53dc7352011-03-20 01:50:21 +01003738 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003739
Victor Stinner53dc7352011-03-20 01:50:21 +01003740 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003741 return NULL;
3742 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003743}
3744
3745static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003746imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003747{
Victor Stinner95872862011-03-07 18:20:56 +01003748 PyObject *name;
3749 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003750 return NULL;
3751 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003752}
3753
Guido van Rossum79f25d91997-04-29 20:08:16 +00003754static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003755imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003756{
Victor Stinner53dc7352011-03-20 01:50:21 +01003757 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003758 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003759 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003760 return NULL;
3761 p = find_frozen(name);
3762 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003763}
3764
3765static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003766get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003767{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003768 FILE *fp;
3769 if (mode[0] == 'U')
3770 mode = "r" PY_STDIOTEXTMODE;
3771 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003772 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003773 }
3774 else {
3775 int fd = PyObject_AsFileDescriptor(fob);
3776 if (fd == -1)
3777 return NULL;
3778 if (!_PyVerify_fd(fd))
3779 goto error;
3780 /* the FILE struct gets a new fd, so that it can be closed
3781 * independently of the file descriptor given
3782 */
3783 fd = dup(fd);
3784 if (fd == -1)
3785 goto error;
3786 fp = fdopen(fd, mode);
3787 }
3788 if (fp)
3789 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003790error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003791 PyErr_SetFromErrno(PyExc_IOError);
3792 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003793}
3794
Guido van Rossum79f25d91997-04-29 20:08:16 +00003795static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003796imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003797{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003798 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003799 PyObject *fob = NULL;
3800 PyObject *m;
3801 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003802 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003803 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003804 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003805 &fob))
3806 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003807 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003808 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003809 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003810 return NULL;
3811 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003812 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003813 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003814 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003815 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003816}
3817
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003818#ifdef HAVE_DYNAMIC_LOADING
3819
Guido van Rossum79f25d91997-04-29 20:08:16 +00003820static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003821imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003822{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003823 PyObject *name, *pathname, *fob = NULL, *mod;
3824 FILE *fp;
3825
3826 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3827 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003828 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003829 if (fob != NULL) {
3830 fp = get_file(NULL, fob, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003831 if (fp == NULL) {
3832 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003833 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003834 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003835 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003836 else
3837 fp = NULL;
3838 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003839 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003840 if (fp)
3841 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003842 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003843}
3844
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003845#endif /* HAVE_DYNAMIC_LOADING */
3846
Guido van Rossum79f25d91997-04-29 20:08:16 +00003847static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003848imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003849{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003850 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003851 PyObject *fob = NULL;
3852 PyObject *m;
3853 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003854 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003855 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003856 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003857 &fob))
3858 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003859 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003860 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003861 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003862 return NULL;
3863 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003864 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003865 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003866 fclose(fp);
3867 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003868}
3869
Guido van Rossum79f25d91997-04-29 20:08:16 +00003870static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003871imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003872{
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003873 PyObject *name, *fob, *pathname, *pathname_obj, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003874 char *suffix; /* Unused */
3875 char *mode;
3876 int type;
3877 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003878
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003879 if (!PyArg_ParseTuple(args, "UOO(ssi):load_module",
3880 &name, &fob, &pathname_obj, &suffix, &mode, &type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003881 return NULL;
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003882 if (pathname_obj != Py_None) {
3883 if (!PyUnicode_FSDecoder(pathname_obj, &pathname))
3884 return NULL;
3885 }
3886 else
3887 pathname = NULL;
3888
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003889 if (*mode) {
3890 /* Mode must start with 'r' or 'U' and must not contain '+'.
3891 Implicit in this test is the assumption that the mode
3892 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003893
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003894 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3895 PyErr_Format(PyExc_ValueError,
3896 "invalid file open mode %.200s", mode);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003897 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003898 return NULL;
3899 }
3900 }
3901 if (fob == Py_None)
3902 fp = NULL;
3903 else {
3904 fp = get_file(NULL, fob, mode);
3905 if (fp == NULL) {
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003906 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003907 return NULL;
3908 }
3909 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003910 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003911 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003912 if (fp)
3913 fclose(fp);
3914 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003915}
3916
3917static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003918imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003919{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003920 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003921 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003922 if (!PyArg_ParseTuple(args, "UO&:load_package",
3923 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003924 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003925 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003926 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003927 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003928}
3929
3930static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003931imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003932{
Victor Stinnerfe19d212011-03-14 14:53:28 -04003933 PyObject *name;
3934 if (!PyArg_ParseTuple(args, "U:new_module", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003935 return NULL;
Victor Stinnerfe19d212011-03-14 14:53:28 -04003936 return PyModule_NewObject(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003937}
3938
Christian Heimes13a7a212008-01-07 17:13:09 +00003939static PyObject *
3940imp_reload(PyObject *self, PyObject *v)
3941{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003942 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003943}
3944
3945PyDoc_STRVAR(doc_reload,
3946"reload(module) -> module\n\
3947\n\
3948Reload the module. The module must have been successfully imported before.");
3949
Barry Warsaw28a691b2010-04-17 00:19:56 +00003950static PyObject *
3951imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3952{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003953 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003954
Victor Stinner2f42ae52011-03-20 00:41:24 +01003955 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003956 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003957 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003958
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003959 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003960 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003961 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003962 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003963
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003964 if (debug_override != NULL &&
3965 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003966 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003967 return NULL;
3968 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003969
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003970 cpathname = make_compiled_pathname(pathname, debug);
Victor Stinner2f42ae52011-03-20 00:41:24 +01003971 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003972
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003973 if (cpathname == NULL) {
3974 PyErr_Format(PyExc_SystemError, "path buffer too short");
3975 return NULL;
3976 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003977 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003978}
3979
3980PyDoc_STRVAR(doc_cache_from_source,
3981"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3982\n\
3983The .py file does not need to exist; this simply returns the path to the\n\
3984.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3985will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3986\n\
3987If debug_override is not None, then it must be a boolean and is taken as\n\
3988the value of __debug__ instead.");
3989
3990static PyObject *
3991imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3992{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003993 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003994 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003995
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003996 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003997 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003998 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003999 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00004000
Victor Stinnerc9abda02011-03-14 13:33:46 -04004001 source = make_source_pathname(pathname);
4002 if (source == NULL) {
4003 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004004 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04004005 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004006 return NULL;
4007 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04004008 Py_DECREF(pathname);
4009 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00004010}
4011
4012PyDoc_STRVAR(doc_source_from_cache,
4013"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
4014\n\
4015The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
4016the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
4017does not conform to PEP 3147 format, ValueError will be raised.");
4018
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004019/* Doc strings */
4020
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004021PyDoc_STRVAR(doc_imp,
4022"This module provides the components needed to build your own\n\
4023__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004024
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004025PyDoc_STRVAR(doc_find_module,
4026"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004027Search for a module. If path is omitted or None, search for a\n\
4028built-in, frozen or special module and continue search in sys.path.\n\
4029The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004030package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004031
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004032PyDoc_STRVAR(doc_load_module,
4033"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004034Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004035The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004036
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004037PyDoc_STRVAR(doc_get_magic,
4038"get_magic() -> string\n\
4039Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004040
Barry Warsaw28a691b2010-04-17 00:19:56 +00004041PyDoc_STRVAR(doc_get_tag,
4042"get_tag() -> string\n\
4043Return the magic tag for .pyc or .pyo files.");
4044
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004045PyDoc_STRVAR(doc_get_suffixes,
4046"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004047Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004048that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004049
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004050PyDoc_STRVAR(doc_new_module,
4051"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004052Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004053The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004054
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004055PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00004056"lock_held() -> boolean\n\
4057Return True if the import lock is currently held, else False.\n\
4058On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00004059
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004060PyDoc_STRVAR(doc_acquire_lock,
4061"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00004062Acquires the interpreter's import lock for the current thread.\n\
4063This lock should be used by import hooks to ensure thread-safety\n\
4064when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004065On platforms without threads, this function does nothing.");
4066
4067PyDoc_STRVAR(doc_release_lock,
4068"release_lock() -> None\n\
4069Release the interpreter's import lock.\n\
4070On platforms without threads, this function does nothing.");
4071
Guido van Rossum79f25d91997-04-29 20:08:16 +00004072static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004073 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
4074 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
4075 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
4076 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
4077 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
4078 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
4079 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
4080 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
4081 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
4082 {"reload", imp_reload, METH_O, doc_reload},
4083 {"cache_from_source", (PyCFunction)imp_cache_from_source,
4084 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
4085 {"source_from_cache", (PyCFunction)imp_source_from_cache,
4086 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
4087 /* The rest are obsolete */
4088 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
4089 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
4090 {"init_builtin", imp_init_builtin, METH_VARARGS},
4091 {"init_frozen", imp_init_frozen, METH_VARARGS},
4092 {"is_builtin", imp_is_builtin, METH_VARARGS},
4093 {"is_frozen", imp_is_frozen, METH_VARARGS},
4094 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004095#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004096 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004097#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004098 {"load_package", imp_load_package, METH_VARARGS},
4099 {"load_source", imp_load_source, METH_VARARGS},
Brett Cannon442c9b92011-03-23 16:14:42 -07004100 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004101 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004102};
4103
Guido van Rossum1a8791e1998-08-04 22:46:29 +00004104static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004105setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004106{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004107 PyObject *v;
4108 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004109
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004110 v = PyLong_FromLong((long)value);
4111 err = PyDict_SetItemString(d, name, v);
4112 Py_XDECREF(v);
4113 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004114}
4115
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004116typedef struct {
4117 PyObject_HEAD
4118} NullImporter;
4119
4120static int
4121NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4122{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004123#ifndef MS_WINDOWS
4124 PyObject *path;
4125 struct stat statbuf;
4126 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004127
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004128 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4129 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004130
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004131 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4132 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004133 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004134
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004135 if (PyBytes_GET_SIZE(path) == 0) {
4136 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004137 PyErr_SetString(PyExc_ImportError, "empty pathname");
4138 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004139 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004140
4141 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4142 Py_DECREF(path);
4143 if (rv == 0) {
4144 /* it exists */
4145 if (S_ISDIR(statbuf.st_mode)) {
4146 /* it's a directory */
4147 PyErr_SetString(PyExc_ImportError, "existing directory");
4148 return -1;
4149 }
4150 }
4151#else /* MS_WINDOWS */
4152 PyObject *pathobj;
4153 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004154 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004155
4156 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4157 return -1;
4158
4159 if (!PyArg_ParseTuple(args, "U:NullImporter",
4160 &pathobj))
4161 return -1;
4162
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02004163 if (PyUnicode_GET_LENGTH(pathobj) == 0) {
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004164 PyErr_SetString(PyExc_ImportError, "empty pathname");
4165 return -1;
4166 }
4167
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004168 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004169 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004170 return -1;
4171 /* see issue1293 and issue3677:
4172 * stat() on Windows doesn't recognise paths like
4173 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4174 */
4175 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004176 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004177 if (rv != INVALID_FILE_ATTRIBUTES) {
4178 /* it exists */
4179 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4180 /* it's a directory */
4181 PyErr_SetString(PyExc_ImportError, "existing directory");
4182 return -1;
4183 }
4184 }
4185#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004186 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004187}
4188
4189static PyObject *
4190NullImporter_find_module(NullImporter *self, PyObject *args)
4191{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004192 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004193}
4194
4195static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004196 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4197 "Always return None"
4198 },
4199 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004200};
4201
4202
Christian Heimes9cd17752007-11-18 19:35:23 +00004203PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004204 PyVarObject_HEAD_INIT(NULL, 0)
4205 "imp.NullImporter", /*tp_name*/
4206 sizeof(NullImporter), /*tp_basicsize*/
4207 0, /*tp_itemsize*/
4208 0, /*tp_dealloc*/
4209 0, /*tp_print*/
4210 0, /*tp_getattr*/
4211 0, /*tp_setattr*/
4212 0, /*tp_reserved*/
4213 0, /*tp_repr*/
4214 0, /*tp_as_number*/
4215 0, /*tp_as_sequence*/
4216 0, /*tp_as_mapping*/
4217 0, /*tp_hash */
4218 0, /*tp_call*/
4219 0, /*tp_str*/
4220 0, /*tp_getattro*/
4221 0, /*tp_setattro*/
4222 0, /*tp_as_buffer*/
4223 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4224 "Null importer object", /* tp_doc */
4225 0, /* tp_traverse */
4226 0, /* tp_clear */
4227 0, /* tp_richcompare */
4228 0, /* tp_weaklistoffset */
4229 0, /* tp_iter */
4230 0, /* tp_iternext */
4231 NullImporter_methods, /* tp_methods */
4232 0, /* tp_members */
4233 0, /* tp_getset */
4234 0, /* tp_base */
4235 0, /* tp_dict */
4236 0, /* tp_descr_get */
4237 0, /* tp_descr_set */
4238 0, /* tp_dictoffset */
4239 (initproc)NullImporter_init, /* tp_init */
4240 0, /* tp_alloc */
4241 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004242};
4243
Martin v. Löwis1a214512008-06-11 05:26:20 +00004244static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004245 PyModuleDef_HEAD_INIT,
4246 "imp",
4247 doc_imp,
4248 0,
4249 imp_methods,
4250 NULL,
4251 NULL,
4252 NULL,
4253 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004254};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004255
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004256PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004257PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004258{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004259 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004260
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004261 if (PyType_Ready(&PyNullImporter_Type) < 0)
4262 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004263
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004264 m = PyModule_Create(&impmodule);
4265 if (m == NULL)
4266 goto failure;
4267 d = PyModule_GetDict(m);
4268 if (d == NULL)
4269 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004270
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004271 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4272 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4273 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4274 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4275 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4276 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4277 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4278 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4279 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4280 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004282 Py_INCREF(&PyNullImporter_Type);
4283 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4284 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004285 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004286 Py_XDECREF(m);
4287 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004288}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004289
4290
Guido van Rossumb18618d2000-05-03 23:44:39 +00004291/* API for embedding applications that want to add their own entries
4292 to the table of built-in modules. This should normally be called
4293 *before* Py_Initialize(). When the table resize fails, -1 is
4294 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004295
4296 After a similar function by Just van Rossum. */
4297
4298int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004299PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004300{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004301 static struct _inittab *our_copy = NULL;
4302 struct _inittab *p;
4303 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004304
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004305 /* Count the number of entries in both tables */
4306 for (n = 0; newtab[n].name != NULL; n++)
4307 ;
4308 if (n == 0)
4309 return 0; /* Nothing to do */
4310 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4311 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004312
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004313 /* Allocate new memory for the combined table */
4314 p = our_copy;
4315 PyMem_RESIZE(p, struct _inittab, i+n+1);
4316 if (p == NULL)
4317 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004318
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004319 /* Copy the tables into the new memory */
4320 if (our_copy != PyImport_Inittab)
4321 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4322 PyImport_Inittab = our_copy = p;
4323 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004324
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004325 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004326}
4327
4328/* Shorthand to add a single entry given a name and a function */
4329
4330int
Brett Cannona826f322009-04-02 03:41:46 +00004331PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004332{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004333 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004334
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004335 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004336
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004337 newtab[0].name = (char *)name;
4338 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004339
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004340 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004341}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004342
4343#ifdef __cplusplus
4344}
4345#endif