blob: 8e3aa4b921c70da4d89c19223ceff28576a77640 [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 Rossum55a83382000-09-20 20:31:38 +00001186/* Helper to open a bytecode file for writing in exclusive mode */
1187
Victor Stinner783c82c2011-04-20 03:27:51 +02001188#ifndef MS_WINDOWS
Guido van Rossum55a83382000-09-20 20:31:38 +00001189static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +00001190open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +00001191{
1192#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001193 /* Use O_EXCL to avoid a race condition when another process tries to
1194 write the same file. When that happens, our open() call fails,
1195 which is just fine (since it's only a cache).
1196 XXX If the file exists and is writable but the directory is not
1197 writable, the file will never be written. Oh well.
1198 */
1199 int fd;
1200 (void) unlink(filename);
1201 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +00001202#ifdef O_BINARY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001203 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +00001204#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001205#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001206 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001207#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001208 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001209#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001210 );
1211 if (fd < 0)
1212 return NULL;
1213 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001214#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 /* Best we can do -- on Windows this can't happen anyway */
1216 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001217#endif
1218}
Victor Stinner783c82c2011-04-20 03:27:51 +02001219#endif
Guido van Rossum55a83382000-09-20 20:31:38 +00001220
1221
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001222/* Write a compiled module to a file, placing the time of last
1223 modification of its source into the header.
1224 Errors are ignored, if a write error occurs an attempt is made to
1225 remove the file. */
1226
1227static void
Victor Stinner2f42ae52011-03-20 00:41:24 +01001228write_compiled_module(PyCodeObject *co, PyObject *cpathname,
1229 struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001230{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001231 Py_UCS4 *cpathname_ucs4;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001232 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001233 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001234#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001235 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001236#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001237 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
1238 mode_t dirmode = (srcstat->st_mode |
1239 S_IXUSR | S_IXGRP | S_IXOTH |
1240 S_IWUSR | S_IWGRP | S_IWOTH);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001241 PyObject *dirbytes;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001242#endif
Victor Stinner783c82c2011-04-20 03:27:51 +02001243#ifdef MS_WINDOWS
1244 int fd;
1245#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001246 PyObject *cpathbytes, *cpathbytes_tmp;
1247 Py_ssize_t cpathbytes_len;
Victor Stinner783c82c2011-04-20 03:27:51 +02001248#endif
1249 PyObject *dirname;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001250 Py_UCS4 *dirsep;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001251 int res, ok;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001252
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001253 /* Ensure that the __pycache__ directory exists. */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001254 cpathname_ucs4 = PyUnicode_AsUCS4Copy(cpathname);
1255 if (!cpathname_ucs4)
1256 return;
1257 dirsep = rightmost_sep(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001258 if (dirsep == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001259 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001260 PySys_FormatStderr("# no %s path found %R\n", CACHEDIR, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001261 return;
1262 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001263 dirname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
1264 cpathname_ucs4,
1265 dirsep - cpathname_ucs4);
1266 PyMem_Free(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001267 if (dirname == NULL) {
1268 PyErr_Clear();
1269 return;
1270 }
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001271
1272#ifdef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001273 res = CreateDirectoryW(PyUnicode_AS_UNICODE(dirname), NULL);
1274 ok = (res != 0);
1275 if (!ok && GetLastError() == ERROR_ALREADY_EXISTS)
1276 ok = 1;
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001277#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001278 dirbytes = PyUnicode_EncodeFSDefault(dirname);
1279 if (dirbytes == NULL) {
1280 PyErr_Clear();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001281 return;
1282 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001283 res = mkdir(PyBytes_AS_STRING(dirbytes), dirmode);
1284 Py_DECREF(dirbytes);
1285 if (0 <= res)
1286 ok = 1;
1287 else
1288 ok = (errno == EEXIST);
1289#endif
1290 if (!ok) {
1291 if (Py_VerboseFlag)
1292 PySys_FormatStderr("# cannot create cache dir %R\n", dirname);
1293 Py_DECREF(dirname);
1294 return;
1295 }
1296 Py_DECREF(dirname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001297
Victor Stinner783c82c2011-04-20 03:27:51 +02001298#ifdef MS_WINDOWS
1299 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1300 fd = _wopen(PyUnicode_AS_UNICODE(cpathname),
1301 O_EXCL | O_CREAT | O_WRONLY | O_TRUNC | O_BINARY,
1302 mode);
1303 if (0 <= fd)
1304 fp = fdopen(fd, "wb");
1305 else
1306 fp = NULL;
1307#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001308 /* Under POSIX, we first write to a tmp file and then take advantage
1309 of atomic renaming. */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001310 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1311 if (cpathbytes == NULL) {
1312 PyErr_Clear();
1313 return;
1314 }
Antoine Pitrou707033a2011-10-17 19:28:44 +02001315 cpathbytes_len = PyBytes_GET_SIZE(cpathbytes);
1316 cpathbytes_tmp = PyBytes_FromStringAndSize(NULL, cpathbytes_len + 4);
1317 if (cpathbytes_tmp == NULL) {
1318 Py_DECREF(cpathbytes);
1319 PyErr_Clear();
1320 return;
1321 }
1322 memcpy(PyBytes_AS_STRING(cpathbytes_tmp), PyBytes_AS_STRING(cpathbytes),
1323 cpathbytes_len);
1324 memcpy(PyBytes_AS_STRING(cpathbytes_tmp) + cpathbytes_len, ".tmp", 4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001325
Antoine Pitrou707033a2011-10-17 19:28:44 +02001326 fp = open_exclusive(PyBytes_AS_STRING(cpathbytes_tmp), mode);
Victor Stinner783c82c2011-04-20 03:27:51 +02001327#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001328 if (fp == NULL) {
1329 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001330 PySys_FormatStderr(
1331 "# can't create %R\n", cpathname);
Victor Stinner783c82c2011-04-20 03:27:51 +02001332#ifndef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001333 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001334 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001335#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001336 return;
1337 }
1338 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1339 /* First write a 0 for mtime */
1340 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1341 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001342 fflush(fp);
1343 /* Now write the true mtime */
1344 fseek(fp, 4L, 0);
1345 assert(mtime < LONG_MAX);
1346 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 if (fflush(fp) != 0 || ferror(fp)) {
1348 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001349 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001350 /* Don't keep partial file */
1351 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001352#ifdef MS_WINDOWS
1353 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1354#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001355 (void) unlink(PyBytes_AS_STRING(cpathbytes_tmp));
Victor Stinner2f42ae52011-03-20 00:41:24 +01001356 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001357 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001358#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001359 return;
1360 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001361 fclose(fp);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001362 /* Under POSIX, do an atomic rename */
1363#ifndef MS_WINDOWS
1364 if (rename(PyBytes_AS_STRING(cpathbytes_tmp),
1365 PyBytes_AS_STRING(cpathbytes))) {
1366 if (Py_VerboseFlag)
1367 PySys_FormatStderr("# can't write %R\n", cpathname);
1368 /* Don't keep tmp file */
1369 unlink(PyBytes_AS_STRING(cpathbytes_tmp));
1370 Py_DECREF(cpathbytes);
1371 Py_DECREF(cpathbytes_tmp);
1372 return;
1373 }
1374 Py_DECREF(cpathbytes);
1375 Py_DECREF(cpathbytes_tmp);
1376#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001377 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001378 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001379}
1380
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001381static void
1382update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1383{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001384 PyObject *constants, *tmp;
1385 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001386
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001387 if (PyUnicode_Compare(co->co_filename, oldname))
1388 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001390 tmp = co->co_filename;
1391 co->co_filename = newname;
1392 Py_INCREF(co->co_filename);
1393 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001394
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001395 constants = co->co_consts;
1396 n = PyTuple_GET_SIZE(constants);
1397 for (i = 0; i < n; i++) {
1398 tmp = PyTuple_GET_ITEM(constants, i);
1399 if (PyCode_Check(tmp))
1400 update_code_filenames((PyCodeObject *)tmp,
1401 oldname, newname);
1402 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001403}
1404
Victor Stinner2f42ae52011-03-20 00:41:24 +01001405static void
1406update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001407{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001408 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001409
Victor Stinner2f42ae52011-03-20 00:41:24 +01001410 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1411 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001412
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001413 oldname = co->co_filename;
1414 Py_INCREF(oldname);
1415 update_code_filenames(co, oldname, newname);
1416 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001417}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001418
Brett Cannon442c9b92011-03-23 16:14:42 -07001419static PyObject *
1420imp_fix_co_filename(PyObject *self, PyObject *args)
1421{
1422 PyObject *co;
1423 PyObject *file_path;
1424
1425 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
1426 return NULL;
1427
1428 if (!PyCode_Check(co)) {
1429 PyErr_SetString(PyExc_TypeError,
1430 "first argument must be a code object");
1431 return NULL;
1432 }
1433
1434 if (!PyUnicode_Check(file_path)) {
1435 PyErr_SetString(PyExc_TypeError,
1436 "second argument must be a string");
1437 return NULL;
1438 }
1439
1440 update_compiled_module((PyCodeObject*)co, file_path);
1441
1442 Py_RETURN_NONE;
1443}
1444
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001445/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001446 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1447 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001448
Guido van Rossum79f25d91997-04-29 20:08:16 +00001449static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001450load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001451{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001452 struct stat st;
1453 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001454 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001455 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001456 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001457
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001458 if (fstat(fileno(fp), &st) != 0) {
1459 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001460 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001461 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001462 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001463 }
Fred Drake4c82b232000-06-30 16:18:57 +00001464#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001465 /* Python's .pyc timestamp handling presumes that the timestamp fits
1466 in 4 bytes. This will be fine until sometime in the year 2038,
1467 when a 4-byte signed time_t will overflow.
1468 */
1469 if (st.st_mtime >> 32) {
1470 PyErr_SetString(PyExc_OverflowError,
1471 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001472 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001473 }
Fred Drake4c82b232000-06-30 16:18:57 +00001474#endif
Martin v. Löwis30260a72011-10-23 17:35:46 +02001475 if (PyUnicode_READY(pathname) < 0)
1476 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001477 cpathname = make_compiled_pathname(pathname, !Py_OptimizeFlag);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001478
1479 if (cpathname != NULL)
1480 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1481 else
1482 fpc = NULL;
1483
1484 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001485 co = read_compiled_module(cpathname, fpc);
1486 fclose(fpc);
1487 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001488 goto error;
1489 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001490 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001491 PySys_FormatStderr("import %U # precompiled from %R\n",
1492 name, cpathname);
1493 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1494 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001495 }
1496 else {
1497 co = parse_source_module(pathname, fp);
1498 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001499 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001500 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001501 PySys_FormatStderr("import %U # from %R\n",
Victor Stinner98dbba52011-03-14 15:15:47 -04001502 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001503 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001504 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1505 if (ro == NULL || !PyObject_IsTrue(ro))
1506 write_compiled_module(co, cpathname, &st);
1507 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001508 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1509 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001510 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001511 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001512
Victor Stinner2f42ae52011-03-20 00:41:24 +01001513error:
1514 Py_XDECREF(cpathbytes);
1515 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001516 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001517}
1518
Christian Heimes3b06e532008-01-07 20:12:44 +00001519/* Get source file -> unicode or None
1520 * Returns the path to the py file if available, else the given path
1521 */
1522static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001523get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001524{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001525 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001526 Py_UCS4 *fileuni;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001527 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001528 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001529
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001530 len = PyUnicode_GET_LENGTH(filename);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001531 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001532 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001533
Victor Stinnerc9abda02011-03-14 13:33:46 -04001534 /* don't match *.pyc or *.pyo? */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001535 fileuni = PyUnicode_AsUCS4Copy(filename);
1536 if (!fileuni)
1537 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001538 if (len < 5
1539 || fileuni[len-4] != '.'
1540 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1541 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1542 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001543
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001544 /* Start by trying to turn PEP 3147 path into source path. If that
1545 * fails, just chop off the trailing character, i.e. legacy pyc path
1546 * to py.
1547 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001548 py = make_source_pathname(filename);
1549 if (py == NULL) {
1550 PyErr_Clear();
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001551 py = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001552 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001553 if (py == NULL)
1554 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001555
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001556 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode)) {
1557 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001558 return py;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001559 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001560 Py_DECREF(py);
1561 goto unchanged;
1562
1563error:
1564 PyErr_Clear();
1565unchanged:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001566 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001567 Py_INCREF(filename);
1568 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001569}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001570
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001571/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001572static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001573static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001574 PyObject **, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001575static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001576
1577/* Load a package and return its module object WITH INCREMENTED
1578 REFERENCE COUNT */
1579
1580static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001581load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001582{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001583 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001584 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 int err;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001586 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001587 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001588
Victor Stinnerc9abda02011-03-14 13:33:46 -04001589 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 if (m == NULL)
1591 return NULL;
1592 if (Py_VerboseFlag)
Victor Stinner98dbba52011-03-14 15:15:47 -04001593 PySys_FormatStderr("import %U # directory %R\n",
1594 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001595 file = get_sourcefile(pathname);
1596 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001597 return NULL;
1598 path_list = Py_BuildValue("[O]", file);
1599 if (path_list == NULL) {
1600 Py_DECREF(file);
1601 return NULL;
1602 }
1603 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001605 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001606 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001607 err = PyDict_SetItemString(d, "__path__", path_list);
1608 if (err != 0) {
1609 Py_DECREF(path_list);
1610 return NULL;
1611 }
Victor Stinner533d7832011-03-14 13:22:54 -04001612 fdp = find_module(name, initstr, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001613 &bufobj, &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001614 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 if (fdp == NULL) {
1616 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1617 PyErr_Clear();
1618 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001619 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001620 }
1621 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001622 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001624 m = load_module(name, fp, bufobj, fdp->type, NULL);
1625 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001626 if (fp != NULL)
1627 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001628 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001629}
1630
1631
1632/* Helper to test for built-in module */
1633
1634static int
Victor Stinner95872862011-03-07 18:20:56 +01001635is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001636{
Victor Stinner95872862011-03-07 18:20:56 +01001637 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001638 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001639 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1640 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001641 if (PyImport_Inittab[i].initfunc == NULL)
1642 return -1;
1643 else
1644 return 1;
1645 }
1646 }
1647 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001648}
1649
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001650
Just van Rossum52e14d62002-12-30 22:08:05 +00001651/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1652 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001653 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001654 that can handle the path item. Return None if no hook could;
1655 this tells our caller it should fall back to the builtin
1656 import mechanism. Cache the result in path_importer_cache.
1657 Returns a borrowed reference. */
1658
1659static PyObject *
1660get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001661 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001662{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001663 PyObject *importer;
1664 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001665
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001666 /* These conditions are the caller's responsibility: */
1667 assert(PyList_Check(path_hooks));
1668 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001669
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001670 nhooks = PyList_Size(path_hooks);
1671 if (nhooks < 0)
1672 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001674 importer = PyDict_GetItem(path_importer_cache, p);
1675 if (importer != NULL)
1676 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001677
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001678 /* set path_importer_cache[p] to None to avoid recursion */
1679 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1680 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001681
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001682 for (j = 0; j < nhooks; j++) {
1683 PyObject *hook = PyList_GetItem(path_hooks, j);
1684 if (hook == NULL)
1685 return NULL;
1686 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1687 if (importer != NULL)
1688 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001689
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001690 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1691 return NULL;
1692 }
1693 PyErr_Clear();
1694 }
1695 if (importer == NULL) {
1696 importer = PyObject_CallFunctionObjArgs(
1697 (PyObject *)&PyNullImporter_Type, p, NULL
1698 );
1699 if (importer == NULL) {
1700 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1701 PyErr_Clear();
1702 return Py_None;
1703 }
1704 }
1705 }
1706 if (importer != NULL) {
1707 int err = PyDict_SetItem(path_importer_cache, p, importer);
1708 Py_DECREF(importer);
1709 if (err != 0)
1710 return NULL;
1711 }
1712 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001713}
1714
Christian Heimes9cd17752007-11-18 19:35:23 +00001715PyAPI_FUNC(PyObject *)
1716PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001717 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001718
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001719 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1720 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1721 importer = get_path_importer(path_importer_cache,
1722 path_hooks, path);
1723 }
1724 }
1725 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1726 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001727}
1728
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001729/* Search the path (default sys.path) for a module. Return the
1730 corresponding filedescr struct, and (via return arguments) the
1731 pathname and an open file. Return NULL if the module is not found. */
1732
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001733#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001734extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1735 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001736#endif
1737
Victor Stinner547a2a62011-03-20 03:07:28 +01001738/* Forward */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001739static int case_ok(PyObject *, Py_ssize_t, PyObject *);
Victor Stinner547a2a62011-03-20 03:07:28 +01001740static int find_init_module(PyObject *);
Just van Rossum52e14d62002-12-30 22:08:05 +00001741static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001742
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001743/* Get the path of a module: get its importer and call importer.find_module()
1744 hook, or check if the module if a package (if path/__init__.py exists).
1745
1746 -1: error: a Python error occurred
1747 0: ignore: an error occurred because of invalid data, but the error is not
1748 important enough to be reported.
1749 1: get path: module not found, but *buf contains its path
1750 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1751 and *buf is the path */
1752
1753static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001754find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001755 PyObject *path_hooks, PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001756 PyObject **p_path, PyObject **p_loader, struct filedescr **p_fd)
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001757{
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001758 PyObject *path_unicode, *filename = NULL;
1759 Py_ssize_t len, pos;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001760 struct stat statbuf;
1761 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001762 int result, addsep;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001763
1764 if (PyUnicode_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001765 Py_INCREF(path);
1766 path_unicode = path;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001767 }
1768 else if (PyBytes_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001769 path_unicode = PyUnicode_DecodeFSDefaultAndSize(
1770 PyBytes_AS_STRING(path), PyBytes_GET_SIZE(path));
1771 if (path_unicode == NULL)
1772 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001773 }
1774 else
1775 return 0;
1776
Victor Stinner46084ba2011-10-06 02:39:42 +02001777 if (PyUnicode_READY(path_unicode))
1778 return -1;
1779
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001780 len = PyUnicode_GET_LENGTH(path_unicode);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001781 if (PyUnicode_FindChar(path_unicode, 0, 0, len, 1) != -1) {
1782 result = 0;
1783 goto out; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001784 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001785
1786 /* sys.path_hooks import hook */
1787 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001788 _Py_IDENTIFIER(find_module);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001789 PyObject *importer;
1790
1791 importer = get_path_importer(path_importer_cache,
1792 path_hooks, path);
1793 if (importer == NULL) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001794 result = -1;
1795 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001796 }
1797 /* Note: importer is a borrowed reference */
1798 if (importer != Py_None) {
1799 PyObject *loader;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001800 loader = _PyObject_CallMethodId(importer,
1801 &PyId_find_module, "O", fullname);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001802 if (loader == NULL) {
1803 result = -1; /* error */
1804 goto out;
1805 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001806 if (loader != Py_None) {
1807 /* a loader was found */
1808 *p_loader = loader;
1809 *p_fd = &importhookdescr;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001810 result = 2;
1811 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001812 }
1813 Py_DECREF(loader);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001814 result = 0;
1815 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001816 }
1817 }
1818 /* no hook was found, use builtin import */
1819
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001820 addsep = 0;
1821 if (len > 0 && PyUnicode_READ_CHAR(path_unicode, len-1) != SEP
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001822#ifdef ALTSEP
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001823 && PyUnicode_READ_CHAR(path_unicode, len-1) != ALTSEP
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001824#endif
1825 )
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001826 addsep = 1;
1827 filename = PyUnicode_New(len + PyUnicode_GET_LENGTH(name) + addsep,
1828 Py_MAX(PyUnicode_MAX_CHAR_VALUE(path_unicode),
1829 PyUnicode_MAX_CHAR_VALUE(name)));
1830 if (filename == NULL) {
1831 result = -1;
1832 goto out;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001833 }
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001834 PyUnicode_CopyCharacters(filename, 0, path_unicode, 0, len);
1835 pos = len;
1836 if (addsep)
1837 PyUnicode_WRITE(PyUnicode_KIND(filename),
1838 PyUnicode_DATA(filename),
1839 pos++, SEP);
1840 PyUnicode_CopyCharacters(filename, pos, name, 0,
1841 PyUnicode_GET_LENGTH(name));
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001842
1843 /* Check for package import (buf holds a directory name,
1844 and there's an __init__ module in that directory */
1845#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001846 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001847 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1848 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001849 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001850
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001851 match = case_ok(filename, 0, name);
1852 if (match < 0) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001853 result = -1;
1854 goto out;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001855 }
1856 if (match) { /* case matches */
1857 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001858 *p_path = filename;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001859 filename = NULL;
Victor Stinnerd0296212011-03-14 14:04:10 -04001860 *p_fd = &fd_package;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001861 result = 2;
1862 goto out;
Victor Stinnerd0296212011-03-14 14:04:10 -04001863 }
1864 else {
1865 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001866 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001867 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001868 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001869 if (err) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001870 result = -1;
1871 goto out;
Victor Stinner547a2a62011-03-20 03:07:28 +01001872 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001873 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001874 }
1875 }
1876#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001877 *p_path = filename;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001878 filename = NULL;
1879 result = 1;
1880 out:
1881 Py_DECREF(path_unicode);
1882 Py_XDECREF(filename);
1883 return result;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001884}
1885
1886/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001887 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001888
1889 If the module is found, return a file descriptor, write the path in
1890 *p_filename, write the pointer to the file object into *p_fp, and (if
1891 p_loader is not NULL) the loader into *p_loader.
1892
1893 Otherwise, raise an exception and return NULL. */
1894
Victor Stinner37580282011-03-20 01:34:43 +01001895static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001896find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001897 PyObject *search_path_list, PyObject *path_hooks,
1898 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001899 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001900{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001901 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001902 struct filedescr *fdp = NULL;
1903 char *filemode;
1904 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001905 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001906 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001907
Victor Stinner37580282011-03-20 01:34:43 +01001908 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001909 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001910 PyObject *path;
1911 int ok;
1912
1913 path = PyList_GetItem(search_path_list, i);
1914 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001915 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001916
Victor Stinner2fd76e42011-03-14 15:19:39 -04001917 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001918 ok = find_module_path(fullname, name, path,
1919 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001920 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001921 if (ok < 0)
1922 return NULL;
1923 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001924 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001925 if (ok == 2) {
1926 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001927 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001928 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001929
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001930 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001931 struct stat statbuf;
1932
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001933 filemode = fdp->mode;
1934 if (filemode[0] == 'U')
1935 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001936
Victor Stinner2fd76e42011-03-14 15:19:39 -04001937 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1938 if (filename == NULL) {
1939 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001940 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001941 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001942
1943 if (Py_VerboseFlag > 1)
1944 PySys_FormatStderr("# trying %R\n", filename);
1945
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001946 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
1947 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1948 {
1949 Py_DECREF(filename);
1950 continue;
1951 }
1952
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001953 fp = _Py_fopen(filename, filemode);
1954 if (fp == NULL) {
1955 Py_DECREF(filename);
Victor Stinner925ef392011-06-20 15:01:10 +02001956 if (PyErr_Occurred()) {
1957 Py_DECREF(prefix);
1958 return NULL;
1959 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001960 continue;
1961 }
1962 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1963 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001964 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001965 Py_DECREF(filename);
1966 return NULL;
1967 }
1968 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001969 Py_DECREF(prefix);
1970 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001971 *p_fp = fp;
1972 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001973 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001974 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001975
1976 fclose(fp);
1977 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001978 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001979 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001980 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001981 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04001982 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04001983 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001984}
1985
Victor Stinner37580282011-03-20 01:34:43 +01001986/* Find a module:
1987
1988 - try find_module() of each sys.meta_path hook
1989 - try find_frozen()
1990 - try is_builtin()
1991 - try _PyWin_FindRegisteredModule() (Windows only)
1992 - otherwise, call find_module_path_list() with search_path_list (if not
1993 NULL) or sys.path
1994
Victor Stinner2fd76e42011-03-14 15:19:39 -04001995 fullname can be NULL, but only if p_loader is NULL.
1996
Victor Stinner37580282011-03-20 01:34:43 +01001997 Return:
1998
1999 - &fd_builtin (C_BUILTIN) if it is a builtin
2000 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04002001 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01002002 if it is a package
2003 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
2004 importer loader was found
2005 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
2006 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04002007 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01002008 - NULL on error
2009
Victor Stinner2fd76e42011-03-14 15:19:39 -04002010 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
2011 Eg. *p_path is set to NULL for a builtin package.
2012*/
Victor Stinner37580282011-03-20 01:34:43 +01002013
2014static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002015find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002016 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01002017{
2018 Py_ssize_t i, npath;
2019 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
2020 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
2021 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01002022
Victor Stinner2fd76e42011-03-14 15:19:39 -04002023 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01002024 *p_fp = NULL;
2025 if (p_loader != NULL)
2026 *p_loader = NULL;
2027
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002028 if (PyUnicode_GET_LENGTH(name) > MAXPATHLEN) {
2029 PyErr_SetString(PyExc_OverflowError,
2030 "module name is too long");
2031 return NULL;
2032 }
2033
Victor Stinner37580282011-03-20 01:34:43 +01002034 /* sys.meta_path import hook */
2035 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002036 _Py_IDENTIFIER(find_module);
Victor Stinner37580282011-03-20 01:34:43 +01002037 PyObject *meta_path;
2038
2039 meta_path = PySys_GetObject("meta_path");
2040 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02002041 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002042 "sys.meta_path must be a list of "
2043 "import hooks");
2044 return NULL;
2045 }
2046 Py_INCREF(meta_path); /* zap guard */
2047 npath = PyList_Size(meta_path);
2048 for (i = 0; i < npath; i++) {
2049 PyObject *loader;
2050 PyObject *hook = PyList_GetItem(meta_path, i);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002051 loader = _PyObject_CallMethodId(hook, &PyId_find_module,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002052 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01002053 search_path_list != NULL ?
2054 search_path_list : Py_None);
2055 if (loader == NULL) {
2056 Py_DECREF(meta_path);
2057 return NULL; /* true error */
2058 }
2059 if (loader != Py_None) {
2060 /* a loader was found */
2061 *p_loader = loader;
2062 Py_DECREF(meta_path);
2063 return &importhookdescr;
2064 }
2065 Py_DECREF(loader);
2066 }
2067 Py_DECREF(meta_path);
2068 }
2069
Victor Stinnerdf75a022011-03-14 13:40:04 -04002070 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002071 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01002072
2073 if (search_path_list == NULL) {
2074#ifdef MS_COREDLL
2075 FILE *fp;
2076 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01002077#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04002078 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01002079 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01002080#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04002081 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01002082 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01002083 *p_fp = fp;
2084 return fdp;
2085 }
2086 else if (PyErr_Occurred())
2087 return NULL;
2088#endif
Victor Stinner37580282011-03-20 01:34:43 +01002089 search_path_list = PySys_GetObject("path");
2090 }
2091
2092 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
Victor Stinner16191322011-09-15 19:28:05 +02002093 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002094 "sys.path must be a list of directory names");
2095 return NULL;
2096 }
2097
2098 path_hooks = PySys_GetObject("path_hooks");
2099 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02002100 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002101 "sys.path_hooks must be a list of "
2102 "import hooks");
2103 return NULL;
2104 }
2105 path_importer_cache = PySys_GetObject("path_importer_cache");
2106 if (path_importer_cache == NULL ||
2107 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02002108 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002109 "sys.path_importer_cache must be a dict");
2110 return NULL;
2111 }
2112
2113 return find_module_path_list(fullname, name,
2114 search_path_list, path_hooks,
2115 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002116 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002117}
2118
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002119/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002120 * The arguments here are tricky, best shown by example:
2121 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2122 * ^ ^ ^ ^
2123 * |--------------------- buf ---------------------|
2124 * |------------------- len ------------------|
2125 * |------ name -------|
2126 * |----- namelen -----|
2127 * buf is the full path, but len only counts up to (& exclusive of) the
2128 * extension. name is the module name, also exclusive of extension.
2129 *
2130 * We've already done a successful stat() or fopen() on buf, so know that
2131 * there's some match, possibly case-insensitive.
2132 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002133 * case_bytes() is to return 1 if there's a case-sensitive match for
2134 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002135 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002136 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002137 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002138 * on platforms with case-insensitive filesystems. It's trivial to implement
2139 * for case-sensitive filesystems. It's pretty much a cross-platform
2140 * nightmare for systems with case-insensitive filesystems.
2141 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002142
Tim Peters50d8d372001-02-28 05:34:27 +00002143/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002144 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002145 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002146#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002147#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002148
Tim Peters50d8d372001-02-28 05:34:27 +00002149#elif defined(DJGPP)
2150#include <dir.h>
2151
Jason Tishler7961aa62005-05-20 00:56:54 +00002152#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002153#include <sys/types.h>
2154#include <dirent.h>
2155
Andrew MacIntyred9400542002-02-26 11:41:34 +00002156#elif defined(PYOS_OS2)
2157#define INCL_DOS
2158#define INCL_DOSERRORS
2159#define INCL_NOPMAPI
2160#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002161#endif
2162
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002163#if defined(DJGPP) \
2164 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2165 && defined(HAVE_DIRENT_H)) \
2166 || defined(PYOS_OS2)
2167# define USE_CASE_OK_BYTES
2168#endif
2169
2170
2171#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002172static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002173case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002174{
Tim Peters50d8d372001-02-28 05:34:27 +00002175/* Pick a platform-specific implementation; the sequence of #if's here should
2176 * match the sequence just above.
2177 */
2178
Tim Peters50d8d372001-02-28 05:34:27 +00002179/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002180#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002181 struct ffblk ffblk;
2182 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002184 if (Py_GETENV("PYTHONCASEOK") != NULL)
2185 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002186
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002187 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2188 if (done) {
2189 PyErr_Format(PyExc_NameError,
2190 "Can't find file for module %.100s\n(filename %.300s)",
2191 name, buf);
Victor Stinner9c61e242011-03-22 01:22:27 +01002192 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002193 }
2194 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002195
Jason Tishler7961aa62005-05-20 00:56:54 +00002196/* new-fangled macintosh (macosx) or Cygwin */
2197#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002198 DIR *dirp;
2199 struct dirent *dp;
2200 char dirname[MAXPATHLEN + 1];
2201 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002202
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002203 if (Py_GETENV("PYTHONCASEOK") != NULL)
2204 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002205
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002206 /* Copy the dir component into dirname; substitute "." if empty */
2207 if (dirlen <= 0) {
2208 dirname[0] = '.';
2209 dirname[1] = '\0';
2210 }
2211 else {
2212 assert(dirlen <= MAXPATHLEN);
2213 memcpy(dirname, buf, dirlen);
2214 dirname[dirlen] = '\0';
2215 }
2216 /* Open the directory and search the entries for an exact match. */
2217 dirp = opendir(dirname);
2218 if (dirp) {
2219 char *nameWithExt = buf + len - namelen;
2220 while ((dp = readdir(dirp)) != NULL) {
2221 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002222#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002223 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002224#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002225 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002226#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002227 if (thislen >= namelen &&
2228 strcmp(dp->d_name, nameWithExt) == 0) {
2229 (void)closedir(dirp);
2230 return 1; /* Found */
2231 }
2232 }
2233 (void)closedir(dirp);
2234 }
2235 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002236
Andrew MacIntyred9400542002-02-26 11:41:34 +00002237/* OS/2 */
2238#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002239 HDIR hdir = 1;
2240 ULONG srchcnt = 1;
2241 FILEFINDBUF3 ffbuf;
2242 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002243
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002244 if (Py_GETENV("PYTHONCASEOK") != NULL)
2245 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002246
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002247 rc = DosFindFirst(buf,
2248 &hdir,
2249 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2250 &ffbuf, sizeof(ffbuf),
2251 &srchcnt,
2252 FIL_STANDARD);
2253 if (rc != NO_ERROR)
2254 return 0;
2255 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002256
Tim Peters50d8d372001-02-28 05:34:27 +00002257/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2258#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002259# error "USE_CASE_OK_BYTES is not correctly defined"
2260#endif
2261}
2262#endif
2263
2264/*
2265 * Check if a filename case matchs the name case. We've already done a
2266 * successful stat() or fopen() on buf, so know that there's some match,
2267 * possibly case-insensitive.
2268 *
2269 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2270 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2271 * if envar PYTHONCASEOK exists.
2272 *
2273 * case_ok() is used to implement case-sensitive import semantics even
2274 * on platforms with case-insensitive filesystems. It's trivial to implement
2275 * for case-sensitive filesystems. It's pretty much a cross-platform
2276 * nightmare for systems with case-insensitive filesystems.
2277 */
2278
2279static int
2280case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2281{
2282#ifdef MS_WINDOWS
2283 WIN32_FIND_DATAW data;
2284 HANDLE h;
2285 int cmp;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002286 wchar_t *wname;
Victor Stinner8c981892011-10-11 22:27:13 +02002287 Py_ssize_t wname_len;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002288
2289 if (Py_GETENV("PYTHONCASEOK") != NULL)
2290 return 1;
2291
2292 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2293 if (h == INVALID_HANDLE_VALUE) {
2294 PyErr_Format(PyExc_NameError,
2295 "Can't find file for module %R\n(filename %R)",
2296 name, filename);
2297 return 0;
2298 }
2299 FindClose(h);
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002300
2301 wname = PyUnicode_AsUnicodeAndSize(name, &wname_len);
2302 if (wname == NULL)
2303 return -1;
2304
2305 cmp = wcsncmp(data.cFileName, wname, wname_len);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002306 return cmp == 0;
2307#elif defined(USE_CASE_OK_BYTES)
2308 int match;
2309 PyObject *filebytes, *namebytes;
2310 filebytes = PyUnicode_EncodeFSDefault(filename);
2311 if (filebytes == NULL)
2312 return -1;
2313 namebytes = PyUnicode_EncodeFSDefault(name);
2314 if (namebytes == NULL) {
2315 Py_DECREF(filebytes);
2316 return -1;
2317 }
2318 match = case_bytes(
2319 PyBytes_AS_STRING(filebytes),
2320 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002321 PyBytes_GET_SIZE(namebytes),
2322 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002323 Py_DECREF(filebytes);
2324 Py_DECREF(namebytes);
2325 return match;
2326#else
2327 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002328 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002329
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002330#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002331}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002332
Guido van Rossum197346f1997-10-31 18:38:52 +00002333#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002334
Victor Stinner547a2a62011-03-20 03:07:28 +01002335/* Helper to look for __init__.py or __init__.py[co] in potential package.
2336 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002337static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002338find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002339{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002340 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002341 PyObject *filename;
2342 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002343
Victor Stinner547a2a62011-03-20 03:07:28 +01002344 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2345 if (filename == NULL)
2346 return -1;
2347 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002348 /* 3=len(".py") */
2349 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002350 if (match < 0) {
2351 Py_DECREF(filename);
2352 return -1;
2353 }
2354 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002355 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002356 return 1;
2357 }
2358 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002359 Py_DECREF(filename);
2360
2361 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2362 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2363 if (filename == NULL)
2364 return -1;
2365 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002366 /* 4=len(".pyc") */
2367 match = case_ok(filename, -4, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002368 if (match < 0) {
2369 Py_DECREF(filename);
2370 return -1;
2371 }
2372 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002373 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002374 return 1;
2375 }
2376 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002377 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002378 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002379}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002380
Guido van Rossum197346f1997-10-31 18:38:52 +00002381#endif /* HAVE_STAT */
2382
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002383
Victor Stinner95872862011-03-07 18:20:56 +01002384static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002385
Victor Stinner44c6c152010-08-09 00:59:10 +00002386static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002387load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002388{
2389 PyObject *m, *modules;
2390 int err;
2391
Victor Stinner44c6c152010-08-09 00:59:10 +00002392 if (type == C_BUILTIN)
2393 err = init_builtin(name);
2394 else
Victor Stinner95872862011-03-07 18:20:56 +01002395 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002396 if (err < 0)
2397 return NULL;
2398 if (err == 0) {
2399 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002400 "Purported %s module %R not found",
2401 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002402 name);
2403 return NULL;
2404 }
2405
2406 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002407 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002408 if (m == NULL) {
2409 PyErr_Format(
2410 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002411 "%s module %R not properly initialized",
2412 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002413 name);
2414 return NULL;
2415 }
2416 Py_INCREF(m);
2417 return m;
2418}
2419
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002420/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002421 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002422
Guido van Rossum79f25d91997-04-29 20:08:16 +00002423static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002424load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002425{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002426 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002428 /* First check that there's an open file (if we need one) */
2429 switch (type) {
2430 case PY_SOURCE:
2431 case PY_COMPILED:
2432 if (fp == NULL) {
2433 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002434 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002435 type);
2436 return NULL;
2437 }
2438 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002439
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002440 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002441
Victor Stinner41c5fec2011-03-13 21:46:30 -04002442 case PY_SOURCE:
2443 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002445
Victor Stinner41c5fec2011-03-13 21:46:30 -04002446 case PY_COMPILED:
2447 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002448 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002449
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002450#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002451 case C_EXTENSION:
2452 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002453 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002454#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002455
Victor Stinner41c5fec2011-03-13 21:46:30 -04002456 case PKG_DIRECTORY:
2457 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002458 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002460 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002461 case PY_FROZEN:
2462 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002463 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002464
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002465 case IMP_HOOK: {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002466 _Py_IDENTIFIER(load_module);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002467 if (loader == NULL) {
2468 PyErr_SetString(PyExc_ImportError,
2469 "import hook without loader");
2470 return NULL;
2471 }
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002472 m = _PyObject_CallMethodId(loader, &PyId_load_module, "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002473 break;
2474 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002475
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002476 default:
2477 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002478 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002479 name, type);
2480 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002482 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002484 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002485}
2486
2487
2488/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002489 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002490 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002491
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002492static int
Victor Stinner95872862011-03-07 18:20:56 +01002493init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002494{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002495 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002496
Victor Stinner95872862011-03-07 18:20:56 +01002497 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002498 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002499
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002500 for (p = PyImport_Inittab; p->name != NULL; p++) {
2501 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002502 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002503 if (p->initfunc == NULL) {
2504 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002505 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002506 name);
2507 return -1;
2508 }
2509 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002510 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002511 mod = (*p->initfunc)();
2512 if (mod == 0)
2513 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002514 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002515 return -1;
2516 /* FixupExtension has put the module into sys.modules,
2517 so we can release our own reference. */
2518 Py_DECREF(mod);
2519 return 1;
2520 }
2521 }
2522 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002523}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002524
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002525
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002526/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002527
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002528static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002529find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002530{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002531 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002532
Victor Stinner53dc7352011-03-20 01:50:21 +01002533 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002534 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002535
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002536 for (p = PyImport_FrozenModules; ; p++) {
2537 if (p->name == NULL)
2538 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002539 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002540 break;
2541 }
2542 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002543}
2544
Guido van Rossum79f25d91997-04-29 20:08:16 +00002545static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002546get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002547{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002548 struct _frozen *p = find_frozen(name);
2549 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002550
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002551 if (p == NULL) {
2552 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002553 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002554 name);
2555 return NULL;
2556 }
2557 if (p->code == NULL) {
2558 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002559 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002560 name);
2561 return NULL;
2562 }
2563 size = p->size;
2564 if (size < 0)
2565 size = -size;
2566 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002567}
2568
Brett Cannon8d110132009-03-15 02:20:16 +00002569static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002570is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002571{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002572 struct _frozen *p = find_frozen(name);
2573 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002574
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002575 if (p == NULL) {
2576 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002577 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002578 name);
2579 return NULL;
2580 }
Brett Cannon8d110132009-03-15 02:20:16 +00002581
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002582 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002583
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002584 if (size < 0)
2585 Py_RETURN_TRUE;
2586 else
2587 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002588}
2589
2590
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002591/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002592 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002593 an exception set if the initialization failed.
2594 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002595
2596int
Victor Stinner53dc7352011-03-20 01:50:21 +01002597PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002598{
Victor Stinner53dc7352011-03-20 01:50:21 +01002599 struct _frozen *p;
2600 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002601 int ispackage;
2602 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002603
Victor Stinner53dc7352011-03-20 01:50:21 +01002604 p = find_frozen(name);
2605
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002606 if (p == NULL)
2607 return 0;
2608 if (p->code == NULL) {
2609 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002610 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002611 name);
2612 return -1;
2613 }
2614 size = p->size;
2615 ispackage = (size < 0);
2616 if (ispackage)
2617 size = -size;
2618 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002619 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002620 name, ispackage ? " package" : "");
2621 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2622 if (co == NULL)
2623 return -1;
2624 if (!PyCode_Check(co)) {
2625 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002626 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002627 name);
2628 goto err_return;
2629 }
2630 if (ispackage) {
2631 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002632 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002633 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002634 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002635 if (m == NULL)
2636 goto err_return;
2637 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002638 l = PyList_New(1);
2639 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002640 goto err_return;
2641 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002642 Py_INCREF(name);
2643 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002644 err = PyDict_SetItemString(d, "__path__", l);
2645 Py_DECREF(l);
2646 if (err != 0)
2647 goto err_return;
2648 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002649 path = PyUnicode_FromString("<frozen>");
2650 if (path == NULL)
2651 goto err_return;
2652 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2653 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002654 if (m == NULL)
2655 goto err_return;
2656 Py_DECREF(co);
2657 Py_DECREF(m);
2658 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002659err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002660 Py_DECREF(co);
2661 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002662}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002663
Victor Stinner53dc7352011-03-20 01:50:21 +01002664int
2665PyImport_ImportFrozenModule(char *name)
2666{
2667 PyObject *nameobj;
2668 int ret;
2669 nameobj = PyUnicode_InternFromString(name);
2670 if (nameobj == NULL)
2671 return -1;
2672 ret = PyImport_ImportFrozenModuleObject(nameobj);
2673 Py_DECREF(nameobj);
2674 return ret;
2675}
2676
Guido van Rossum74e6a111994-08-29 12:54:38 +00002677
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002678/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002679 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002680
Guido van Rossum79f25d91997-04-29 20:08:16 +00002681PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002682PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002683{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002684 PyObject *pname;
2685 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002686
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002687 pname = PyUnicode_FromString(name);
2688 if (pname == NULL)
2689 return NULL;
2690 result = PyImport_Import(pname);
2691 Py_DECREF(pname);
2692 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002693}
2694
Christian Heimes072c0f12008-01-03 23:01:04 +00002695/* Import a module without blocking
2696 *
2697 * At first it tries to fetch the module from sys.modules. If the module was
2698 * never loaded before it loads it with PyImport_ImportModule() unless another
2699 * thread holds the import lock. In the latter case the function raises an
2700 * ImportError instead of blocking.
2701 *
2702 * Returns the module object with incremented ref count.
2703 */
2704PyObject *
2705PyImport_ImportModuleNoBlock(const char *name)
2706{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002707 PyObject *nameobj, *modules, *result;
Victor Stinner0af03062011-09-02 00:11:43 +02002708#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002709 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002710#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002711
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002712 /* Try to get the module from sys.modules[name] */
2713 modules = PyImport_GetModuleDict();
2714 if (modules == NULL)
2715 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002716
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002717 nameobj = PyUnicode_FromString(name);
2718 if (nameobj == NULL)
2719 return NULL;
2720 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002721 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002722 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002723 Py_INCREF(result);
2724 return result;
2725 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002726 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002727#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002728 /* check the import lock
2729 * me might be -1 but I ignore the error here, the lock function
2730 * takes care of the problem */
2731 me = PyThread_get_thread_ident();
2732 if (import_lock_thread == -1 || import_lock_thread == me) {
2733 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002734 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002735 }
2736 else {
2737 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002738 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002739 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002740 nameobj);
2741 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002742 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002743#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002744 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002745#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002746 Py_DECREF(nameobj);
2747 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002748}
2749
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002750/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002751static PyObject *get_parent(PyObject *globals,
2752 PyObject **p_name,
2753 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002754static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002755 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002756 Py_UCS4 *buf, Py_ssize_t *p_buflen,
Victor Stinner974389d2011-03-15 09:33:57 +01002757 Py_ssize_t bufsize);
2758static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002759static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002760 PyObject *buf, int recursive);
2761static PyObject * import_submodule(PyObject *mod, PyObject *name,
2762 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002763
2764/* The Magnum Opus of dotted-name import :-) */
2765
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002766static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002767import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002768 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002769{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002770 Py_UCS4 buf[MAXPATHLEN+1];
Victor Stinner974389d2011-03-15 09:33:57 +01002771 Py_ssize_t buflen;
2772 Py_ssize_t bufsize = MAXPATHLEN+1;
2773 PyObject *parent, *head, *next, *tail, *inputname, *outputname;
2774 PyObject *parent_name, *ensure_name;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002775 Py_ssize_t sep, altsep;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002776
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002777 if (PyUnicode_READY(name))
2778 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002779
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002780 sep = PyUnicode_FindChar(name, SEP, 0, PyUnicode_GET_LENGTH(name), 1);
2781 if (sep == -2)
2782 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002783#ifdef ALTSEP
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002784 altsep = PyUnicode_FindChar(name, ALTSEP, 0, PyUnicode_GET_LENGTH(name), 1);
2785 if (altsep == -2)
2786 return NULL;
2787#else
2788 altsep = -1;
Christian Heimes454f37b2008-01-10 00:10:02 +00002789#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002790 if (sep != -1 || altsep != -1)
2791 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002792 PyErr_SetString(PyExc_ImportError,
2793 "Import by filename is not supported.");
2794 return NULL;
2795 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002796
Victor Stinner974389d2011-03-15 09:33:57 +01002797 parent = get_parent(globals, &parent_name, level);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002798 if (parent == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002799 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002800 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002801
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002802 if (PyUnicode_READY(parent_name))
2803 return NULL;
2804 buflen = PyUnicode_GET_LENGTH(parent_name);
Georg Brandl4cb0de22011-09-28 21:49:49 +02002805 if (!PyUnicode_AsUCS4(parent_name, buf, Py_ARRAY_LENGTH(buf), 1)) {
Victor Stinner974389d2011-03-15 09:33:57 +01002806 Py_DECREF(parent_name);
2807 PyErr_SetString(PyExc_ValueError,
2808 "Module name too long");
2809 return NULL;
2810 }
Victor Stinner974389d2011-03-15 09:33:57 +01002811 Py_DECREF(parent_name);
2812
2813 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
2814 buf, &buflen, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002815 if (head == NULL)
2816 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002817
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002818 tail = head;
2819 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002820
2821 if (outputname != NULL) {
2822 while (1) {
2823 inputname = outputname;
2824 next = load_next(tail, tail, inputname, &outputname,
2825 buf, &buflen, bufsize);
2826 Py_DECREF(tail);
2827 Py_DECREF(inputname);
2828 if (next == NULL) {
2829 Py_DECREF(head);
2830 return NULL;
2831 }
2832 tail = next;
2833
2834 if (outputname == NULL) {
2835 break;
2836 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002837 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002838 }
2839 if (tail == Py_None) {
2840 /* If tail is Py_None, both get_parent and load_next found
2841 an empty module name: someone called __import__("") or
2842 doctored faulty bytecode */
2843 Py_DECREF(tail);
2844 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002845 PyErr_SetString(PyExc_ValueError, "Empty module name");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002846 return NULL;
2847 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002848
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002849 if (fromlist != NULL) {
2850 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2851 fromlist = NULL;
2852 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002853
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002854 if (fromlist == NULL) {
2855 Py_DECREF(tail);
2856 return head;
2857 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002858
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002859 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002860
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002861 ensure_name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
2862 buf, Py_UCS4_strlen(buf));
Victor Stinner974389d2011-03-15 09:33:57 +01002863 if (ensure_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002864 Py_DECREF(tail);
2865 return NULL;
2866 }
Victor Stinner974389d2011-03-15 09:33:57 +01002867 if (!ensure_fromlist(tail, fromlist, ensure_name, 0)) {
2868 Py_DECREF(tail);
2869 Py_DECREF(ensure_name);
2870 return NULL;
2871 }
2872 Py_DECREF(ensure_name);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002873
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002874 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002875}
2876
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002877PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002878PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2879 PyObject *locals, PyObject *fromlist,
2880 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002881{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002882 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002883 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002884 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002885 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002886 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002887 PyErr_SetString(PyExc_RuntimeError,
2888 "not holding the import lock");
2889 return NULL;
2890 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002891 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002892}
2893
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002894PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05002895PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002896 PyObject *fromlist, int level)
2897{
2898 PyObject *nameobj, *mod;
2899 nameobj = PyUnicode_FromString(name);
2900 if (nameobj == NULL)
2901 return NULL;
2902 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2903 fromlist, level);
2904 Py_DECREF(nameobj);
2905 return mod;
2906}
2907
2908
Fred Drake87590902004-05-28 20:21:36 +00002909/* Return the package that an import is being performed in. If globals comes
2910 from the module foo.bar.bat (not itself a package), this returns the
2911 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002912 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002913
Victor Stinner974389d2011-03-15 09:33:57 +01002914 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002915
2916 If globals doesn't come from a package or a module in a package, or a
2917 corresponding entry is not found in sys.modules, Py_None is returned.
2918*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002919static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002920get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002921{
Victor Stinner974389d2011-03-15 09:33:57 +01002922 PyObject *nameobj;
2923
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002924 static PyObject *namestr = NULL;
2925 static PyObject *pathstr = NULL;
2926 static PyObject *pkgstr = NULL;
2927 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2928 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002929
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002930 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002931 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002932
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002933 if (namestr == NULL) {
2934 namestr = PyUnicode_InternFromString("__name__");
2935 if (namestr == NULL)
2936 return NULL;
2937 }
2938 if (pathstr == NULL) {
2939 pathstr = PyUnicode_InternFromString("__path__");
2940 if (pathstr == NULL)
2941 return NULL;
2942 }
2943 if (pkgstr == NULL) {
2944 pkgstr = PyUnicode_InternFromString("__package__");
2945 if (pkgstr == NULL)
2946 return NULL;
2947 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002948
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002949 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002950
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002951 if ((pkgname != NULL) && (pkgname != Py_None)) {
2952 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002953 if (!PyUnicode_Check(pkgname)) {
2954 PyErr_SetString(PyExc_ValueError,
2955 "__package__ set to non-string");
2956 return NULL;
2957 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002958 if (PyUnicode_GET_LENGTH(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002959 if (level > 0) {
2960 PyErr_SetString(PyExc_ValueError,
2961 "Attempted relative import in non-package");
2962 return NULL;
2963 }
Victor Stinner974389d2011-03-15 09:33:57 +01002964 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002965 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002966 Py_INCREF(pkgname);
2967 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002968 } else {
2969 /* __package__ not set, so figure it out and set it */
2970 modname = PyDict_GetItem(globals, namestr);
2971 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002972 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002973
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002974 modpath = PyDict_GetItem(globals, pathstr);
2975 if (modpath != NULL) {
2976 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002977 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002978
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002979 error = PyDict_SetItem(globals, pkgstr, modname);
2980 if (error) {
2981 PyErr_SetString(PyExc_ValueError,
2982 "Could not set __package__");
2983 return NULL;
2984 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002985 Py_INCREF(modname);
2986 nameobj = modname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002987 } else {
2988 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002989 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002990 len = PyUnicode_FindChar(modname, '.',
2991 0, PyUnicode_GET_LENGTH(modname), -1);
2992 if (len == -2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002993 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002994 if (len < 0) {
2995 if (level > 0) {
2996 PyErr_SetString(PyExc_ValueError,
2997 "Attempted relative import in non-package");
2998 return NULL;
2999 }
3000 if (PyDict_SetItem(globals, pkgstr, Py_None)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003001 PyErr_SetString(PyExc_ValueError,
3002 "Could not set __package__");
3003 return NULL;
3004 }
Victor Stinner974389d2011-03-15 09:33:57 +01003005 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003006 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003007 pkgname = PyUnicode_Substring(modname, 0, len);
3008 if (pkgname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003009 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003010 if (PyDict_SetItem(globals, pkgstr, pkgname)) {
3011 Py_DECREF(pkgname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003012 PyErr_SetString(PyExc_ValueError,
3013 "Could not set __package__");
3014 return NULL;
3015 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003016 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003017 }
3018 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003019 if (level > 1) {
3020 Py_ssize_t dot, end = PyUnicode_GET_LENGTH(nameobj);
3021 PyObject *newname;
3022 while (--level > 0) {
3023 dot = PyUnicode_FindChar(nameobj, '.', 0, end, -1);
3024 if (dot == -2) {
3025 Py_DECREF(nameobj);
3026 return NULL;
3027 }
3028 if (dot < 0) {
3029 Py_DECREF(nameobj);
3030 PyErr_SetString(PyExc_ValueError,
3031 "Attempted relative import beyond "
3032 "toplevel package");
3033 return NULL;
3034 }
3035 end = dot;
3036 }
3037 newname = PyUnicode_Substring(nameobj, 0, end);
3038 Py_DECREF(nameobj);
3039 if (newname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003040 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003041 nameobj = newname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003042 }
Victor Stinner974389d2011-03-15 09:33:57 +01003043
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003044 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003045 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003046 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003047 int err;
3048
3049 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003050 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01003051 "Parent module %R not loaded, "
3052 "cannot perform relative import", nameobj);
3053 Py_DECREF(nameobj);
3054 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003055 }
Victor Stinner974389d2011-03-15 09:33:57 +01003056
3057 err = PyErr_WarnFormat(
3058 PyExc_RuntimeWarning, 1,
3059 "Parent module %R not found while handling absolute import",
3060 nameobj);
3061 Py_DECREF(nameobj);
3062 if (err)
3063 return NULL;
3064
3065 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003066 }
Victor Stinner974389d2011-03-15 09:33:57 +01003067 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003068 return parent;
3069 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01003070 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003071 - parent.__dict__ is globals
3072 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01003073
3074return_none:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003075 nameobj = PyUnicode_New(0, 0);
Victor Stinner974389d2011-03-15 09:33:57 +01003076 if (nameobj == NULL)
3077 return NULL;
3078 *p_name = nameobj;
3079 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003080}
3081
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003082/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003083static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003084load_next(PyObject *mod, PyObject *altmod,
3085 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003086 Py_UCS4 *buf, Py_ssize_t *p_buflen, Py_ssize_t bufsize)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003087{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003088 Py_UCS4 *dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003089 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003090 Py_UCS4 *p;
Victor Stinner974389d2011-03-15 09:33:57 +01003091 PyObject *fullname, *name, *result, *mark_name;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003092 Py_UCS4 *nameuni;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003093
Victor Stinner974389d2011-03-15 09:33:57 +01003094 *p_outputname = NULL;
3095
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003096 if (PyUnicode_GET_LENGTH(inputname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003097 /* completely empty module name should only happen in
3098 'from . import' (or '__import__("")')*/
3099 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003100 return mod;
3101 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00003102
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003103 nameuni = PyUnicode_AsUCS4Copy(inputname);
Victor Stinner974389d2011-03-15 09:33:57 +01003104 if (nameuni == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003105 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003106
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003107 dot = Py_UCS4_strchr(nameuni, '.');
Victor Stinner974389d2011-03-15 09:33:57 +01003108 if (dot != NULL) {
3109 len = dot - nameuni;
3110 if (len == 0) {
3111 PyErr_SetString(PyExc_ValueError,
3112 "Empty module name");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003113 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003114 }
3115 }
3116 else
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003117 len = PyUnicode_GET_LENGTH(inputname);
Victor Stinner974389d2011-03-15 09:33:57 +01003118
3119 if (*p_buflen+len+1 >= bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003120 PyErr_SetString(PyExc_ValueError,
3121 "Module name too long");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003122 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003123 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003124
Victor Stinner974389d2011-03-15 09:33:57 +01003125 p = buf + *p_buflen;
3126 if (p != buf) {
3127 *p++ = '.';
3128 *p_buflen += 1;
3129 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003130 Py_UCS4_strncpy(p, nameuni, len);
Victor Stinner974389d2011-03-15 09:33:57 +01003131 p[len] = '\0';
3132 *p_buflen += len;
3133
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003134 fullname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3135 buf, *p_buflen);
Victor Stinner974389d2011-03-15 09:33:57 +01003136 if (fullname == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003137 goto error;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003138 name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3139 p, len);
Victor Stinner974389d2011-03-15 09:33:57 +01003140 if (name == NULL) {
3141 Py_DECREF(fullname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003142 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003143 }
3144 result = import_submodule(mod, name, fullname);
3145 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003146 if (result == Py_None && altmod != mod) {
3147 Py_DECREF(result);
3148 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003149 result = import_submodule(altmod, name, name);
3150 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003151 if (result != NULL && result != Py_None) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003152 mark_name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3153 buf, *p_buflen);
Victor Stinner974389d2011-03-15 09:33:57 +01003154 if (mark_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003155 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003156 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003157 }
Victor Stinner974389d2011-03-15 09:33:57 +01003158 if (mark_miss(mark_name) != 0) {
3159 Py_DECREF(result);
3160 Py_DECREF(mark_name);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003161 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003162 }
3163 Py_DECREF(mark_name);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003164 Py_UCS4_strncpy(buf, nameuni, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003165 buf[len] = '\0';
3166 *p_buflen = len;
3167 }
3168 }
Victor Stinner974389d2011-03-15 09:33:57 +01003169 else
3170 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003171 if (result == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003172 goto error;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003173
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003174 if (result == Py_None) {
3175 Py_DECREF(result);
3176 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003177 "No module named %R", inputname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003178 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003179 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003180
Victor Stinner974389d2011-03-15 09:33:57 +01003181 if (dot != NULL) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003182 *p_outputname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3183 dot+1, Py_UCS4_strlen(dot+1));
Victor Stinner974389d2011-03-15 09:33:57 +01003184 if (*p_outputname == NULL) {
3185 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003186 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003187 }
3188 }
3189
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003190 PyMem_Free(nameuni);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003191 return result;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003192
3193error:
3194 PyMem_Free(nameuni);
3195 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003196}
3197
3198static int
Victor Stinner974389d2011-03-15 09:33:57 +01003199mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003200{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003201 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003202 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003203}
3204
3205static int
Victor Stinner974389d2011-03-15 09:33:57 +01003206ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003207 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003208{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003209 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003210 PyObject *fullname;
3211 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003212
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003213 if (!_PyObject_HasAttrId(mod, &PyId___path__))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003214 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003215
Victor Stinner974389d2011-03-15 09:33:57 +01003216 fromlist_len = PySequence_Size(fromlist);
3217
3218 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003219 PyObject *item = PySequence_GetItem(fromlist, i);
3220 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003221 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003222 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003223 if (!PyUnicode_Check(item)) {
3224 PyErr_SetString(PyExc_TypeError,
3225 "Item in ``from list'' not a string");
3226 Py_DECREF(item);
3227 return 0;
3228 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003229 if (PyUnicode_READ_CHAR(item, 0) == '*') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003230 PyObject *all;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02003231 _Py_IDENTIFIER(__all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003232 Py_DECREF(item);
3233 /* See if the package defines __all__ */
3234 if (recursive)
3235 continue; /* Avoid endless recursion */
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003236 all = _PyObject_GetAttrId(mod, &PyId___all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003237 if (all == NULL)
3238 PyErr_Clear();
3239 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003240 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003241 Py_DECREF(all);
3242 if (!ret)
3243 return 0;
3244 }
3245 continue;
3246 }
3247 hasit = PyObject_HasAttr(mod, item);
3248 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003249 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003250 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3251 if (fullname != NULL) {
3252 submod = import_submodule(mod, item, fullname);
3253 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003254 }
Victor Stinner974389d2011-03-15 09:33:57 +01003255 else
3256 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003257 Py_XDECREF(submod);
3258 if (submod == NULL) {
3259 Py_DECREF(item);
3260 return 0;
3261 }
3262 }
3263 Py_DECREF(item);
3264 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003265
Victor Stinner974389d2011-03-15 09:33:57 +01003266 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003267}
3268
Neil Schemenauer00b09662003-06-16 21:03:07 +00003269static int
Victor Stinner974389d2011-03-15 09:33:57 +01003270add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3271 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003272{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003273 if (mod == Py_None)
3274 return 1;
3275 /* Irrespective of the success of this load, make a
3276 reference to it in the parent package module. A copy gets
3277 saved in the modules dictionary under the full name, so get a
3278 reference from there, if need be. (The exception is when the
3279 load failed with a SyntaxError -- then there's no trace in
3280 sys.modules. In that case, of course, do nothing extra.) */
3281 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003282 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003283 if (submod == NULL)
3284 return 1;
3285 }
3286 if (PyModule_Check(mod)) {
3287 /* We can't use setattr here since it can give a
3288 * spurious warning if the submodule name shadows a
3289 * builtin name */
3290 PyObject *dict = PyModule_GetDict(mod);
3291 if (!dict)
3292 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003293 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003294 return 0;
3295 }
3296 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003297 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003298 return 0;
3299 }
3300 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003301}
3302
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003303static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003304import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003305{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003306 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003307 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003308 struct filedescr *fdp;
3309 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003310
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003311 /* Require:
3312 if mod == None: subname == fullname
3313 else: mod.__name__ + "." + subname == fullname
3314 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003315
Victor Stinner974389d2011-03-15 09:33:57 +01003316 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003317 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003318 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003319 }
Victor Stinner9599de52011-03-13 22:38:38 -04003320
3321 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003322 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003323 else {
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003324 path_list = _PyObject_GetAttrId(mod, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003325 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003326 PyErr_Clear();
3327 Py_INCREF(Py_None);
3328 return Py_None;
3329 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003330 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003331
Victor Stinner533d7832011-03-14 13:22:54 -04003332 fdp = find_module(fullname, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003333 &bufobj, &fp, &loader);
Victor Stinner533d7832011-03-14 13:22:54 -04003334 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003335 if (fdp == NULL) {
3336 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3337 return NULL;
3338 PyErr_Clear();
3339 Py_INCREF(Py_None);
3340 return Py_None;
3341 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003342 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3343 Py_XDECREF(bufobj);
Victor Stinner9599de52011-03-13 22:38:38 -04003344 Py_XDECREF(loader);
3345 if (fp)
3346 fclose(fp);
3347 if (m == NULL)
3348 return NULL;
3349 if (!add_submodule(mod, m, fullname, subname, modules)) {
3350 Py_XDECREF(m);
3351 return NULL;
3352 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003353 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003354}
3355
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003356
3357/* Re-import a module of any kind and return its module object, WITH
3358 INCREMENTED REFERENCE COUNT */
3359
Guido van Rossum79f25d91997-04-29 20:08:16 +00003360PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003361PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003362{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003363 PyInterpreterState *interp = PyThreadState_Get()->interp;
3364 PyObject *modules_reloading = interp->modules_reloading;
3365 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003366 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003367 PyObject *name, *bufobj, *subname;
3368 Py_ssize_t subname_start;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003369 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003370 FILE *fp = NULL;
3371 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003372
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003373 if (modules_reloading == NULL) {
3374 Py_FatalError("PyImport_ReloadModule: "
3375 "no modules_reloading dictionary!");
3376 return NULL;
3377 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003379 if (m == NULL || !PyModule_Check(m)) {
3380 PyErr_SetString(PyExc_TypeError,
3381 "reload() argument must be module");
3382 return NULL;
3383 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003384 name = PyModule_GetNameObject(m);
3385 if (name == NULL || PyUnicode_READY(name) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003386 return NULL;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003387 if (m != PyDict_GetItem(modules, name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003388 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003389 "reload(): module %R not in sys.modules",
Martin v. Löwis796ea532011-10-30 09:07:07 +01003390 name);
3391 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003392 return NULL;
3393 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003394 existing_m = PyDict_GetItem(modules_reloading, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003395 if (existing_m != NULL) {
3396 /* Due to a recursive reload, this module is already
3397 being reloaded. */
Martin v. Löwis796ea532011-10-30 09:07:07 +01003398 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003399 Py_INCREF(existing_m);
3400 return existing_m;
3401 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003402 if (PyDict_SetItem(modules_reloading, name, m) < 0) {
3403 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003404 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003405 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003406
Martin v. Löwis796ea532011-10-30 09:07:07 +01003407 subname_start = PyUnicode_FindChar(name, '.', 0,
3408 PyUnicode_GET_LENGTH(name), -1);
3409 if (subname_start == -1) {
3410 Py_INCREF(name);
3411 subname = name;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003412 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003413 else {
3414 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003415 Py_ssize_t len;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003416 parentname = PyUnicode_Substring(name, 0, subname_start);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003417 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003418 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003419 }
3420 parent = PyDict_GetItem(modules, parentname);
3421 if (parent == NULL) {
3422 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003423 "reload(): parent %R not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003424 parentname);
3425 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003426 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003427 }
3428 Py_DECREF(parentname);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003429 path_list = _PyObject_GetAttrId(parent, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003430 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003431 PyErr_Clear();
Martin v. Löwis796ea532011-10-30 09:07:07 +01003432 subname_start++;
3433 len = PyUnicode_GET_LENGTH(name) - (subname_start + 1);
3434 subname = PyUnicode_Substring(name, subname_start, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003435 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003436 if (subname == NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003437 goto error;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003438 fdp = find_module(name, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003439 &bufobj, &fp, &loader);
Martin v. Löwis796ea532011-10-30 09:07:07 +01003440 Py_DECREF(subname);
Victor Stinner533d7832011-03-14 13:22:54 -04003441 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003442
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003443 if (fdp == NULL) {
3444 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003445 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003446 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003447
Martin v. Löwis796ea532011-10-30 09:07:07 +01003448 newm = load_module(name, fp, bufobj, fdp->type, loader);
Victor Stinner2fd76e42011-03-14 15:19:39 -04003449 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003450 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003451
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003452 if (fp)
3453 fclose(fp);
3454 if (newm == NULL) {
3455 /* load_module probably removed name from modules because of
3456 * the error. Put back the original module object. We're
3457 * going to return NULL in this case regardless of whether
3458 * replacing name succeeds, so the return value is ignored.
3459 */
Martin v. Löwis796ea532011-10-30 09:07:07 +01003460 PyDict_SetItem(modules, name, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003461 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003462
3463error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003464 imp_modules_reloading_clear();
Martin v. Löwis796ea532011-10-30 09:07:07 +01003465 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003466 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003467}
3468
3469
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003470/* Higher-level import emulator which emulates the "import" statement
3471 more accurately -- it invokes the __import__() function from the
3472 builtins of the current globals. This means that the import is
3473 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003474 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003475 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003476 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003477 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003478
3479PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003480PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003481{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003482 static PyObject *silly_list = NULL;
3483 static PyObject *builtins_str = NULL;
3484 static PyObject *import_str = NULL;
3485 PyObject *globals = NULL;
3486 PyObject *import = NULL;
3487 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003488 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003489 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003490
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003491 /* Initialize constant string objects */
3492 if (silly_list == NULL) {
3493 import_str = PyUnicode_InternFromString("__import__");
3494 if (import_str == NULL)
3495 return NULL;
3496 builtins_str = PyUnicode_InternFromString("__builtins__");
3497 if (builtins_str == NULL)
3498 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003499 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003500 if (silly_list == NULL)
3501 return NULL;
3502 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003503
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003504 /* Get the builtins from current globals */
3505 globals = PyEval_GetGlobals();
3506 if (globals != NULL) {
3507 Py_INCREF(globals);
3508 builtins = PyObject_GetItem(globals, builtins_str);
3509 if (builtins == NULL)
3510 goto err;
3511 }
3512 else {
3513 /* No globals -- use standard builtins, and fake globals */
3514 builtins = PyImport_ImportModuleLevel("builtins",
3515 NULL, NULL, NULL, 0);
3516 if (builtins == NULL)
3517 return NULL;
3518 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3519 if (globals == NULL)
3520 goto err;
3521 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003522
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003523 /* Get the __import__ function from the builtins */
3524 if (PyDict_Check(builtins)) {
3525 import = PyObject_GetItem(builtins, import_str);
3526 if (import == NULL)
3527 PyErr_SetObject(PyExc_KeyError, import_str);
3528 }
3529 else
3530 import = PyObject_GetAttr(builtins, import_str);
3531 if (import == NULL)
3532 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003533
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003534 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003535 Always use absolute import here.
3536 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003537 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3538 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003539 if (r == NULL)
3540 goto err;
3541 Py_DECREF(r);
3542
3543 modules = PyImport_GetModuleDict();
3544 r = PyDict_GetItem(modules, module_name);
3545 if (r != NULL)
3546 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003547
3548 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003549 Py_XDECREF(globals);
3550 Py_XDECREF(builtins);
3551 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003552
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003553 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003554}
3555
3556
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003557/* Module 'imp' provides Python access to the primitives used for
3558 importing modules.
3559*/
3560
Guido van Rossum79f25d91997-04-29 20:08:16 +00003561static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003562imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003563{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003564 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003565
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003566 buf[0] = (char) ((magic >> 0) & 0xff);
3567 buf[1] = (char) ((magic >> 8) & 0xff);
3568 buf[2] = (char) ((magic >> 16) & 0xff);
3569 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003570
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003571 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003572}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003573
3574static PyObject *
3575imp_get_magic(PyObject *self, PyObject *noargs)
3576{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003577 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003578}
3579
3580static PyObject *
3581imp_get_tag(PyObject *self, PyObject *noargs)
3582{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003583 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003584}
3585
Guido van Rossum79f25d91997-04-29 20:08:16 +00003586static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003587imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003588{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003589 PyObject *list;
3590 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003591
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003592 list = PyList_New(0);
3593 if (list == NULL)
3594 return NULL;
3595 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3596 PyObject *item = Py_BuildValue("ssi",
3597 fdp->suffix, fdp->mode, fdp->type);
3598 if (item == NULL) {
3599 Py_DECREF(list);
3600 return NULL;
3601 }
3602 if (PyList_Append(list, item) < 0) {
3603 Py_DECREF(list);
3604 Py_DECREF(item);
3605 return NULL;
3606 }
3607 Py_DECREF(item);
3608 }
3609 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003610}
3611
Guido van Rossum79f25d91997-04-29 20:08:16 +00003612static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003613call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003614{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003615 extern int fclose(FILE *);
3616 PyObject *fob, *ret;
3617 PyObject *pathobj;
3618 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003619 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003620 int fd = -1;
3621 char *found_encoding = NULL;
3622 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003623
Victor Stinner533d7832011-03-14 13:22:54 -04003624 if (path_list == Py_None)
3625 path_list = NULL;
3626 fdp = find_module(NULL, name, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003627 &pathobj, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003628 if (fdp == NULL)
3629 return NULL;
3630 if (fp != NULL) {
3631 fd = fileno(fp);
3632 if (fd != -1)
3633 fd = dup(fd);
3634 fclose(fp);
Victor Stinnerd417d012011-06-20 15:16:55 +02003635 if (fd == -1) {
3636 PyErr_SetFromErrno(PyExc_OSError);
3637 return NULL;
3638 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003639 fp = NULL;
3640 }
3641 if (fd != -1) {
3642 if (strchr(fdp->mode, 'b') == NULL) {
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003643 /* PyTokenizer_FindEncodingFilename() returns PyMem_MALLOC'ed
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003644 memory. */
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003645 found_encoding = PyTokenizer_FindEncodingFilename(fd, pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003646 lseek(fd, 0, 0); /* Reset position */
Victor Stinner2fd76e42011-03-14 15:19:39 -04003647 if (found_encoding == NULL && PyErr_Occurred()) {
3648 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003649 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04003650 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003651 encoding = (found_encoding != NULL) ? found_encoding :
3652 (char*)PyUnicode_GetDefaultEncoding();
3653 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003654 fob = PyFile_FromFd(fd, NULL, fdp->mode, -1,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003655 (char*)encoding, NULL, NULL, 1);
3656 if (fob == NULL) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04003657 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003658 close(fd);
3659 PyMem_FREE(found_encoding);
3660 return NULL;
3661 }
3662 }
3663 else {
3664 fob = Py_None;
3665 Py_INCREF(fob);
3666 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003667 if (pathobj == NULL) {
3668 Py_INCREF(Py_None);
3669 pathobj = Py_None;
3670 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003671 ret = Py_BuildValue("NN(ssi)",
3672 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3673 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003674
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003675 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003676}
3677
Guido van Rossum79f25d91997-04-29 20:08:16 +00003678static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003679imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003680{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003681 PyObject *name, *path_list = NULL;
3682 if (!PyArg_ParseTuple(args, "U|O:find_module",
3683 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003684 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003685 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003686}
3687
3688static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003689imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003690{
Victor Stinner95872862011-03-07 18:20:56 +01003691 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003692 int ret;
3693 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003694 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003695 return NULL;
3696 ret = init_builtin(name);
3697 if (ret < 0)
3698 return NULL;
3699 if (ret == 0) {
3700 Py_INCREF(Py_None);
3701 return Py_None;
3702 }
Victor Stinner95872862011-03-07 18:20:56 +01003703 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003704 Py_XINCREF(m);
3705 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003706}
3707
Guido van Rossum79f25d91997-04-29 20:08:16 +00003708static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003709imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003710{
Victor Stinner53dc7352011-03-20 01:50:21 +01003711 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003712 int ret;
3713 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003714 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003715 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003716 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003717 if (ret < 0)
3718 return NULL;
3719 if (ret == 0) {
3720 Py_INCREF(Py_None);
3721 return Py_None;
3722 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003723 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003724 Py_XINCREF(m);
3725 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003726}
3727
Guido van Rossum79f25d91997-04-29 20:08:16 +00003728static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003729imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003730{
Victor Stinner53dc7352011-03-20 01:50:21 +01003731 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003732
Victor Stinner53dc7352011-03-20 01:50:21 +01003733 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003734 return NULL;
3735 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003736}
3737
Guido van Rossum79f25d91997-04-29 20:08:16 +00003738static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003739imp_is_frozen_package(PyObject *self, PyObject *args)
3740{
Victor Stinner53dc7352011-03-20 01:50:21 +01003741 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003742
Victor Stinner53dc7352011-03-20 01:50:21 +01003743 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003744 return NULL;
3745 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003746}
3747
3748static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003749imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003750{
Victor Stinner95872862011-03-07 18:20:56 +01003751 PyObject *name;
3752 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003753 return NULL;
3754 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003755}
3756
Guido van Rossum79f25d91997-04-29 20:08:16 +00003757static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003758imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003759{
Victor Stinner53dc7352011-03-20 01:50:21 +01003760 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003761 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003762 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003763 return NULL;
3764 p = find_frozen(name);
3765 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003766}
3767
3768static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003769get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003770{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003771 FILE *fp;
3772 if (mode[0] == 'U')
3773 mode = "r" PY_STDIOTEXTMODE;
3774 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003775 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003776 }
3777 else {
3778 int fd = PyObject_AsFileDescriptor(fob);
3779 if (fd == -1)
3780 return NULL;
3781 if (!_PyVerify_fd(fd))
3782 goto error;
3783 /* the FILE struct gets a new fd, so that it can be closed
3784 * independently of the file descriptor given
3785 */
3786 fd = dup(fd);
3787 if (fd == -1)
3788 goto error;
3789 fp = fdopen(fd, mode);
3790 }
3791 if (fp)
3792 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003793error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003794 PyErr_SetFromErrno(PyExc_IOError);
3795 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003796}
3797
Guido van Rossum79f25d91997-04-29 20:08:16 +00003798static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003799imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003800{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003801 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003802 PyObject *fob = NULL;
3803 PyObject *m;
3804 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003805 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003806 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003807 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003808 &fob))
3809 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003810 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003811 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003812 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003813 return NULL;
3814 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003815 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003816 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003817 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003818 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003819}
3820
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003821#ifdef HAVE_DYNAMIC_LOADING
3822
Guido van Rossum79f25d91997-04-29 20:08:16 +00003823static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003824imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003825{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003826 PyObject *name, *pathname, *fob = NULL, *mod;
3827 FILE *fp;
3828
3829 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3830 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003831 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003832 if (fob != NULL) {
3833 fp = get_file(NULL, fob, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003834 if (fp == NULL) {
3835 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003836 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003837 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003838 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003839 else
3840 fp = NULL;
3841 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003842 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003843 if (fp)
3844 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003845 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003846}
3847
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003848#endif /* HAVE_DYNAMIC_LOADING */
3849
Guido van Rossum79f25d91997-04-29 20:08:16 +00003850static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003851imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003852{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003853 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003854 PyObject *fob = NULL;
3855 PyObject *m;
3856 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003857 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003858 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003859 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003860 &fob))
3861 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003862 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003863 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003864 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003865 return NULL;
3866 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003867 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003868 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003869 fclose(fp);
3870 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003871}
3872
Guido van Rossum79f25d91997-04-29 20:08:16 +00003873static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003874imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003875{
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003876 PyObject *name, *fob, *pathname, *pathname_obj, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003877 char *suffix; /* Unused */
3878 char *mode;
3879 int type;
3880 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003881
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003882 if (!PyArg_ParseTuple(args, "UOO(ssi):load_module",
3883 &name, &fob, &pathname_obj, &suffix, &mode, &type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003884 return NULL;
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003885 if (pathname_obj != Py_None) {
3886 if (!PyUnicode_FSDecoder(pathname_obj, &pathname))
3887 return NULL;
3888 }
3889 else
3890 pathname = NULL;
3891
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003892 if (*mode) {
3893 /* Mode must start with 'r' or 'U' and must not contain '+'.
3894 Implicit in this test is the assumption that the mode
3895 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003896
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003897 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3898 PyErr_Format(PyExc_ValueError,
3899 "invalid file open mode %.200s", mode);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003900 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003901 return NULL;
3902 }
3903 }
3904 if (fob == Py_None)
3905 fp = NULL;
3906 else {
3907 fp = get_file(NULL, fob, mode);
3908 if (fp == NULL) {
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003909 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003910 return NULL;
3911 }
3912 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003913 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003914 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003915 if (fp)
3916 fclose(fp);
3917 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003918}
3919
3920static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003921imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003922{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003923 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003924 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003925 if (!PyArg_ParseTuple(args, "UO&:load_package",
3926 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003927 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003928 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003929 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003930 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003931}
3932
3933static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003934imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003935{
Victor Stinnerfe19d212011-03-14 14:53:28 -04003936 PyObject *name;
3937 if (!PyArg_ParseTuple(args, "U:new_module", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003938 return NULL;
Victor Stinnerfe19d212011-03-14 14:53:28 -04003939 return PyModule_NewObject(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003940}
3941
Christian Heimes13a7a212008-01-07 17:13:09 +00003942static PyObject *
3943imp_reload(PyObject *self, PyObject *v)
3944{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003945 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003946}
3947
3948PyDoc_STRVAR(doc_reload,
3949"reload(module) -> module\n\
3950\n\
3951Reload the module. The module must have been successfully imported before.");
3952
Barry Warsaw28a691b2010-04-17 00:19:56 +00003953static PyObject *
3954imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3955{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003956 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003957
Victor Stinner2f42ae52011-03-20 00:41:24 +01003958 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003959 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003960 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003961
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003962 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003963 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003964 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003965 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003966
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003967 if (debug_override != NULL &&
3968 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003969 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003970 return NULL;
3971 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003972
Martin v. Löwis30260a72011-10-23 17:35:46 +02003973 if (PyUnicode_READY(pathname) < 0)
3974 return NULL;
3975
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003976 cpathname = make_compiled_pathname(pathname, debug);
Victor Stinner2f42ae52011-03-20 00:41:24 +01003977 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003978
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003979 if (cpathname == NULL) {
3980 PyErr_Format(PyExc_SystemError, "path buffer too short");
3981 return NULL;
3982 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003983 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003984}
3985
3986PyDoc_STRVAR(doc_cache_from_source,
3987"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3988\n\
3989The .py file does not need to exist; this simply returns the path to the\n\
3990.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3991will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3992\n\
3993If debug_override is not None, then it must be a boolean and is taken as\n\
3994the value of __debug__ instead.");
3995
3996static PyObject *
3997imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3998{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003999 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04004000 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00004001
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004002 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00004003 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04004004 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004005 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00004006
Victor Stinnerc9abda02011-03-14 13:33:46 -04004007 source = make_source_pathname(pathname);
4008 if (source == NULL) {
4009 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004010 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04004011 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004012 return NULL;
4013 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04004014 Py_DECREF(pathname);
4015 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00004016}
4017
4018PyDoc_STRVAR(doc_source_from_cache,
4019"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
4020\n\
4021The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
4022the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
4023does not conform to PEP 3147 format, ValueError will be raised.");
4024
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004025/* Doc strings */
4026
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004027PyDoc_STRVAR(doc_imp,
4028"This module provides the components needed to build your own\n\
4029__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004030
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004031PyDoc_STRVAR(doc_find_module,
4032"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004033Search for a module. If path is omitted or None, search for a\n\
4034built-in, frozen or special module and continue search in sys.path.\n\
4035The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004036package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004037
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004038PyDoc_STRVAR(doc_load_module,
4039"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004040Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004041The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004042
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004043PyDoc_STRVAR(doc_get_magic,
4044"get_magic() -> string\n\
4045Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004046
Barry Warsaw28a691b2010-04-17 00:19:56 +00004047PyDoc_STRVAR(doc_get_tag,
4048"get_tag() -> string\n\
4049Return the magic tag for .pyc or .pyo files.");
4050
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004051PyDoc_STRVAR(doc_get_suffixes,
4052"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004053Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004054that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004055
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004056PyDoc_STRVAR(doc_new_module,
4057"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004058Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004059The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004060
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004061PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00004062"lock_held() -> boolean\n\
4063Return True if the import lock is currently held, else False.\n\
4064On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00004065
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004066PyDoc_STRVAR(doc_acquire_lock,
4067"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00004068Acquires the interpreter's import lock for the current thread.\n\
4069This lock should be used by import hooks to ensure thread-safety\n\
4070when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004071On platforms without threads, this function does nothing.");
4072
4073PyDoc_STRVAR(doc_release_lock,
4074"release_lock() -> None\n\
4075Release the interpreter's import lock.\n\
4076On platforms without threads, this function does nothing.");
4077
Guido van Rossum79f25d91997-04-29 20:08:16 +00004078static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004079 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
4080 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
4081 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
4082 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
4083 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
4084 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
4085 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
4086 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
4087 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
4088 {"reload", imp_reload, METH_O, doc_reload},
4089 {"cache_from_source", (PyCFunction)imp_cache_from_source,
4090 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
4091 {"source_from_cache", (PyCFunction)imp_source_from_cache,
4092 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
4093 /* The rest are obsolete */
4094 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
4095 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
4096 {"init_builtin", imp_init_builtin, METH_VARARGS},
4097 {"init_frozen", imp_init_frozen, METH_VARARGS},
4098 {"is_builtin", imp_is_builtin, METH_VARARGS},
4099 {"is_frozen", imp_is_frozen, METH_VARARGS},
4100 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004101#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004102 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004103#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004104 {"load_package", imp_load_package, METH_VARARGS},
4105 {"load_source", imp_load_source, METH_VARARGS},
Brett Cannon442c9b92011-03-23 16:14:42 -07004106 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004107 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004108};
4109
Guido van Rossum1a8791e1998-08-04 22:46:29 +00004110static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004111setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004112{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004113 PyObject *v;
4114 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004115
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004116 v = PyLong_FromLong((long)value);
4117 err = PyDict_SetItemString(d, name, v);
4118 Py_XDECREF(v);
4119 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004120}
4121
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004122typedef struct {
4123 PyObject_HEAD
4124} NullImporter;
4125
4126static int
4127NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4128{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004129#ifndef MS_WINDOWS
4130 PyObject *path;
4131 struct stat statbuf;
4132 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004133
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004134 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4135 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004136
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004137 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4138 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004139 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004140
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004141 if (PyBytes_GET_SIZE(path) == 0) {
4142 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004143 PyErr_SetString(PyExc_ImportError, "empty pathname");
4144 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004145 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004146
4147 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4148 Py_DECREF(path);
4149 if (rv == 0) {
4150 /* it exists */
4151 if (S_ISDIR(statbuf.st_mode)) {
4152 /* it's a directory */
4153 PyErr_SetString(PyExc_ImportError, "existing directory");
4154 return -1;
4155 }
4156 }
4157#else /* MS_WINDOWS */
4158 PyObject *pathobj;
4159 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004160 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004161
4162 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4163 return -1;
4164
4165 if (!PyArg_ParseTuple(args, "U:NullImporter",
4166 &pathobj))
4167 return -1;
4168
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02004169 if (PyUnicode_GET_LENGTH(pathobj) == 0) {
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004170 PyErr_SetString(PyExc_ImportError, "empty pathname");
4171 return -1;
4172 }
4173
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004174 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004175 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004176 return -1;
4177 /* see issue1293 and issue3677:
4178 * stat() on Windows doesn't recognise paths like
4179 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4180 */
4181 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004182 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004183 if (rv != INVALID_FILE_ATTRIBUTES) {
4184 /* it exists */
4185 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4186 /* it's a directory */
4187 PyErr_SetString(PyExc_ImportError, "existing directory");
4188 return -1;
4189 }
4190 }
4191#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004192 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004193}
4194
4195static PyObject *
4196NullImporter_find_module(NullImporter *self, PyObject *args)
4197{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004198 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004199}
4200
4201static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004202 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4203 "Always return None"
4204 },
4205 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004206};
4207
4208
Christian Heimes9cd17752007-11-18 19:35:23 +00004209PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004210 PyVarObject_HEAD_INIT(NULL, 0)
4211 "imp.NullImporter", /*tp_name*/
4212 sizeof(NullImporter), /*tp_basicsize*/
4213 0, /*tp_itemsize*/
4214 0, /*tp_dealloc*/
4215 0, /*tp_print*/
4216 0, /*tp_getattr*/
4217 0, /*tp_setattr*/
4218 0, /*tp_reserved*/
4219 0, /*tp_repr*/
4220 0, /*tp_as_number*/
4221 0, /*tp_as_sequence*/
4222 0, /*tp_as_mapping*/
4223 0, /*tp_hash */
4224 0, /*tp_call*/
4225 0, /*tp_str*/
4226 0, /*tp_getattro*/
4227 0, /*tp_setattro*/
4228 0, /*tp_as_buffer*/
4229 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4230 "Null importer object", /* tp_doc */
4231 0, /* tp_traverse */
4232 0, /* tp_clear */
4233 0, /* tp_richcompare */
4234 0, /* tp_weaklistoffset */
4235 0, /* tp_iter */
4236 0, /* tp_iternext */
4237 NullImporter_methods, /* tp_methods */
4238 0, /* tp_members */
4239 0, /* tp_getset */
4240 0, /* tp_base */
4241 0, /* tp_dict */
4242 0, /* tp_descr_get */
4243 0, /* tp_descr_set */
4244 0, /* tp_dictoffset */
4245 (initproc)NullImporter_init, /* tp_init */
4246 0, /* tp_alloc */
4247 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004248};
4249
Martin v. Löwis1a214512008-06-11 05:26:20 +00004250static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004251 PyModuleDef_HEAD_INIT,
4252 "imp",
4253 doc_imp,
4254 0,
4255 imp_methods,
4256 NULL,
4257 NULL,
4258 NULL,
4259 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004260};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004261
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004262PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004263PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004264{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004265 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004266
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004267 if (PyType_Ready(&PyNullImporter_Type) < 0)
4268 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004269
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004270 m = PyModule_Create(&impmodule);
4271 if (m == NULL)
4272 goto failure;
4273 d = PyModule_GetDict(m);
4274 if (d == NULL)
4275 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004276
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004277 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4278 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4279 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4280 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4281 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4282 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4283 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4284 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4285 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4286 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004287
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004288 Py_INCREF(&PyNullImporter_Type);
4289 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4290 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004291 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004292 Py_XDECREF(m);
4293 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004294}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004295
4296
Guido van Rossumb18618d2000-05-03 23:44:39 +00004297/* API for embedding applications that want to add their own entries
4298 to the table of built-in modules. This should normally be called
4299 *before* Py_Initialize(). When the table resize fails, -1 is
4300 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004301
4302 After a similar function by Just van Rossum. */
4303
4304int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004305PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004306{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004307 static struct _inittab *our_copy = NULL;
4308 struct _inittab *p;
4309 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004310
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004311 /* Count the number of entries in both tables */
4312 for (n = 0; newtab[n].name != NULL; n++)
4313 ;
4314 if (n == 0)
4315 return 0; /* Nothing to do */
4316 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4317 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004318
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004319 /* Allocate new memory for the combined table */
4320 p = our_copy;
4321 PyMem_RESIZE(p, struct _inittab, i+n+1);
4322 if (p == NULL)
4323 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004324
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004325 /* Copy the tables into the new memory */
4326 if (our_copy != PyImport_Inittab)
4327 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4328 PyImport_Inittab = our_copy = p;
4329 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004330
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004331 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004332}
4333
4334/* Shorthand to add a single entry given a name and a function */
4335
4336int
Brett Cannona826f322009-04-02 03:41:46 +00004337PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004338{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004339 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004340
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004341 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004342
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004343 newtab[0].name = (char *)name;
4344 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004345
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004346 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004347}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004348
4349#ifdef __cplusplus
4350}
4351#endif