blob: ae1101e4ec3589576246d2366941dc267e72bf57 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Module definition and import implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00006#include "Python-ast.h"
Guido van Rossumd8faa362007-04-27 19:54:29 +00007#undef Yield /* undefine macro conflicting with winbase.h */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00008#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +00009#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000010#include "code.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000011#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000012#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000013
Guido van Rossum55a83382000-09-20 20:31:38 +000014#ifdef HAVE_FCNTL_H
15#include <fcntl.h>
16#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000017#ifdef __cplusplus
Brett Cannon9a5b25a2010-03-01 02:09:17 +000018extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000019#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000020
Christian Heimesd3eb5a152008-02-24 00:38:49 +000021#ifdef MS_WINDOWS
22/* for stat.st_mode */
23typedef unsigned short mode_t;
Daniel Stutzbachc7937792010-09-09 21:18:04 +000024/* for _mkdir */
25#include <direct.h>
Christian Heimesd3eb5a152008-02-24 00:38:49 +000026#endif
27
Guido van Rossum21d335e1993-10-15 13:01:11 +000028
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000029/* Magic word to reject .pyc files generated by other Python versions.
30 It should change for each incompatible change to the bytecode.
31
32 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000033 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000034 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000035
Guido van Rossum45aecf42006-03-15 04:58:47 +000036 The magic numbers must be spaced apart at least 2 values, as the
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000037 -U interpeter flag will cause MAGIC+1 being used. They have been
38 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000039
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000040 There were a variety of old schemes for setting the magic number.
41 The current working scheme is to increment the previous value by
42 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000043
Barry Warsaw28a691b2010-04-17 00:19:56 +000044 Starting with the adoption of PEP 3147 in Python 3.2, every bump in magic
45 number also includes a new "magic tag", i.e. a human readable string used
46 to represent the magic number in __pycache__ directories. When you change
47 the magic number, you must also set a new unique magic tag. Generally this
48 can be named after the Python major version of the magic number bump, but
49 it can really be anything, as long as it's different than anything else
50 that's come before. The tags are included in the following table, starting
51 with Python 3.2a0.
52
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000053 Known values:
54 Python 1.5: 20121
55 Python 1.5.1: 20121
56 Python 1.5.2: 20121
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000057 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000058 Python 2.0: 50823
59 Python 2.0.1: 50823
60 Python 2.1: 60202
61 Python 2.1.1: 60202
62 Python 2.1.2: 60202
63 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000064 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000065 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000066 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000067 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000068 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000069 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000070 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000071 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000072 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000073 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000074 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
75 Python 2.5b3: 62111 (fix wrong code: x += yield)
76 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000077 storing constants that should have been removed)
Thomas Wouters89f507f2006-12-13 04:49:30 +000078 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
Christian Heimes99170a52007-12-19 02:07:34 +000079 Python 2.6a0: 62151 (peephole optimizations and STORE_MAP opcode)
Christian Heimesdd15f6c2008-03-16 00:07:10 +000080 Python 2.6a1: 62161 (WITH_CLEANUP optimization)
Guido van Rossum45aecf42006-03-15 04:58:47 +000081 Python 3000: 3000
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000082 3010 (removed UNARY_CONVERT)
83 3020 (added BUILD_SET)
84 3030 (added keyword-only parameters)
85 3040 (added signature annotations)
86 3050 (print becomes a function)
87 3060 (PEP 3115 metaclass syntax)
88 3061 (string literals become unicode)
89 3071 (PEP 3109 raise changes)
90 3081 (PEP 3137 make __file__ and __name__ unicode)
91 3091 (kill str8 interning)
92 3101 (merge from 2.6a0, see 62151)
93 3103 (__file__ points to source file)
Benjamin Peterson0f6cae02009-12-10 02:09:08 +000094 Python 3.0a4: 3111 (WITH_CLEANUP optimization).
95 Python 3.0a5: 3131 (lexical exception stacking, including POP_EXCEPT)
96 Python 3.1a0: 3141 (optimize list, set and dict comprehensions:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000097 change LIST_APPEND and SET_ADD, add MAP_ADD)
Benjamin Peterson0f6cae02009-12-10 02:09:08 +000098 Python 3.1a0: 3151 (optimize conditional branches:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000099 introduce POP_JUMP_IF_FALSE and POP_JUMP_IF_TRUE)
Benjamin Peterson876b2f22009-06-28 03:18:59 +0000100 Python 3.2a0: 3160 (add SETUP_WITH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000101 tag: cpython-32
Antoine Pitrou74a69fa2010-09-04 18:43:52 +0000102 Python 3.2a1: 3170 (add DUP_TOP_TWO, remove DUP_TOPX and ROT_FOUR)
103 tag: cpython-32
Benjamin Peterson6246d6d2010-09-10 21:51:44 +0000104 Python 3.2a2 3180 (add DELETE_DEREF)
Benjamin Petersone7c15fa2011-06-19 19:54:45 -0500105 Python 3.3a0 3190 __class__ super closure changed
Tim Peters36515e22001-11-18 04:06:29 +0000106*/
Guido van Rossum3ddee711991-12-16 13:06:34 +0000107
Nick Coghlancd419ab2010-09-11 00:39:25 +0000108/* MAGIC must change whenever the bytecode emitted by the compiler may no
109 longer be understood by older implementations of the eval loop (usually
110 due to the addition of new opcodes)
Martin v. Löwisfadcd312011-10-23 18:08:20 +0200111 TAG must change for each major Python release. The magic number will take
112 care of any bytecode changes that occur during development.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000113*/
Benjamin Peterson48deae12011-06-03 17:50:16 -0500114#define QUOTE(arg) #arg
115#define STRIFY(name) QUOTE(name)
116#define MAJOR STRIFY(PY_MAJOR_VERSION)
117#define MINOR STRIFY(PY_MINOR_VERSION)
Benjamin Petersone7c15fa2011-06-19 19:54:45 -0500118#define MAGIC (3190 | ((long)'\r'<<16) | ((long)'\n'<<24))
Benjamin Peterson48deae12011-06-03 17:50:16 -0500119#define TAG "cpython-" MAJOR MINOR;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000120#define CACHEDIR "__pycache__"
121/* Current magic word and string tag as globals. */
Guido van Rossum96774c12000-05-01 20:19:08 +0000122static long pyc_magic = MAGIC;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000123static const char *pyc_tag = TAG;
Benjamin Peterson48deae12011-06-03 17:50:16 -0500124#undef QUOTE
125#undef STRIFY
126#undef MAJOR
127#undef MINOR
Guido van Rossum96774c12000-05-01 20:19:08 +0000128
Victor Stinner95872862011-03-07 18:20:56 +0100129/* See _PyImport_FixupExtensionObject() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +0000130static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000131
Victor Stinnerfe7c5b52011-04-05 01:48:03 +0200132/* Function from Parser/tokenizer.c */
133extern char * PyTokenizer_FindEncodingFilename(int, PyObject *);
134
Guido van Rossum771c6c81997-10-31 18:37:24 +0000135/* This table is defined in config.c: */
136extern struct _inittab _PyImport_Inittab[];
137
138struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +0000139
Guido van Rossumed1170e1999-12-20 21:23:41 +0000140/* these tables define the module suffixes that Python recognizes */
141struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000142
Guido van Rossumed1170e1999-12-20 21:23:41 +0000143static const struct filedescr _PyImport_StandardFiletab[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000144 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000145#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000146 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000147#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000148 {".pyc", "rb", PY_COMPILED},
149 {0, 0}
Guido van Rossumed1170e1999-12-20 21:23:41 +0000150};
151
Victor Stinnerd0296212011-03-14 14:04:10 -0400152static PyObject *initstr = NULL;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200153_Py_IDENTIFIER(__path__);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000154
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000155/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000156
157void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000158_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000159{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000160 const struct filedescr *scan;
161 struct filedescr *filetab;
162 int countD = 0;
163 int countS = 0;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000164
Victor Stinnerd0296212011-03-14 14:04:10 -0400165 initstr = PyUnicode_InternFromString("__init__");
166 if (initstr == NULL)
167 Py_FatalError("Can't initialize import variables");
168
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000169 /* prepare _PyImport_Filetab: copy entries from
170 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
171 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000172#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000173 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
174 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000175#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000176 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
177 ++countS;
178 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
179 if (filetab == NULL)
180 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000181#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000182 memcpy(filetab, _PyImport_DynLoadFiletab,
183 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000184#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000185 memcpy(filetab + countD, _PyImport_StandardFiletab,
186 countS * sizeof(struct filedescr));
187 filetab[countD + countS].suffix = NULL;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000188
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000189 _PyImport_Filetab = filetab;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000190
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000191 if (Py_OptimizeFlag) {
192 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
193 for (; filetab->suffix != NULL; filetab++) {
194 if (strcmp(filetab->suffix, ".pyc") == 0)
195 filetab->suffix = ".pyo";
196 }
197 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000198}
199
Guido van Rossum25ce5661997-08-02 03:10:38 +0000200void
Just van Rossum52e14d62002-12-30 22:08:05 +0000201_PyImportHooks_Init(void)
202{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000203 PyObject *v, *path_hooks = NULL, *zimpimport;
204 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +0000205
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000206 /* adding sys.path_hooks and sys.path_importer_cache, setting up
207 zipimport */
208 if (PyType_Ready(&PyNullImporter_Type) < 0)
209 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000210
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000211 if (Py_VerboseFlag)
212 PySys_WriteStderr("# installing zipimport hook\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000213
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000214 v = PyList_New(0);
215 if (v == NULL)
216 goto error;
217 err = PySys_SetObject("meta_path", v);
218 Py_DECREF(v);
219 if (err)
220 goto error;
221 v = PyDict_New();
222 if (v == NULL)
223 goto error;
224 err = PySys_SetObject("path_importer_cache", v);
225 Py_DECREF(v);
226 if (err)
227 goto error;
228 path_hooks = PyList_New(0);
229 if (path_hooks == NULL)
230 goto error;
231 err = PySys_SetObject("path_hooks", path_hooks);
232 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +0000233 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000234 PyErr_Print();
235 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
236 "path_importer_cache, or NullImporter failed"
237 );
238 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000239
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000240 zimpimport = PyImport_ImportModule("zipimport");
241 if (zimpimport == NULL) {
242 PyErr_Clear(); /* No zip import module -- okay */
243 if (Py_VerboseFlag)
244 PySys_WriteStderr("# can't import zipimport\n");
245 }
246 else {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200247 _Py_IDENTIFIER(zipimporter);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200248 PyObject *zipimporter = _PyObject_GetAttrId(zimpimport,
249 &PyId_zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000250 Py_DECREF(zimpimport);
251 if (zipimporter == NULL) {
252 PyErr_Clear(); /* No zipimporter object -- okay */
253 if (Py_VerboseFlag)
254 PySys_WriteStderr(
255 "# can't import zipimport.zipimporter\n");
256 }
257 else {
258 /* sys.path_hooks.append(zipimporter) */
259 err = PyList_Append(path_hooks, zipimporter);
260 Py_DECREF(zipimporter);
261 if (err)
262 goto error;
263 if (Py_VerboseFlag)
264 PySys_WriteStderr(
265 "# installed zipimport hook\n");
266 }
267 }
268 Py_DECREF(path_hooks);
Just van Rossum52e14d62002-12-30 22:08:05 +0000269}
270
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000271/* Locking primitives to prevent parallel imports of the same module
272 in different threads to return with a partially loaded module.
273 These calls are serialized by the global interpreter lock. */
274
275#ifdef WITH_THREAD
276
Guido van Rossum49b56061998-10-01 20:42:43 +0000277#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000278
Guido van Rossum65d5b571998-12-21 19:32:43 +0000279static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000280static long import_lock_thread = -1;
281static int import_lock_level = 0;
282
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000283void
284_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000285{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000286 long me = PyThread_get_thread_ident();
287 if (me == -1)
288 return; /* Too bad */
289 if (import_lock == NULL) {
290 import_lock = PyThread_allocate_lock();
291 if (import_lock == NULL)
292 return; /* Nothing much we can do. */
293 }
294 if (import_lock_thread == me) {
295 import_lock_level++;
296 return;
297 }
298 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
299 {
300 PyThreadState *tstate = PyEval_SaveThread();
301 PyThread_acquire_lock(import_lock, 1);
302 PyEval_RestoreThread(tstate);
303 }
304 import_lock_thread = me;
305 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000306}
307
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000308int
309_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000310{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000311 long me = PyThread_get_thread_ident();
312 if (me == -1 || import_lock == NULL)
313 return 0; /* Too bad */
314 if (import_lock_thread != me)
315 return -1;
316 import_lock_level--;
317 if (import_lock_level == 0) {
318 import_lock_thread = -1;
319 PyThread_release_lock(import_lock);
320 }
321 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000322}
323
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000324/* This function is called from PyOS_AfterFork to ensure that newly
325 created child processes do not share locks with the parent.
326 We now acquire the import lock around fork() calls but on some platforms
327 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000328
329void
330_PyImport_ReInitLock(void)
331{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000332 if (import_lock != NULL)
333 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000334 if (import_lock_level > 1) {
335 /* Forked as a side effect of import */
336 long me = PyThread_get_thread_ident();
337 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100338 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000339 import_lock_thread = me;
340 import_lock_level--;
341 } else {
342 import_lock_thread = -1;
343 import_lock_level = 0;
344 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000345}
346
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000347#endif
348
Tim Peters69232342001-08-30 05:16:13 +0000349static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000350imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000351{
Tim Peters69232342001-08-30 05:16:13 +0000352#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000353 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000354#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000355 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000356#endif
357}
358
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000359static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000360imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000361{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000362#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000363 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000364#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000365 Py_INCREF(Py_None);
366 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000367}
368
369static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000370imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000371{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000372#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000373 if (_PyImport_ReleaseLock() < 0) {
374 PyErr_SetString(PyExc_RuntimeError,
375 "not holding the import lock");
376 return NULL;
377 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000378#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000379 Py_INCREF(Py_None);
380 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000381}
382
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100383void
384_PyImport_Fini(void)
385{
386 Py_XDECREF(extensions);
387 extensions = NULL;
388 PyMem_DEL(_PyImport_Filetab);
389 _PyImport_Filetab = NULL;
390#ifdef WITH_THREAD
391 if (import_lock != NULL) {
392 PyThread_free_lock(import_lock);
393 import_lock = NULL;
394 }
395#endif
396}
397
Guido van Rossumd8faa362007-04-27 19:54:29 +0000398static void
399imp_modules_reloading_clear(void)
400{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000401 PyInterpreterState *interp = PyThreadState_Get()->interp;
402 if (interp->modules_reloading != NULL)
403 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000404}
405
Guido van Rossum25ce5661997-08-02 03:10:38 +0000406/* Helper for sys */
407
408PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000409PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000410{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000411 PyInterpreterState *interp = PyThreadState_GET()->interp;
412 if (interp->modules == NULL)
413 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
414 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000415}
416
Guido van Rossum3f5da241990-12-20 15:06:42 +0000417
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000418/* List of names to clear in sys */
419static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000420 "path", "argv", "ps1", "ps2",
421 "last_type", "last_value", "last_traceback",
422 "path_hooks", "path_importer_cache", "meta_path",
423 /* misc stuff */
424 "flags", "float_info",
425 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000426};
427
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000428static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000429 "stdin", "__stdin__",
430 "stdout", "__stdout__",
431 "stderr", "__stderr__",
432 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000433};
434
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000435
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000436/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000437
Guido van Rossum3f5da241990-12-20 15:06:42 +0000438void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000439PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000440{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000441 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000442 PyObject *key, *value, *dict;
443 PyInterpreterState *interp = PyThreadState_GET()->interp;
444 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000446 if (modules == NULL)
447 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000448
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000449 /* Delete some special variables first. These are common
450 places where user values hide and people complain when their
451 destructors fail. Since the modules containing them are
452 deleted *last* of all, they would come too late in the normal
453 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000454
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000455 value = PyDict_GetItemString(modules, "builtins");
456 if (value != NULL && PyModule_Check(value)) {
457 dict = PyModule_GetDict(value);
458 if (Py_VerboseFlag)
459 PySys_WriteStderr("# clear builtins._\n");
460 PyDict_SetItemString(dict, "_", Py_None);
461 }
462 value = PyDict_GetItemString(modules, "sys");
463 if (value != NULL && PyModule_Check(value)) {
464 char **p;
465 PyObject *v;
466 dict = PyModule_GetDict(value);
467 for (p = sys_deletes; *p != NULL; p++) {
468 if (Py_VerboseFlag)
469 PySys_WriteStderr("# clear sys.%s\n", *p);
470 PyDict_SetItemString(dict, *p, Py_None);
471 }
472 for (p = sys_files; *p != NULL; p+=2) {
473 if (Py_VerboseFlag)
474 PySys_WriteStderr("# restore sys.%s\n", *p);
475 v = PyDict_GetItemString(dict, *(p+1));
476 if (v == NULL)
477 v = Py_None;
478 PyDict_SetItemString(dict, *p, v);
479 }
480 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000482 /* First, delete __main__ */
483 value = PyDict_GetItemString(modules, "__main__");
484 if (value != NULL && PyModule_Check(value)) {
485 if (Py_VerboseFlag)
486 PySys_WriteStderr("# cleanup __main__\n");
487 _PyModule_Clear(value);
488 PyDict_SetItemString(modules, "__main__", Py_None);
489 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000490
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000491 /* The special treatment of "builtins" here is because even
492 when it's not referenced as a module, its dictionary is
493 referenced by almost every module's __builtins__. Since
494 deleting a module clears its dictionary (even if there are
495 references left to it), we need to delete the "builtins"
496 module last. Likewise, we don't delete sys until the very
497 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000498
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000499 Also note that we 'delete' modules by replacing their entry
500 in the modules dict with None, rather than really deleting
501 them; this avoids a rehash of the modules dictionary and
502 also marks them as "non existent" so they won't be
503 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000505 /* Next, repeatedly delete modules with a reference count of
506 one (skipping builtins and sys) and delete them */
507 do {
508 ndone = 0;
509 pos = 0;
510 while (PyDict_Next(modules, &pos, &key, &value)) {
511 if (value->ob_refcnt != 1)
512 continue;
513 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100514 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000515 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100516 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000517 continue;
518 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100519 PySys_FormatStderr(
520 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000521 _PyModule_Clear(value);
522 PyDict_SetItem(modules, key, Py_None);
523 ndone++;
524 }
525 }
526 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000528 /* Next, delete all modules (still skipping builtins and sys) */
529 pos = 0;
530 while (PyDict_Next(modules, &pos, &key, &value)) {
531 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100532 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000533 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100534 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000535 continue;
536 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100537 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 _PyModule_Clear(value);
539 PyDict_SetItem(modules, key, Py_None);
540 }
541 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000542
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000543 /* Next, delete sys and builtins (in that order) */
544 value = PyDict_GetItemString(modules, "sys");
545 if (value != NULL && PyModule_Check(value)) {
546 if (Py_VerboseFlag)
547 PySys_WriteStderr("# cleanup sys\n");
548 _PyModule_Clear(value);
549 PyDict_SetItemString(modules, "sys", Py_None);
550 }
551 value = PyDict_GetItemString(modules, "builtins");
552 if (value != NULL && PyModule_Check(value)) {
553 if (Py_VerboseFlag)
554 PySys_WriteStderr("# cleanup builtins\n");
555 _PyModule_Clear(value);
556 PyDict_SetItemString(modules, "builtins", Py_None);
557 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000558
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000559 /* Finally, clear and delete the modules directory */
560 PyDict_Clear(modules);
561 interp->modules = NULL;
562 Py_DECREF(modules);
563 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000564}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000565
566
Barry Warsaw28a691b2010-04-17 00:19:56 +0000567/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000568
569long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000570PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000571{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000572 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000573}
574
575
Barry Warsaw28a691b2010-04-17 00:19:56 +0000576const char *
577PyImport_GetMagicTag(void)
578{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000579 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000580}
581
Guido van Rossum25ce5661997-08-02 03:10:38 +0000582/* Magic for extension modules (built-in as well as dynamically
583 loaded). To prevent initializing an extension module more than
584 once, we keep a static dictionary 'extensions' keyed by module name
585 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000586 modules), containing these modules. A copy of the module's
Victor Stinner95872862011-03-07 18:20:56 +0100587 dictionary is stored by calling _PyImport_FixupExtensionObject()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000588 immediately after the module initialization function succeeds. A
589 copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100590 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000591
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000592 Modules which do support multiple initialization set their m_size
593 field to a non-negative number (indicating the size of the
594 module-specific state). They are still recorded in the extensions
595 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000596*/
597
598int
Victor Stinner95872862011-03-07 18:20:56 +0100599_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
600 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000601{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000602 PyObject *modules, *dict;
603 struct PyModuleDef *def;
604 if (extensions == NULL) {
605 extensions = PyDict_New();
606 if (extensions == NULL)
607 return -1;
608 }
609 if (mod == NULL || !PyModule_Check(mod)) {
610 PyErr_BadInternalCall();
611 return -1;
612 }
613 def = PyModule_GetDef(mod);
614 if (!def) {
615 PyErr_BadInternalCall();
616 return -1;
617 }
618 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100619 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000620 return -1;
621 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100622 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000623 return -1;
624 }
625 if (def->m_size == -1) {
626 if (def->m_base.m_copy) {
627 /* Somebody already imported the module,
628 likely under a different name.
629 XXX this should really not happen. */
630 Py_DECREF(def->m_base.m_copy);
631 def->m_base.m_copy = NULL;
632 }
633 dict = PyModule_GetDict(mod);
634 if (dict == NULL)
635 return -1;
636 def->m_base.m_copy = PyDict_Copy(dict);
637 if (def->m_base.m_copy == NULL)
638 return -1;
639 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000640 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000641 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000642}
643
Victor Stinner49d3f252010-10-17 01:24:53 +0000644int
645_PyImport_FixupBuiltin(PyObject *mod, char *name)
646{
647 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100648 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100649 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100650 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000651 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100652 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
653 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000654 return res;
655}
656
Guido van Rossum25ce5661997-08-02 03:10:38 +0000657PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100658_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000659{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000660 PyObject *mod, *mdict;
661 PyModuleDef* def;
662 if (extensions == NULL)
663 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000664 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000665 if (def == NULL)
666 return NULL;
667 if (def->m_size == -1) {
668 /* Module does not support repeated initialization */
669 if (def->m_base.m_copy == NULL)
670 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100671 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000672 if (mod == NULL)
673 return NULL;
674 mdict = PyModule_GetDict(mod);
675 if (mdict == NULL)
676 return NULL;
677 if (PyDict_Update(mdict, def->m_base.m_copy))
678 return NULL;
679 }
680 else {
681 if (def->m_base.m_init == NULL)
682 return NULL;
683 mod = def->m_base.m_init();
684 if (mod == NULL)
685 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100686 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000687 Py_DECREF(mod);
688 }
689 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100690 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000691 Py_DECREF(mod);
692 return NULL;
693 }
694 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100695 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000696 name, filename);
697 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000698
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000699}
700
Victor Stinner49d3f252010-10-17 01:24:53 +0000701PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000702_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000703{
Victor Stinner95872862011-03-07 18:20:56 +0100704 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100705 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100706 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000707 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100708 res = _PyImport_FindExtensionObject(nameobj, nameobj);
709 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000710 return res;
711}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000712
713/* Get the module object corresponding to a module name.
714 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000715 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000716 Because the former action is most common, THIS DOES NOT RETURN A
717 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000718
Guido van Rossum79f25d91997-04-29 20:08:16 +0000719PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000720PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000721{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000722 PyObject *modules = PyImport_GetModuleDict();
723 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000724
Victor Stinner27ee0892011-03-04 12:57:09 +0000725 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000726 PyModule_Check(m))
727 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000728 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000729 if (m == NULL)
730 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000731 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000732 Py_DECREF(m);
733 return NULL;
734 }
735 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000736
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000737 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000738}
739
Victor Stinner27ee0892011-03-04 12:57:09 +0000740PyObject *
741PyImport_AddModule(const char *name)
742{
743 PyObject *nameobj, *module;
744 nameobj = PyUnicode_FromString(name);
745 if (nameobj == NULL)
746 return NULL;
747 module = PyImport_AddModuleObject(nameobj);
748 Py_DECREF(nameobj);
749 return module;
750}
751
752
Tim Peters1cd70172004-08-02 03:52:12 +0000753/* Remove name from sys.modules, if it's there. */
754static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000755remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000756{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000757 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000758 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000759 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000760 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000761 Py_FatalError("import: deleting existing key in"
762 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000763}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000764
Victor Stinnerc9abda02011-03-14 13:33:46 -0400765static PyObject * get_sourcefile(PyObject *filename);
766static PyObject *make_source_pathname(PyObject *pathname);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200767static PyObject* make_compiled_pathname(PyObject *pathname, int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000768
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000769/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000770 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
771 * removed from sys.modules, to avoid leaving damaged module objects
772 * in sys.modules. The caller may wish to restore the original
773 * module object (if any) in this case; PyImport_ReloadModule is an
774 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000775 *
776 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
777 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000778 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000779PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000780PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000781{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000782 return PyImport_ExecCodeModuleWithPathnames(
783 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000784}
785
786PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000787PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000788{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000789 return PyImport_ExecCodeModuleWithPathnames(
790 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000791}
792
793PyObject *
794PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000795 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000796{
Victor Stinner27ee0892011-03-04 12:57:09 +0000797 PyObject *m = NULL;
798 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
799
800 nameobj = PyUnicode_FromString(name);
801 if (nameobj == NULL)
802 return NULL;
803
804 if (pathname != NULL) {
805 pathobj = PyUnicode_DecodeFSDefault(pathname);
806 if (pathobj == NULL)
807 goto error;
808 } else
809 pathobj = NULL;
810 if (cpathname != NULL) {
811 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
812 if (cpathobj == NULL)
813 goto error;
814 } else
815 cpathobj = NULL;
816 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
817error:
818 Py_DECREF(nameobj);
819 Py_XDECREF(pathobj);
820 Py_XDECREF(cpathobj);
821 return m;
822}
823
824PyObject*
825PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
826 PyObject *cpathname)
827{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 PyObject *modules = PyImport_GetModuleDict();
829 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000830
Victor Stinner27ee0892011-03-04 12:57:09 +0000831 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000832 if (m == NULL)
833 return NULL;
834 /* If the module is being reloaded, we get the old module back
835 and re-use its dict to exec the new code. */
836 d = PyModule_GetDict(m);
837 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
838 if (PyDict_SetItemString(d, "__builtins__",
839 PyEval_GetBuiltins()) != 0)
840 goto error;
841 }
842 /* Remember the filename as the __file__ attribute */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 if (pathname != NULL) {
Victor Stinnerc9abda02011-03-14 13:33:46 -0400844 v = get_sourcefile(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000845 if (v == NULL)
846 PyErr_Clear();
847 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000848 else
849 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000850 if (v == NULL) {
851 v = ((PyCodeObject *)co)->co_filename;
852 Py_INCREF(v);
853 }
854 if (PyDict_SetItemString(d, "__file__", v) != 0)
855 PyErr_Clear(); /* Not important enough to report */
856 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000857
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000858 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000859 if (cpathname != NULL)
860 v = cpathname;
861 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000862 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000863 if (PyDict_SetItemString(d, "__cached__", v) != 0)
864 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000865
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000866 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 if (v == NULL)
868 goto error;
869 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000870
Victor Stinner27ee0892011-03-04 12:57:09 +0000871 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000872 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000873 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000874 name);
875 return NULL;
876 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000877
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000878 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000880 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000881
882 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000883 remove_module(name);
884 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000885}
886
887
Barry Warsaw28a691b2010-04-17 00:19:56 +0000888/* Like strrchr(string, '/') but searches for the rightmost of either SEP
889 or ALTSEP, if the latter is defined.
890*/
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200891static Py_UCS4*
892rightmost_sep(Py_UCS4 *s)
Victor Stinnerc9abda02011-03-14 13:33:46 -0400893{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200894 Py_UCS4 *found, c;
Victor Stinnerc9abda02011-03-14 13:33:46 -0400895 for (found = NULL; (c = *s); s++) {
896 if (c == SEP
897#ifdef ALTSEP
898 || c == ALTSEP
899#endif
900 )
901 {
902 found = s;
903 }
904 }
905 return found;
906}
907
Martin v. Löwis2db72862011-10-23 17:29:08 +0200908/* Like rightmost_sep, but operate on unicode objects. */
909static Py_ssize_t
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200910rightmost_sep_obj(PyObject* o, Py_ssize_t start, Py_ssize_t end)
Martin v. Löwis2db72862011-10-23 17:29:08 +0200911{
912 Py_ssize_t found, i;
913 Py_UCS4 c;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200914 for (found = -1, i = start; i < end; i++) {
Martin v. Löwis2db72862011-10-23 17:29:08 +0200915 c = PyUnicode_READ_CHAR(o, i);
916 if (c == SEP
917#ifdef ALTSEP
918 || c == ALTSEP
919#endif
920 )
921 {
922 found = i;
923 }
924 }
925 return found;
926}
Victor Stinnerc9abda02011-03-14 13:33:46 -0400927
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000928/* Given a pathname for a Python source file, fill a buffer with the
929 pathname for the corresponding compiled file. Return the pathname
930 for the compiled file, or NULL if there's no space in the buffer.
Victor Stinner2f42ae52011-03-20 00:41:24 +0100931 Doesn't set an exception.
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000932
Martin v. Löwis30260a72011-10-23 17:35:46 +0200933 foo.py -> __pycache__/foo.<tag>.pyc
934
935 pathstr is assumed to be "ready".
936*/
Victor Stinner2f42ae52011-03-20 00:41:24 +0100937
938static PyObject*
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200939make_compiled_pathname(PyObject *pathstr, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000940{
Martin v. Löwis2db72862011-10-23 17:29:08 +0200941 PyObject *result;
942 Py_ssize_t fname, ext, len, i, pos, taglen;
Martin v. Löwisfadcd312011-10-23 18:08:20 +0200943 Py_ssize_t pycache_len = sizeof(CACHEDIR) - 1;
Martin v. Löwis2db72862011-10-23 17:29:08 +0200944 int kind;
945 void *data;
Antoine Pitroub528fcf2011-10-25 00:21:02 +0200946 Py_UCS4 lastsep;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000947
Martin v. Löwis2db72862011-10-23 17:29:08 +0200948 /* Compute the output string size. */
949 len = PyUnicode_GET_LENGTH(pathstr);
950 /* If there is no separator, this returns -1, so
Antoine Pitroub528fcf2011-10-25 00:21:02 +0200951 fname will be 0. */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200952 fname = rightmost_sep_obj(pathstr, 0, len) + 1;
Antoine Pitroub528fcf2011-10-25 00:21:02 +0200953 /* Windows: re-use the last separator character (/ or \\) when
954 appending the __pycache__ path. */
955 if (fname > 0)
956 lastsep = PyUnicode_READ_CHAR(pathstr, fname -1);
957 else
958 lastsep = SEP;
Martin v. Löwis2db72862011-10-23 17:29:08 +0200959 ext = fname - 1;
960 for(i = fname; i < len; i++)
961 if (PyUnicode_READ_CHAR(pathstr, i) == '.')
962 ext = i + 1;
963 if (ext < fname)
964 /* No dot in filename; use entire filename */
965 ext = len;
966
967 /* result = pathstr[:fname] + "__pycache__" + SEP +
968 pathstr[fname:ext] + tag + ".py[co]" */
969 taglen = strlen(pyc_tag);
Martin v. Löwis2cc0cc52011-10-23 18:41:56 +0200970 result = PyUnicode_New(ext + pycache_len + 1 + taglen + 4,
Martin v. Löwis2db72862011-10-23 17:29:08 +0200971 PyUnicode_MAX_CHAR_VALUE(pathstr));
972 if (!result)
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200973 return NULL;
Martin v. Löwis2db72862011-10-23 17:29:08 +0200974 kind = PyUnicode_KIND(result);
975 data = PyUnicode_DATA(result);
976 PyUnicode_CopyCharacters(result, 0, pathstr, 0, fname);
977 pos = fname;
Martin v. Löwis2cc0cc52011-10-23 18:41:56 +0200978 for (i = 0; i < pycache_len; i++)
Martin v. Löwisfadcd312011-10-23 18:08:20 +0200979 PyUnicode_WRITE(kind, data, pos++, CACHEDIR[i]);
Antoine Pitroub528fcf2011-10-25 00:21:02 +0200980 PyUnicode_WRITE(kind, data, pos++, lastsep);
Martin v. Löwis2db72862011-10-23 17:29:08 +0200981 PyUnicode_CopyCharacters(result, pos, pathstr,
982 fname, ext - fname);
983 pos += ext - fname;
984 for (i = 0; pyc_tag[i]; i++)
985 PyUnicode_WRITE(kind, data, pos++, pyc_tag[i]);
986 PyUnicode_WRITE(kind, data, pos++, '.');
987 PyUnicode_WRITE(kind, data, pos++, 'p');
988 PyUnicode_WRITE(kind, data, pos++, 'y');
989 PyUnicode_WRITE(kind, data, pos++, debug ? 'c' : 'o');
990 return result;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000991}
992
993
Barry Warsaw28a691b2010-04-17 00:19:56 +0000994/* Given a pathname to a Python byte compiled file, return the path to the
995 source file, if the path matches the PEP 3147 format. This does not check
996 for any file existence, however, if the pyc file name does not match PEP
997 3147 style, NULL is returned. buf must be at least as big as pathname;
Victor Stinnerc9abda02011-03-14 13:33:46 -0400998 the resulting path will always be shorter.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000999
Victor Stinnerc9abda02011-03-14 13:33:46 -04001000 (...)/__pycache__/foo.<tag>.pyc -> (...)/foo.py */
1001
1002static PyObject*
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001003make_source_pathname(PyObject *path)
Barry Warsaw28a691b2010-04-17 00:19:56 +00001004{
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001005 Py_ssize_t left, right, dot0, dot1, len;
1006 Py_ssize_t i, j;
1007 PyObject *result;
1008 int kind;
1009 void *data;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001010
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001011 len = PyUnicode_GET_LENGTH(path);
1012 if (len > MAXPATHLEN)
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001013 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001014
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001015 /* Look back two slashes from the end. In between these two slashes
1016 must be the string __pycache__ or this is not a PEP 3147 style
1017 path. It's possible for there to be only one slash.
1018 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001019 right = rightmost_sep_obj(path, 0, len);
1020 if (right == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001021 return NULL;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001022 left = rightmost_sep_obj(path, 0, right);
1023 if (left == -1)
1024 left = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001025 else
1026 left++;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001027 if (right-left != sizeof(CACHEDIR)-1)
1028 return NULL;
1029 for (i = 0; i < sizeof(CACHEDIR)-1; i++)
1030 if (PyUnicode_READ_CHAR(path, left+i) != CACHEDIR[i])
1031 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001032
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001033 /* Now verify that the path component to the right of the last slash
1034 has two dots in it.
1035 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001036 dot0 = PyUnicode_FindChar(path, '.', right+1, len, 1);
1037 if (dot0 < 0)
1038 return NULL;
1039 dot1 = PyUnicode_FindChar(path, '.', dot0+1, len, 1);
1040 if (dot1 < 0)
1041 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001042 /* Too many dots? */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001043 if (PyUnicode_FindChar(path, '.', dot1+1, len, 1) != -1)
1044 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001045
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 /* This is a PEP 3147 path. Start by copying everything from the
1047 start of pathname up to and including the leftmost slash. Then
1048 copy the file's basename, removing the magic tag and adding a .py
1049 suffix.
1050 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001051 result = PyUnicode_New(left + (dot0-right) + 2,
1052 PyUnicode_MAX_CHAR_VALUE(path));
1053 if (!result)
1054 return NULL;
1055 kind = PyUnicode_KIND(result);
1056 data = PyUnicode_DATA(result);
1057 PyUnicode_CopyCharacters(result, 0, path, 0, (i = left));
1058 PyUnicode_CopyCharacters(result, left, path, right+1,
1059 (j = dot0-right));
1060 PyUnicode_WRITE(kind, data, i+j, 'p');
1061 PyUnicode_WRITE(kind, data, i+j+1, 'y');
1062 return result;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001063}
1064
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001065/* Given a pathname for a Python source file, its time of last
1066 modification, and a pathname for a compiled file, check whether the
1067 compiled file represents the same version of the source. If so,
1068 return a FILE pointer for the compiled file, positioned just after
1069 the header; if not, return NULL.
1070 Doesn't set an exception. */
1071
1072static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001073check_compiled_module(PyObject *pathname, time_t mtime, PyObject *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001074{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001075 FILE *fp;
1076 long magic;
1077 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001078
Victor Stinner2f42ae52011-03-20 00:41:24 +01001079 fp = _Py_fopen(cpathname, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001080 if (fp == NULL)
1081 return NULL;
1082 magic = PyMarshal_ReadLongFromFile(fp);
1083 if (magic != pyc_magic) {
1084 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001085 PySys_FormatStderr("# %R has bad magic\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001086 fclose(fp);
1087 return NULL;
1088 }
1089 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
1090 if (pyc_mtime != mtime) {
1091 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001092 PySys_FormatStderr("# %R has bad mtime\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 fclose(fp);
1094 return NULL;
1095 }
1096 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001097 PySys_FormatStderr("# %R matches %R\n", cpathname, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001098 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001099}
1100
1101
1102/* Read a code object from a file and check it for validity */
1103
Guido van Rossum79f25d91997-04-29 20:08:16 +00001104static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001105read_compiled_module(PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001106{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001107 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001108
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001109 co = PyMarshal_ReadLastObjectFromFile(fp);
1110 if (co == NULL)
1111 return NULL;
1112 if (!PyCode_Check(co)) {
1113 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001114 "Non-code object in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001115 Py_DECREF(co);
1116 return NULL;
1117 }
1118 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001119}
1120
1121
1122/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001123 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001124
Guido van Rossum79f25d91997-04-29 20:08:16 +00001125static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001126load_compiled_module(PyObject *name, PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001127{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001128 long magic;
1129 PyCodeObject *co;
1130 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001131
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001132 magic = PyMarshal_ReadLongFromFile(fp);
1133 if (magic != pyc_magic) {
1134 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001135 "Bad magic number in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001136 return NULL;
1137 }
1138 (void) PyMarshal_ReadLongFromFile(fp);
1139 co = read_compiled_module(cpathname, fp);
1140 if (co == NULL)
1141 return NULL;
1142 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001143 PySys_FormatStderr("import %U # precompiled from %R\n",
1144 name, cpathname);
1145 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1146 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001147 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001148
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001149 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001150}
1151
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001152/* Parse a source file and return the corresponding code object */
1153
Guido van Rossum79f25d91997-04-29 20:08:16 +00001154static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001155parse_source_module(PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001156{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001157 PyCodeObject *co;
1158 PyObject *pathbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001159 mod_ty mod;
1160 PyCompilerFlags flags;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001161 PyArena *arena;
1162
1163 pathbytes = PyUnicode_EncodeFSDefault(pathname);
1164 if (pathbytes == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001165 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001166
Victor Stinner2f42ae52011-03-20 00:41:24 +01001167 arena = PyArena_New();
1168 if (arena == NULL) {
1169 Py_DECREF(pathbytes);
1170 return NULL;
1171 }
1172
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001173 flags.cf_flags = 0;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001174 mod = PyParser_ASTFromFile(fp, PyBytes_AS_STRING(pathbytes), NULL,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001175 Py_file_input, 0, 0, &flags,
1176 NULL, arena);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001177 if (mod != NULL)
1178 co = PyAST_Compile(mod, PyBytes_AS_STRING(pathbytes), NULL, arena);
1179 else
1180 co = NULL;
1181 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001182 PyArena_Free(arena);
1183 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001184}
1185
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001186/* Write a compiled module to a file, placing the time of last
1187 modification of its source into the header.
1188 Errors are ignored, if a write error occurs an attempt is made to
1189 remove the file. */
1190
1191static void
Victor Stinner2f42ae52011-03-20 00:41:24 +01001192write_compiled_module(PyCodeObject *co, PyObject *cpathname,
1193 struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001194{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001195 Py_UCS4 *cpathname_ucs4;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001196 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001197 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001198#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001199 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001200#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001201 mode_t dirmode = (srcstat->st_mode |
1202 S_IXUSR | S_IXGRP | S_IXOTH |
1203 S_IWUSR | S_IWGRP | S_IWOTH);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001204 PyObject *dirbytes;
Antoine Pitrou707033a2011-10-17 19:28:44 +02001205 PyObject *cpathbytes, *cpathbytes_tmp;
1206 Py_ssize_t cpathbytes_len;
Victor Stinner783c82c2011-04-20 03:27:51 +02001207#endif
Charles-François Natali0c929d92011-11-10 19:12:29 +01001208 int fd;
Victor Stinner783c82c2011-04-20 03:27:51 +02001209 PyObject *dirname;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001210 Py_UCS4 *dirsep;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001211 int res, ok;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001212
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001213 /* Ensure that the __pycache__ directory exists. */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001214 cpathname_ucs4 = PyUnicode_AsUCS4Copy(cpathname);
1215 if (!cpathname_ucs4)
1216 return;
1217 dirsep = rightmost_sep(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001218 if (dirsep == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001219 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001220 PySys_FormatStderr("# no %s path found %R\n", CACHEDIR, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001221 return;
1222 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001223 dirname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
1224 cpathname_ucs4,
1225 dirsep - cpathname_ucs4);
1226 PyMem_Free(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001227 if (dirname == NULL) {
1228 PyErr_Clear();
1229 return;
1230 }
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001231
1232#ifdef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001233 res = CreateDirectoryW(PyUnicode_AS_UNICODE(dirname), NULL);
1234 ok = (res != 0);
1235 if (!ok && GetLastError() == ERROR_ALREADY_EXISTS)
1236 ok = 1;
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001237#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001238 dirbytes = PyUnicode_EncodeFSDefault(dirname);
1239 if (dirbytes == NULL) {
1240 PyErr_Clear();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001241 return;
1242 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001243 res = mkdir(PyBytes_AS_STRING(dirbytes), dirmode);
1244 Py_DECREF(dirbytes);
1245 if (0 <= res)
1246 ok = 1;
1247 else
1248 ok = (errno == EEXIST);
1249#endif
1250 if (!ok) {
1251 if (Py_VerboseFlag)
1252 PySys_FormatStderr("# cannot create cache dir %R\n", dirname);
1253 Py_DECREF(dirname);
1254 return;
1255 }
1256 Py_DECREF(dirname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001257
Victor Stinner783c82c2011-04-20 03:27:51 +02001258#ifdef MS_WINDOWS
1259 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1260 fd = _wopen(PyUnicode_AS_UNICODE(cpathname),
1261 O_EXCL | O_CREAT | O_WRONLY | O_TRUNC | O_BINARY,
1262 mode);
1263 if (0 <= fd)
1264 fp = fdopen(fd, "wb");
1265 else
1266 fp = NULL;
1267#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001268 /* Under POSIX, we first write to a tmp file and then take advantage
1269 of atomic renaming. */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001270 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1271 if (cpathbytes == NULL) {
1272 PyErr_Clear();
1273 return;
1274 }
Antoine Pitrou707033a2011-10-17 19:28:44 +02001275 cpathbytes_len = PyBytes_GET_SIZE(cpathbytes);
Charles-François Natali0c929d92011-11-10 19:12:29 +01001276 cpathbytes_tmp = PyBytes_FromStringAndSize(NULL, cpathbytes_len + 4);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001277 if (cpathbytes_tmp == NULL) {
1278 Py_DECREF(cpathbytes);
1279 PyErr_Clear();
1280 return;
1281 }
1282 memcpy(PyBytes_AS_STRING(cpathbytes_tmp), PyBytes_AS_STRING(cpathbytes),
1283 cpathbytes_len);
Charles-François Natali0c929d92011-11-10 19:12:29 +01001284 memcpy(PyBytes_AS_STRING(cpathbytes_tmp) + cpathbytes_len, ".tmp", 4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001285
Charles-François Natali0c929d92011-11-10 19:12:29 +01001286 fd = open(PyBytes_AS_STRING(cpathbytes_tmp),
1287 O_CREAT | O_EXCL | O_WRONLY, 0666);
Charles-François Natalie695eec2011-10-31 20:47:31 +01001288 if (0 <= fd)
1289 fp = fdopen(fd, "wb");
1290 else
1291 fp = NULL;
Victor Stinner783c82c2011-04-20 03:27:51 +02001292#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001293 if (fp == NULL) {
1294 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001295 PySys_FormatStderr(
1296 "# can't create %R\n", cpathname);
Victor Stinner783c82c2011-04-20 03:27:51 +02001297#ifndef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001298 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001299 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001300#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001301 return;
1302 }
1303 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1304 /* First write a 0 for mtime */
1305 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1306 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001307 fflush(fp);
1308 /* Now write the true mtime */
1309 fseek(fp, 4L, 0);
1310 assert(mtime < LONG_MAX);
1311 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001312 if (fflush(fp) != 0 || ferror(fp)) {
1313 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001314 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001315 /* Don't keep partial file */
1316 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001317#ifdef MS_WINDOWS
1318 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1319#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001320 (void) unlink(PyBytes_AS_STRING(cpathbytes_tmp));
Victor Stinner2f42ae52011-03-20 00:41:24 +01001321 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001322 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001323#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001324 return;
1325 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001326 fclose(fp);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001327 /* Under POSIX, do an atomic rename */
1328#ifndef MS_WINDOWS
1329 if (rename(PyBytes_AS_STRING(cpathbytes_tmp),
1330 PyBytes_AS_STRING(cpathbytes))) {
1331 if (Py_VerboseFlag)
1332 PySys_FormatStderr("# can't write %R\n", cpathname);
1333 /* Don't keep tmp file */
1334 unlink(PyBytes_AS_STRING(cpathbytes_tmp));
1335 Py_DECREF(cpathbytes);
1336 Py_DECREF(cpathbytes_tmp);
1337 return;
1338 }
1339 Py_DECREF(cpathbytes);
1340 Py_DECREF(cpathbytes_tmp);
1341#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001342 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001343 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001344}
1345
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001346static void
1347update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1348{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001349 PyObject *constants, *tmp;
1350 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001351
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001352 if (PyUnicode_Compare(co->co_filename, oldname))
1353 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001354
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001355 tmp = co->co_filename;
1356 co->co_filename = newname;
1357 Py_INCREF(co->co_filename);
1358 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001359
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001360 constants = co->co_consts;
1361 n = PyTuple_GET_SIZE(constants);
1362 for (i = 0; i < n; i++) {
1363 tmp = PyTuple_GET_ITEM(constants, i);
1364 if (PyCode_Check(tmp))
1365 update_code_filenames((PyCodeObject *)tmp,
1366 oldname, newname);
1367 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001368}
1369
Victor Stinner2f42ae52011-03-20 00:41:24 +01001370static void
1371update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001372{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001373 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001374
Victor Stinner2f42ae52011-03-20 00:41:24 +01001375 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1376 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001377
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001378 oldname = co->co_filename;
1379 Py_INCREF(oldname);
1380 update_code_filenames(co, oldname, newname);
1381 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001382}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001383
Brett Cannon442c9b92011-03-23 16:14:42 -07001384static PyObject *
1385imp_fix_co_filename(PyObject *self, PyObject *args)
1386{
1387 PyObject *co;
1388 PyObject *file_path;
1389
1390 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
1391 return NULL;
1392
1393 if (!PyCode_Check(co)) {
1394 PyErr_SetString(PyExc_TypeError,
1395 "first argument must be a code object");
1396 return NULL;
1397 }
1398
1399 if (!PyUnicode_Check(file_path)) {
1400 PyErr_SetString(PyExc_TypeError,
1401 "second argument must be a string");
1402 return NULL;
1403 }
1404
1405 update_compiled_module((PyCodeObject*)co, file_path);
1406
1407 Py_RETURN_NONE;
1408}
1409
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001410/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001411 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1412 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001413
Guido van Rossum79f25d91997-04-29 20:08:16 +00001414static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001415load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001416{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001417 struct stat st;
1418 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001419 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001420 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001421 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001422
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001423 if (fstat(fileno(fp), &st) != 0) {
1424 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001425 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001426 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001427 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 }
Fred Drake4c82b232000-06-30 16:18:57 +00001429#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001430 /* Python's .pyc timestamp handling presumes that the timestamp fits
1431 in 4 bytes. This will be fine until sometime in the year 2038,
1432 when a 4-byte signed time_t will overflow.
1433 */
1434 if (st.st_mtime >> 32) {
1435 PyErr_SetString(PyExc_OverflowError,
1436 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001437 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001438 }
Fred Drake4c82b232000-06-30 16:18:57 +00001439#endif
Martin v. Löwis30260a72011-10-23 17:35:46 +02001440 if (PyUnicode_READY(pathname) < 0)
1441 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001442 cpathname = make_compiled_pathname(pathname, !Py_OptimizeFlag);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001443
1444 if (cpathname != NULL)
1445 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1446 else
1447 fpc = NULL;
1448
1449 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001450 co = read_compiled_module(cpathname, fpc);
1451 fclose(fpc);
1452 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001453 goto error;
1454 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001455 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001456 PySys_FormatStderr("import %U # precompiled from %R\n",
1457 name, cpathname);
1458 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1459 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001460 }
1461 else {
1462 co = parse_source_module(pathname, fp);
1463 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001464 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001465 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001466 PySys_FormatStderr("import %U # from %R\n",
Victor Stinner98dbba52011-03-14 15:15:47 -04001467 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001468 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001469 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1470 if (ro == NULL || !PyObject_IsTrue(ro))
1471 write_compiled_module(co, cpathname, &st);
1472 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001473 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1474 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001475 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001476 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001477
Victor Stinner2f42ae52011-03-20 00:41:24 +01001478error:
1479 Py_XDECREF(cpathbytes);
1480 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001481 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001482}
1483
Christian Heimes3b06e532008-01-07 20:12:44 +00001484/* Get source file -> unicode or None
1485 * Returns the path to the py file if available, else the given path
1486 */
1487static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001488get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001489{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001490 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001491 Py_UCS4 *fileuni;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001492 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001494
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001495 len = PyUnicode_GET_LENGTH(filename);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001496 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001498
Victor Stinnerc9abda02011-03-14 13:33:46 -04001499 /* don't match *.pyc or *.pyo? */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001500 fileuni = PyUnicode_AsUCS4Copy(filename);
1501 if (!fileuni)
1502 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001503 if (len < 5
1504 || fileuni[len-4] != '.'
1505 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1506 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1507 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001508
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001509 /* Start by trying to turn PEP 3147 path into source path. If that
1510 * fails, just chop off the trailing character, i.e. legacy pyc path
1511 * to py.
1512 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001513 py = make_source_pathname(filename);
1514 if (py == NULL) {
1515 PyErr_Clear();
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001516 py = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001517 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001518 if (py == NULL)
1519 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001520
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001521 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode)) {
1522 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001523 return py;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001524 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001525 Py_DECREF(py);
1526 goto unchanged;
1527
1528error:
1529 PyErr_Clear();
1530unchanged:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001531 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001532 Py_INCREF(filename);
1533 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001534}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001535
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001536/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001537static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001538static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001539 PyObject **, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001540static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001541
1542/* Load a package and return its module object WITH INCREMENTED
1543 REFERENCE COUNT */
1544
1545static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001546load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001547{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001548 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001549 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001550 int err;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001551 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001552 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001553
Victor Stinnerc9abda02011-03-14 13:33:46 -04001554 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001555 if (m == NULL)
1556 return NULL;
1557 if (Py_VerboseFlag)
Victor Stinner98dbba52011-03-14 15:15:47 -04001558 PySys_FormatStderr("import %U # directory %R\n",
1559 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001560 file = get_sourcefile(pathname);
1561 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001562 return NULL;
1563 path_list = Py_BuildValue("[O]", file);
1564 if (path_list == NULL) {
1565 Py_DECREF(file);
1566 return NULL;
1567 }
1568 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001569 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001570 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001571 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001572 err = PyDict_SetItemString(d, "__path__", path_list);
1573 if (err != 0) {
1574 Py_DECREF(path_list);
1575 return NULL;
1576 }
Victor Stinner533d7832011-03-14 13:22:54 -04001577 fdp = find_module(name, initstr, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001578 &bufobj, &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001579 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001580 if (fdp == NULL) {
1581 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1582 PyErr_Clear();
1583 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001584 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 }
1586 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001587 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001589 m = load_module(name, fp, bufobj, fdp->type, NULL);
1590 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001591 if (fp != NULL)
1592 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001593 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001594}
1595
1596
1597/* Helper to test for built-in module */
1598
1599static int
Victor Stinner95872862011-03-07 18:20:56 +01001600is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001601{
Victor Stinner95872862011-03-07 18:20:56 +01001602 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001603 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001604 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1605 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001606 if (PyImport_Inittab[i].initfunc == NULL)
1607 return -1;
1608 else
1609 return 1;
1610 }
1611 }
1612 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001613}
1614
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001615
Just van Rossum52e14d62002-12-30 22:08:05 +00001616/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1617 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001618 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001619 that can handle the path item. Return None if no hook could;
1620 this tells our caller it should fall back to the builtin
1621 import mechanism. Cache the result in path_importer_cache.
1622 Returns a borrowed reference. */
1623
1624static PyObject *
1625get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001626 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001627{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001628 PyObject *importer;
1629 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001630
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001631 /* These conditions are the caller's responsibility: */
1632 assert(PyList_Check(path_hooks));
1633 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001634
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001635 nhooks = PyList_Size(path_hooks);
1636 if (nhooks < 0)
1637 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001638
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001639 importer = PyDict_GetItem(path_importer_cache, p);
1640 if (importer != NULL)
1641 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001642
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 /* set path_importer_cache[p] to None to avoid recursion */
1644 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1645 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001646
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001647 for (j = 0; j < nhooks; j++) {
1648 PyObject *hook = PyList_GetItem(path_hooks, j);
1649 if (hook == NULL)
1650 return NULL;
1651 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1652 if (importer != NULL)
1653 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001654
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001655 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1656 return NULL;
1657 }
1658 PyErr_Clear();
1659 }
1660 if (importer == NULL) {
1661 importer = PyObject_CallFunctionObjArgs(
1662 (PyObject *)&PyNullImporter_Type, p, NULL
1663 );
1664 if (importer == NULL) {
1665 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1666 PyErr_Clear();
1667 return Py_None;
1668 }
1669 }
1670 }
1671 if (importer != NULL) {
1672 int err = PyDict_SetItem(path_importer_cache, p, importer);
1673 Py_DECREF(importer);
1674 if (err != 0)
1675 return NULL;
1676 }
1677 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001678}
1679
Christian Heimes9cd17752007-11-18 19:35:23 +00001680PyAPI_FUNC(PyObject *)
1681PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001682 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001683
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001684 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1685 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1686 importer = get_path_importer(path_importer_cache,
1687 path_hooks, path);
1688 }
1689 }
1690 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1691 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001692}
1693
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001694/* Search the path (default sys.path) for a module. Return the
1695 corresponding filedescr struct, and (via return arguments) the
1696 pathname and an open file. Return NULL if the module is not found. */
1697
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001698#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001699extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1700 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001701#endif
1702
Victor Stinner547a2a62011-03-20 03:07:28 +01001703/* Forward */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001704static int case_ok(PyObject *, Py_ssize_t, PyObject *);
Victor Stinner547a2a62011-03-20 03:07:28 +01001705static int find_init_module(PyObject *);
Just van Rossum52e14d62002-12-30 22:08:05 +00001706static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001707
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001708/* Get the path of a module: get its importer and call importer.find_module()
1709 hook, or check if the module if a package (if path/__init__.py exists).
1710
1711 -1: error: a Python error occurred
1712 0: ignore: an error occurred because of invalid data, but the error is not
1713 important enough to be reported.
1714 1: get path: module not found, but *buf contains its path
1715 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1716 and *buf is the path */
1717
1718static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001719find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001720 PyObject *path_hooks, PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001721 PyObject **p_path, PyObject **p_loader, struct filedescr **p_fd)
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001722{
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001723 PyObject *path_unicode, *filename = NULL;
1724 Py_ssize_t len, pos;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001725 struct stat statbuf;
1726 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001727 int result, addsep;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001728
1729 if (PyUnicode_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001730 Py_INCREF(path);
1731 path_unicode = path;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001732 }
1733 else if (PyBytes_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001734 path_unicode = PyUnicode_DecodeFSDefaultAndSize(
1735 PyBytes_AS_STRING(path), PyBytes_GET_SIZE(path));
1736 if (path_unicode == NULL)
1737 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001738 }
1739 else
1740 return 0;
1741
Victor Stinner46084ba2011-10-06 02:39:42 +02001742 if (PyUnicode_READY(path_unicode))
1743 return -1;
1744
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001745 len = PyUnicode_GET_LENGTH(path_unicode);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001746 if (PyUnicode_FindChar(path_unicode, 0, 0, len, 1) != -1) {
1747 result = 0;
1748 goto out; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001749 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001750
1751 /* sys.path_hooks import hook */
1752 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001753 _Py_IDENTIFIER(find_module);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001754 PyObject *importer;
1755
1756 importer = get_path_importer(path_importer_cache,
1757 path_hooks, path);
1758 if (importer == NULL) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001759 result = -1;
1760 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001761 }
1762 /* Note: importer is a borrowed reference */
1763 if (importer != Py_None) {
1764 PyObject *loader;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001765 loader = _PyObject_CallMethodId(importer,
1766 &PyId_find_module, "O", fullname);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001767 if (loader == NULL) {
1768 result = -1; /* error */
1769 goto out;
1770 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001771 if (loader != Py_None) {
1772 /* a loader was found */
1773 *p_loader = loader;
1774 *p_fd = &importhookdescr;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001775 result = 2;
1776 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001777 }
1778 Py_DECREF(loader);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001779 result = 0;
1780 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001781 }
1782 }
1783 /* no hook was found, use builtin import */
1784
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001785 addsep = 0;
1786 if (len > 0 && PyUnicode_READ_CHAR(path_unicode, len-1) != SEP
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001787#ifdef ALTSEP
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001788 && PyUnicode_READ_CHAR(path_unicode, len-1) != ALTSEP
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001789#endif
1790 )
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001791 addsep = 1;
1792 filename = PyUnicode_New(len + PyUnicode_GET_LENGTH(name) + addsep,
1793 Py_MAX(PyUnicode_MAX_CHAR_VALUE(path_unicode),
1794 PyUnicode_MAX_CHAR_VALUE(name)));
1795 if (filename == NULL) {
1796 result = -1;
1797 goto out;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001798 }
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001799 PyUnicode_CopyCharacters(filename, 0, path_unicode, 0, len);
1800 pos = len;
1801 if (addsep)
1802 PyUnicode_WRITE(PyUnicode_KIND(filename),
1803 PyUnicode_DATA(filename),
1804 pos++, SEP);
1805 PyUnicode_CopyCharacters(filename, pos, name, 0,
1806 PyUnicode_GET_LENGTH(name));
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001807
1808 /* Check for package import (buf holds a directory name,
1809 and there's an __init__ module in that directory */
1810#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001811 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001812 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1813 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001814 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001815
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001816 match = case_ok(filename, 0, name);
1817 if (match < 0) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001818 result = -1;
1819 goto out;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001820 }
1821 if (match) { /* case matches */
1822 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001823 *p_path = filename;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001824 filename = NULL;
Victor Stinnerd0296212011-03-14 14:04:10 -04001825 *p_fd = &fd_package;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001826 result = 2;
1827 goto out;
Victor Stinnerd0296212011-03-14 14:04:10 -04001828 }
1829 else {
1830 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001831 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001832 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001833 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001834 if (err) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001835 result = -1;
1836 goto out;
Victor Stinner547a2a62011-03-20 03:07:28 +01001837 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001838 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001839 }
1840 }
1841#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001842 *p_path = filename;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001843 filename = NULL;
1844 result = 1;
1845 out:
1846 Py_DECREF(path_unicode);
1847 Py_XDECREF(filename);
1848 return result;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001849}
1850
1851/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001852 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001853
1854 If the module is found, return a file descriptor, write the path in
1855 *p_filename, write the pointer to the file object into *p_fp, and (if
1856 p_loader is not NULL) the loader into *p_loader.
1857
1858 Otherwise, raise an exception and return NULL. */
1859
Victor Stinner37580282011-03-20 01:34:43 +01001860static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001861find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001862 PyObject *search_path_list, PyObject *path_hooks,
1863 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001864 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001865{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001866 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001867 struct filedescr *fdp = NULL;
1868 char *filemode;
1869 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001870 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001871 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001872
Victor Stinner37580282011-03-20 01:34:43 +01001873 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001874 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001875 PyObject *path;
1876 int ok;
1877
1878 path = PyList_GetItem(search_path_list, i);
1879 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001880 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001881
Victor Stinner2fd76e42011-03-14 15:19:39 -04001882 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001883 ok = find_module_path(fullname, name, path,
1884 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001885 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001886 if (ok < 0)
1887 return NULL;
1888 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001889 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001890 if (ok == 2) {
1891 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001892 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001893 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001894
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001895 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001896 struct stat statbuf;
1897
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001898 filemode = fdp->mode;
1899 if (filemode[0] == 'U')
1900 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001901
Victor Stinner2fd76e42011-03-14 15:19:39 -04001902 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1903 if (filename == NULL) {
1904 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001905 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001906 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001907
1908 if (Py_VerboseFlag > 1)
1909 PySys_FormatStderr("# trying %R\n", filename);
1910
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001911 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
1912 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1913 {
1914 Py_DECREF(filename);
1915 continue;
1916 }
1917
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001918 fp = _Py_fopen(filename, filemode);
1919 if (fp == NULL) {
1920 Py_DECREF(filename);
Victor Stinner925ef392011-06-20 15:01:10 +02001921 if (PyErr_Occurred()) {
1922 Py_DECREF(prefix);
1923 return NULL;
1924 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001925 continue;
1926 }
1927 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1928 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001929 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001930 Py_DECREF(filename);
1931 return NULL;
1932 }
1933 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001934 Py_DECREF(prefix);
1935 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001936 *p_fp = fp;
1937 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001938 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001939 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001940
1941 fclose(fp);
1942 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001943 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001944 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001945 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001946 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04001947 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04001948 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001949}
1950
Victor Stinner37580282011-03-20 01:34:43 +01001951/* Find a module:
1952
1953 - try find_module() of each sys.meta_path hook
1954 - try find_frozen()
1955 - try is_builtin()
1956 - try _PyWin_FindRegisteredModule() (Windows only)
1957 - otherwise, call find_module_path_list() with search_path_list (if not
1958 NULL) or sys.path
1959
Victor Stinner2fd76e42011-03-14 15:19:39 -04001960 fullname can be NULL, but only if p_loader is NULL.
1961
Victor Stinner37580282011-03-20 01:34:43 +01001962 Return:
1963
1964 - &fd_builtin (C_BUILTIN) if it is a builtin
1965 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04001966 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01001967 if it is a package
1968 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1969 importer loader was found
1970 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1971 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04001972 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01001973 - NULL on error
1974
Victor Stinner2fd76e42011-03-14 15:19:39 -04001975 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
1976 Eg. *p_path is set to NULL for a builtin package.
1977*/
Victor Stinner37580282011-03-20 01:34:43 +01001978
1979static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001980find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001981 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01001982{
1983 Py_ssize_t i, npath;
1984 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1985 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1986 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01001987
Victor Stinner2fd76e42011-03-14 15:19:39 -04001988 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01001989 *p_fp = NULL;
1990 if (p_loader != NULL)
1991 *p_loader = NULL;
1992
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001993 if (PyUnicode_GET_LENGTH(name) > MAXPATHLEN) {
1994 PyErr_SetString(PyExc_OverflowError,
1995 "module name is too long");
1996 return NULL;
1997 }
1998
Victor Stinner37580282011-03-20 01:34:43 +01001999 /* sys.meta_path import hook */
2000 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002001 _Py_IDENTIFIER(find_module);
Victor Stinner37580282011-03-20 01:34:43 +01002002 PyObject *meta_path;
2003
2004 meta_path = PySys_GetObject("meta_path");
2005 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02002006 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002007 "sys.meta_path must be a list of "
2008 "import hooks");
2009 return NULL;
2010 }
2011 Py_INCREF(meta_path); /* zap guard */
2012 npath = PyList_Size(meta_path);
2013 for (i = 0; i < npath; i++) {
2014 PyObject *loader;
2015 PyObject *hook = PyList_GetItem(meta_path, i);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002016 loader = _PyObject_CallMethodId(hook, &PyId_find_module,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002017 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01002018 search_path_list != NULL ?
2019 search_path_list : Py_None);
2020 if (loader == NULL) {
2021 Py_DECREF(meta_path);
2022 return NULL; /* true error */
2023 }
2024 if (loader != Py_None) {
2025 /* a loader was found */
2026 *p_loader = loader;
2027 Py_DECREF(meta_path);
2028 return &importhookdescr;
2029 }
2030 Py_DECREF(loader);
2031 }
2032 Py_DECREF(meta_path);
2033 }
2034
Victor Stinnerdf75a022011-03-14 13:40:04 -04002035 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002036 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01002037
2038 if (search_path_list == NULL) {
2039#ifdef MS_COREDLL
2040 FILE *fp;
2041 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01002042#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04002043 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01002044 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01002045#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04002046 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01002047 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01002048 *p_fp = fp;
2049 return fdp;
2050 }
2051 else if (PyErr_Occurred())
2052 return NULL;
2053#endif
Victor Stinner37580282011-03-20 01:34:43 +01002054 search_path_list = PySys_GetObject("path");
2055 }
2056
2057 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
Victor Stinner16191322011-09-15 19:28:05 +02002058 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002059 "sys.path must be a list of directory names");
2060 return NULL;
2061 }
2062
2063 path_hooks = PySys_GetObject("path_hooks");
2064 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02002065 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002066 "sys.path_hooks must be a list of "
2067 "import hooks");
2068 return NULL;
2069 }
2070 path_importer_cache = PySys_GetObject("path_importer_cache");
2071 if (path_importer_cache == NULL ||
2072 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02002073 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002074 "sys.path_importer_cache must be a dict");
2075 return NULL;
2076 }
2077
2078 return find_module_path_list(fullname, name,
2079 search_path_list, path_hooks,
2080 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002081 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002082}
2083
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002084/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002085 * The arguments here are tricky, best shown by example:
2086 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2087 * ^ ^ ^ ^
2088 * |--------------------- buf ---------------------|
2089 * |------------------- len ------------------|
2090 * |------ name -------|
2091 * |----- namelen -----|
2092 * buf is the full path, but len only counts up to (& exclusive of) the
2093 * extension. name is the module name, also exclusive of extension.
2094 *
2095 * We've already done a successful stat() or fopen() on buf, so know that
2096 * there's some match, possibly case-insensitive.
2097 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002098 * case_bytes() is to return 1 if there's a case-sensitive match for
2099 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002100 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002101 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002102 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002103 * on platforms with case-insensitive filesystems. It's trivial to implement
2104 * for case-sensitive filesystems. It's pretty much a cross-platform
2105 * nightmare for systems with case-insensitive filesystems.
2106 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002107
Tim Peters50d8d372001-02-28 05:34:27 +00002108/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002109 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002110 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002111#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002112#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002113
Tim Peters50d8d372001-02-28 05:34:27 +00002114#elif defined(DJGPP)
2115#include <dir.h>
2116
Jason Tishler7961aa62005-05-20 00:56:54 +00002117#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002118#include <sys/types.h>
2119#include <dirent.h>
2120
Andrew MacIntyred9400542002-02-26 11:41:34 +00002121#elif defined(PYOS_OS2)
2122#define INCL_DOS
2123#define INCL_DOSERRORS
2124#define INCL_NOPMAPI
2125#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002126#endif
2127
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002128#if defined(DJGPP) \
2129 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2130 && defined(HAVE_DIRENT_H)) \
2131 || defined(PYOS_OS2)
2132# define USE_CASE_OK_BYTES
2133#endif
2134
2135
2136#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002137static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002138case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002139{
Tim Peters50d8d372001-02-28 05:34:27 +00002140/* Pick a platform-specific implementation; the sequence of #if's here should
2141 * match the sequence just above.
2142 */
2143
Tim Peters50d8d372001-02-28 05:34:27 +00002144/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002145#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002146 struct ffblk ffblk;
2147 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002148
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002149 if (Py_GETENV("PYTHONCASEOK") != NULL)
2150 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002151
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002152 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2153 if (done) {
2154 PyErr_Format(PyExc_NameError,
2155 "Can't find file for module %.100s\n(filename %.300s)",
2156 name, buf);
Victor Stinner9c61e242011-03-22 01:22:27 +01002157 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002158 }
2159 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002160
Jason Tishler7961aa62005-05-20 00:56:54 +00002161/* new-fangled macintosh (macosx) or Cygwin */
2162#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002163 DIR *dirp;
2164 struct dirent *dp;
2165 char dirname[MAXPATHLEN + 1];
2166 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002167
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002168 if (Py_GETENV("PYTHONCASEOK") != NULL)
2169 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002170
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002171 /* Copy the dir component into dirname; substitute "." if empty */
2172 if (dirlen <= 0) {
2173 dirname[0] = '.';
2174 dirname[1] = '\0';
2175 }
2176 else {
2177 assert(dirlen <= MAXPATHLEN);
2178 memcpy(dirname, buf, dirlen);
2179 dirname[dirlen] = '\0';
2180 }
2181 /* Open the directory and search the entries for an exact match. */
2182 dirp = opendir(dirname);
2183 if (dirp) {
2184 char *nameWithExt = buf + len - namelen;
2185 while ((dp = readdir(dirp)) != NULL) {
2186 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002187#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002188 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002189#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002190 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002191#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002192 if (thislen >= namelen &&
2193 strcmp(dp->d_name, nameWithExt) == 0) {
2194 (void)closedir(dirp);
2195 return 1; /* Found */
2196 }
2197 }
2198 (void)closedir(dirp);
2199 }
2200 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002201
Andrew MacIntyred9400542002-02-26 11:41:34 +00002202/* OS/2 */
2203#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002204 HDIR hdir = 1;
2205 ULONG srchcnt = 1;
2206 FILEFINDBUF3 ffbuf;
2207 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002208
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002209 if (Py_GETENV("PYTHONCASEOK") != NULL)
2210 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002211
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002212 rc = DosFindFirst(buf,
2213 &hdir,
2214 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2215 &ffbuf, sizeof(ffbuf),
2216 &srchcnt,
2217 FIL_STANDARD);
2218 if (rc != NO_ERROR)
2219 return 0;
2220 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002221
Tim Peters50d8d372001-02-28 05:34:27 +00002222/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2223#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002224# error "USE_CASE_OK_BYTES is not correctly defined"
2225#endif
2226}
2227#endif
2228
2229/*
2230 * Check if a filename case matchs the name case. We've already done a
2231 * successful stat() or fopen() on buf, so know that there's some match,
2232 * possibly case-insensitive.
2233 *
2234 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2235 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2236 * if envar PYTHONCASEOK exists.
2237 *
2238 * case_ok() is used to implement case-sensitive import semantics even
2239 * on platforms with case-insensitive filesystems. It's trivial to implement
2240 * for case-sensitive filesystems. It's pretty much a cross-platform
2241 * nightmare for systems with case-insensitive filesystems.
2242 */
2243
2244static int
2245case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2246{
2247#ifdef MS_WINDOWS
2248 WIN32_FIND_DATAW data;
2249 HANDLE h;
2250 int cmp;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002251 wchar_t *wname;
Victor Stinner8c981892011-10-11 22:27:13 +02002252 Py_ssize_t wname_len;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002253
2254 if (Py_GETENV("PYTHONCASEOK") != NULL)
2255 return 1;
2256
2257 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2258 if (h == INVALID_HANDLE_VALUE) {
2259 PyErr_Format(PyExc_NameError,
2260 "Can't find file for module %R\n(filename %R)",
2261 name, filename);
2262 return 0;
2263 }
2264 FindClose(h);
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002265
2266 wname = PyUnicode_AsUnicodeAndSize(name, &wname_len);
2267 if (wname == NULL)
2268 return -1;
2269
2270 cmp = wcsncmp(data.cFileName, wname, wname_len);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002271 return cmp == 0;
2272#elif defined(USE_CASE_OK_BYTES)
2273 int match;
2274 PyObject *filebytes, *namebytes;
2275 filebytes = PyUnicode_EncodeFSDefault(filename);
2276 if (filebytes == NULL)
2277 return -1;
2278 namebytes = PyUnicode_EncodeFSDefault(name);
2279 if (namebytes == NULL) {
2280 Py_DECREF(filebytes);
2281 return -1;
2282 }
2283 match = case_bytes(
2284 PyBytes_AS_STRING(filebytes),
2285 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002286 PyBytes_GET_SIZE(namebytes),
2287 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002288 Py_DECREF(filebytes);
2289 Py_DECREF(namebytes);
2290 return match;
2291#else
2292 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002293 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002294
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002295#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002296}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002297
Guido van Rossum197346f1997-10-31 18:38:52 +00002298#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002299
Victor Stinner547a2a62011-03-20 03:07:28 +01002300/* Helper to look for __init__.py or __init__.py[co] in potential package.
2301 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002302static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002303find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002304{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002305 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002306 PyObject *filename;
2307 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002308
Victor Stinner547a2a62011-03-20 03:07:28 +01002309 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2310 if (filename == NULL)
2311 return -1;
2312 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002313 /* 3=len(".py") */
2314 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002315 if (match < 0) {
2316 Py_DECREF(filename);
2317 return -1;
2318 }
2319 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002320 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002321 return 1;
2322 }
2323 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002324 Py_DECREF(filename);
2325
2326 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2327 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2328 if (filename == NULL)
2329 return -1;
2330 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002331 /* 4=len(".pyc") */
2332 match = case_ok(filename, -4, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002333 if (match < 0) {
2334 Py_DECREF(filename);
2335 return -1;
2336 }
2337 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002338 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002339 return 1;
2340 }
2341 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002342 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002343 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002344}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002345
Guido van Rossum197346f1997-10-31 18:38:52 +00002346#endif /* HAVE_STAT */
2347
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002348
Victor Stinner95872862011-03-07 18:20:56 +01002349static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002350
Victor Stinner44c6c152010-08-09 00:59:10 +00002351static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002352load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002353{
2354 PyObject *m, *modules;
2355 int err;
2356
Victor Stinner44c6c152010-08-09 00:59:10 +00002357 if (type == C_BUILTIN)
2358 err = init_builtin(name);
2359 else
Victor Stinner95872862011-03-07 18:20:56 +01002360 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002361 if (err < 0)
2362 return NULL;
2363 if (err == 0) {
2364 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002365 "Purported %s module %R not found",
2366 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002367 name);
2368 return NULL;
2369 }
2370
2371 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002372 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002373 if (m == NULL) {
2374 PyErr_Format(
2375 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002376 "%s module %R not properly initialized",
2377 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002378 name);
2379 return NULL;
2380 }
2381 Py_INCREF(m);
2382 return m;
2383}
2384
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002385/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002386 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002387
Guido van Rossum79f25d91997-04-29 20:08:16 +00002388static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002389load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002390{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002391 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002392
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002393 /* First check that there's an open file (if we need one) */
2394 switch (type) {
2395 case PY_SOURCE:
2396 case PY_COMPILED:
2397 if (fp == NULL) {
2398 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002399 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002400 type);
2401 return NULL;
2402 }
2403 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002404
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002405 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002406
Victor Stinner41c5fec2011-03-13 21:46:30 -04002407 case PY_SOURCE:
2408 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002409 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002410
Victor Stinner41c5fec2011-03-13 21:46:30 -04002411 case PY_COMPILED:
2412 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002413 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002414
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002415#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002416 case C_EXTENSION:
2417 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002418 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002419#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002420
Victor Stinner41c5fec2011-03-13 21:46:30 -04002421 case PKG_DIRECTORY:
2422 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002423 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002424
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002425 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002426 case PY_FROZEN:
2427 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002428 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002429
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002430 case IMP_HOOK: {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002431 _Py_IDENTIFIER(load_module);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002432 if (loader == NULL) {
2433 PyErr_SetString(PyExc_ImportError,
2434 "import hook without loader");
2435 return NULL;
2436 }
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002437 m = _PyObject_CallMethodId(loader, &PyId_load_module, "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002438 break;
2439 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002440
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002441 default:
2442 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002443 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 name, type);
2445 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002447 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002448
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002449 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002450}
2451
2452
2453/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002454 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002455 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002456
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002457static int
Victor Stinner95872862011-03-07 18:20:56 +01002458init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002459{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002460 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002461
Victor Stinner95872862011-03-07 18:20:56 +01002462 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002463 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002464
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002465 for (p = PyImport_Inittab; p->name != NULL; p++) {
2466 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002467 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002468 if (p->initfunc == NULL) {
2469 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002470 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002471 name);
2472 return -1;
2473 }
2474 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002475 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002476 mod = (*p->initfunc)();
2477 if (mod == 0)
2478 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002479 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002480 return -1;
2481 /* FixupExtension has put the module into sys.modules,
2482 so we can release our own reference. */
2483 Py_DECREF(mod);
2484 return 1;
2485 }
2486 }
2487 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002488}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002489
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002490
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002491/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002492
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002493static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002494find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002495{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002496 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002497
Victor Stinner53dc7352011-03-20 01:50:21 +01002498 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002499 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002500
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002501 for (p = PyImport_FrozenModules; ; p++) {
2502 if (p->name == NULL)
2503 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002504 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002505 break;
2506 }
2507 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002508}
2509
Guido van Rossum79f25d91997-04-29 20:08:16 +00002510static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002511get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002512{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002513 struct _frozen *p = find_frozen(name);
2514 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002516 if (p == NULL) {
2517 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002518 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002519 name);
2520 return NULL;
2521 }
2522 if (p->code == NULL) {
2523 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002524 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002525 name);
2526 return NULL;
2527 }
2528 size = p->size;
2529 if (size < 0)
2530 size = -size;
2531 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002532}
2533
Brett Cannon8d110132009-03-15 02:20:16 +00002534static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002535is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002536{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002537 struct _frozen *p = find_frozen(name);
2538 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002539
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002540 if (p == NULL) {
2541 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002542 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002543 name);
2544 return NULL;
2545 }
Brett Cannon8d110132009-03-15 02:20:16 +00002546
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002547 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002548
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002549 if (size < 0)
2550 Py_RETURN_TRUE;
2551 else
2552 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002553}
2554
2555
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002556/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002557 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002558 an exception set if the initialization failed.
2559 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002560
2561int
Victor Stinner53dc7352011-03-20 01:50:21 +01002562PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002563{
Victor Stinner53dc7352011-03-20 01:50:21 +01002564 struct _frozen *p;
2565 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002566 int ispackage;
2567 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002568
Victor Stinner53dc7352011-03-20 01:50:21 +01002569 p = find_frozen(name);
2570
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002571 if (p == NULL)
2572 return 0;
2573 if (p->code == NULL) {
2574 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002575 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002576 name);
2577 return -1;
2578 }
2579 size = p->size;
2580 ispackage = (size < 0);
2581 if (ispackage)
2582 size = -size;
2583 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002584 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002585 name, ispackage ? " package" : "");
2586 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2587 if (co == NULL)
2588 return -1;
2589 if (!PyCode_Check(co)) {
2590 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002591 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002592 name);
2593 goto err_return;
2594 }
2595 if (ispackage) {
2596 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002597 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002598 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002599 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002600 if (m == NULL)
2601 goto err_return;
2602 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002603 l = PyList_New(1);
2604 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002605 goto err_return;
2606 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002607 Py_INCREF(name);
2608 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002609 err = PyDict_SetItemString(d, "__path__", l);
2610 Py_DECREF(l);
2611 if (err != 0)
2612 goto err_return;
2613 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002614 path = PyUnicode_FromString("<frozen>");
2615 if (path == NULL)
2616 goto err_return;
2617 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2618 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002619 if (m == NULL)
2620 goto err_return;
2621 Py_DECREF(co);
2622 Py_DECREF(m);
2623 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002624err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002625 Py_DECREF(co);
2626 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002627}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002628
Victor Stinner53dc7352011-03-20 01:50:21 +01002629int
2630PyImport_ImportFrozenModule(char *name)
2631{
2632 PyObject *nameobj;
2633 int ret;
2634 nameobj = PyUnicode_InternFromString(name);
2635 if (nameobj == NULL)
2636 return -1;
2637 ret = PyImport_ImportFrozenModuleObject(nameobj);
2638 Py_DECREF(nameobj);
2639 return ret;
2640}
2641
Guido van Rossum74e6a111994-08-29 12:54:38 +00002642
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002643/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002644 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002645
Guido van Rossum79f25d91997-04-29 20:08:16 +00002646PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002647PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002648{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002649 PyObject *pname;
2650 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002651
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002652 pname = PyUnicode_FromString(name);
2653 if (pname == NULL)
2654 return NULL;
2655 result = PyImport_Import(pname);
2656 Py_DECREF(pname);
2657 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002658}
2659
Christian Heimes072c0f12008-01-03 23:01:04 +00002660/* Import a module without blocking
2661 *
2662 * At first it tries to fetch the module from sys.modules. If the module was
2663 * never loaded before it loads it with PyImport_ImportModule() unless another
2664 * thread holds the import lock. In the latter case the function raises an
2665 * ImportError instead of blocking.
2666 *
2667 * Returns the module object with incremented ref count.
2668 */
2669PyObject *
2670PyImport_ImportModuleNoBlock(const char *name)
2671{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002672 PyObject *nameobj, *modules, *result;
Victor Stinner0af03062011-09-02 00:11:43 +02002673#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002674 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002675#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002676
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002677 /* Try to get the module from sys.modules[name] */
2678 modules = PyImport_GetModuleDict();
2679 if (modules == NULL)
2680 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002681
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002682 nameobj = PyUnicode_FromString(name);
2683 if (nameobj == NULL)
2684 return NULL;
2685 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002686 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002687 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002688 Py_INCREF(result);
2689 return result;
2690 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002691 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002692#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002693 /* check the import lock
2694 * me might be -1 but I ignore the error here, the lock function
2695 * takes care of the problem */
2696 me = PyThread_get_thread_ident();
2697 if (import_lock_thread == -1 || import_lock_thread == me) {
2698 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002699 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002700 }
2701 else {
2702 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002703 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002704 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002705 nameobj);
2706 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002707 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002708#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002709 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002710#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002711 Py_DECREF(nameobj);
2712 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002713}
2714
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002715/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002716static PyObject *get_parent(PyObject *globals,
2717 PyObject **p_name,
2718 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002719static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002720 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002721 PyObject **p_prefix);
Victor Stinner974389d2011-03-15 09:33:57 +01002722static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002723static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002724 PyObject *buf, int recursive);
2725static PyObject * import_submodule(PyObject *mod, PyObject *name,
2726 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002727
2728/* The Magnum Opus of dotted-name import :-) */
2729
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002730static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002731import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002732 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002733{
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002734 PyObject *parent, *next, *inputname, *outputname;
2735 PyObject *head = NULL;
2736 PyObject *tail = NULL;
2737 PyObject *prefix = NULL;
2738 PyObject *result = NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002739 Py_ssize_t sep, altsep;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002740
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002741 if (PyUnicode_READY(name))
2742 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002743
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002744 sep = PyUnicode_FindChar(name, SEP, 0, PyUnicode_GET_LENGTH(name), 1);
2745 if (sep == -2)
2746 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002747#ifdef ALTSEP
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002748 altsep = PyUnicode_FindChar(name, ALTSEP, 0, PyUnicode_GET_LENGTH(name), 1);
2749 if (altsep == -2)
2750 return NULL;
2751#else
2752 altsep = -1;
Christian Heimes454f37b2008-01-10 00:10:02 +00002753#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002754 if (sep != -1 || altsep != -1)
2755 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002756 PyErr_SetString(PyExc_ImportError,
2757 "Import by filename is not supported.");
2758 return NULL;
2759 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002760
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002761 parent = get_parent(globals, &prefix, level);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002762 if (parent == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002763 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002764 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002765
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002766 if (PyUnicode_READY(prefix))
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002767 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002768
2769 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002770 &prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002771 if (head == NULL)
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002772 goto out;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002773
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002774 tail = head;
2775 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002776
2777 if (outputname != NULL) {
2778 while (1) {
2779 inputname = outputname;
2780 next = load_next(tail, tail, inputname, &outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002781 &prefix);
2782 Py_CLEAR(tail);
2783 Py_CLEAR(inputname);
2784 if (next == NULL)
2785 goto out;
Victor Stinner974389d2011-03-15 09:33:57 +01002786 tail = next;
2787
2788 if (outputname == NULL) {
2789 break;
2790 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002791 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002792 }
2793 if (tail == Py_None) {
2794 /* If tail is Py_None, both get_parent and load_next found
2795 an empty module name: someone called __import__("") or
2796 doctored faulty bytecode */
Victor Stinner974389d2011-03-15 09:33:57 +01002797 PyErr_SetString(PyExc_ValueError, "Empty module name");
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002798 goto out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002799 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002800
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002801 if (fromlist != NULL) {
2802 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2803 fromlist = NULL;
2804 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002805
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002806 if (fromlist == NULL) {
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002807 result = head;
2808 Py_INCREF(result);
2809 goto out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002810 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002811
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002812 if (!ensure_fromlist(tail, fromlist, prefix, 0))
2813 goto out;
2814
2815 result = tail;
2816 Py_INCREF(result);
2817 out:
2818 Py_XDECREF(head);
2819 Py_XDECREF(tail);
2820 Py_XDECREF(prefix);
2821 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002822}
2823
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002824PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002825PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2826 PyObject *locals, PyObject *fromlist,
2827 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002828{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002829 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002830 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002831 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002832 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002833 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002834 PyErr_SetString(PyExc_RuntimeError,
2835 "not holding the import lock");
2836 return NULL;
2837 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002838 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002839}
2840
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002841PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05002842PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002843 PyObject *fromlist, int level)
2844{
2845 PyObject *nameobj, *mod;
2846 nameobj = PyUnicode_FromString(name);
2847 if (nameobj == NULL)
2848 return NULL;
2849 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2850 fromlist, level);
2851 Py_DECREF(nameobj);
2852 return mod;
2853}
2854
2855
Fred Drake87590902004-05-28 20:21:36 +00002856/* Return the package that an import is being performed in. If globals comes
2857 from the module foo.bar.bat (not itself a package), this returns the
2858 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002859 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002860
Victor Stinner974389d2011-03-15 09:33:57 +01002861 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002862
2863 If globals doesn't come from a package or a module in a package, or a
2864 corresponding entry is not found in sys.modules, Py_None is returned.
2865*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002866static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002867get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002868{
Victor Stinner974389d2011-03-15 09:33:57 +01002869 PyObject *nameobj;
2870
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002871 static PyObject *namestr = NULL;
2872 static PyObject *pathstr = NULL;
2873 static PyObject *pkgstr = NULL;
2874 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2875 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002876
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002877 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002878 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002880 if (namestr == NULL) {
2881 namestr = PyUnicode_InternFromString("__name__");
2882 if (namestr == NULL)
2883 return NULL;
2884 }
2885 if (pathstr == NULL) {
2886 pathstr = PyUnicode_InternFromString("__path__");
2887 if (pathstr == NULL)
2888 return NULL;
2889 }
2890 if (pkgstr == NULL) {
2891 pkgstr = PyUnicode_InternFromString("__package__");
2892 if (pkgstr == NULL)
2893 return NULL;
2894 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002895
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002896 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002897
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002898 if ((pkgname != NULL) && (pkgname != Py_None)) {
2899 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002900 if (!PyUnicode_Check(pkgname)) {
2901 PyErr_SetString(PyExc_ValueError,
2902 "__package__ set to non-string");
2903 return NULL;
2904 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002905 if (PyUnicode_GET_LENGTH(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002906 if (level > 0) {
2907 PyErr_SetString(PyExc_ValueError,
2908 "Attempted relative import in non-package");
2909 return NULL;
2910 }
Victor Stinner974389d2011-03-15 09:33:57 +01002911 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002912 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002913 Py_INCREF(pkgname);
2914 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002915 } else {
2916 /* __package__ not set, so figure it out and set it */
2917 modname = PyDict_GetItem(globals, namestr);
2918 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002919 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002921 modpath = PyDict_GetItem(globals, pathstr);
2922 if (modpath != NULL) {
2923 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002924 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002926 error = PyDict_SetItem(globals, pkgstr, modname);
2927 if (error) {
2928 PyErr_SetString(PyExc_ValueError,
2929 "Could not set __package__");
2930 return NULL;
2931 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002932 Py_INCREF(modname);
2933 nameobj = modname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002934 } else {
2935 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002936 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002937 len = PyUnicode_FindChar(modname, '.',
2938 0, PyUnicode_GET_LENGTH(modname), -1);
2939 if (len == -2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002940 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002941 if (len < 0) {
2942 if (level > 0) {
2943 PyErr_SetString(PyExc_ValueError,
2944 "Attempted relative import in non-package");
2945 return NULL;
2946 }
2947 if (PyDict_SetItem(globals, pkgstr, Py_None)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002948 PyErr_SetString(PyExc_ValueError,
2949 "Could not set __package__");
2950 return NULL;
2951 }
Victor Stinner974389d2011-03-15 09:33:57 +01002952 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002953 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002954 pkgname = PyUnicode_Substring(modname, 0, len);
2955 if (pkgname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002956 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002957 if (PyDict_SetItem(globals, pkgstr, pkgname)) {
2958 Py_DECREF(pkgname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002959 PyErr_SetString(PyExc_ValueError,
2960 "Could not set __package__");
2961 return NULL;
2962 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002963 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002964 }
2965 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002966 if (level > 1) {
2967 Py_ssize_t dot, end = PyUnicode_GET_LENGTH(nameobj);
2968 PyObject *newname;
2969 while (--level > 0) {
2970 dot = PyUnicode_FindChar(nameobj, '.', 0, end, -1);
2971 if (dot == -2) {
2972 Py_DECREF(nameobj);
2973 return NULL;
2974 }
2975 if (dot < 0) {
2976 Py_DECREF(nameobj);
2977 PyErr_SetString(PyExc_ValueError,
2978 "Attempted relative import beyond "
2979 "toplevel package");
2980 return NULL;
2981 }
2982 end = dot;
2983 }
2984 newname = PyUnicode_Substring(nameobj, 0, end);
2985 Py_DECREF(nameobj);
2986 if (newname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002987 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002988 nameobj = newname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002989 }
Victor Stinner974389d2011-03-15 09:33:57 +01002990
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002991 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01002992 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002993 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01002994 int err;
2995
2996 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002997 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01002998 "Parent module %R not loaded, "
2999 "cannot perform relative import", nameobj);
3000 Py_DECREF(nameobj);
3001 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003002 }
Victor Stinner974389d2011-03-15 09:33:57 +01003003
3004 err = PyErr_WarnFormat(
3005 PyExc_RuntimeWarning, 1,
3006 "Parent module %R not found while handling absolute import",
3007 nameobj);
3008 Py_DECREF(nameobj);
3009 if (err)
3010 return NULL;
3011
3012 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003013 }
Victor Stinner974389d2011-03-15 09:33:57 +01003014 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003015 return parent;
3016 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01003017 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003018 - parent.__dict__ is globals
3019 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01003020
3021return_none:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003022 nameobj = PyUnicode_New(0, 0);
Victor Stinner974389d2011-03-15 09:33:57 +01003023 if (nameobj == NULL)
3024 return NULL;
3025 *p_name = nameobj;
3026 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003027}
3028
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003029/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003030static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003031load_next(PyObject *mod, PyObject *altmod,
3032 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003033 PyObject **p_prefix)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003034{
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003035 Py_ssize_t dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003036 Py_ssize_t len;
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003037 PyObject *fullname, *name = NULL, *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003038
Victor Stinner974389d2011-03-15 09:33:57 +01003039 *p_outputname = NULL;
3040
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003041 len = PyUnicode_GET_LENGTH(inputname);
3042 if (len == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003043 /* completely empty module name should only happen in
3044 'from . import' (or '__import__("")')*/
3045 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003046 return mod;
3047 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00003048
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003049
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003050 dot = PyUnicode_FindChar(inputname, '.', 0, len, 1);
3051 if (dot >= 0) {
3052 len = dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003053 if (len == 0) {
3054 PyErr_SetString(PyExc_ValueError,
3055 "Empty module name");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003056 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003057 }
3058 }
Victor Stinner974389d2011-03-15 09:33:57 +01003059
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003060 /* name = inputname[:len] */
3061 name = PyUnicode_Substring(inputname, 0, len);
3062 if (name == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003063 goto error;
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003064
3065 if (PyUnicode_GET_LENGTH(*p_prefix)) {
3066 /* fullname = prefix + "." + name */
3067 fullname = PyUnicode_FromFormat("%U.%U", *p_prefix, name);
3068 if (fullname == NULL)
3069 goto error;
3070 }
3071 else {
3072 fullname = name;
3073 Py_INCREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003074 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003075
Victor Stinner974389d2011-03-15 09:33:57 +01003076 result = import_submodule(mod, name, fullname);
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003077 Py_DECREF(*p_prefix);
3078 /* Transfer reference. */
3079 *p_prefix = fullname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003080 if (result == Py_None && altmod != mod) {
3081 Py_DECREF(result);
3082 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003083 result = import_submodule(altmod, name, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003084 if (result != NULL && result != Py_None) {
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003085 if (mark_miss(*p_prefix) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003086 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003087 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003088 }
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003089 Py_DECREF(*p_prefix);
3090 *p_prefix = name;
3091 Py_INCREF(*p_prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003092 }
3093 }
3094 if (result == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003095 goto error;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003096
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003097 if (result == Py_None) {
3098 Py_DECREF(result);
3099 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003100 "No module named %R", inputname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003101 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003102 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003103
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003104 if (dot >= 0) {
3105 *p_outputname = PyUnicode_Substring(inputname, dot+1,
3106 PyUnicode_GET_LENGTH(inputname));
Victor Stinner974389d2011-03-15 09:33:57 +01003107 if (*p_outputname == NULL) {
3108 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003109 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003110 }
3111 }
3112
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003113 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003114 return result;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003115
3116error:
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003117 Py_XDECREF(name);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003118 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003119}
3120
3121static int
Victor Stinner974389d2011-03-15 09:33:57 +01003122mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003123{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003124 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003125 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003126}
3127
3128static int
Victor Stinner974389d2011-03-15 09:33:57 +01003129ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003130 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003131{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003132 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003133 PyObject *fullname;
3134 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003135
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003136 if (!_PyObject_HasAttrId(mod, &PyId___path__))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003137 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003138
Victor Stinner974389d2011-03-15 09:33:57 +01003139 fromlist_len = PySequence_Size(fromlist);
3140
3141 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003142 PyObject *item = PySequence_GetItem(fromlist, i);
3143 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003144 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003145 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003146 if (!PyUnicode_Check(item)) {
3147 PyErr_SetString(PyExc_TypeError,
3148 "Item in ``from list'' not a string");
3149 Py_DECREF(item);
3150 return 0;
3151 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003152 if (PyUnicode_READ_CHAR(item, 0) == '*') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003153 PyObject *all;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02003154 _Py_IDENTIFIER(__all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003155 Py_DECREF(item);
3156 /* See if the package defines __all__ */
3157 if (recursive)
3158 continue; /* Avoid endless recursion */
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003159 all = _PyObject_GetAttrId(mod, &PyId___all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003160 if (all == NULL)
3161 PyErr_Clear();
3162 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003163 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003164 Py_DECREF(all);
3165 if (!ret)
3166 return 0;
3167 }
3168 continue;
3169 }
3170 hasit = PyObject_HasAttr(mod, item);
3171 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003172 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003173 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3174 if (fullname != NULL) {
3175 submod = import_submodule(mod, item, fullname);
3176 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003177 }
Victor Stinner974389d2011-03-15 09:33:57 +01003178 else
3179 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003180 Py_XDECREF(submod);
3181 if (submod == NULL) {
3182 Py_DECREF(item);
3183 return 0;
3184 }
3185 }
3186 Py_DECREF(item);
3187 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003188
Victor Stinner974389d2011-03-15 09:33:57 +01003189 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003190}
3191
Neil Schemenauer00b09662003-06-16 21:03:07 +00003192static int
Victor Stinner974389d2011-03-15 09:33:57 +01003193add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3194 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003195{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003196 if (mod == Py_None)
3197 return 1;
3198 /* Irrespective of the success of this load, make a
3199 reference to it in the parent package module. A copy gets
3200 saved in the modules dictionary under the full name, so get a
3201 reference from there, if need be. (The exception is when the
3202 load failed with a SyntaxError -- then there's no trace in
3203 sys.modules. In that case, of course, do nothing extra.) */
3204 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003205 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003206 if (submod == NULL)
3207 return 1;
3208 }
3209 if (PyModule_Check(mod)) {
3210 /* We can't use setattr here since it can give a
3211 * spurious warning if the submodule name shadows a
3212 * builtin name */
3213 PyObject *dict = PyModule_GetDict(mod);
3214 if (!dict)
3215 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003216 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003217 return 0;
3218 }
3219 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003220 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003221 return 0;
3222 }
3223 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003224}
3225
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003226static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003227import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003228{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003229 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003230 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003231 struct filedescr *fdp;
3232 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003233
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003234 /* Require:
3235 if mod == None: subname == fullname
3236 else: mod.__name__ + "." + subname == fullname
3237 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003238
Victor Stinner974389d2011-03-15 09:33:57 +01003239 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003240 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003241 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003242 }
Victor Stinner9599de52011-03-13 22:38:38 -04003243
3244 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003245 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003246 else {
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003247 path_list = _PyObject_GetAttrId(mod, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003248 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003249 PyErr_Clear();
3250 Py_INCREF(Py_None);
3251 return Py_None;
3252 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003253 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003254
Victor Stinner533d7832011-03-14 13:22:54 -04003255 fdp = find_module(fullname, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003256 &bufobj, &fp, &loader);
Victor Stinner533d7832011-03-14 13:22:54 -04003257 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003258 if (fdp == NULL) {
3259 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3260 return NULL;
3261 PyErr_Clear();
3262 Py_INCREF(Py_None);
3263 return Py_None;
3264 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003265 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3266 Py_XDECREF(bufobj);
Victor Stinner9599de52011-03-13 22:38:38 -04003267 Py_XDECREF(loader);
3268 if (fp)
3269 fclose(fp);
3270 if (m == NULL)
3271 return NULL;
3272 if (!add_submodule(mod, m, fullname, subname, modules)) {
3273 Py_XDECREF(m);
3274 return NULL;
3275 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003276 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003277}
3278
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003279
3280/* Re-import a module of any kind and return its module object, WITH
3281 INCREMENTED REFERENCE COUNT */
3282
Guido van Rossum79f25d91997-04-29 20:08:16 +00003283PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003284PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003285{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003286 PyInterpreterState *interp = PyThreadState_Get()->interp;
3287 PyObject *modules_reloading = interp->modules_reloading;
3288 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003289 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003290 PyObject *name, *bufobj, *subname;
3291 Py_ssize_t subname_start;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003292 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003293 FILE *fp = NULL;
3294 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003295
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003296 if (modules_reloading == NULL) {
3297 Py_FatalError("PyImport_ReloadModule: "
3298 "no modules_reloading dictionary!");
3299 return NULL;
3300 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003301
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003302 if (m == NULL || !PyModule_Check(m)) {
3303 PyErr_SetString(PyExc_TypeError,
3304 "reload() argument must be module");
3305 return NULL;
3306 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003307 name = PyModule_GetNameObject(m);
3308 if (name == NULL || PyUnicode_READY(name) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003309 return NULL;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003310 if (m != PyDict_GetItem(modules, name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003311 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003312 "reload(): module %R not in sys.modules",
Martin v. Löwis796ea532011-10-30 09:07:07 +01003313 name);
3314 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003315 return NULL;
3316 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003317 existing_m = PyDict_GetItem(modules_reloading, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003318 if (existing_m != NULL) {
3319 /* Due to a recursive reload, this module is already
3320 being reloaded. */
Martin v. Löwis796ea532011-10-30 09:07:07 +01003321 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003322 Py_INCREF(existing_m);
3323 return existing_m;
3324 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003325 if (PyDict_SetItem(modules_reloading, name, m) < 0) {
3326 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003327 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003328 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003329
Martin v. Löwis796ea532011-10-30 09:07:07 +01003330 subname_start = PyUnicode_FindChar(name, '.', 0,
3331 PyUnicode_GET_LENGTH(name), -1);
3332 if (subname_start == -1) {
3333 Py_INCREF(name);
3334 subname = name;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003335 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003336 else {
3337 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003338 Py_ssize_t len;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003339 parentname = PyUnicode_Substring(name, 0, subname_start);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003340 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003341 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003342 }
3343 parent = PyDict_GetItem(modules, parentname);
3344 if (parent == NULL) {
3345 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003346 "reload(): parent %R not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003347 parentname);
3348 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003349 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003350 }
3351 Py_DECREF(parentname);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003352 path_list = _PyObject_GetAttrId(parent, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003353 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003354 PyErr_Clear();
Martin v. Löwis796ea532011-10-30 09:07:07 +01003355 subname_start++;
3356 len = PyUnicode_GET_LENGTH(name) - (subname_start + 1);
3357 subname = PyUnicode_Substring(name, subname_start, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003358 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003359 if (subname == NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003360 goto error;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003361 fdp = find_module(name, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003362 &bufobj, &fp, &loader);
Martin v. Löwis796ea532011-10-30 09:07:07 +01003363 Py_DECREF(subname);
Victor Stinner533d7832011-03-14 13:22:54 -04003364 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003365
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003366 if (fdp == NULL) {
3367 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003368 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003369 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003370
Martin v. Löwis796ea532011-10-30 09:07:07 +01003371 newm = load_module(name, fp, bufobj, fdp->type, loader);
Victor Stinner2fd76e42011-03-14 15:19:39 -04003372 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003373 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003374
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003375 if (fp)
3376 fclose(fp);
3377 if (newm == NULL) {
3378 /* load_module probably removed name from modules because of
3379 * the error. Put back the original module object. We're
3380 * going to return NULL in this case regardless of whether
3381 * replacing name succeeds, so the return value is ignored.
3382 */
Martin v. Löwis796ea532011-10-30 09:07:07 +01003383 PyDict_SetItem(modules, name, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003384 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003385
3386error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003387 imp_modules_reloading_clear();
Martin v. Löwis796ea532011-10-30 09:07:07 +01003388 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003389 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003390}
3391
3392
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003393/* Higher-level import emulator which emulates the "import" statement
3394 more accurately -- it invokes the __import__() function from the
3395 builtins of the current globals. This means that the import is
3396 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003397 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003398 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003399 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003400 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003401
3402PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003403PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003404{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003405 static PyObject *silly_list = NULL;
3406 static PyObject *builtins_str = NULL;
3407 static PyObject *import_str = NULL;
3408 PyObject *globals = NULL;
3409 PyObject *import = NULL;
3410 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003411 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003412 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003413
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003414 /* Initialize constant string objects */
3415 if (silly_list == NULL) {
3416 import_str = PyUnicode_InternFromString("__import__");
3417 if (import_str == NULL)
3418 return NULL;
3419 builtins_str = PyUnicode_InternFromString("__builtins__");
3420 if (builtins_str == NULL)
3421 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003422 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003423 if (silly_list == NULL)
3424 return NULL;
3425 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003426
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003427 /* Get the builtins from current globals */
3428 globals = PyEval_GetGlobals();
3429 if (globals != NULL) {
3430 Py_INCREF(globals);
3431 builtins = PyObject_GetItem(globals, builtins_str);
3432 if (builtins == NULL)
3433 goto err;
3434 }
3435 else {
3436 /* No globals -- use standard builtins, and fake globals */
3437 builtins = PyImport_ImportModuleLevel("builtins",
3438 NULL, NULL, NULL, 0);
3439 if (builtins == NULL)
3440 return NULL;
3441 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3442 if (globals == NULL)
3443 goto err;
3444 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003446 /* Get the __import__ function from the builtins */
3447 if (PyDict_Check(builtins)) {
3448 import = PyObject_GetItem(builtins, import_str);
3449 if (import == NULL)
3450 PyErr_SetObject(PyExc_KeyError, import_str);
3451 }
3452 else
3453 import = PyObject_GetAttr(builtins, import_str);
3454 if (import == NULL)
3455 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003456
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003457 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003458 Always use absolute import here.
3459 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003460 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3461 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003462 if (r == NULL)
3463 goto err;
3464 Py_DECREF(r);
3465
3466 modules = PyImport_GetModuleDict();
3467 r = PyDict_GetItem(modules, module_name);
3468 if (r != NULL)
3469 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003470
3471 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003472 Py_XDECREF(globals);
3473 Py_XDECREF(builtins);
3474 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003475
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003476 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003477}
3478
3479
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003480/* Module 'imp' provides Python access to the primitives used for
3481 importing modules.
3482*/
3483
Guido van Rossum79f25d91997-04-29 20:08:16 +00003484static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003485imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003486{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003487 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003488
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003489 buf[0] = (char) ((magic >> 0) & 0xff);
3490 buf[1] = (char) ((magic >> 8) & 0xff);
3491 buf[2] = (char) ((magic >> 16) & 0xff);
3492 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003493
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003494 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003495}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003496
3497static PyObject *
3498imp_get_magic(PyObject *self, PyObject *noargs)
3499{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003500 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003501}
3502
3503static PyObject *
3504imp_get_tag(PyObject *self, PyObject *noargs)
3505{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003506 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003507}
3508
Guido van Rossum79f25d91997-04-29 20:08:16 +00003509static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003510imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003511{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003512 PyObject *list;
3513 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003514
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003515 list = PyList_New(0);
3516 if (list == NULL)
3517 return NULL;
3518 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3519 PyObject *item = Py_BuildValue("ssi",
3520 fdp->suffix, fdp->mode, fdp->type);
3521 if (item == NULL) {
3522 Py_DECREF(list);
3523 return NULL;
3524 }
3525 if (PyList_Append(list, item) < 0) {
3526 Py_DECREF(list);
3527 Py_DECREF(item);
3528 return NULL;
3529 }
3530 Py_DECREF(item);
3531 }
3532 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003533}
3534
Guido van Rossum79f25d91997-04-29 20:08:16 +00003535static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003536call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003537{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003538 extern int fclose(FILE *);
3539 PyObject *fob, *ret;
3540 PyObject *pathobj;
3541 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003542 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003543 int fd = -1;
3544 char *found_encoding = NULL;
3545 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003546
Victor Stinner533d7832011-03-14 13:22:54 -04003547 if (path_list == Py_None)
3548 path_list = NULL;
3549 fdp = find_module(NULL, name, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003550 &pathobj, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003551 if (fdp == NULL)
3552 return NULL;
3553 if (fp != NULL) {
3554 fd = fileno(fp);
3555 if (fd != -1)
3556 fd = dup(fd);
3557 fclose(fp);
Victor Stinnerd417d012011-06-20 15:16:55 +02003558 if (fd == -1) {
3559 PyErr_SetFromErrno(PyExc_OSError);
3560 return NULL;
3561 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003562 fp = NULL;
3563 }
3564 if (fd != -1) {
3565 if (strchr(fdp->mode, 'b') == NULL) {
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003566 /* PyTokenizer_FindEncodingFilename() returns PyMem_MALLOC'ed
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003567 memory. */
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003568 found_encoding = PyTokenizer_FindEncodingFilename(fd, pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003569 lseek(fd, 0, 0); /* Reset position */
Victor Stinner2fd76e42011-03-14 15:19:39 -04003570 if (found_encoding == NULL && PyErr_Occurred()) {
3571 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003572 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04003573 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003574 encoding = (found_encoding != NULL) ? found_encoding :
3575 (char*)PyUnicode_GetDefaultEncoding();
3576 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003577 fob = PyFile_FromFd(fd, NULL, fdp->mode, -1,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003578 (char*)encoding, NULL, NULL, 1);
3579 if (fob == NULL) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04003580 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003581 close(fd);
3582 PyMem_FREE(found_encoding);
3583 return NULL;
3584 }
3585 }
3586 else {
3587 fob = Py_None;
3588 Py_INCREF(fob);
3589 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003590 if (pathobj == NULL) {
3591 Py_INCREF(Py_None);
3592 pathobj = Py_None;
3593 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003594 ret = Py_BuildValue("NN(ssi)",
3595 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3596 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003597
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003598 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003599}
3600
Guido van Rossum79f25d91997-04-29 20:08:16 +00003601static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003602imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003603{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003604 PyObject *name, *path_list = NULL;
3605 if (!PyArg_ParseTuple(args, "U|O:find_module",
3606 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003607 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003608 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003609}
3610
3611static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003612imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003613{
Victor Stinner95872862011-03-07 18:20:56 +01003614 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003615 int ret;
3616 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003617 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003618 return NULL;
3619 ret = init_builtin(name);
3620 if (ret < 0)
3621 return NULL;
3622 if (ret == 0) {
3623 Py_INCREF(Py_None);
3624 return Py_None;
3625 }
Victor Stinner95872862011-03-07 18:20:56 +01003626 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003627 Py_XINCREF(m);
3628 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003629}
3630
Guido van Rossum79f25d91997-04-29 20:08:16 +00003631static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003632imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003633{
Victor Stinner53dc7352011-03-20 01:50:21 +01003634 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003635 int ret;
3636 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003637 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003638 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003639 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003640 if (ret < 0)
3641 return NULL;
3642 if (ret == 0) {
3643 Py_INCREF(Py_None);
3644 return Py_None;
3645 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003646 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003647 Py_XINCREF(m);
3648 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003649}
3650
Guido van Rossum79f25d91997-04-29 20:08:16 +00003651static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003652imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003653{
Victor Stinner53dc7352011-03-20 01:50:21 +01003654 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003655
Victor Stinner53dc7352011-03-20 01:50:21 +01003656 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003657 return NULL;
3658 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003659}
3660
Guido van Rossum79f25d91997-04-29 20:08:16 +00003661static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003662imp_is_frozen_package(PyObject *self, PyObject *args)
3663{
Victor Stinner53dc7352011-03-20 01:50:21 +01003664 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003665
Victor Stinner53dc7352011-03-20 01:50:21 +01003666 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003667 return NULL;
3668 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003669}
3670
3671static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003672imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003673{
Victor Stinner95872862011-03-07 18:20:56 +01003674 PyObject *name;
3675 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003676 return NULL;
3677 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003678}
3679
Guido van Rossum79f25d91997-04-29 20:08:16 +00003680static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003681imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003682{
Victor Stinner53dc7352011-03-20 01:50:21 +01003683 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003684 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003685 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003686 return NULL;
3687 p = find_frozen(name);
3688 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003689}
3690
3691static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003692get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003693{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003694 FILE *fp;
3695 if (mode[0] == 'U')
3696 mode = "r" PY_STDIOTEXTMODE;
3697 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003698 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003699 }
3700 else {
3701 int fd = PyObject_AsFileDescriptor(fob);
3702 if (fd == -1)
3703 return NULL;
3704 if (!_PyVerify_fd(fd))
3705 goto error;
3706 /* the FILE struct gets a new fd, so that it can be closed
3707 * independently of the file descriptor given
3708 */
3709 fd = dup(fd);
3710 if (fd == -1)
3711 goto error;
3712 fp = fdopen(fd, mode);
3713 }
3714 if (fp)
3715 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003716error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003717 PyErr_SetFromErrno(PyExc_IOError);
3718 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003719}
3720
Guido van Rossum79f25d91997-04-29 20:08:16 +00003721static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003722imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003723{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003724 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003725 PyObject *fob = NULL;
3726 PyObject *m;
3727 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003728 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003729 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003730 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003731 &fob))
3732 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003733 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003734 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003735 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003736 return NULL;
3737 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003738 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003739 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003740 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003741 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003742}
3743
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003744#ifdef HAVE_DYNAMIC_LOADING
3745
Guido van Rossum79f25d91997-04-29 20:08:16 +00003746static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003747imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003748{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003749 PyObject *name, *pathname, *fob = NULL, *mod;
3750 FILE *fp;
3751
3752 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3753 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003754 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003755 if (fob != NULL) {
3756 fp = get_file(NULL, fob, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003757 if (fp == NULL) {
3758 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003759 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003760 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003761 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003762 else
3763 fp = NULL;
3764 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003765 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003766 if (fp)
3767 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003768 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003769}
3770
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003771#endif /* HAVE_DYNAMIC_LOADING */
3772
Guido van Rossum79f25d91997-04-29 20:08:16 +00003773static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003774imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003775{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003776 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003777 PyObject *fob = NULL;
3778 PyObject *m;
3779 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003780 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003781 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003782 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003783 &fob))
3784 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003785 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003786 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003787 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003788 return NULL;
3789 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003790 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003791 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003792 fclose(fp);
3793 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003794}
3795
Guido van Rossum79f25d91997-04-29 20:08:16 +00003796static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003797imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003798{
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003799 PyObject *name, *fob, *pathname, *pathname_obj, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003800 char *suffix; /* Unused */
3801 char *mode;
3802 int type;
3803 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003804
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003805 if (!PyArg_ParseTuple(args, "UOO(ssi):load_module",
3806 &name, &fob, &pathname_obj, &suffix, &mode, &type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003807 return NULL;
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003808 if (pathname_obj != Py_None) {
3809 if (!PyUnicode_FSDecoder(pathname_obj, &pathname))
3810 return NULL;
3811 }
3812 else
3813 pathname = NULL;
3814
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003815 if (*mode) {
3816 /* Mode must start with 'r' or 'U' and must not contain '+'.
3817 Implicit in this test is the assumption that the mode
3818 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003819
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003820 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3821 PyErr_Format(PyExc_ValueError,
3822 "invalid file open mode %.200s", mode);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003823 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003824 return NULL;
3825 }
3826 }
3827 if (fob == Py_None)
3828 fp = NULL;
3829 else {
3830 fp = get_file(NULL, fob, mode);
3831 if (fp == NULL) {
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003832 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003833 return NULL;
3834 }
3835 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003836 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003837 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003838 if (fp)
3839 fclose(fp);
3840 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003841}
3842
3843static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003844imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003845{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003846 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003847 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003848 if (!PyArg_ParseTuple(args, "UO&:load_package",
3849 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003850 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003851 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003852 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003853 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003854}
3855
3856static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003857imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003858{
Victor Stinnerfe19d212011-03-14 14:53:28 -04003859 PyObject *name;
3860 if (!PyArg_ParseTuple(args, "U:new_module", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003861 return NULL;
Victor Stinnerfe19d212011-03-14 14:53:28 -04003862 return PyModule_NewObject(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003863}
3864
Christian Heimes13a7a212008-01-07 17:13:09 +00003865static PyObject *
3866imp_reload(PyObject *self, PyObject *v)
3867{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003868 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003869}
3870
3871PyDoc_STRVAR(doc_reload,
3872"reload(module) -> module\n\
3873\n\
3874Reload the module. The module must have been successfully imported before.");
3875
Barry Warsaw28a691b2010-04-17 00:19:56 +00003876static PyObject *
3877imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3878{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003879 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003880
Victor Stinner2f42ae52011-03-20 00:41:24 +01003881 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003882 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003883 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003884
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003885 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003886 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003887 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003888 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003889
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003890 if (debug_override != NULL &&
3891 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003892 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003893 return NULL;
3894 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003895
Martin v. Löwis30260a72011-10-23 17:35:46 +02003896 if (PyUnicode_READY(pathname) < 0)
3897 return NULL;
3898
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003899 cpathname = make_compiled_pathname(pathname, debug);
Victor Stinner2f42ae52011-03-20 00:41:24 +01003900 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003901
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003902 if (cpathname == NULL) {
3903 PyErr_Format(PyExc_SystemError, "path buffer too short");
3904 return NULL;
3905 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003906 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003907}
3908
3909PyDoc_STRVAR(doc_cache_from_source,
Éric Araujo5df11082011-11-03 03:38:44 +01003910"cache_from_source(path, [debug_override]) -> path\n\
3911Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003912\n\
3913The .py file does not need to exist; this simply returns the path to the\n\
3914.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3915will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3916\n\
3917If debug_override is not None, then it must be a boolean and is taken as\n\
3918the value of __debug__ instead.");
3919
3920static PyObject *
3921imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3922{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003923 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003924 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003926 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003927 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003928 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003929 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003930
Victor Stinnerc9abda02011-03-14 13:33:46 -04003931 source = make_source_pathname(pathname);
3932 if (source == NULL) {
3933 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003934 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003935 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003936 return NULL;
3937 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003938 Py_DECREF(pathname);
3939 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003940}
3941
3942PyDoc_STRVAR(doc_source_from_cache,
Éric Araujo5df11082011-11-03 03:38:44 +01003943"source_from_cache(path) -> path\n\
3944Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003945\n\
3946The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3947the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3948does not conform to PEP 3147 format, ValueError will be raised.");
3949
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003950/* Doc strings */
3951
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003952PyDoc_STRVAR(doc_imp,
3953"This module provides the components needed to build your own\n\
3954__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003955
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003956PyDoc_STRVAR(doc_find_module,
3957"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003958Search for a module. If path is omitted or None, search for a\n\
3959built-in, frozen or special module and continue search in sys.path.\n\
3960The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003961package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003962
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003963PyDoc_STRVAR(doc_load_module,
3964"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003965Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003966The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003967
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003968PyDoc_STRVAR(doc_get_magic,
3969"get_magic() -> string\n\
3970Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003971
Barry Warsaw28a691b2010-04-17 00:19:56 +00003972PyDoc_STRVAR(doc_get_tag,
3973"get_tag() -> string\n\
3974Return the magic tag for .pyc or .pyo files.");
3975
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003976PyDoc_STRVAR(doc_get_suffixes,
3977"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003978Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003979that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003980
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003981PyDoc_STRVAR(doc_new_module,
3982"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003983Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003984The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003985
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003986PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003987"lock_held() -> boolean\n\
3988Return True if the import lock is currently held, else False.\n\
3989On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003990
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003991PyDoc_STRVAR(doc_acquire_lock,
3992"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003993Acquires the interpreter's import lock for the current thread.\n\
3994This lock should be used by import hooks to ensure thread-safety\n\
3995when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003996On platforms without threads, this function does nothing.");
3997
3998PyDoc_STRVAR(doc_release_lock,
3999"release_lock() -> None\n\
4000Release the interpreter's import lock.\n\
4001On platforms without threads, this function does nothing.");
4002
Guido van Rossum79f25d91997-04-29 20:08:16 +00004003static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004004 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
4005 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
4006 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
4007 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
4008 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
4009 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
4010 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
4011 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
4012 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
4013 {"reload", imp_reload, METH_O, doc_reload},
4014 {"cache_from_source", (PyCFunction)imp_cache_from_source,
4015 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
4016 {"source_from_cache", (PyCFunction)imp_source_from_cache,
4017 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
4018 /* The rest are obsolete */
4019 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
4020 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
4021 {"init_builtin", imp_init_builtin, METH_VARARGS},
4022 {"init_frozen", imp_init_frozen, METH_VARARGS},
4023 {"is_builtin", imp_is_builtin, METH_VARARGS},
4024 {"is_frozen", imp_is_frozen, METH_VARARGS},
4025 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004026#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004027 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004028#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004029 {"load_package", imp_load_package, METH_VARARGS},
4030 {"load_source", imp_load_source, METH_VARARGS},
Brett Cannon442c9b92011-03-23 16:14:42 -07004031 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004032 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004033};
4034
Guido van Rossum1a8791e1998-08-04 22:46:29 +00004035static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004036setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004037{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004038 PyObject *v;
4039 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004040
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004041 v = PyLong_FromLong((long)value);
4042 err = PyDict_SetItemString(d, name, v);
4043 Py_XDECREF(v);
4044 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004045}
4046
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004047typedef struct {
4048 PyObject_HEAD
4049} NullImporter;
4050
4051static int
4052NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4053{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004054#ifndef MS_WINDOWS
4055 PyObject *path;
4056 struct stat statbuf;
4057 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004058
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004059 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4060 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004061
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004062 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4063 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004064 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004065
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004066 if (PyBytes_GET_SIZE(path) == 0) {
4067 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004068 PyErr_SetString(PyExc_ImportError, "empty pathname");
4069 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004070 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004071
4072 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4073 Py_DECREF(path);
4074 if (rv == 0) {
4075 /* it exists */
4076 if (S_ISDIR(statbuf.st_mode)) {
4077 /* it's a directory */
4078 PyErr_SetString(PyExc_ImportError, "existing directory");
4079 return -1;
4080 }
4081 }
4082#else /* MS_WINDOWS */
4083 PyObject *pathobj;
4084 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004085 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004086
4087 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4088 return -1;
4089
4090 if (!PyArg_ParseTuple(args, "U:NullImporter",
4091 &pathobj))
4092 return -1;
4093
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02004094 if (PyUnicode_GET_LENGTH(pathobj) == 0) {
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004095 PyErr_SetString(PyExc_ImportError, "empty pathname");
4096 return -1;
4097 }
4098
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004099 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004100 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004101 return -1;
4102 /* see issue1293 and issue3677:
4103 * stat() on Windows doesn't recognise paths like
4104 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4105 */
4106 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004107 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004108 if (rv != INVALID_FILE_ATTRIBUTES) {
4109 /* it exists */
4110 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4111 /* it's a directory */
4112 PyErr_SetString(PyExc_ImportError, "existing directory");
4113 return -1;
4114 }
4115 }
4116#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004117 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004118}
4119
4120static PyObject *
4121NullImporter_find_module(NullImporter *self, PyObject *args)
4122{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004123 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004124}
4125
4126static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004127 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4128 "Always return None"
4129 },
4130 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004131};
4132
4133
Christian Heimes9cd17752007-11-18 19:35:23 +00004134PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004135 PyVarObject_HEAD_INIT(NULL, 0)
4136 "imp.NullImporter", /*tp_name*/
4137 sizeof(NullImporter), /*tp_basicsize*/
4138 0, /*tp_itemsize*/
4139 0, /*tp_dealloc*/
4140 0, /*tp_print*/
4141 0, /*tp_getattr*/
4142 0, /*tp_setattr*/
4143 0, /*tp_reserved*/
4144 0, /*tp_repr*/
4145 0, /*tp_as_number*/
4146 0, /*tp_as_sequence*/
4147 0, /*tp_as_mapping*/
4148 0, /*tp_hash */
4149 0, /*tp_call*/
4150 0, /*tp_str*/
4151 0, /*tp_getattro*/
4152 0, /*tp_setattro*/
4153 0, /*tp_as_buffer*/
4154 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4155 "Null importer object", /* tp_doc */
4156 0, /* tp_traverse */
4157 0, /* tp_clear */
4158 0, /* tp_richcompare */
4159 0, /* tp_weaklistoffset */
4160 0, /* tp_iter */
4161 0, /* tp_iternext */
4162 NullImporter_methods, /* tp_methods */
4163 0, /* tp_members */
4164 0, /* tp_getset */
4165 0, /* tp_base */
4166 0, /* tp_dict */
4167 0, /* tp_descr_get */
4168 0, /* tp_descr_set */
4169 0, /* tp_dictoffset */
4170 (initproc)NullImporter_init, /* tp_init */
4171 0, /* tp_alloc */
4172 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004173};
4174
Martin v. Löwis1a214512008-06-11 05:26:20 +00004175static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004176 PyModuleDef_HEAD_INIT,
4177 "imp",
4178 doc_imp,
4179 0,
4180 imp_methods,
4181 NULL,
4182 NULL,
4183 NULL,
4184 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004185};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004186
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004187PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004188PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004189{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004190 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004191
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004192 if (PyType_Ready(&PyNullImporter_Type) < 0)
4193 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004194
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004195 m = PyModule_Create(&impmodule);
4196 if (m == NULL)
4197 goto failure;
4198 d = PyModule_GetDict(m);
4199 if (d == NULL)
4200 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004201
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004202 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4203 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4204 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4205 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4206 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4207 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4208 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4209 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4210 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4211 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004212
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004213 Py_INCREF(&PyNullImporter_Type);
4214 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4215 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004216 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004217 Py_XDECREF(m);
4218 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004219}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004220
4221
Guido van Rossumb18618d2000-05-03 23:44:39 +00004222/* API for embedding applications that want to add their own entries
4223 to the table of built-in modules. This should normally be called
4224 *before* Py_Initialize(). When the table resize fails, -1 is
4225 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004226
4227 After a similar function by Just van Rossum. */
4228
4229int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004230PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004231{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004232 static struct _inittab *our_copy = NULL;
4233 struct _inittab *p;
4234 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004235
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004236 /* Count the number of entries in both tables */
4237 for (n = 0; newtab[n].name != NULL; n++)
4238 ;
4239 if (n == 0)
4240 return 0; /* Nothing to do */
4241 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4242 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004243
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004244 /* Allocate new memory for the combined table */
4245 p = our_copy;
4246 PyMem_RESIZE(p, struct _inittab, i+n+1);
4247 if (p == NULL)
4248 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004249
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004250 /* Copy the tables into the new memory */
4251 if (our_copy != PyImport_Inittab)
4252 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4253 PyImport_Inittab = our_copy = p;
4254 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004255
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004256 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004257}
4258
4259/* Shorthand to add a single entry given a name and a function */
4260
4261int
Brett Cannona826f322009-04-02 03:41:46 +00004262PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004263{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004264 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004265
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004266 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004267
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004268 newtab[0].name = (char *)name;
4269 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004270
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004271 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004272}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004273
4274#ifdef __cplusplus
4275}
4276#endif