blob: 5c33b6be575a90a0baedfce5bd0bbde9cb67aa4f [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;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001205#endif
Victor Stinner783c82c2011-04-20 03:27:51 +02001206 int fd;
Charles-François Natalie695eec2011-10-31 20:47:31 +01001207#ifndef MS_WINDOWS
Antoine Pitrou707033a2011-10-17 19:28:44 +02001208 PyObject *cpathbytes, *cpathbytes_tmp;
1209 Py_ssize_t cpathbytes_len;
Victor Stinner783c82c2011-04-20 03:27:51 +02001210#endif
1211 PyObject *dirname;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001212 Py_UCS4 *dirsep;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001213 int res, ok;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 /* Ensure that the __pycache__ directory exists. */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001216 cpathname_ucs4 = PyUnicode_AsUCS4Copy(cpathname);
1217 if (!cpathname_ucs4)
1218 return;
1219 dirsep = rightmost_sep(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001220 if (dirsep == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001221 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001222 PySys_FormatStderr("# no %s path found %R\n", CACHEDIR, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 return;
1224 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001225 dirname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
1226 cpathname_ucs4,
1227 dirsep - cpathname_ucs4);
1228 PyMem_Free(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001229 if (dirname == NULL) {
1230 PyErr_Clear();
1231 return;
1232 }
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001233
1234#ifdef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001235 res = CreateDirectoryW(PyUnicode_AS_UNICODE(dirname), NULL);
1236 ok = (res != 0);
1237 if (!ok && GetLastError() == ERROR_ALREADY_EXISTS)
1238 ok = 1;
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001239#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001240 dirbytes = PyUnicode_EncodeFSDefault(dirname);
1241 if (dirbytes == NULL) {
1242 PyErr_Clear();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001243 return;
1244 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001245 res = mkdir(PyBytes_AS_STRING(dirbytes), dirmode);
1246 Py_DECREF(dirbytes);
1247 if (0 <= res)
1248 ok = 1;
1249 else
1250 ok = (errno == EEXIST);
1251#endif
1252 if (!ok) {
1253 if (Py_VerboseFlag)
1254 PySys_FormatStderr("# cannot create cache dir %R\n", dirname);
1255 Py_DECREF(dirname);
1256 return;
1257 }
1258 Py_DECREF(dirname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001259
Victor Stinner783c82c2011-04-20 03:27:51 +02001260#ifdef MS_WINDOWS
1261 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1262 fd = _wopen(PyUnicode_AS_UNICODE(cpathname),
1263 O_EXCL | O_CREAT | O_WRONLY | O_TRUNC | O_BINARY,
1264 mode);
1265 if (0 <= fd)
1266 fp = fdopen(fd, "wb");
1267 else
1268 fp = NULL;
1269#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001270 /* Under POSIX, we first write to a tmp file and then take advantage
1271 of atomic renaming. */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001272 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1273 if (cpathbytes == NULL) {
1274 PyErr_Clear();
1275 return;
1276 }
Antoine Pitrou707033a2011-10-17 19:28:44 +02001277 cpathbytes_len = PyBytes_GET_SIZE(cpathbytes);
Charles-François Natalie695eec2011-10-31 20:47:31 +01001278 cpathbytes_tmp = PyBytes_FromStringAndSize(NULL, cpathbytes_len + 6);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001279 if (cpathbytes_tmp == NULL) {
1280 Py_DECREF(cpathbytes);
1281 PyErr_Clear();
1282 return;
1283 }
1284 memcpy(PyBytes_AS_STRING(cpathbytes_tmp), PyBytes_AS_STRING(cpathbytes),
1285 cpathbytes_len);
Charles-François Natalie695eec2011-10-31 20:47:31 +01001286 memcpy(PyBytes_AS_STRING(cpathbytes_tmp) + cpathbytes_len, "XXXXXX", 6);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001287
Charles-François Natalie695eec2011-10-31 20:47:31 +01001288 fd = mkstemp(PyBytes_AS_STRING(cpathbytes_tmp));
1289 if (0 <= fd)
1290 fp = fdopen(fd, "wb");
1291 else
1292 fp = NULL;
Victor Stinner783c82c2011-04-20 03:27:51 +02001293#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001294 if (fp == NULL) {
1295 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001296 PySys_FormatStderr(
1297 "# can't create %R\n", cpathname);
Victor Stinner783c82c2011-04-20 03:27:51 +02001298#ifndef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001299 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001300 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001301#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001302 return;
1303 }
1304 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1305 /* First write a 0 for mtime */
1306 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1307 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001308 fflush(fp);
1309 /* Now write the true mtime */
1310 fseek(fp, 4L, 0);
1311 assert(mtime < LONG_MAX);
1312 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001313 if (fflush(fp) != 0 || ferror(fp)) {
1314 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001315 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 /* Don't keep partial file */
1317 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001318#ifdef MS_WINDOWS
1319 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1320#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001321 (void) unlink(PyBytes_AS_STRING(cpathbytes_tmp));
Victor Stinner2f42ae52011-03-20 00:41:24 +01001322 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001323 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001324#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001325 return;
1326 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001327 fclose(fp);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001328 /* Under POSIX, do an atomic rename */
1329#ifndef MS_WINDOWS
1330 if (rename(PyBytes_AS_STRING(cpathbytes_tmp),
1331 PyBytes_AS_STRING(cpathbytes))) {
1332 if (Py_VerboseFlag)
1333 PySys_FormatStderr("# can't write %R\n", cpathname);
1334 /* Don't keep tmp file */
1335 unlink(PyBytes_AS_STRING(cpathbytes_tmp));
1336 Py_DECREF(cpathbytes);
1337 Py_DECREF(cpathbytes_tmp);
1338 return;
1339 }
1340 Py_DECREF(cpathbytes);
1341 Py_DECREF(cpathbytes_tmp);
1342#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001343 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001344 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001345}
1346
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001347static void
1348update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1349{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001350 PyObject *constants, *tmp;
1351 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001352
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353 if (PyUnicode_Compare(co->co_filename, oldname))
1354 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001355
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001356 tmp = co->co_filename;
1357 co->co_filename = newname;
1358 Py_INCREF(co->co_filename);
1359 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001360
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001361 constants = co->co_consts;
1362 n = PyTuple_GET_SIZE(constants);
1363 for (i = 0; i < n; i++) {
1364 tmp = PyTuple_GET_ITEM(constants, i);
1365 if (PyCode_Check(tmp))
1366 update_code_filenames((PyCodeObject *)tmp,
1367 oldname, newname);
1368 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001369}
1370
Victor Stinner2f42ae52011-03-20 00:41:24 +01001371static void
1372update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001373{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001374 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001375
Victor Stinner2f42ae52011-03-20 00:41:24 +01001376 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1377 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 oldname = co->co_filename;
1380 Py_INCREF(oldname);
1381 update_code_filenames(co, oldname, newname);
1382 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001383}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001384
Brett Cannon442c9b92011-03-23 16:14:42 -07001385static PyObject *
1386imp_fix_co_filename(PyObject *self, PyObject *args)
1387{
1388 PyObject *co;
1389 PyObject *file_path;
1390
1391 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
1392 return NULL;
1393
1394 if (!PyCode_Check(co)) {
1395 PyErr_SetString(PyExc_TypeError,
1396 "first argument must be a code object");
1397 return NULL;
1398 }
1399
1400 if (!PyUnicode_Check(file_path)) {
1401 PyErr_SetString(PyExc_TypeError,
1402 "second argument must be a string");
1403 return NULL;
1404 }
1405
1406 update_compiled_module((PyCodeObject*)co, file_path);
1407
1408 Py_RETURN_NONE;
1409}
1410
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001411/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001412 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1413 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001414
Guido van Rossum79f25d91997-04-29 20:08:16 +00001415static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001416load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001417{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001418 struct stat st;
1419 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001420 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001421 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001422 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001423
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001424 if (fstat(fileno(fp), &st) != 0) {
1425 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001426 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001427 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001428 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001429 }
Fred Drake4c82b232000-06-30 16:18:57 +00001430#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001431 /* Python's .pyc timestamp handling presumes that the timestamp fits
1432 in 4 bytes. This will be fine until sometime in the year 2038,
1433 when a 4-byte signed time_t will overflow.
1434 */
1435 if (st.st_mtime >> 32) {
1436 PyErr_SetString(PyExc_OverflowError,
1437 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001438 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001439 }
Fred Drake4c82b232000-06-30 16:18:57 +00001440#endif
Martin v. Löwis30260a72011-10-23 17:35:46 +02001441 if (PyUnicode_READY(pathname) < 0)
1442 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001443 cpathname = make_compiled_pathname(pathname, !Py_OptimizeFlag);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001444
1445 if (cpathname != NULL)
1446 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1447 else
1448 fpc = NULL;
1449
1450 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001451 co = read_compiled_module(cpathname, fpc);
1452 fclose(fpc);
1453 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001454 goto error;
1455 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001457 PySys_FormatStderr("import %U # precompiled from %R\n",
1458 name, cpathname);
1459 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1460 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001461 }
1462 else {
1463 co = parse_source_module(pathname, fp);
1464 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001465 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001466 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001467 PySys_FormatStderr("import %U # from %R\n",
Victor Stinner98dbba52011-03-14 15:15:47 -04001468 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001469 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001470 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1471 if (ro == NULL || !PyObject_IsTrue(ro))
1472 write_compiled_module(co, cpathname, &st);
1473 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001474 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1475 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001476 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001477 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001478
Victor Stinner2f42ae52011-03-20 00:41:24 +01001479error:
1480 Py_XDECREF(cpathbytes);
1481 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001482 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001483}
1484
Christian Heimes3b06e532008-01-07 20:12:44 +00001485/* Get source file -> unicode or None
1486 * Returns the path to the py file if available, else the given path
1487 */
1488static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001489get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001490{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001491 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001492 Py_UCS4 *fileuni;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001493 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001494 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001495
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001496 len = PyUnicode_GET_LENGTH(filename);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001497 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001498 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001499
Victor Stinnerc9abda02011-03-14 13:33:46 -04001500 /* don't match *.pyc or *.pyo? */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001501 fileuni = PyUnicode_AsUCS4Copy(filename);
1502 if (!fileuni)
1503 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001504 if (len < 5
1505 || fileuni[len-4] != '.'
1506 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1507 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1508 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001510 /* Start by trying to turn PEP 3147 path into source path. If that
1511 * fails, just chop off the trailing character, i.e. legacy pyc path
1512 * to py.
1513 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001514 py = make_source_pathname(filename);
1515 if (py == NULL) {
1516 PyErr_Clear();
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001517 py = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001519 if (py == NULL)
1520 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001521
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001522 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode)) {
1523 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001524 return py;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001525 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001526 Py_DECREF(py);
1527 goto unchanged;
1528
1529error:
1530 PyErr_Clear();
1531unchanged:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001532 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001533 Py_INCREF(filename);
1534 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001535}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001536
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001537/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001538static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001539static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001540 PyObject **, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001541static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001542
1543/* Load a package and return its module object WITH INCREMENTED
1544 REFERENCE COUNT */
1545
1546static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001547load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001548{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001549 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001550 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001551 int err;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001552 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001553 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001554
Victor Stinnerc9abda02011-03-14 13:33:46 -04001555 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001556 if (m == NULL)
1557 return NULL;
1558 if (Py_VerboseFlag)
Victor Stinner98dbba52011-03-14 15:15:47 -04001559 PySys_FormatStderr("import %U # directory %R\n",
1560 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001561 file = get_sourcefile(pathname);
1562 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001563 return NULL;
1564 path_list = Py_BuildValue("[O]", file);
1565 if (path_list == NULL) {
1566 Py_DECREF(file);
1567 return NULL;
1568 }
1569 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001570 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001571 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001572 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001573 err = PyDict_SetItemString(d, "__path__", path_list);
1574 if (err != 0) {
1575 Py_DECREF(path_list);
1576 return NULL;
1577 }
Victor Stinner533d7832011-03-14 13:22:54 -04001578 fdp = find_module(name, initstr, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001579 &bufobj, &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001580 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001581 if (fdp == NULL) {
1582 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1583 PyErr_Clear();
1584 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001585 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001586 }
1587 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001588 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001589 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001590 m = load_module(name, fp, bufobj, fdp->type, NULL);
1591 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001592 if (fp != NULL)
1593 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001594 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001595}
1596
1597
1598/* Helper to test for built-in module */
1599
1600static int
Victor Stinner95872862011-03-07 18:20:56 +01001601is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001602{
Victor Stinner95872862011-03-07 18:20:56 +01001603 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001605 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1606 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001607 if (PyImport_Inittab[i].initfunc == NULL)
1608 return -1;
1609 else
1610 return 1;
1611 }
1612 }
1613 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001614}
1615
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001616
Just van Rossum52e14d62002-12-30 22:08:05 +00001617/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1618 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001619 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001620 that can handle the path item. Return None if no hook could;
1621 this tells our caller it should fall back to the builtin
1622 import mechanism. Cache the result in path_importer_cache.
1623 Returns a borrowed reference. */
1624
1625static PyObject *
1626get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001627 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001628{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 PyObject *importer;
1630 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001631
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001632 /* These conditions are the caller's responsibility: */
1633 assert(PyList_Check(path_hooks));
1634 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001635
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001636 nhooks = PyList_Size(path_hooks);
1637 if (nhooks < 0)
1638 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001639
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001640 importer = PyDict_GetItem(path_importer_cache, p);
1641 if (importer != NULL)
1642 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001643
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001644 /* set path_importer_cache[p] to None to avoid recursion */
1645 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1646 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001647
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 for (j = 0; j < nhooks; j++) {
1649 PyObject *hook = PyList_GetItem(path_hooks, j);
1650 if (hook == NULL)
1651 return NULL;
1652 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1653 if (importer != NULL)
1654 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001655
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001656 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1657 return NULL;
1658 }
1659 PyErr_Clear();
1660 }
1661 if (importer == NULL) {
1662 importer = PyObject_CallFunctionObjArgs(
1663 (PyObject *)&PyNullImporter_Type, p, NULL
1664 );
1665 if (importer == NULL) {
1666 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1667 PyErr_Clear();
1668 return Py_None;
1669 }
1670 }
1671 }
1672 if (importer != NULL) {
1673 int err = PyDict_SetItem(path_importer_cache, p, importer);
1674 Py_DECREF(importer);
1675 if (err != 0)
1676 return NULL;
1677 }
1678 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001679}
1680
Christian Heimes9cd17752007-11-18 19:35:23 +00001681PyAPI_FUNC(PyObject *)
1682PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001683 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001684
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1686 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1687 importer = get_path_importer(path_importer_cache,
1688 path_hooks, path);
1689 }
1690 }
1691 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1692 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001693}
1694
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001695/* Search the path (default sys.path) for a module. Return the
1696 corresponding filedescr struct, and (via return arguments) the
1697 pathname and an open file. Return NULL if the module is not found. */
1698
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001699#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001700extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1701 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001702#endif
1703
Victor Stinner547a2a62011-03-20 03:07:28 +01001704/* Forward */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001705static int case_ok(PyObject *, Py_ssize_t, PyObject *);
Victor Stinner547a2a62011-03-20 03:07:28 +01001706static int find_init_module(PyObject *);
Just van Rossum52e14d62002-12-30 22:08:05 +00001707static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001708
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001709/* Get the path of a module: get its importer and call importer.find_module()
1710 hook, or check if the module if a package (if path/__init__.py exists).
1711
1712 -1: error: a Python error occurred
1713 0: ignore: an error occurred because of invalid data, but the error is not
1714 important enough to be reported.
1715 1: get path: module not found, but *buf contains its path
1716 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1717 and *buf is the path */
1718
1719static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001720find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001721 PyObject *path_hooks, PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001722 PyObject **p_path, PyObject **p_loader, struct filedescr **p_fd)
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001723{
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001724 PyObject *path_unicode, *filename = NULL;
1725 Py_ssize_t len, pos;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001726 struct stat statbuf;
1727 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001728 int result, addsep;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001729
1730 if (PyUnicode_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001731 Py_INCREF(path);
1732 path_unicode = path;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001733 }
1734 else if (PyBytes_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001735 path_unicode = PyUnicode_DecodeFSDefaultAndSize(
1736 PyBytes_AS_STRING(path), PyBytes_GET_SIZE(path));
1737 if (path_unicode == NULL)
1738 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001739 }
1740 else
1741 return 0;
1742
Victor Stinner46084ba2011-10-06 02:39:42 +02001743 if (PyUnicode_READY(path_unicode))
1744 return -1;
1745
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001746 len = PyUnicode_GET_LENGTH(path_unicode);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001747 if (PyUnicode_FindChar(path_unicode, 0, 0, len, 1) != -1) {
1748 result = 0;
1749 goto out; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001750 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001751
1752 /* sys.path_hooks import hook */
1753 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001754 _Py_IDENTIFIER(find_module);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001755 PyObject *importer;
1756
1757 importer = get_path_importer(path_importer_cache,
1758 path_hooks, path);
1759 if (importer == NULL) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001760 result = -1;
1761 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001762 }
1763 /* Note: importer is a borrowed reference */
1764 if (importer != Py_None) {
1765 PyObject *loader;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001766 loader = _PyObject_CallMethodId(importer,
1767 &PyId_find_module, "O", fullname);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001768 if (loader == NULL) {
1769 result = -1; /* error */
1770 goto out;
1771 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001772 if (loader != Py_None) {
1773 /* a loader was found */
1774 *p_loader = loader;
1775 *p_fd = &importhookdescr;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001776 result = 2;
1777 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001778 }
1779 Py_DECREF(loader);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001780 result = 0;
1781 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001782 }
1783 }
1784 /* no hook was found, use builtin import */
1785
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001786 addsep = 0;
1787 if (len > 0 && PyUnicode_READ_CHAR(path_unicode, len-1) != SEP
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001788#ifdef ALTSEP
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001789 && PyUnicode_READ_CHAR(path_unicode, len-1) != ALTSEP
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001790#endif
1791 )
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001792 addsep = 1;
1793 filename = PyUnicode_New(len + PyUnicode_GET_LENGTH(name) + addsep,
1794 Py_MAX(PyUnicode_MAX_CHAR_VALUE(path_unicode),
1795 PyUnicode_MAX_CHAR_VALUE(name)));
1796 if (filename == NULL) {
1797 result = -1;
1798 goto out;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001799 }
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001800 PyUnicode_CopyCharacters(filename, 0, path_unicode, 0, len);
1801 pos = len;
1802 if (addsep)
1803 PyUnicode_WRITE(PyUnicode_KIND(filename),
1804 PyUnicode_DATA(filename),
1805 pos++, SEP);
1806 PyUnicode_CopyCharacters(filename, pos, name, 0,
1807 PyUnicode_GET_LENGTH(name));
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001808
1809 /* Check for package import (buf holds a directory name,
1810 and there's an __init__ module in that directory */
1811#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001812 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001813 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1814 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001815 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001816
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001817 match = case_ok(filename, 0, name);
1818 if (match < 0) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001819 result = -1;
1820 goto out;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001821 }
1822 if (match) { /* case matches */
1823 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001824 *p_path = filename;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001825 filename = NULL;
Victor Stinnerd0296212011-03-14 14:04:10 -04001826 *p_fd = &fd_package;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001827 result = 2;
1828 goto out;
Victor Stinnerd0296212011-03-14 14:04:10 -04001829 }
1830 else {
1831 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001832 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001833 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001834 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001835 if (err) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001836 result = -1;
1837 goto out;
Victor Stinner547a2a62011-03-20 03:07:28 +01001838 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001839 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001840 }
1841 }
1842#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001843 *p_path = filename;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001844 filename = NULL;
1845 result = 1;
1846 out:
1847 Py_DECREF(path_unicode);
1848 Py_XDECREF(filename);
1849 return result;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001850}
1851
1852/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001853 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001854
1855 If the module is found, return a file descriptor, write the path in
1856 *p_filename, write the pointer to the file object into *p_fp, and (if
1857 p_loader is not NULL) the loader into *p_loader.
1858
1859 Otherwise, raise an exception and return NULL. */
1860
Victor Stinner37580282011-03-20 01:34:43 +01001861static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001862find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001863 PyObject *search_path_list, PyObject *path_hooks,
1864 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001865 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001866{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001867 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001868 struct filedescr *fdp = NULL;
1869 char *filemode;
1870 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001871 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001872 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001873
Victor Stinner37580282011-03-20 01:34:43 +01001874 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001875 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001876 PyObject *path;
1877 int ok;
1878
1879 path = PyList_GetItem(search_path_list, i);
1880 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001881 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001882
Victor Stinner2fd76e42011-03-14 15:19:39 -04001883 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001884 ok = find_module_path(fullname, name, path,
1885 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001886 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001887 if (ok < 0)
1888 return NULL;
1889 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001890 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001891 if (ok == 2) {
1892 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001893 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001894 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001895
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001896 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001897 struct stat statbuf;
1898
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001899 filemode = fdp->mode;
1900 if (filemode[0] == 'U')
1901 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001902
Victor Stinner2fd76e42011-03-14 15:19:39 -04001903 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1904 if (filename == NULL) {
1905 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001906 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001907 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001908
1909 if (Py_VerboseFlag > 1)
1910 PySys_FormatStderr("# trying %R\n", filename);
1911
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001912 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
1913 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1914 {
1915 Py_DECREF(filename);
1916 continue;
1917 }
1918
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001919 fp = _Py_fopen(filename, filemode);
1920 if (fp == NULL) {
1921 Py_DECREF(filename);
Victor Stinner925ef392011-06-20 15:01:10 +02001922 if (PyErr_Occurred()) {
1923 Py_DECREF(prefix);
1924 return NULL;
1925 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001926 continue;
1927 }
1928 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1929 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001930 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001931 Py_DECREF(filename);
1932 return NULL;
1933 }
1934 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001935 Py_DECREF(prefix);
1936 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001937 *p_fp = fp;
1938 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001939 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001940 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001941
1942 fclose(fp);
1943 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001944 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001945 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001946 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001947 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04001948 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04001949 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001950}
1951
Victor Stinner37580282011-03-20 01:34:43 +01001952/* Find a module:
1953
1954 - try find_module() of each sys.meta_path hook
1955 - try find_frozen()
1956 - try is_builtin()
1957 - try _PyWin_FindRegisteredModule() (Windows only)
1958 - otherwise, call find_module_path_list() with search_path_list (if not
1959 NULL) or sys.path
1960
Victor Stinner2fd76e42011-03-14 15:19:39 -04001961 fullname can be NULL, but only if p_loader is NULL.
1962
Victor Stinner37580282011-03-20 01:34:43 +01001963 Return:
1964
1965 - &fd_builtin (C_BUILTIN) if it is a builtin
1966 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04001967 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01001968 if it is a package
1969 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1970 importer loader was found
1971 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1972 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04001973 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01001974 - NULL on error
1975
Victor Stinner2fd76e42011-03-14 15:19:39 -04001976 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
1977 Eg. *p_path is set to NULL for a builtin package.
1978*/
Victor Stinner37580282011-03-20 01:34:43 +01001979
1980static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001981find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001982 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01001983{
1984 Py_ssize_t i, npath;
1985 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1986 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1987 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01001988
Victor Stinner2fd76e42011-03-14 15:19:39 -04001989 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01001990 *p_fp = NULL;
1991 if (p_loader != NULL)
1992 *p_loader = NULL;
1993
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001994 if (PyUnicode_GET_LENGTH(name) > MAXPATHLEN) {
1995 PyErr_SetString(PyExc_OverflowError,
1996 "module name is too long");
1997 return NULL;
1998 }
1999
Victor Stinner37580282011-03-20 01:34:43 +01002000 /* sys.meta_path import hook */
2001 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002002 _Py_IDENTIFIER(find_module);
Victor Stinner37580282011-03-20 01:34:43 +01002003 PyObject *meta_path;
2004
2005 meta_path = PySys_GetObject("meta_path");
2006 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02002007 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002008 "sys.meta_path must be a list of "
2009 "import hooks");
2010 return NULL;
2011 }
2012 Py_INCREF(meta_path); /* zap guard */
2013 npath = PyList_Size(meta_path);
2014 for (i = 0; i < npath; i++) {
2015 PyObject *loader;
2016 PyObject *hook = PyList_GetItem(meta_path, i);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002017 loader = _PyObject_CallMethodId(hook, &PyId_find_module,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002018 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01002019 search_path_list != NULL ?
2020 search_path_list : Py_None);
2021 if (loader == NULL) {
2022 Py_DECREF(meta_path);
2023 return NULL; /* true error */
2024 }
2025 if (loader != Py_None) {
2026 /* a loader was found */
2027 *p_loader = loader;
2028 Py_DECREF(meta_path);
2029 return &importhookdescr;
2030 }
2031 Py_DECREF(loader);
2032 }
2033 Py_DECREF(meta_path);
2034 }
2035
Victor Stinnerdf75a022011-03-14 13:40:04 -04002036 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002037 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01002038
2039 if (search_path_list == NULL) {
2040#ifdef MS_COREDLL
2041 FILE *fp;
2042 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01002043#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04002044 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01002045 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01002046#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04002047 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01002048 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01002049 *p_fp = fp;
2050 return fdp;
2051 }
2052 else if (PyErr_Occurred())
2053 return NULL;
2054#endif
Victor Stinner37580282011-03-20 01:34:43 +01002055 search_path_list = PySys_GetObject("path");
2056 }
2057
2058 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
Victor Stinner16191322011-09-15 19:28:05 +02002059 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002060 "sys.path must be a list of directory names");
2061 return NULL;
2062 }
2063
2064 path_hooks = PySys_GetObject("path_hooks");
2065 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02002066 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002067 "sys.path_hooks must be a list of "
2068 "import hooks");
2069 return NULL;
2070 }
2071 path_importer_cache = PySys_GetObject("path_importer_cache");
2072 if (path_importer_cache == NULL ||
2073 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02002074 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002075 "sys.path_importer_cache must be a dict");
2076 return NULL;
2077 }
2078
2079 return find_module_path_list(fullname, name,
2080 search_path_list, path_hooks,
2081 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002082 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002083}
2084
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002085/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002086 * The arguments here are tricky, best shown by example:
2087 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2088 * ^ ^ ^ ^
2089 * |--------------------- buf ---------------------|
2090 * |------------------- len ------------------|
2091 * |------ name -------|
2092 * |----- namelen -----|
2093 * buf is the full path, but len only counts up to (& exclusive of) the
2094 * extension. name is the module name, also exclusive of extension.
2095 *
2096 * We've already done a successful stat() or fopen() on buf, so know that
2097 * there's some match, possibly case-insensitive.
2098 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002099 * case_bytes() is to return 1 if there's a case-sensitive match for
2100 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002101 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002102 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002103 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002104 * on platforms with case-insensitive filesystems. It's trivial to implement
2105 * for case-sensitive filesystems. It's pretty much a cross-platform
2106 * nightmare for systems with case-insensitive filesystems.
2107 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002108
Tim Peters50d8d372001-02-28 05:34:27 +00002109/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002110 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002111 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002112#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002113#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002114
Tim Peters50d8d372001-02-28 05:34:27 +00002115#elif defined(DJGPP)
2116#include <dir.h>
2117
Jason Tishler7961aa62005-05-20 00:56:54 +00002118#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002119#include <sys/types.h>
2120#include <dirent.h>
2121
Andrew MacIntyred9400542002-02-26 11:41:34 +00002122#elif defined(PYOS_OS2)
2123#define INCL_DOS
2124#define INCL_DOSERRORS
2125#define INCL_NOPMAPI
2126#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002127#endif
2128
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002129#if defined(DJGPP) \
2130 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2131 && defined(HAVE_DIRENT_H)) \
2132 || defined(PYOS_OS2)
2133# define USE_CASE_OK_BYTES
2134#endif
2135
2136
2137#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002138static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002139case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002140{
Tim Peters50d8d372001-02-28 05:34:27 +00002141/* Pick a platform-specific implementation; the sequence of #if's here should
2142 * match the sequence just above.
2143 */
2144
Tim Peters50d8d372001-02-28 05:34:27 +00002145/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002146#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002147 struct ffblk ffblk;
2148 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002149
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002150 if (Py_GETENV("PYTHONCASEOK") != NULL)
2151 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002152
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002153 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2154 if (done) {
2155 PyErr_Format(PyExc_NameError,
2156 "Can't find file for module %.100s\n(filename %.300s)",
2157 name, buf);
Victor Stinner9c61e242011-03-22 01:22:27 +01002158 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002159 }
2160 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002161
Jason Tishler7961aa62005-05-20 00:56:54 +00002162/* new-fangled macintosh (macosx) or Cygwin */
2163#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002164 DIR *dirp;
2165 struct dirent *dp;
2166 char dirname[MAXPATHLEN + 1];
2167 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002168
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002169 if (Py_GETENV("PYTHONCASEOK") != NULL)
2170 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002171
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002172 /* Copy the dir component into dirname; substitute "." if empty */
2173 if (dirlen <= 0) {
2174 dirname[0] = '.';
2175 dirname[1] = '\0';
2176 }
2177 else {
2178 assert(dirlen <= MAXPATHLEN);
2179 memcpy(dirname, buf, dirlen);
2180 dirname[dirlen] = '\0';
2181 }
2182 /* Open the directory and search the entries for an exact match. */
2183 dirp = opendir(dirname);
2184 if (dirp) {
2185 char *nameWithExt = buf + len - namelen;
2186 while ((dp = readdir(dirp)) != NULL) {
2187 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002188#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002189 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002190#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002191 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002192#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002193 if (thislen >= namelen &&
2194 strcmp(dp->d_name, nameWithExt) == 0) {
2195 (void)closedir(dirp);
2196 return 1; /* Found */
2197 }
2198 }
2199 (void)closedir(dirp);
2200 }
2201 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002202
Andrew MacIntyred9400542002-02-26 11:41:34 +00002203/* OS/2 */
2204#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002205 HDIR hdir = 1;
2206 ULONG srchcnt = 1;
2207 FILEFINDBUF3 ffbuf;
2208 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002210 if (Py_GETENV("PYTHONCASEOK") != NULL)
2211 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002212
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002213 rc = DosFindFirst(buf,
2214 &hdir,
2215 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2216 &ffbuf, sizeof(ffbuf),
2217 &srchcnt,
2218 FIL_STANDARD);
2219 if (rc != NO_ERROR)
2220 return 0;
2221 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002222
Tim Peters50d8d372001-02-28 05:34:27 +00002223/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2224#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002225# error "USE_CASE_OK_BYTES is not correctly defined"
2226#endif
2227}
2228#endif
2229
2230/*
2231 * Check if a filename case matchs the name case. We've already done a
2232 * successful stat() or fopen() on buf, so know that there's some match,
2233 * possibly case-insensitive.
2234 *
2235 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2236 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2237 * if envar PYTHONCASEOK exists.
2238 *
2239 * case_ok() is used to implement case-sensitive import semantics even
2240 * on platforms with case-insensitive filesystems. It's trivial to implement
2241 * for case-sensitive filesystems. It's pretty much a cross-platform
2242 * nightmare for systems with case-insensitive filesystems.
2243 */
2244
2245static int
2246case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2247{
2248#ifdef MS_WINDOWS
2249 WIN32_FIND_DATAW data;
2250 HANDLE h;
2251 int cmp;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002252 wchar_t *wname;
Victor Stinner8c981892011-10-11 22:27:13 +02002253 Py_ssize_t wname_len;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002254
2255 if (Py_GETENV("PYTHONCASEOK") != NULL)
2256 return 1;
2257
2258 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2259 if (h == INVALID_HANDLE_VALUE) {
2260 PyErr_Format(PyExc_NameError,
2261 "Can't find file for module %R\n(filename %R)",
2262 name, filename);
2263 return 0;
2264 }
2265 FindClose(h);
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002266
2267 wname = PyUnicode_AsUnicodeAndSize(name, &wname_len);
2268 if (wname == NULL)
2269 return -1;
2270
2271 cmp = wcsncmp(data.cFileName, wname, wname_len);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002272 return cmp == 0;
2273#elif defined(USE_CASE_OK_BYTES)
2274 int match;
2275 PyObject *filebytes, *namebytes;
2276 filebytes = PyUnicode_EncodeFSDefault(filename);
2277 if (filebytes == NULL)
2278 return -1;
2279 namebytes = PyUnicode_EncodeFSDefault(name);
2280 if (namebytes == NULL) {
2281 Py_DECREF(filebytes);
2282 return -1;
2283 }
2284 match = case_bytes(
2285 PyBytes_AS_STRING(filebytes),
2286 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002287 PyBytes_GET_SIZE(namebytes),
2288 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002289 Py_DECREF(filebytes);
2290 Py_DECREF(namebytes);
2291 return match;
2292#else
2293 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002294 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002295
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002296#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002297}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002298
Guido van Rossum197346f1997-10-31 18:38:52 +00002299#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002300
Victor Stinner547a2a62011-03-20 03:07:28 +01002301/* Helper to look for __init__.py or __init__.py[co] in potential package.
2302 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002303static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002304find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002305{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002306 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002307 PyObject *filename;
2308 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002309
Victor Stinner547a2a62011-03-20 03:07:28 +01002310 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2311 if (filename == NULL)
2312 return -1;
2313 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002314 /* 3=len(".py") */
2315 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002316 if (match < 0) {
2317 Py_DECREF(filename);
2318 return -1;
2319 }
2320 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002321 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002322 return 1;
2323 }
2324 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002325 Py_DECREF(filename);
2326
2327 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2328 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2329 if (filename == NULL)
2330 return -1;
2331 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002332 /* 4=len(".pyc") */
2333 match = case_ok(filename, -4, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002334 if (match < 0) {
2335 Py_DECREF(filename);
2336 return -1;
2337 }
2338 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002339 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002340 return 1;
2341 }
2342 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002343 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002344 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002345}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002346
Guido van Rossum197346f1997-10-31 18:38:52 +00002347#endif /* HAVE_STAT */
2348
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002349
Victor Stinner95872862011-03-07 18:20:56 +01002350static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002351
Victor Stinner44c6c152010-08-09 00:59:10 +00002352static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002353load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002354{
2355 PyObject *m, *modules;
2356 int err;
2357
Victor Stinner44c6c152010-08-09 00:59:10 +00002358 if (type == C_BUILTIN)
2359 err = init_builtin(name);
2360 else
Victor Stinner95872862011-03-07 18:20:56 +01002361 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002362 if (err < 0)
2363 return NULL;
2364 if (err == 0) {
2365 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002366 "Purported %s module %R not found",
2367 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002368 name);
2369 return NULL;
2370 }
2371
2372 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002373 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002374 if (m == NULL) {
2375 PyErr_Format(
2376 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002377 "%s module %R not properly initialized",
2378 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002379 name);
2380 return NULL;
2381 }
2382 Py_INCREF(m);
2383 return m;
2384}
2385
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002386/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002387 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002388
Guido van Rossum79f25d91997-04-29 20:08:16 +00002389static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002390load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002391{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002392 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002393
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002394 /* First check that there's an open file (if we need one) */
2395 switch (type) {
2396 case PY_SOURCE:
2397 case PY_COMPILED:
2398 if (fp == NULL) {
2399 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002400 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002401 type);
2402 return NULL;
2403 }
2404 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002406 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002407
Victor Stinner41c5fec2011-03-13 21:46:30 -04002408 case PY_SOURCE:
2409 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002410 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002411
Victor Stinner41c5fec2011-03-13 21:46:30 -04002412 case PY_COMPILED:
2413 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002414 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002415
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002416#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002417 case C_EXTENSION:
2418 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002419 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002420#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002421
Victor Stinner41c5fec2011-03-13 21:46:30 -04002422 case PKG_DIRECTORY:
2423 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002424 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002425
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002426 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002427 case PY_FROZEN:
2428 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002429 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002430
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002431 case IMP_HOOK: {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002432 _Py_IDENTIFIER(load_module);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002433 if (loader == NULL) {
2434 PyErr_SetString(PyExc_ImportError,
2435 "import hook without loader");
2436 return NULL;
2437 }
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002438 m = _PyObject_CallMethodId(loader, &PyId_load_module, "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002439 break;
2440 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002441
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002442 default:
2443 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002444 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002445 name, type);
2446 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002448 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002450 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002451}
2452
2453
2454/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002455 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002456 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002457
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002458static int
Victor Stinner95872862011-03-07 18:20:56 +01002459init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002460{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002461 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002462
Victor Stinner95872862011-03-07 18:20:56 +01002463 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002464 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 for (p = PyImport_Inittab; p->name != NULL; p++) {
2467 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002468 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 if (p->initfunc == NULL) {
2470 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002471 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002472 name);
2473 return -1;
2474 }
2475 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002476 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002477 mod = (*p->initfunc)();
2478 if (mod == 0)
2479 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002480 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002481 return -1;
2482 /* FixupExtension has put the module into sys.modules,
2483 so we can release our own reference. */
2484 Py_DECREF(mod);
2485 return 1;
2486 }
2487 }
2488 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002489}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002490
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002491
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002492/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002493
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002494static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002495find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002496{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002497 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002498
Victor Stinner53dc7352011-03-20 01:50:21 +01002499 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002500 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002501
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002502 for (p = PyImport_FrozenModules; ; p++) {
2503 if (p->name == NULL)
2504 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002505 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002506 break;
2507 }
2508 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002509}
2510
Guido van Rossum79f25d91997-04-29 20:08:16 +00002511static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002512get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002513{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002514 struct _frozen *p = find_frozen(name);
2515 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002516
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002517 if (p == NULL) {
2518 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002519 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002520 name);
2521 return NULL;
2522 }
2523 if (p->code == NULL) {
2524 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002525 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002526 name);
2527 return NULL;
2528 }
2529 size = p->size;
2530 if (size < 0)
2531 size = -size;
2532 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002533}
2534
Brett Cannon8d110132009-03-15 02:20:16 +00002535static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002536is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002537{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002538 struct _frozen *p = find_frozen(name);
2539 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 if (p == NULL) {
2542 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002543 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002544 name);
2545 return NULL;
2546 }
Brett Cannon8d110132009-03-15 02:20:16 +00002547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002548 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002549
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002550 if (size < 0)
2551 Py_RETURN_TRUE;
2552 else
2553 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002554}
2555
2556
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002557/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002558 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002559 an exception set if the initialization failed.
2560 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002561
2562int
Victor Stinner53dc7352011-03-20 01:50:21 +01002563PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002564{
Victor Stinner53dc7352011-03-20 01:50:21 +01002565 struct _frozen *p;
2566 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002567 int ispackage;
2568 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002569
Victor Stinner53dc7352011-03-20 01:50:21 +01002570 p = find_frozen(name);
2571
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002572 if (p == NULL)
2573 return 0;
2574 if (p->code == NULL) {
2575 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002576 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002577 name);
2578 return -1;
2579 }
2580 size = p->size;
2581 ispackage = (size < 0);
2582 if (ispackage)
2583 size = -size;
2584 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002585 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002586 name, ispackage ? " package" : "");
2587 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2588 if (co == NULL)
2589 return -1;
2590 if (!PyCode_Check(co)) {
2591 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002592 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002593 name);
2594 goto err_return;
2595 }
2596 if (ispackage) {
2597 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002598 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002599 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002600 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002601 if (m == NULL)
2602 goto err_return;
2603 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002604 l = PyList_New(1);
2605 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002606 goto err_return;
2607 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002608 Py_INCREF(name);
2609 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002610 err = PyDict_SetItemString(d, "__path__", l);
2611 Py_DECREF(l);
2612 if (err != 0)
2613 goto err_return;
2614 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002615 path = PyUnicode_FromString("<frozen>");
2616 if (path == NULL)
2617 goto err_return;
2618 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2619 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002620 if (m == NULL)
2621 goto err_return;
2622 Py_DECREF(co);
2623 Py_DECREF(m);
2624 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002625err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002626 Py_DECREF(co);
2627 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002628}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002629
Victor Stinner53dc7352011-03-20 01:50:21 +01002630int
2631PyImport_ImportFrozenModule(char *name)
2632{
2633 PyObject *nameobj;
2634 int ret;
2635 nameobj = PyUnicode_InternFromString(name);
2636 if (nameobj == NULL)
2637 return -1;
2638 ret = PyImport_ImportFrozenModuleObject(nameobj);
2639 Py_DECREF(nameobj);
2640 return ret;
2641}
2642
Guido van Rossum74e6a111994-08-29 12:54:38 +00002643
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002644/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002645 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002646
Guido van Rossum79f25d91997-04-29 20:08:16 +00002647PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002648PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002649{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002650 PyObject *pname;
2651 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002652
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002653 pname = PyUnicode_FromString(name);
2654 if (pname == NULL)
2655 return NULL;
2656 result = PyImport_Import(pname);
2657 Py_DECREF(pname);
2658 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002659}
2660
Christian Heimes072c0f12008-01-03 23:01:04 +00002661/* Import a module without blocking
2662 *
2663 * At first it tries to fetch the module from sys.modules. If the module was
2664 * never loaded before it loads it with PyImport_ImportModule() unless another
2665 * thread holds the import lock. In the latter case the function raises an
2666 * ImportError instead of blocking.
2667 *
2668 * Returns the module object with incremented ref count.
2669 */
2670PyObject *
2671PyImport_ImportModuleNoBlock(const char *name)
2672{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002673 PyObject *nameobj, *modules, *result;
Victor Stinner0af03062011-09-02 00:11:43 +02002674#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002675 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002676#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002677
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002678 /* Try to get the module from sys.modules[name] */
2679 modules = PyImport_GetModuleDict();
2680 if (modules == NULL)
2681 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002682
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002683 nameobj = PyUnicode_FromString(name);
2684 if (nameobj == NULL)
2685 return NULL;
2686 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002687 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002688 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002689 Py_INCREF(result);
2690 return result;
2691 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002692 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002693#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002694 /* check the import lock
2695 * me might be -1 but I ignore the error here, the lock function
2696 * takes care of the problem */
2697 me = PyThread_get_thread_ident();
2698 if (import_lock_thread == -1 || import_lock_thread == me) {
2699 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002700 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002701 }
2702 else {
2703 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002704 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002705 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002706 nameobj);
2707 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002708 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002709#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002710 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002711#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002712 Py_DECREF(nameobj);
2713 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002714}
2715
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002716/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002717static PyObject *get_parent(PyObject *globals,
2718 PyObject **p_name,
2719 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002720static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002721 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002722 PyObject **p_prefix);
Victor Stinner974389d2011-03-15 09:33:57 +01002723static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002724static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002725 PyObject *buf, int recursive);
2726static PyObject * import_submodule(PyObject *mod, PyObject *name,
2727 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002728
2729/* The Magnum Opus of dotted-name import :-) */
2730
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002731static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002732import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002733 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002734{
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002735 PyObject *parent, *next, *inputname, *outputname;
2736 PyObject *head = NULL;
2737 PyObject *tail = NULL;
2738 PyObject *prefix = NULL;
2739 PyObject *result = NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002740 Py_ssize_t sep, altsep;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002741
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002742 if (PyUnicode_READY(name))
2743 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002744
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002745 sep = PyUnicode_FindChar(name, SEP, 0, PyUnicode_GET_LENGTH(name), 1);
2746 if (sep == -2)
2747 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002748#ifdef ALTSEP
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002749 altsep = PyUnicode_FindChar(name, ALTSEP, 0, PyUnicode_GET_LENGTH(name), 1);
2750 if (altsep == -2)
2751 return NULL;
2752#else
2753 altsep = -1;
Christian Heimes454f37b2008-01-10 00:10:02 +00002754#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002755 if (sep != -1 || altsep != -1)
2756 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002757 PyErr_SetString(PyExc_ImportError,
2758 "Import by filename is not supported.");
2759 return NULL;
2760 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002761
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002762 parent = get_parent(globals, &prefix, level);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002763 if (parent == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002764 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002765 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002766
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002767 if (PyUnicode_READY(prefix))
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002768 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002769
2770 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002771 &prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002772 if (head == NULL)
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002773 goto out;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002774
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002775 tail = head;
2776 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002777
2778 if (outputname != NULL) {
2779 while (1) {
2780 inputname = outputname;
2781 next = load_next(tail, tail, inputname, &outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002782 &prefix);
2783 Py_CLEAR(tail);
2784 Py_CLEAR(inputname);
2785 if (next == NULL)
2786 goto out;
Victor Stinner974389d2011-03-15 09:33:57 +01002787 tail = next;
2788
2789 if (outputname == NULL) {
2790 break;
2791 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002792 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002793 }
2794 if (tail == Py_None) {
2795 /* If tail is Py_None, both get_parent and load_next found
2796 an empty module name: someone called __import__("") or
2797 doctored faulty bytecode */
Victor Stinner974389d2011-03-15 09:33:57 +01002798 PyErr_SetString(PyExc_ValueError, "Empty module name");
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002799 goto out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002800 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002801
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002802 if (fromlist != NULL) {
2803 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2804 fromlist = NULL;
2805 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002806
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002807 if (fromlist == NULL) {
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002808 result = head;
2809 Py_INCREF(result);
2810 goto out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002811 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002812
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002813 if (!ensure_fromlist(tail, fromlist, prefix, 0))
2814 goto out;
2815
2816 result = tail;
2817 Py_INCREF(result);
2818 out:
2819 Py_XDECREF(head);
2820 Py_XDECREF(tail);
2821 Py_XDECREF(prefix);
2822 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002823}
2824
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002825PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002826PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2827 PyObject *locals, PyObject *fromlist,
2828 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002829{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002830 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002831 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002832 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002833 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002834 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002835 PyErr_SetString(PyExc_RuntimeError,
2836 "not holding the import lock");
2837 return NULL;
2838 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002839 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002840}
2841
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002842PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05002843PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002844 PyObject *fromlist, int level)
2845{
2846 PyObject *nameobj, *mod;
2847 nameobj = PyUnicode_FromString(name);
2848 if (nameobj == NULL)
2849 return NULL;
2850 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2851 fromlist, level);
2852 Py_DECREF(nameobj);
2853 return mod;
2854}
2855
2856
Fred Drake87590902004-05-28 20:21:36 +00002857/* Return the package that an import is being performed in. If globals comes
2858 from the module foo.bar.bat (not itself a package), this returns the
2859 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002860 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002861
Victor Stinner974389d2011-03-15 09:33:57 +01002862 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002863
2864 If globals doesn't come from a package or a module in a package, or a
2865 corresponding entry is not found in sys.modules, Py_None is returned.
2866*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002867static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002868get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002869{
Victor Stinner974389d2011-03-15 09:33:57 +01002870 PyObject *nameobj;
2871
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002872 static PyObject *namestr = NULL;
2873 static PyObject *pathstr = NULL;
2874 static PyObject *pkgstr = NULL;
2875 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2876 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002877
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002878 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002879 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002880
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002881 if (namestr == NULL) {
2882 namestr = PyUnicode_InternFromString("__name__");
2883 if (namestr == NULL)
2884 return NULL;
2885 }
2886 if (pathstr == NULL) {
2887 pathstr = PyUnicode_InternFromString("__path__");
2888 if (pathstr == NULL)
2889 return NULL;
2890 }
2891 if (pkgstr == NULL) {
2892 pkgstr = PyUnicode_InternFromString("__package__");
2893 if (pkgstr == NULL)
2894 return NULL;
2895 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002896
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002897 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002898
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002899 if ((pkgname != NULL) && (pkgname != Py_None)) {
2900 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002901 if (!PyUnicode_Check(pkgname)) {
2902 PyErr_SetString(PyExc_ValueError,
2903 "__package__ set to non-string");
2904 return NULL;
2905 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002906 if (PyUnicode_GET_LENGTH(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002907 if (level > 0) {
2908 PyErr_SetString(PyExc_ValueError,
2909 "Attempted relative import in non-package");
2910 return NULL;
2911 }
Victor Stinner974389d2011-03-15 09:33:57 +01002912 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002913 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002914 Py_INCREF(pkgname);
2915 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002916 } else {
2917 /* __package__ not set, so figure it out and set it */
2918 modname = PyDict_GetItem(globals, namestr);
2919 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002920 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002921
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002922 modpath = PyDict_GetItem(globals, pathstr);
2923 if (modpath != NULL) {
2924 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002925 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002927 error = PyDict_SetItem(globals, pkgstr, modname);
2928 if (error) {
2929 PyErr_SetString(PyExc_ValueError,
2930 "Could not set __package__");
2931 return NULL;
2932 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002933 Py_INCREF(modname);
2934 nameobj = modname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002935 } else {
2936 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002937 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002938 len = PyUnicode_FindChar(modname, '.',
2939 0, PyUnicode_GET_LENGTH(modname), -1);
2940 if (len == -2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002941 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002942 if (len < 0) {
2943 if (level > 0) {
2944 PyErr_SetString(PyExc_ValueError,
2945 "Attempted relative import in non-package");
2946 return NULL;
2947 }
2948 if (PyDict_SetItem(globals, pkgstr, Py_None)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002949 PyErr_SetString(PyExc_ValueError,
2950 "Could not set __package__");
2951 return NULL;
2952 }
Victor Stinner974389d2011-03-15 09:33:57 +01002953 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002954 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002955 pkgname = PyUnicode_Substring(modname, 0, len);
2956 if (pkgname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002957 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002958 if (PyDict_SetItem(globals, pkgstr, pkgname)) {
2959 Py_DECREF(pkgname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002960 PyErr_SetString(PyExc_ValueError,
2961 "Could not set __package__");
2962 return NULL;
2963 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002964 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002965 }
2966 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002967 if (level > 1) {
2968 Py_ssize_t dot, end = PyUnicode_GET_LENGTH(nameobj);
2969 PyObject *newname;
2970 while (--level > 0) {
2971 dot = PyUnicode_FindChar(nameobj, '.', 0, end, -1);
2972 if (dot == -2) {
2973 Py_DECREF(nameobj);
2974 return NULL;
2975 }
2976 if (dot < 0) {
2977 Py_DECREF(nameobj);
2978 PyErr_SetString(PyExc_ValueError,
2979 "Attempted relative import beyond "
2980 "toplevel package");
2981 return NULL;
2982 }
2983 end = dot;
2984 }
2985 newname = PyUnicode_Substring(nameobj, 0, end);
2986 Py_DECREF(nameobj);
2987 if (newname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002988 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002989 nameobj = newname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002990 }
Victor Stinner974389d2011-03-15 09:33:57 +01002991
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002992 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01002993 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002994 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01002995 int err;
2996
2997 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002998 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01002999 "Parent module %R not loaded, "
3000 "cannot perform relative import", nameobj);
3001 Py_DECREF(nameobj);
3002 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003003 }
Victor Stinner974389d2011-03-15 09:33:57 +01003004
3005 err = PyErr_WarnFormat(
3006 PyExc_RuntimeWarning, 1,
3007 "Parent module %R not found while handling absolute import",
3008 nameobj);
3009 Py_DECREF(nameobj);
3010 if (err)
3011 return NULL;
3012
3013 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003014 }
Victor Stinner974389d2011-03-15 09:33:57 +01003015 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003016 return parent;
3017 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01003018 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003019 - parent.__dict__ is globals
3020 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01003021
3022return_none:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003023 nameobj = PyUnicode_New(0, 0);
Victor Stinner974389d2011-03-15 09:33:57 +01003024 if (nameobj == NULL)
3025 return NULL;
3026 *p_name = nameobj;
3027 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003028}
3029
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003030/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003031static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003032load_next(PyObject *mod, PyObject *altmod,
3033 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003034 PyObject **p_prefix)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003035{
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003036 Py_ssize_t dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003037 Py_ssize_t len;
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003038 PyObject *fullname, *name = NULL, *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003039
Victor Stinner974389d2011-03-15 09:33:57 +01003040 *p_outputname = NULL;
3041
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003042 len = PyUnicode_GET_LENGTH(inputname);
3043 if (len == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003044 /* completely empty module name should only happen in
3045 'from . import' (or '__import__("")')*/
3046 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003047 return mod;
3048 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00003049
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003050
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003051 dot = PyUnicode_FindChar(inputname, '.', 0, len, 1);
3052 if (dot >= 0) {
3053 len = dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003054 if (len == 0) {
3055 PyErr_SetString(PyExc_ValueError,
3056 "Empty module name");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003057 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003058 }
3059 }
Victor Stinner974389d2011-03-15 09:33:57 +01003060
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003061 /* name = inputname[:len] */
3062 name = PyUnicode_Substring(inputname, 0, len);
3063 if (name == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003064 goto error;
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003065
3066 if (PyUnicode_GET_LENGTH(*p_prefix)) {
3067 /* fullname = prefix + "." + name */
3068 fullname = PyUnicode_FromFormat("%U.%U", *p_prefix, name);
3069 if (fullname == NULL)
3070 goto error;
3071 }
3072 else {
3073 fullname = name;
3074 Py_INCREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003075 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003076
Victor Stinner974389d2011-03-15 09:33:57 +01003077 result = import_submodule(mod, name, fullname);
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003078 Py_DECREF(*p_prefix);
3079 /* Transfer reference. */
3080 *p_prefix = fullname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003081 if (result == Py_None && altmod != mod) {
3082 Py_DECREF(result);
3083 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003084 result = import_submodule(altmod, name, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003085 if (result != NULL && result != Py_None) {
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003086 if (mark_miss(*p_prefix) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003087 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003088 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003089 }
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003090 Py_DECREF(*p_prefix);
3091 *p_prefix = name;
3092 Py_INCREF(*p_prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003093 }
3094 }
3095 if (result == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003096 goto error;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003097
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003098 if (result == Py_None) {
3099 Py_DECREF(result);
3100 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003101 "No module named %R", inputname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003102 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003103 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003104
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003105 if (dot >= 0) {
3106 *p_outputname = PyUnicode_Substring(inputname, dot+1,
3107 PyUnicode_GET_LENGTH(inputname));
Victor Stinner974389d2011-03-15 09:33:57 +01003108 if (*p_outputname == NULL) {
3109 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003110 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003111 }
3112 }
3113
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003114 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003115 return result;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003116
3117error:
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003118 Py_XDECREF(name);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003119 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003120}
3121
3122static int
Victor Stinner974389d2011-03-15 09:33:57 +01003123mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003124{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003125 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003126 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003127}
3128
3129static int
Victor Stinner974389d2011-03-15 09:33:57 +01003130ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003131 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003132{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003133 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003134 PyObject *fullname;
3135 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003136
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003137 if (!_PyObject_HasAttrId(mod, &PyId___path__))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003138 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003139
Victor Stinner974389d2011-03-15 09:33:57 +01003140 fromlist_len = PySequence_Size(fromlist);
3141
3142 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003143 PyObject *item = PySequence_GetItem(fromlist, i);
3144 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003145 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003146 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003147 if (!PyUnicode_Check(item)) {
3148 PyErr_SetString(PyExc_TypeError,
3149 "Item in ``from list'' not a string");
3150 Py_DECREF(item);
3151 return 0;
3152 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003153 if (PyUnicode_READ_CHAR(item, 0) == '*') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003154 PyObject *all;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02003155 _Py_IDENTIFIER(__all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003156 Py_DECREF(item);
3157 /* See if the package defines __all__ */
3158 if (recursive)
3159 continue; /* Avoid endless recursion */
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003160 all = _PyObject_GetAttrId(mod, &PyId___all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003161 if (all == NULL)
3162 PyErr_Clear();
3163 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003164 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003165 Py_DECREF(all);
3166 if (!ret)
3167 return 0;
3168 }
3169 continue;
3170 }
3171 hasit = PyObject_HasAttr(mod, item);
3172 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003173 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003174 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3175 if (fullname != NULL) {
3176 submod = import_submodule(mod, item, fullname);
3177 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003178 }
Victor Stinner974389d2011-03-15 09:33:57 +01003179 else
3180 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003181 Py_XDECREF(submod);
3182 if (submod == NULL) {
3183 Py_DECREF(item);
3184 return 0;
3185 }
3186 }
3187 Py_DECREF(item);
3188 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003189
Victor Stinner974389d2011-03-15 09:33:57 +01003190 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003191}
3192
Neil Schemenauer00b09662003-06-16 21:03:07 +00003193static int
Victor Stinner974389d2011-03-15 09:33:57 +01003194add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3195 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003196{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003197 if (mod == Py_None)
3198 return 1;
3199 /* Irrespective of the success of this load, make a
3200 reference to it in the parent package module. A copy gets
3201 saved in the modules dictionary under the full name, so get a
3202 reference from there, if need be. (The exception is when the
3203 load failed with a SyntaxError -- then there's no trace in
3204 sys.modules. In that case, of course, do nothing extra.) */
3205 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003206 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003207 if (submod == NULL)
3208 return 1;
3209 }
3210 if (PyModule_Check(mod)) {
3211 /* We can't use setattr here since it can give a
3212 * spurious warning if the submodule name shadows a
3213 * builtin name */
3214 PyObject *dict = PyModule_GetDict(mod);
3215 if (!dict)
3216 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003217 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003218 return 0;
3219 }
3220 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003221 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003222 return 0;
3223 }
3224 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003225}
3226
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003227static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003228import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003229{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003230 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003231 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003232 struct filedescr *fdp;
3233 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003235 /* Require:
3236 if mod == None: subname == fullname
3237 else: mod.__name__ + "." + subname == fullname
3238 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003239
Victor Stinner974389d2011-03-15 09:33:57 +01003240 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003241 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003242 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003243 }
Victor Stinner9599de52011-03-13 22:38:38 -04003244
3245 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003246 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003247 else {
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003248 path_list = _PyObject_GetAttrId(mod, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003249 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003250 PyErr_Clear();
3251 Py_INCREF(Py_None);
3252 return Py_None;
3253 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003254 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003255
Victor Stinner533d7832011-03-14 13:22:54 -04003256 fdp = find_module(fullname, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003257 &bufobj, &fp, &loader);
Victor Stinner533d7832011-03-14 13:22:54 -04003258 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003259 if (fdp == NULL) {
3260 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3261 return NULL;
3262 PyErr_Clear();
3263 Py_INCREF(Py_None);
3264 return Py_None;
3265 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003266 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3267 Py_XDECREF(bufobj);
Victor Stinner9599de52011-03-13 22:38:38 -04003268 Py_XDECREF(loader);
3269 if (fp)
3270 fclose(fp);
3271 if (m == NULL)
3272 return NULL;
3273 if (!add_submodule(mod, m, fullname, subname, modules)) {
3274 Py_XDECREF(m);
3275 return NULL;
3276 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003277 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003278}
3279
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003280
3281/* Re-import a module of any kind and return its module object, WITH
3282 INCREMENTED REFERENCE COUNT */
3283
Guido van Rossum79f25d91997-04-29 20:08:16 +00003284PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003285PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003286{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003287 PyInterpreterState *interp = PyThreadState_Get()->interp;
3288 PyObject *modules_reloading = interp->modules_reloading;
3289 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003290 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003291 PyObject *name, *bufobj, *subname;
3292 Py_ssize_t subname_start;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003293 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003294 FILE *fp = NULL;
3295 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003296
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003297 if (modules_reloading == NULL) {
3298 Py_FatalError("PyImport_ReloadModule: "
3299 "no modules_reloading dictionary!");
3300 return NULL;
3301 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003302
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003303 if (m == NULL || !PyModule_Check(m)) {
3304 PyErr_SetString(PyExc_TypeError,
3305 "reload() argument must be module");
3306 return NULL;
3307 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003308 name = PyModule_GetNameObject(m);
3309 if (name == NULL || PyUnicode_READY(name) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003310 return NULL;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003311 if (m != PyDict_GetItem(modules, name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003312 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003313 "reload(): module %R not in sys.modules",
Martin v. Löwis796ea532011-10-30 09:07:07 +01003314 name);
3315 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003316 return NULL;
3317 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003318 existing_m = PyDict_GetItem(modules_reloading, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003319 if (existing_m != NULL) {
3320 /* Due to a recursive reload, this module is already
3321 being reloaded. */
Martin v. Löwis796ea532011-10-30 09:07:07 +01003322 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003323 Py_INCREF(existing_m);
3324 return existing_m;
3325 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003326 if (PyDict_SetItem(modules_reloading, name, m) < 0) {
3327 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003328 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003329 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003330
Martin v. Löwis796ea532011-10-30 09:07:07 +01003331 subname_start = PyUnicode_FindChar(name, '.', 0,
3332 PyUnicode_GET_LENGTH(name), -1);
3333 if (subname_start == -1) {
3334 Py_INCREF(name);
3335 subname = name;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003336 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003337 else {
3338 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003339 Py_ssize_t len;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003340 parentname = PyUnicode_Substring(name, 0, subname_start);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003341 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003342 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003343 }
3344 parent = PyDict_GetItem(modules, parentname);
3345 if (parent == NULL) {
3346 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003347 "reload(): parent %R not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003348 parentname);
3349 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003350 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003351 }
3352 Py_DECREF(parentname);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003353 path_list = _PyObject_GetAttrId(parent, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003354 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003355 PyErr_Clear();
Martin v. Löwis796ea532011-10-30 09:07:07 +01003356 subname_start++;
3357 len = PyUnicode_GET_LENGTH(name) - (subname_start + 1);
3358 subname = PyUnicode_Substring(name, subname_start, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003359 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003360 if (subname == NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003361 goto error;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003362 fdp = find_module(name, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003363 &bufobj, &fp, &loader);
Martin v. Löwis796ea532011-10-30 09:07:07 +01003364 Py_DECREF(subname);
Victor Stinner533d7832011-03-14 13:22:54 -04003365 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003366
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003367 if (fdp == NULL) {
3368 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003369 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003370 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003371
Martin v. Löwis796ea532011-10-30 09:07:07 +01003372 newm = load_module(name, fp, bufobj, fdp->type, loader);
Victor Stinner2fd76e42011-03-14 15:19:39 -04003373 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003374 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003375
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003376 if (fp)
3377 fclose(fp);
3378 if (newm == NULL) {
3379 /* load_module probably removed name from modules because of
3380 * the error. Put back the original module object. We're
3381 * going to return NULL in this case regardless of whether
3382 * replacing name succeeds, so the return value is ignored.
3383 */
Martin v. Löwis796ea532011-10-30 09:07:07 +01003384 PyDict_SetItem(modules, name, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003385 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003386
3387error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003388 imp_modules_reloading_clear();
Martin v. Löwis796ea532011-10-30 09:07:07 +01003389 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003390 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003391}
3392
3393
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003394/* Higher-level import emulator which emulates the "import" statement
3395 more accurately -- it invokes the __import__() function from the
3396 builtins of the current globals. This means that the import is
3397 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003398 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003399 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003400 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003401 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003402
3403PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003404PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003405{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003406 static PyObject *silly_list = NULL;
3407 static PyObject *builtins_str = NULL;
3408 static PyObject *import_str = NULL;
3409 PyObject *globals = NULL;
3410 PyObject *import = NULL;
3411 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003412 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003413 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003415 /* Initialize constant string objects */
3416 if (silly_list == NULL) {
3417 import_str = PyUnicode_InternFromString("__import__");
3418 if (import_str == NULL)
3419 return NULL;
3420 builtins_str = PyUnicode_InternFromString("__builtins__");
3421 if (builtins_str == NULL)
3422 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003423 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003424 if (silly_list == NULL)
3425 return NULL;
3426 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003428 /* Get the builtins from current globals */
3429 globals = PyEval_GetGlobals();
3430 if (globals != NULL) {
3431 Py_INCREF(globals);
3432 builtins = PyObject_GetItem(globals, builtins_str);
3433 if (builtins == NULL)
3434 goto err;
3435 }
3436 else {
3437 /* No globals -- use standard builtins, and fake globals */
3438 builtins = PyImport_ImportModuleLevel("builtins",
3439 NULL, NULL, NULL, 0);
3440 if (builtins == NULL)
3441 return NULL;
3442 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3443 if (globals == NULL)
3444 goto err;
3445 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003447 /* Get the __import__ function from the builtins */
3448 if (PyDict_Check(builtins)) {
3449 import = PyObject_GetItem(builtins, import_str);
3450 if (import == NULL)
3451 PyErr_SetObject(PyExc_KeyError, import_str);
3452 }
3453 else
3454 import = PyObject_GetAttr(builtins, import_str);
3455 if (import == NULL)
3456 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003457
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003458 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003459 Always use absolute import here.
3460 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003461 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3462 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003463 if (r == NULL)
3464 goto err;
3465 Py_DECREF(r);
3466
3467 modules = PyImport_GetModuleDict();
3468 r = PyDict_GetItem(modules, module_name);
3469 if (r != NULL)
3470 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003471
3472 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003473 Py_XDECREF(globals);
3474 Py_XDECREF(builtins);
3475 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003476
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003477 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003478}
3479
3480
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003481/* Module 'imp' provides Python access to the primitives used for
3482 importing modules.
3483*/
3484
Guido van Rossum79f25d91997-04-29 20:08:16 +00003485static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003486imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003487{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003488 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003490 buf[0] = (char) ((magic >> 0) & 0xff);
3491 buf[1] = (char) ((magic >> 8) & 0xff);
3492 buf[2] = (char) ((magic >> 16) & 0xff);
3493 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003494
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003495 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003496}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003497
3498static PyObject *
3499imp_get_magic(PyObject *self, PyObject *noargs)
3500{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003501 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003502}
3503
3504static PyObject *
3505imp_get_tag(PyObject *self, PyObject *noargs)
3506{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003507 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003508}
3509
Guido van Rossum79f25d91997-04-29 20:08:16 +00003510static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003511imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003512{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003513 PyObject *list;
3514 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003516 list = PyList_New(0);
3517 if (list == NULL)
3518 return NULL;
3519 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3520 PyObject *item = Py_BuildValue("ssi",
3521 fdp->suffix, fdp->mode, fdp->type);
3522 if (item == NULL) {
3523 Py_DECREF(list);
3524 return NULL;
3525 }
3526 if (PyList_Append(list, item) < 0) {
3527 Py_DECREF(list);
3528 Py_DECREF(item);
3529 return NULL;
3530 }
3531 Py_DECREF(item);
3532 }
3533 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003534}
3535
Guido van Rossum79f25d91997-04-29 20:08:16 +00003536static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003537call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003538{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003539 extern int fclose(FILE *);
3540 PyObject *fob, *ret;
3541 PyObject *pathobj;
3542 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003543 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003544 int fd = -1;
3545 char *found_encoding = NULL;
3546 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003547
Victor Stinner533d7832011-03-14 13:22:54 -04003548 if (path_list == Py_None)
3549 path_list = NULL;
3550 fdp = find_module(NULL, name, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003551 &pathobj, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003552 if (fdp == NULL)
3553 return NULL;
3554 if (fp != NULL) {
3555 fd = fileno(fp);
3556 if (fd != -1)
3557 fd = dup(fd);
3558 fclose(fp);
Victor Stinnerd417d012011-06-20 15:16:55 +02003559 if (fd == -1) {
3560 PyErr_SetFromErrno(PyExc_OSError);
3561 return NULL;
3562 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003563 fp = NULL;
3564 }
3565 if (fd != -1) {
3566 if (strchr(fdp->mode, 'b') == NULL) {
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003567 /* PyTokenizer_FindEncodingFilename() returns PyMem_MALLOC'ed
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003568 memory. */
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003569 found_encoding = PyTokenizer_FindEncodingFilename(fd, pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003570 lseek(fd, 0, 0); /* Reset position */
Victor Stinner2fd76e42011-03-14 15:19:39 -04003571 if (found_encoding == NULL && PyErr_Occurred()) {
3572 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003573 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04003574 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003575 encoding = (found_encoding != NULL) ? found_encoding :
3576 (char*)PyUnicode_GetDefaultEncoding();
3577 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003578 fob = PyFile_FromFd(fd, NULL, fdp->mode, -1,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003579 (char*)encoding, NULL, NULL, 1);
3580 if (fob == NULL) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04003581 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003582 close(fd);
3583 PyMem_FREE(found_encoding);
3584 return NULL;
3585 }
3586 }
3587 else {
3588 fob = Py_None;
3589 Py_INCREF(fob);
3590 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003591 if (pathobj == NULL) {
3592 Py_INCREF(Py_None);
3593 pathobj = Py_None;
3594 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003595 ret = Py_BuildValue("NN(ssi)",
3596 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3597 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003598
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003599 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003600}
3601
Guido van Rossum79f25d91997-04-29 20:08:16 +00003602static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003603imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003604{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003605 PyObject *name, *path_list = NULL;
3606 if (!PyArg_ParseTuple(args, "U|O:find_module",
3607 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003608 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003609 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003610}
3611
3612static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003613imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003614{
Victor Stinner95872862011-03-07 18:20:56 +01003615 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003616 int ret;
3617 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003618 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003619 return NULL;
3620 ret = init_builtin(name);
3621 if (ret < 0)
3622 return NULL;
3623 if (ret == 0) {
3624 Py_INCREF(Py_None);
3625 return Py_None;
3626 }
Victor Stinner95872862011-03-07 18:20:56 +01003627 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003628 Py_XINCREF(m);
3629 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003630}
3631
Guido van Rossum79f25d91997-04-29 20:08:16 +00003632static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003633imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003634{
Victor Stinner53dc7352011-03-20 01:50:21 +01003635 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003636 int ret;
3637 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003638 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003639 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003640 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003641 if (ret < 0)
3642 return NULL;
3643 if (ret == 0) {
3644 Py_INCREF(Py_None);
3645 return Py_None;
3646 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003647 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003648 Py_XINCREF(m);
3649 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003650}
3651
Guido van Rossum79f25d91997-04-29 20:08:16 +00003652static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003653imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003654{
Victor Stinner53dc7352011-03-20 01:50:21 +01003655 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003656
Victor Stinner53dc7352011-03-20 01:50:21 +01003657 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003658 return NULL;
3659 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003660}
3661
Guido van Rossum79f25d91997-04-29 20:08:16 +00003662static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003663imp_is_frozen_package(PyObject *self, PyObject *args)
3664{
Victor Stinner53dc7352011-03-20 01:50:21 +01003665 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003666
Victor Stinner53dc7352011-03-20 01:50:21 +01003667 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003668 return NULL;
3669 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003670}
3671
3672static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003673imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003674{
Victor Stinner95872862011-03-07 18:20:56 +01003675 PyObject *name;
3676 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003677 return NULL;
3678 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003679}
3680
Guido van Rossum79f25d91997-04-29 20:08:16 +00003681static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003682imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003683{
Victor Stinner53dc7352011-03-20 01:50:21 +01003684 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003685 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003686 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003687 return NULL;
3688 p = find_frozen(name);
3689 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003690}
3691
3692static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003693get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003694{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003695 FILE *fp;
3696 if (mode[0] == 'U')
3697 mode = "r" PY_STDIOTEXTMODE;
3698 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003699 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003700 }
3701 else {
3702 int fd = PyObject_AsFileDescriptor(fob);
3703 if (fd == -1)
3704 return NULL;
3705 if (!_PyVerify_fd(fd))
3706 goto error;
3707 /* the FILE struct gets a new fd, so that it can be closed
3708 * independently of the file descriptor given
3709 */
3710 fd = dup(fd);
3711 if (fd == -1)
3712 goto error;
3713 fp = fdopen(fd, mode);
3714 }
3715 if (fp)
3716 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003717error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003718 PyErr_SetFromErrno(PyExc_IOError);
3719 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003720}
3721
Guido van Rossum79f25d91997-04-29 20:08:16 +00003722static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003723imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003724{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003725 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003726 PyObject *fob = NULL;
3727 PyObject *m;
3728 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003729 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003730 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003731 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003732 &fob))
3733 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003734 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003735 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003736 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003737 return NULL;
3738 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003739 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003740 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003741 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003742 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003743}
3744
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003745#ifdef HAVE_DYNAMIC_LOADING
3746
Guido van Rossum79f25d91997-04-29 20:08:16 +00003747static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003748imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003749{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003750 PyObject *name, *pathname, *fob = NULL, *mod;
3751 FILE *fp;
3752
3753 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3754 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003755 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003756 if (fob != NULL) {
3757 fp = get_file(NULL, fob, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003758 if (fp == NULL) {
3759 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003760 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003761 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003762 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003763 else
3764 fp = NULL;
3765 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003766 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003767 if (fp)
3768 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003769 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003770}
3771
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003772#endif /* HAVE_DYNAMIC_LOADING */
3773
Guido van Rossum79f25d91997-04-29 20:08:16 +00003774static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003775imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003776{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003777 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003778 PyObject *fob = NULL;
3779 PyObject *m;
3780 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003781 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003782 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003783 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003784 &fob))
3785 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003786 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003787 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003788 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003789 return NULL;
3790 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003791 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003792 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003793 fclose(fp);
3794 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003795}
3796
Guido van Rossum79f25d91997-04-29 20:08:16 +00003797static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003798imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003799{
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003800 PyObject *name, *fob, *pathname, *pathname_obj, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003801 char *suffix; /* Unused */
3802 char *mode;
3803 int type;
3804 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003805
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003806 if (!PyArg_ParseTuple(args, "UOO(ssi):load_module",
3807 &name, &fob, &pathname_obj, &suffix, &mode, &type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003808 return NULL;
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003809 if (pathname_obj != Py_None) {
3810 if (!PyUnicode_FSDecoder(pathname_obj, &pathname))
3811 return NULL;
3812 }
3813 else
3814 pathname = NULL;
3815
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003816 if (*mode) {
3817 /* Mode must start with 'r' or 'U' and must not contain '+'.
3818 Implicit in this test is the assumption that the mode
3819 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003820
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003821 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3822 PyErr_Format(PyExc_ValueError,
3823 "invalid file open mode %.200s", mode);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003824 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003825 return NULL;
3826 }
3827 }
3828 if (fob == Py_None)
3829 fp = NULL;
3830 else {
3831 fp = get_file(NULL, fob, mode);
3832 if (fp == NULL) {
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003833 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003834 return NULL;
3835 }
3836 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003837 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003838 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003839 if (fp)
3840 fclose(fp);
3841 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003842}
3843
3844static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003845imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003846{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003847 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003848 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003849 if (!PyArg_ParseTuple(args, "UO&:load_package",
3850 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003851 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003852 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003853 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003854 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003855}
3856
3857static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003858imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003859{
Victor Stinnerfe19d212011-03-14 14:53:28 -04003860 PyObject *name;
3861 if (!PyArg_ParseTuple(args, "U:new_module", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003862 return NULL;
Victor Stinnerfe19d212011-03-14 14:53:28 -04003863 return PyModule_NewObject(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003864}
3865
Christian Heimes13a7a212008-01-07 17:13:09 +00003866static PyObject *
3867imp_reload(PyObject *self, PyObject *v)
3868{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003869 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003870}
3871
3872PyDoc_STRVAR(doc_reload,
3873"reload(module) -> module\n\
3874\n\
3875Reload the module. The module must have been successfully imported before.");
3876
Barry Warsaw28a691b2010-04-17 00:19:56 +00003877static PyObject *
3878imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3879{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003880 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003881
Victor Stinner2f42ae52011-03-20 00:41:24 +01003882 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003883 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003884 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003885
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003886 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003887 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003888 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003889 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003890
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003891 if (debug_override != NULL &&
3892 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003893 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003894 return NULL;
3895 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003896
Martin v. Löwis30260a72011-10-23 17:35:46 +02003897 if (PyUnicode_READY(pathname) < 0)
3898 return NULL;
3899
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003900 cpathname = make_compiled_pathname(pathname, debug);
Victor Stinner2f42ae52011-03-20 00:41:24 +01003901 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003902
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003903 if (cpathname == NULL) {
3904 PyErr_Format(PyExc_SystemError, "path buffer too short");
3905 return NULL;
3906 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003907 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003908}
3909
3910PyDoc_STRVAR(doc_cache_from_source,
Éric Araujo5df11082011-11-03 03:38:44 +01003911"cache_from_source(path, [debug_override]) -> path\n\
3912Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003913\n\
3914The .py file does not need to exist; this simply returns the path to the\n\
3915.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3916will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3917\n\
3918If debug_override is not None, then it must be a boolean and is taken as\n\
3919the value of __debug__ instead.");
3920
3921static PyObject *
3922imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3923{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003924 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003925 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003927 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003928 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003929 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003930 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003931
Victor Stinnerc9abda02011-03-14 13:33:46 -04003932 source = make_source_pathname(pathname);
3933 if (source == NULL) {
3934 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003935 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003936 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003937 return NULL;
3938 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003939 Py_DECREF(pathname);
3940 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003941}
3942
3943PyDoc_STRVAR(doc_source_from_cache,
Éric Araujo5df11082011-11-03 03:38:44 +01003944"source_from_cache(path) -> path\n\
3945Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003946\n\
3947The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3948the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3949does not conform to PEP 3147 format, ValueError will be raised.");
3950
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003951/* Doc strings */
3952
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003953PyDoc_STRVAR(doc_imp,
3954"This module provides the components needed to build your own\n\
3955__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003956
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003957PyDoc_STRVAR(doc_find_module,
3958"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003959Search for a module. If path is omitted or None, search for a\n\
3960built-in, frozen or special module and continue search in sys.path.\n\
3961The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003962package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003963
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003964PyDoc_STRVAR(doc_load_module,
3965"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003966Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003967The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003968
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003969PyDoc_STRVAR(doc_get_magic,
3970"get_magic() -> string\n\
3971Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003972
Barry Warsaw28a691b2010-04-17 00:19:56 +00003973PyDoc_STRVAR(doc_get_tag,
3974"get_tag() -> string\n\
3975Return the magic tag for .pyc or .pyo files.");
3976
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003977PyDoc_STRVAR(doc_get_suffixes,
3978"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003979Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003980that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003981
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003982PyDoc_STRVAR(doc_new_module,
3983"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003984Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003985The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003986
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003987PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003988"lock_held() -> boolean\n\
3989Return True if the import lock is currently held, else False.\n\
3990On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003991
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003992PyDoc_STRVAR(doc_acquire_lock,
3993"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003994Acquires the interpreter's import lock for the current thread.\n\
3995This lock should be used by import hooks to ensure thread-safety\n\
3996when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003997On platforms without threads, this function does nothing.");
3998
3999PyDoc_STRVAR(doc_release_lock,
4000"release_lock() -> None\n\
4001Release the interpreter's import lock.\n\
4002On platforms without threads, this function does nothing.");
4003
Guido van Rossum79f25d91997-04-29 20:08:16 +00004004static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004005 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
4006 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
4007 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
4008 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
4009 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
4010 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
4011 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
4012 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
4013 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
4014 {"reload", imp_reload, METH_O, doc_reload},
4015 {"cache_from_source", (PyCFunction)imp_cache_from_source,
4016 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
4017 {"source_from_cache", (PyCFunction)imp_source_from_cache,
4018 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
4019 /* The rest are obsolete */
4020 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
4021 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
4022 {"init_builtin", imp_init_builtin, METH_VARARGS},
4023 {"init_frozen", imp_init_frozen, METH_VARARGS},
4024 {"is_builtin", imp_is_builtin, METH_VARARGS},
4025 {"is_frozen", imp_is_frozen, METH_VARARGS},
4026 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004027#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004028 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004029#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004030 {"load_package", imp_load_package, METH_VARARGS},
4031 {"load_source", imp_load_source, METH_VARARGS},
Brett Cannon442c9b92011-03-23 16:14:42 -07004032 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004033 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004034};
4035
Guido van Rossum1a8791e1998-08-04 22:46:29 +00004036static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004037setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004038{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004039 PyObject *v;
4040 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004041
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004042 v = PyLong_FromLong((long)value);
4043 err = PyDict_SetItemString(d, name, v);
4044 Py_XDECREF(v);
4045 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004046}
4047
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004048typedef struct {
4049 PyObject_HEAD
4050} NullImporter;
4051
4052static int
4053NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4054{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004055#ifndef MS_WINDOWS
4056 PyObject *path;
4057 struct stat statbuf;
4058 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004060 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4061 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004062
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004063 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4064 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004065 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004066
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004067 if (PyBytes_GET_SIZE(path) == 0) {
4068 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004069 PyErr_SetString(PyExc_ImportError, "empty pathname");
4070 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004071 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004072
4073 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4074 Py_DECREF(path);
4075 if (rv == 0) {
4076 /* it exists */
4077 if (S_ISDIR(statbuf.st_mode)) {
4078 /* it's a directory */
4079 PyErr_SetString(PyExc_ImportError, "existing directory");
4080 return -1;
4081 }
4082 }
4083#else /* MS_WINDOWS */
4084 PyObject *pathobj;
4085 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004086 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004087
4088 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4089 return -1;
4090
4091 if (!PyArg_ParseTuple(args, "U:NullImporter",
4092 &pathobj))
4093 return -1;
4094
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02004095 if (PyUnicode_GET_LENGTH(pathobj) == 0) {
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004096 PyErr_SetString(PyExc_ImportError, "empty pathname");
4097 return -1;
4098 }
4099
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004100 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004101 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004102 return -1;
4103 /* see issue1293 and issue3677:
4104 * stat() on Windows doesn't recognise paths like
4105 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4106 */
4107 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004108 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004109 if (rv != INVALID_FILE_ATTRIBUTES) {
4110 /* it exists */
4111 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4112 /* it's a directory */
4113 PyErr_SetString(PyExc_ImportError, "existing directory");
4114 return -1;
4115 }
4116 }
4117#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004118 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004119}
4120
4121static PyObject *
4122NullImporter_find_module(NullImporter *self, PyObject *args)
4123{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004124 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004125}
4126
4127static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004128 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4129 "Always return None"
4130 },
4131 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004132};
4133
4134
Christian Heimes9cd17752007-11-18 19:35:23 +00004135PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004136 PyVarObject_HEAD_INIT(NULL, 0)
4137 "imp.NullImporter", /*tp_name*/
4138 sizeof(NullImporter), /*tp_basicsize*/
4139 0, /*tp_itemsize*/
4140 0, /*tp_dealloc*/
4141 0, /*tp_print*/
4142 0, /*tp_getattr*/
4143 0, /*tp_setattr*/
4144 0, /*tp_reserved*/
4145 0, /*tp_repr*/
4146 0, /*tp_as_number*/
4147 0, /*tp_as_sequence*/
4148 0, /*tp_as_mapping*/
4149 0, /*tp_hash */
4150 0, /*tp_call*/
4151 0, /*tp_str*/
4152 0, /*tp_getattro*/
4153 0, /*tp_setattro*/
4154 0, /*tp_as_buffer*/
4155 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4156 "Null importer object", /* tp_doc */
4157 0, /* tp_traverse */
4158 0, /* tp_clear */
4159 0, /* tp_richcompare */
4160 0, /* tp_weaklistoffset */
4161 0, /* tp_iter */
4162 0, /* tp_iternext */
4163 NullImporter_methods, /* tp_methods */
4164 0, /* tp_members */
4165 0, /* tp_getset */
4166 0, /* tp_base */
4167 0, /* tp_dict */
4168 0, /* tp_descr_get */
4169 0, /* tp_descr_set */
4170 0, /* tp_dictoffset */
4171 (initproc)NullImporter_init, /* tp_init */
4172 0, /* tp_alloc */
4173 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004174};
4175
Martin v. Löwis1a214512008-06-11 05:26:20 +00004176static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004177 PyModuleDef_HEAD_INIT,
4178 "imp",
4179 doc_imp,
4180 0,
4181 imp_methods,
4182 NULL,
4183 NULL,
4184 NULL,
4185 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004186};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004187
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004188PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004189PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004190{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004191 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004193 if (PyType_Ready(&PyNullImporter_Type) < 0)
4194 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004195
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004196 m = PyModule_Create(&impmodule);
4197 if (m == NULL)
4198 goto failure;
4199 d = PyModule_GetDict(m);
4200 if (d == NULL)
4201 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004202
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004203 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4204 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4205 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4206 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4207 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4208 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4209 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4210 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4211 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4212 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004213
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004214 Py_INCREF(&PyNullImporter_Type);
4215 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4216 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004217 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004218 Py_XDECREF(m);
4219 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004220}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004221
4222
Guido van Rossumb18618d2000-05-03 23:44:39 +00004223/* API for embedding applications that want to add their own entries
4224 to the table of built-in modules. This should normally be called
4225 *before* Py_Initialize(). When the table resize fails, -1 is
4226 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004227
4228 After a similar function by Just van Rossum. */
4229
4230int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004231PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004232{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004233 static struct _inittab *our_copy = NULL;
4234 struct _inittab *p;
4235 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004236
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004237 /* Count the number of entries in both tables */
4238 for (n = 0; newtab[n].name != NULL; n++)
4239 ;
4240 if (n == 0)
4241 return 0; /* Nothing to do */
4242 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4243 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004245 /* Allocate new memory for the combined table */
4246 p = our_copy;
4247 PyMem_RESIZE(p, struct _inittab, i+n+1);
4248 if (p == NULL)
4249 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004250
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004251 /* Copy the tables into the new memory */
4252 if (our_copy != PyImport_Inittab)
4253 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4254 PyImport_Inittab = our_copy = p;
4255 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004256
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004257 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004258}
4259
4260/* Shorthand to add a single entry given a name and a function */
4261
4262int
Brett Cannona826f322009-04-02 03:41:46 +00004263PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004264{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004265 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004266
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004267 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004268
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004269 newtab[0].name = (char *)name;
4270 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004271
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004272 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004273}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004274
4275#ifdef __cplusplus
4276}
4277#endif