blob: 71992300987b9597d520cd216da00af19244392a [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
Antoine Pitrou86a36b52011-11-25 18:56:07 +0100106 Python 3.3a0 3200 (__qualname__ added)
Tim Peters36515e22001-11-18 04:06:29 +0000107*/
Guido van Rossum3ddee711991-12-16 13:06:34 +0000108
Nick Coghlancd419ab2010-09-11 00:39:25 +0000109/* MAGIC must change whenever the bytecode emitted by the compiler may no
110 longer be understood by older implementations of the eval loop (usually
111 due to the addition of new opcodes)
Martin v. Löwisfadcd312011-10-23 18:08:20 +0200112 TAG must change for each major Python release. The magic number will take
113 care of any bytecode changes that occur during development.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000114*/
Benjamin Peterson48deae12011-06-03 17:50:16 -0500115#define QUOTE(arg) #arg
116#define STRIFY(name) QUOTE(name)
117#define MAJOR STRIFY(PY_MAJOR_VERSION)
118#define MINOR STRIFY(PY_MINOR_VERSION)
Antoine Pitrou86a36b52011-11-25 18:56:07 +0100119#define MAGIC (3200 | ((long)'\r'<<16) | ((long)'\n'<<24))
Benjamin Peterson48deae12011-06-03 17:50:16 -0500120#define TAG "cpython-" MAJOR MINOR;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000121#define CACHEDIR "__pycache__"
122/* Current magic word and string tag as globals. */
Guido van Rossum96774c12000-05-01 20:19:08 +0000123static long pyc_magic = MAGIC;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000124static const char *pyc_tag = TAG;
Benjamin Peterson48deae12011-06-03 17:50:16 -0500125#undef QUOTE
126#undef STRIFY
127#undef MAJOR
128#undef MINOR
Guido van Rossum96774c12000-05-01 20:19:08 +0000129
Victor Stinner95872862011-03-07 18:20:56 +0100130/* See _PyImport_FixupExtensionObject() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +0000131static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000132
Victor Stinnerfe7c5b52011-04-05 01:48:03 +0200133/* Function from Parser/tokenizer.c */
134extern char * PyTokenizer_FindEncodingFilename(int, PyObject *);
135
Guido van Rossum771c6c81997-10-31 18:37:24 +0000136/* This table is defined in config.c: */
137extern struct _inittab _PyImport_Inittab[];
138
139struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +0000140
Guido van Rossumed1170e1999-12-20 21:23:41 +0000141/* these tables define the module suffixes that Python recognizes */
142struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000143
Guido van Rossumed1170e1999-12-20 21:23:41 +0000144static const struct filedescr _PyImport_StandardFiletab[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000145 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000146#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000147 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000148#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000149 {".pyc", "rb", PY_COMPILED},
150 {0, 0}
Guido van Rossumed1170e1999-12-20 21:23:41 +0000151};
152
Victor Stinnerd0296212011-03-14 14:04:10 -0400153static PyObject *initstr = NULL;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200154_Py_IDENTIFIER(__path__);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000155
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000156/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000157
158void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000159_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000160{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000161 const struct filedescr *scan;
162 struct filedescr *filetab;
163 int countD = 0;
164 int countS = 0;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000165
Victor Stinnerd0296212011-03-14 14:04:10 -0400166 initstr = PyUnicode_InternFromString("__init__");
167 if (initstr == NULL)
168 Py_FatalError("Can't initialize import variables");
169
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000170 /* prepare _PyImport_Filetab: copy entries from
171 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
172 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000173#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000174 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
175 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000176#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000177 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
178 ++countS;
179 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
180 if (filetab == NULL)
181 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000182#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000183 memcpy(filetab, _PyImport_DynLoadFiletab,
184 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000185#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 memcpy(filetab + countD, _PyImport_StandardFiletab,
187 countS * sizeof(struct filedescr));
188 filetab[countD + countS].suffix = NULL;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000189
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000190 _PyImport_Filetab = filetab;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000191
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000192 if (Py_OptimizeFlag) {
193 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
194 for (; filetab->suffix != NULL; filetab++) {
195 if (strcmp(filetab->suffix, ".pyc") == 0)
196 filetab->suffix = ".pyo";
197 }
198 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000199}
200
Guido van Rossum25ce5661997-08-02 03:10:38 +0000201void
Just van Rossum52e14d62002-12-30 22:08:05 +0000202_PyImportHooks_Init(void)
203{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000204 PyObject *v, *path_hooks = NULL, *zimpimport;
205 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +0000206
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000207 /* adding sys.path_hooks and sys.path_importer_cache, setting up
208 zipimport */
209 if (PyType_Ready(&PyNullImporter_Type) < 0)
210 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000211
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000212 if (Py_VerboseFlag)
213 PySys_WriteStderr("# installing zipimport hook\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000215 v = PyList_New(0);
216 if (v == NULL)
217 goto error;
218 err = PySys_SetObject("meta_path", v);
219 Py_DECREF(v);
220 if (err)
221 goto error;
222 v = PyDict_New();
223 if (v == NULL)
224 goto error;
225 err = PySys_SetObject("path_importer_cache", v);
226 Py_DECREF(v);
227 if (err)
228 goto error;
229 path_hooks = PyList_New(0);
230 if (path_hooks == NULL)
231 goto error;
232 err = PySys_SetObject("path_hooks", path_hooks);
233 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +0000234 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000235 PyErr_Print();
236 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
237 "path_importer_cache, or NullImporter failed"
238 );
239 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000240
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000241 zimpimport = PyImport_ImportModule("zipimport");
242 if (zimpimport == NULL) {
243 PyErr_Clear(); /* No zip import module -- okay */
244 if (Py_VerboseFlag)
245 PySys_WriteStderr("# can't import zipimport\n");
246 }
247 else {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200248 _Py_IDENTIFIER(zipimporter);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200249 PyObject *zipimporter = _PyObject_GetAttrId(zimpimport,
250 &PyId_zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000251 Py_DECREF(zimpimport);
252 if (zipimporter == NULL) {
253 PyErr_Clear(); /* No zipimporter object -- okay */
254 if (Py_VerboseFlag)
255 PySys_WriteStderr(
256 "# can't import zipimport.zipimporter\n");
257 }
258 else {
259 /* sys.path_hooks.append(zipimporter) */
260 err = PyList_Append(path_hooks, zipimporter);
261 Py_DECREF(zipimporter);
262 if (err)
263 goto error;
264 if (Py_VerboseFlag)
265 PySys_WriteStderr(
266 "# installed zipimport hook\n");
267 }
268 }
269 Py_DECREF(path_hooks);
Just van Rossum52e14d62002-12-30 22:08:05 +0000270}
271
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000272/* Locking primitives to prevent parallel imports of the same module
273 in different threads to return with a partially loaded module.
274 These calls are serialized by the global interpreter lock. */
275
276#ifdef WITH_THREAD
277
Guido van Rossum49b56061998-10-01 20:42:43 +0000278#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000279
Guido van Rossum65d5b571998-12-21 19:32:43 +0000280static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000281static long import_lock_thread = -1;
282static int import_lock_level = 0;
283
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000284void
285_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000286{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000287 long me = PyThread_get_thread_ident();
288 if (me == -1)
289 return; /* Too bad */
290 if (import_lock == NULL) {
291 import_lock = PyThread_allocate_lock();
292 if (import_lock == NULL)
293 return; /* Nothing much we can do. */
294 }
295 if (import_lock_thread == me) {
296 import_lock_level++;
297 return;
298 }
299 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
300 {
301 PyThreadState *tstate = PyEval_SaveThread();
302 PyThread_acquire_lock(import_lock, 1);
303 PyEval_RestoreThread(tstate);
304 }
305 import_lock_thread = me;
306 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000307}
308
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000309int
310_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000311{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000312 long me = PyThread_get_thread_ident();
313 if (me == -1 || import_lock == NULL)
314 return 0; /* Too bad */
315 if (import_lock_thread != me)
316 return -1;
317 import_lock_level--;
318 if (import_lock_level == 0) {
319 import_lock_thread = -1;
320 PyThread_release_lock(import_lock);
321 }
322 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000323}
324
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000325/* This function is called from PyOS_AfterFork to ensure that newly
326 created child processes do not share locks with the parent.
327 We now acquire the import lock around fork() calls but on some platforms
328 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000329
330void
331_PyImport_ReInitLock(void)
332{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000333 if (import_lock != NULL)
334 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000335 if (import_lock_level > 1) {
336 /* Forked as a side effect of import */
337 long me = PyThread_get_thread_ident();
338 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100339 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000340 import_lock_thread = me;
341 import_lock_level--;
342 } else {
343 import_lock_thread = -1;
344 import_lock_level = 0;
345 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000346}
347
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000348#endif
349
Tim Peters69232342001-08-30 05:16:13 +0000350static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000351imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000352{
Tim Peters69232342001-08-30 05:16:13 +0000353#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000354 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000355#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000356 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000357#endif
358}
359
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000360static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000361imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000362{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000363#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000364 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000365#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000366 Py_INCREF(Py_None);
367 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000368}
369
370static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000371imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000372{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000373#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000374 if (_PyImport_ReleaseLock() < 0) {
375 PyErr_SetString(PyExc_RuntimeError,
376 "not holding the import lock");
377 return NULL;
378 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000379#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000380 Py_INCREF(Py_None);
381 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000382}
383
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100384void
385_PyImport_Fini(void)
386{
387 Py_XDECREF(extensions);
388 extensions = NULL;
389 PyMem_DEL(_PyImport_Filetab);
390 _PyImport_Filetab = NULL;
391#ifdef WITH_THREAD
392 if (import_lock != NULL) {
393 PyThread_free_lock(import_lock);
394 import_lock = NULL;
395 }
396#endif
397}
398
Guido van Rossumd8faa362007-04-27 19:54:29 +0000399static void
400imp_modules_reloading_clear(void)
401{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000402 PyInterpreterState *interp = PyThreadState_Get()->interp;
403 if (interp->modules_reloading != NULL)
404 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000405}
406
Guido van Rossum25ce5661997-08-02 03:10:38 +0000407/* Helper for sys */
408
409PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000410PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000411{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000412 PyInterpreterState *interp = PyThreadState_GET()->interp;
413 if (interp->modules == NULL)
414 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
415 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000416}
417
Guido van Rossum3f5da241990-12-20 15:06:42 +0000418
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000419/* List of names to clear in sys */
420static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000421 "path", "argv", "ps1", "ps2",
422 "last_type", "last_value", "last_traceback",
423 "path_hooks", "path_importer_cache", "meta_path",
424 /* misc stuff */
425 "flags", "float_info",
426 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000427};
428
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000429static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000430 "stdin", "__stdin__",
431 "stdout", "__stdout__",
432 "stderr", "__stderr__",
433 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000434};
435
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000436
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000437/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000438
Guido van Rossum3f5da241990-12-20 15:06:42 +0000439void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000440PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000441{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000442 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000443 PyObject *key, *value, *dict;
444 PyInterpreterState *interp = PyThreadState_GET()->interp;
445 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000447 if (modules == NULL)
448 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000450 /* Delete some special variables first. These are common
451 places where user values hide and people complain when their
452 destructors fail. Since the modules containing them are
453 deleted *last* of all, they would come too late in the normal
454 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 value = PyDict_GetItemString(modules, "builtins");
457 if (value != NULL && PyModule_Check(value)) {
458 dict = PyModule_GetDict(value);
459 if (Py_VerboseFlag)
460 PySys_WriteStderr("# clear builtins._\n");
461 PyDict_SetItemString(dict, "_", Py_None);
462 }
463 value = PyDict_GetItemString(modules, "sys");
464 if (value != NULL && PyModule_Check(value)) {
465 char **p;
466 PyObject *v;
467 dict = PyModule_GetDict(value);
468 for (p = sys_deletes; *p != NULL; p++) {
469 if (Py_VerboseFlag)
470 PySys_WriteStderr("# clear sys.%s\n", *p);
471 PyDict_SetItemString(dict, *p, Py_None);
472 }
473 for (p = sys_files; *p != NULL; p+=2) {
474 if (Py_VerboseFlag)
475 PySys_WriteStderr("# restore sys.%s\n", *p);
476 v = PyDict_GetItemString(dict, *(p+1));
477 if (v == NULL)
478 v = Py_None;
479 PyDict_SetItemString(dict, *p, v);
480 }
481 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000482
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000483 /* First, delete __main__ */
484 value = PyDict_GetItemString(modules, "__main__");
485 if (value != NULL && PyModule_Check(value)) {
486 if (Py_VerboseFlag)
487 PySys_WriteStderr("# cleanup __main__\n");
488 _PyModule_Clear(value);
489 PyDict_SetItemString(modules, "__main__", Py_None);
490 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000491
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000492 /* The special treatment of "builtins" here is because even
493 when it's not referenced as a module, its dictionary is
494 referenced by almost every module's __builtins__. Since
495 deleting a module clears its dictionary (even if there are
496 references left to it), we need to delete the "builtins"
497 module last. Likewise, we don't delete sys until the very
498 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000499
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000500 Also note that we 'delete' modules by replacing their entry
501 in the modules dict with None, rather than really deleting
502 them; this avoids a rehash of the modules dictionary and
503 also marks them as "non existent" so they won't be
504 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000505
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000506 /* Next, repeatedly delete modules with a reference count of
507 one (skipping builtins and sys) and delete them */
508 do {
509 ndone = 0;
510 pos = 0;
511 while (PyDict_Next(modules, &pos, &key, &value)) {
512 if (value->ob_refcnt != 1)
513 continue;
514 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100515 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000516 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100517 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000518 continue;
519 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100520 PySys_FormatStderr(
521 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000522 _PyModule_Clear(value);
523 PyDict_SetItem(modules, key, Py_None);
524 ndone++;
525 }
526 }
527 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000529 /* Next, delete all modules (still skipping builtins and sys) */
530 pos = 0;
531 while (PyDict_Next(modules, &pos, &key, &value)) {
532 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100533 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000534 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100535 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000536 continue;
537 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100538 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000539 _PyModule_Clear(value);
540 PyDict_SetItem(modules, key, Py_None);
541 }
542 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000543
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000544 /* Next, delete sys and builtins (in that order) */
545 value = PyDict_GetItemString(modules, "sys");
546 if (value != NULL && PyModule_Check(value)) {
547 if (Py_VerboseFlag)
548 PySys_WriteStderr("# cleanup sys\n");
549 _PyModule_Clear(value);
550 PyDict_SetItemString(modules, "sys", Py_None);
551 }
552 value = PyDict_GetItemString(modules, "builtins");
553 if (value != NULL && PyModule_Check(value)) {
554 if (Py_VerboseFlag)
555 PySys_WriteStderr("# cleanup builtins\n");
556 _PyModule_Clear(value);
557 PyDict_SetItemString(modules, "builtins", Py_None);
558 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000559
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000560 /* Finally, clear and delete the modules directory */
561 PyDict_Clear(modules);
562 interp->modules = NULL;
563 Py_DECREF(modules);
564 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000565}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000566
567
Barry Warsaw28a691b2010-04-17 00:19:56 +0000568/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000569
570long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000571PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000572{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000573 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000574}
575
576
Barry Warsaw28a691b2010-04-17 00:19:56 +0000577const char *
578PyImport_GetMagicTag(void)
579{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000580 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000581}
582
Guido van Rossum25ce5661997-08-02 03:10:38 +0000583/* Magic for extension modules (built-in as well as dynamically
584 loaded). To prevent initializing an extension module more than
585 once, we keep a static dictionary 'extensions' keyed by module name
586 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000587 modules), containing these modules. A copy of the module's
Victor Stinner95872862011-03-07 18:20:56 +0100588 dictionary is stored by calling _PyImport_FixupExtensionObject()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000589 immediately after the module initialization function succeeds. A
590 copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100591 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000592
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000593 Modules which do support multiple initialization set their m_size
594 field to a non-negative number (indicating the size of the
595 module-specific state). They are still recorded in the extensions
596 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000597*/
598
599int
Victor Stinner95872862011-03-07 18:20:56 +0100600_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
601 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000602{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000603 PyObject *modules, *dict;
604 struct PyModuleDef *def;
605 if (extensions == NULL) {
606 extensions = PyDict_New();
607 if (extensions == NULL)
608 return -1;
609 }
610 if (mod == NULL || !PyModule_Check(mod)) {
611 PyErr_BadInternalCall();
612 return -1;
613 }
614 def = PyModule_GetDef(mod);
615 if (!def) {
616 PyErr_BadInternalCall();
617 return -1;
618 }
619 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100620 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000621 return -1;
622 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100623 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000624 return -1;
625 }
626 if (def->m_size == -1) {
627 if (def->m_base.m_copy) {
628 /* Somebody already imported the module,
629 likely under a different name.
630 XXX this should really not happen. */
631 Py_DECREF(def->m_base.m_copy);
632 def->m_base.m_copy = NULL;
633 }
634 dict = PyModule_GetDict(mod);
635 if (dict == NULL)
636 return -1;
637 def->m_base.m_copy = PyDict_Copy(dict);
638 if (def->m_base.m_copy == NULL)
639 return -1;
640 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000641 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000642 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000643}
644
Victor Stinner49d3f252010-10-17 01:24:53 +0000645int
646_PyImport_FixupBuiltin(PyObject *mod, char *name)
647{
648 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100649 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100650 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100651 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000652 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100653 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
654 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000655 return res;
656}
657
Guido van Rossum25ce5661997-08-02 03:10:38 +0000658PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100659_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000660{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000661 PyObject *mod, *mdict;
662 PyModuleDef* def;
663 if (extensions == NULL)
664 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000665 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000666 if (def == NULL)
667 return NULL;
668 if (def->m_size == -1) {
669 /* Module does not support repeated initialization */
670 if (def->m_base.m_copy == NULL)
671 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100672 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000673 if (mod == NULL)
674 return NULL;
675 mdict = PyModule_GetDict(mod);
676 if (mdict == NULL)
677 return NULL;
678 if (PyDict_Update(mdict, def->m_base.m_copy))
679 return NULL;
680 }
681 else {
682 if (def->m_base.m_init == NULL)
683 return NULL;
684 mod = def->m_base.m_init();
685 if (mod == NULL)
686 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100687 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000688 Py_DECREF(mod);
689 }
690 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100691 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000692 Py_DECREF(mod);
693 return NULL;
694 }
695 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100696 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000697 name, filename);
698 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000699
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000700}
701
Victor Stinner49d3f252010-10-17 01:24:53 +0000702PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000703_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000704{
Victor Stinner95872862011-03-07 18:20:56 +0100705 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100706 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100707 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000708 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100709 res = _PyImport_FindExtensionObject(nameobj, nameobj);
710 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000711 return res;
712}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000713
714/* Get the module object corresponding to a module name.
715 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000716 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000717 Because the former action is most common, THIS DOES NOT RETURN A
718 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000719
Guido van Rossum79f25d91997-04-29 20:08:16 +0000720PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000721PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000722{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000723 PyObject *modules = PyImport_GetModuleDict();
724 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000725
Victor Stinner27ee0892011-03-04 12:57:09 +0000726 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000727 PyModule_Check(m))
728 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000729 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000730 if (m == NULL)
731 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000732 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000733 Py_DECREF(m);
734 return NULL;
735 }
736 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000737
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000738 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000739}
740
Victor Stinner27ee0892011-03-04 12:57:09 +0000741PyObject *
742PyImport_AddModule(const char *name)
743{
744 PyObject *nameobj, *module;
745 nameobj = PyUnicode_FromString(name);
746 if (nameobj == NULL)
747 return NULL;
748 module = PyImport_AddModuleObject(nameobj);
749 Py_DECREF(nameobj);
750 return module;
751}
752
753
Tim Peters1cd70172004-08-02 03:52:12 +0000754/* Remove name from sys.modules, if it's there. */
755static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000756remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000757{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000758 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000759 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000760 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000761 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000762 Py_FatalError("import: deleting existing key in"
763 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000764}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000765
Victor Stinnerc9abda02011-03-14 13:33:46 -0400766static PyObject * get_sourcefile(PyObject *filename);
767static PyObject *make_source_pathname(PyObject *pathname);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200768static PyObject* make_compiled_pathname(PyObject *pathname, int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000769
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000770/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000771 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
772 * removed from sys.modules, to avoid leaving damaged module objects
773 * in sys.modules. The caller may wish to restore the original
774 * module object (if any) in this case; PyImport_ReloadModule is an
775 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000776 *
777 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
778 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000779 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000780PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000781PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000782{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000783 return PyImport_ExecCodeModuleWithPathnames(
784 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000785}
786
787PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000788PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000789{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000790 return PyImport_ExecCodeModuleWithPathnames(
791 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000792}
793
794PyObject *
795PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000796 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000797{
Victor Stinner27ee0892011-03-04 12:57:09 +0000798 PyObject *m = NULL;
799 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
800
801 nameobj = PyUnicode_FromString(name);
802 if (nameobj == NULL)
803 return NULL;
804
805 if (pathname != NULL) {
806 pathobj = PyUnicode_DecodeFSDefault(pathname);
807 if (pathobj == NULL)
808 goto error;
809 } else
810 pathobj = NULL;
811 if (cpathname != NULL) {
812 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
813 if (cpathobj == NULL)
814 goto error;
815 } else
816 cpathobj = NULL;
817 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
818error:
819 Py_DECREF(nameobj);
820 Py_XDECREF(pathobj);
821 Py_XDECREF(cpathobj);
822 return m;
823}
824
825PyObject*
826PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
827 PyObject *cpathname)
828{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000829 PyObject *modules = PyImport_GetModuleDict();
830 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000831
Victor Stinner27ee0892011-03-04 12:57:09 +0000832 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000833 if (m == NULL)
834 return NULL;
835 /* If the module is being reloaded, we get the old module back
836 and re-use its dict to exec the new code. */
837 d = PyModule_GetDict(m);
838 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
839 if (PyDict_SetItemString(d, "__builtins__",
840 PyEval_GetBuiltins()) != 0)
841 goto error;
842 }
843 /* Remember the filename as the __file__ attribute */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000844 if (pathname != NULL) {
Victor Stinnerc9abda02011-03-14 13:33:46 -0400845 v = get_sourcefile(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000846 if (v == NULL)
847 PyErr_Clear();
848 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000849 else
850 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000851 if (v == NULL) {
852 v = ((PyCodeObject *)co)->co_filename;
853 Py_INCREF(v);
854 }
855 if (PyDict_SetItemString(d, "__file__", v) != 0)
856 PyErr_Clear(); /* Not important enough to report */
857 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000858
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000859 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000860 if (cpathname != NULL)
861 v = cpathname;
862 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000863 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000864 if (PyDict_SetItemString(d, "__cached__", v) != 0)
865 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000866
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000867 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000868 if (v == NULL)
869 goto error;
870 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000871
Victor Stinner27ee0892011-03-04 12:57:09 +0000872 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000873 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000874 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000875 name);
876 return NULL;
877 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000878
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000879 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000880
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000881 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000882
883 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 remove_module(name);
885 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000886}
887
888
Barry Warsaw28a691b2010-04-17 00:19:56 +0000889/* Like strrchr(string, '/') but searches for the rightmost of either SEP
890 or ALTSEP, if the latter is defined.
891*/
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200892static Py_UCS4*
893rightmost_sep(Py_UCS4 *s)
Victor Stinnerc9abda02011-03-14 13:33:46 -0400894{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200895 Py_UCS4 *found, c;
Victor Stinnerc9abda02011-03-14 13:33:46 -0400896 for (found = NULL; (c = *s); s++) {
897 if (c == SEP
898#ifdef ALTSEP
899 || c == ALTSEP
900#endif
901 )
902 {
903 found = s;
904 }
905 }
906 return found;
907}
908
Martin v. Löwis2db72862011-10-23 17:29:08 +0200909/* Like rightmost_sep, but operate on unicode objects. */
910static Py_ssize_t
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200911rightmost_sep_obj(PyObject* o, Py_ssize_t start, Py_ssize_t end)
Martin v. Löwis2db72862011-10-23 17:29:08 +0200912{
913 Py_ssize_t found, i;
914 Py_UCS4 c;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200915 for (found = -1, i = start; i < end; i++) {
Martin v. Löwis2db72862011-10-23 17:29:08 +0200916 c = PyUnicode_READ_CHAR(o, i);
917 if (c == SEP
918#ifdef ALTSEP
919 || c == ALTSEP
920#endif
921 )
922 {
923 found = i;
924 }
925 }
926 return found;
927}
Victor Stinnerc9abda02011-03-14 13:33:46 -0400928
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000929/* Given a pathname for a Python source file, fill a buffer with the
930 pathname for the corresponding compiled file. Return the pathname
931 for the compiled file, or NULL if there's no space in the buffer.
Victor Stinner2f42ae52011-03-20 00:41:24 +0100932 Doesn't set an exception.
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000933
Martin v. Löwis30260a72011-10-23 17:35:46 +0200934 foo.py -> __pycache__/foo.<tag>.pyc
935
936 pathstr is assumed to be "ready".
937*/
Victor Stinner2f42ae52011-03-20 00:41:24 +0100938
939static PyObject*
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200940make_compiled_pathname(PyObject *pathstr, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000941{
Martin v. Löwis2db72862011-10-23 17:29:08 +0200942 PyObject *result;
943 Py_ssize_t fname, ext, len, i, pos, taglen;
Martin v. Löwisfadcd312011-10-23 18:08:20 +0200944 Py_ssize_t pycache_len = sizeof(CACHEDIR) - 1;
Martin v. Löwis2db72862011-10-23 17:29:08 +0200945 int kind;
946 void *data;
Antoine Pitroub528fcf2011-10-25 00:21:02 +0200947 Py_UCS4 lastsep;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000948
Martin v. Löwis2db72862011-10-23 17:29:08 +0200949 /* Compute the output string size. */
950 len = PyUnicode_GET_LENGTH(pathstr);
951 /* If there is no separator, this returns -1, so
Antoine Pitroub528fcf2011-10-25 00:21:02 +0200952 fname will be 0. */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200953 fname = rightmost_sep_obj(pathstr, 0, len) + 1;
Antoine Pitroub528fcf2011-10-25 00:21:02 +0200954 /* Windows: re-use the last separator character (/ or \\) when
955 appending the __pycache__ path. */
956 if (fname > 0)
957 lastsep = PyUnicode_READ_CHAR(pathstr, fname -1);
958 else
959 lastsep = SEP;
Martin v. Löwis2db72862011-10-23 17:29:08 +0200960 ext = fname - 1;
961 for(i = fname; i < len; i++)
962 if (PyUnicode_READ_CHAR(pathstr, i) == '.')
963 ext = i + 1;
964 if (ext < fname)
965 /* No dot in filename; use entire filename */
966 ext = len;
967
968 /* result = pathstr[:fname] + "__pycache__" + SEP +
969 pathstr[fname:ext] + tag + ".py[co]" */
970 taglen = strlen(pyc_tag);
Martin v. Löwis2cc0cc52011-10-23 18:41:56 +0200971 result = PyUnicode_New(ext + pycache_len + 1 + taglen + 4,
Martin v. Löwis2db72862011-10-23 17:29:08 +0200972 PyUnicode_MAX_CHAR_VALUE(pathstr));
973 if (!result)
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200974 return NULL;
Martin v. Löwis2db72862011-10-23 17:29:08 +0200975 kind = PyUnicode_KIND(result);
976 data = PyUnicode_DATA(result);
977 PyUnicode_CopyCharacters(result, 0, pathstr, 0, fname);
978 pos = fname;
Martin v. Löwis2cc0cc52011-10-23 18:41:56 +0200979 for (i = 0; i < pycache_len; i++)
Martin v. Löwisfadcd312011-10-23 18:08:20 +0200980 PyUnicode_WRITE(kind, data, pos++, CACHEDIR[i]);
Antoine Pitroub528fcf2011-10-25 00:21:02 +0200981 PyUnicode_WRITE(kind, data, pos++, lastsep);
Martin v. Löwis2db72862011-10-23 17:29:08 +0200982 PyUnicode_CopyCharacters(result, pos, pathstr,
983 fname, ext - fname);
984 pos += ext - fname;
985 for (i = 0; pyc_tag[i]; i++)
986 PyUnicode_WRITE(kind, data, pos++, pyc_tag[i]);
987 PyUnicode_WRITE(kind, data, pos++, '.');
988 PyUnicode_WRITE(kind, data, pos++, 'p');
989 PyUnicode_WRITE(kind, data, pos++, 'y');
990 PyUnicode_WRITE(kind, data, pos++, debug ? 'c' : 'o');
991 return result;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000992}
993
994
Barry Warsaw28a691b2010-04-17 00:19:56 +0000995/* Given a pathname to a Python byte compiled file, return the path to the
996 source file, if the path matches the PEP 3147 format. This does not check
997 for any file existence, however, if the pyc file name does not match PEP
998 3147 style, NULL is returned. buf must be at least as big as pathname;
Victor Stinnerc9abda02011-03-14 13:33:46 -0400999 the resulting path will always be shorter.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001000
Victor Stinnerc9abda02011-03-14 13:33:46 -04001001 (...)/__pycache__/foo.<tag>.pyc -> (...)/foo.py */
1002
1003static PyObject*
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001004make_source_pathname(PyObject *path)
Barry Warsaw28a691b2010-04-17 00:19:56 +00001005{
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001006 Py_ssize_t left, right, dot0, dot1, len;
1007 Py_ssize_t i, j;
1008 PyObject *result;
1009 int kind;
1010 void *data;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001011
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001012 len = PyUnicode_GET_LENGTH(path);
1013 if (len > MAXPATHLEN)
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001014 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001015
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001016 /* Look back two slashes from the end. In between these two slashes
1017 must be the string __pycache__ or this is not a PEP 3147 style
1018 path. It's possible for there to be only one slash.
1019 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001020 right = rightmost_sep_obj(path, 0, len);
1021 if (right == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001022 return NULL;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001023 left = rightmost_sep_obj(path, 0, right);
1024 if (left == -1)
1025 left = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001026 else
1027 left++;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001028 if (right-left != sizeof(CACHEDIR)-1)
1029 return NULL;
1030 for (i = 0; i < sizeof(CACHEDIR)-1; i++)
1031 if (PyUnicode_READ_CHAR(path, left+i) != CACHEDIR[i])
1032 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001033
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001034 /* Now verify that the path component to the right of the last slash
1035 has two dots in it.
1036 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001037 dot0 = PyUnicode_FindChar(path, '.', right+1, len, 1);
1038 if (dot0 < 0)
1039 return NULL;
1040 dot1 = PyUnicode_FindChar(path, '.', dot0+1, len, 1);
1041 if (dot1 < 0)
1042 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001043 /* Too many dots? */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001044 if (PyUnicode_FindChar(path, '.', dot1+1, len, 1) != -1)
1045 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001046
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001047 /* This is a PEP 3147 path. Start by copying everything from the
1048 start of pathname up to and including the leftmost slash. Then
1049 copy the file's basename, removing the magic tag and adding a .py
1050 suffix.
1051 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001052 result = PyUnicode_New(left + (dot0-right) + 2,
1053 PyUnicode_MAX_CHAR_VALUE(path));
1054 if (!result)
1055 return NULL;
1056 kind = PyUnicode_KIND(result);
1057 data = PyUnicode_DATA(result);
1058 PyUnicode_CopyCharacters(result, 0, path, 0, (i = left));
1059 PyUnicode_CopyCharacters(result, left, path, right+1,
1060 (j = dot0-right));
1061 PyUnicode_WRITE(kind, data, i+j, 'p');
1062 PyUnicode_WRITE(kind, data, i+j+1, 'y');
1063 return result;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001064}
1065
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001066/* Given a pathname for a Python source file, its time of last
1067 modification, and a pathname for a compiled file, check whether the
1068 compiled file represents the same version of the source. If so,
1069 return a FILE pointer for the compiled file, positioned just after
1070 the header; if not, return NULL.
1071 Doesn't set an exception. */
1072
1073static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001074check_compiled_module(PyObject *pathname, time_t mtime, PyObject *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001075{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001076 FILE *fp;
1077 long magic;
1078 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001079
Victor Stinner2f42ae52011-03-20 00:41:24 +01001080 fp = _Py_fopen(cpathname, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001081 if (fp == NULL)
1082 return NULL;
1083 magic = PyMarshal_ReadLongFromFile(fp);
1084 if (magic != pyc_magic) {
1085 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001086 PySys_FormatStderr("# %R has bad magic\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001087 fclose(fp);
1088 return NULL;
1089 }
1090 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
1091 if (pyc_mtime != mtime) {
1092 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001093 PySys_FormatStderr("# %R has bad mtime\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001094 fclose(fp);
1095 return NULL;
1096 }
1097 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001098 PySys_FormatStderr("# %R matches %R\n", cpathname, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001099 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001100}
1101
1102
1103/* Read a code object from a file and check it for validity */
1104
Guido van Rossum79f25d91997-04-29 20:08:16 +00001105static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001106read_compiled_module(PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001107{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001108 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001109
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001110 co = PyMarshal_ReadLastObjectFromFile(fp);
1111 if (co == NULL)
1112 return NULL;
1113 if (!PyCode_Check(co)) {
1114 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001115 "Non-code object in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001116 Py_DECREF(co);
1117 return NULL;
1118 }
1119 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001120}
1121
1122
1123/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001124 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001125
Guido van Rossum79f25d91997-04-29 20:08:16 +00001126static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001127load_compiled_module(PyObject *name, PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001128{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001129 long magic;
1130 PyCodeObject *co;
1131 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001132
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001133 magic = PyMarshal_ReadLongFromFile(fp);
1134 if (magic != pyc_magic) {
1135 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001136 "Bad magic number in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001137 return NULL;
1138 }
1139 (void) PyMarshal_ReadLongFromFile(fp);
1140 co = read_compiled_module(cpathname, fp);
1141 if (co == NULL)
1142 return NULL;
1143 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001144 PySys_FormatStderr("import %U # precompiled from %R\n",
1145 name, cpathname);
1146 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1147 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001148 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001149
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001150 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001151}
1152
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001153/* Parse a source file and return the corresponding code object */
1154
Guido van Rossum79f25d91997-04-29 20:08:16 +00001155static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001156parse_source_module(PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001157{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001158 PyCodeObject *co;
1159 PyObject *pathbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001160 mod_ty mod;
1161 PyCompilerFlags flags;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001162 PyArena *arena;
1163
1164 pathbytes = PyUnicode_EncodeFSDefault(pathname);
1165 if (pathbytes == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001167
Victor Stinner2f42ae52011-03-20 00:41:24 +01001168 arena = PyArena_New();
1169 if (arena == NULL) {
1170 Py_DECREF(pathbytes);
1171 return NULL;
1172 }
1173
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001174 flags.cf_flags = 0;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001175 mod = PyParser_ASTFromFile(fp, PyBytes_AS_STRING(pathbytes), NULL,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001176 Py_file_input, 0, 0, &flags,
1177 NULL, arena);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001178 if (mod != NULL)
1179 co = PyAST_Compile(mod, PyBytes_AS_STRING(pathbytes), NULL, arena);
1180 else
1181 co = NULL;
1182 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001183 PyArena_Free(arena);
1184 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001185}
1186
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001187/* Write a compiled module to a file, placing the time of last
1188 modification of its source into the header.
1189 Errors are ignored, if a write error occurs an attempt is made to
1190 remove the file. */
1191
1192static void
Victor Stinner2f42ae52011-03-20 00:41:24 +01001193write_compiled_module(PyCodeObject *co, PyObject *cpathname,
1194 struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001195{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001196 Py_UCS4 *cpathname_ucs4;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001197 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001198 time_t mtime = srcstat->st_mtime;
Antoine Pitrou8ad982c2011-11-15 22:27:32 +01001199 PyObject *cpathname_tmp;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001200#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001201 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Victor Stinner1f795172011-11-17 00:45:54 +01001202 wchar_t *wdirname, *wpathname, *wpathname_tmp;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001203#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001204 mode_t dirmode = (srcstat->st_mode |
1205 S_IXUSR | S_IXGRP | S_IXOTH |
1206 S_IWUSR | S_IWGRP | S_IWOTH);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001207 PyObject *dirbytes;
Antoine Pitrou707033a2011-10-17 19:28:44 +02001208 PyObject *cpathbytes, *cpathbytes_tmp;
Victor Stinner783c82c2011-04-20 03:27:51 +02001209#endif
Charles-François Natali0c929d92011-11-10 19:12:29 +01001210 int fd;
Victor Stinner783c82c2011-04-20 03:27:51 +02001211 PyObject *dirname;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001212 Py_UCS4 *dirsep;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001213 int res, ok;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 /* Ensure that the __pycache__ directory exists. */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001216 cpathname_ucs4 = PyUnicode_AsUCS4Copy(cpathname);
1217 if (!cpathname_ucs4)
1218 return;
1219 dirsep = rightmost_sep(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001220 if (dirsep == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001221 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001222 PySys_FormatStderr("# no %s path found %R\n", CACHEDIR, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 return;
1224 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001225 dirname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
1226 cpathname_ucs4,
1227 dirsep - cpathname_ucs4);
1228 PyMem_Free(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001229 if (dirname == NULL) {
1230 PyErr_Clear();
1231 return;
1232 }
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001233
1234#ifdef MS_WINDOWS
Victor Stinner1f795172011-11-17 00:45:54 +01001235 wdirname = PyUnicode_AsUnicode(dirname);
1236 if (wdirname == NULL) {
1237 PyErr_Clear();
1238 return;
1239 }
1240 res = CreateDirectoryW(wdirname, NULL);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001241 ok = (res != 0);
1242 if (!ok && GetLastError() == ERROR_ALREADY_EXISTS)
1243 ok = 1;
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001244#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001245 dirbytes = PyUnicode_EncodeFSDefault(dirname);
1246 if (dirbytes == NULL) {
1247 PyErr_Clear();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 return;
1249 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001250 res = mkdir(PyBytes_AS_STRING(dirbytes), dirmode);
1251 Py_DECREF(dirbytes);
1252 if (0 <= res)
1253 ok = 1;
1254 else
1255 ok = (errno == EEXIST);
1256#endif
1257 if (!ok) {
1258 if (Py_VerboseFlag)
1259 PySys_FormatStderr("# cannot create cache dir %R\n", dirname);
1260 Py_DECREF(dirname);
1261 return;
1262 }
1263 Py_DECREF(dirname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001264
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001265 /* We first write to a tmp file and then take advantage
Antoine Pitrou8ad982c2011-11-15 22:27:32 +01001266 of atomic renaming (which *should* be true even under Windows).
1267 As in importlib, we use id(something) to generate a pseudo-random
1268 filename. mkstemp() can't be used since it doesn't allow specifying
1269 the file access permissions.
1270 */
1271 cpathname_tmp = PyUnicode_FromFormat("%U.%zd",
1272 cpathname, (Py_ssize_t) co);
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001273 if (cpathname_tmp == NULL) {
1274 PyErr_Clear();
1275 return;
1276 }
Antoine Pitrou8ad982c2011-11-15 22:27:32 +01001277#ifdef MS_WINDOWS
Victor Stinner1f795172011-11-17 00:45:54 +01001278 wpathname = PyUnicode_AsUnicode(cpathname);
1279 if (wpathname == NULL) {
1280 PyErr_Clear();
1281 return;
1282 }
1283 wpathname_tmp = PyUnicode_AsUnicode(cpathname_tmp);
1284 if (wpathname_tmp == NULL) {
1285 PyErr_Clear();
1286 return;
1287 }
1288
1289 (void)DeleteFileW(wpathname_tmp);
1290 fd = _wopen(wpathname_tmp,
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001291 O_EXCL | O_CREAT | O_WRONLY | O_BINARY,
1292 mode);
Victor Stinner783c82c2011-04-20 03:27:51 +02001293 if (0 <= fd)
1294 fp = fdopen(fd, "wb");
1295 else
1296 fp = NULL;
1297#else
Antoine Pitrou8ad982c2011-11-15 22:27:32 +01001298 cpathbytes_tmp = PyUnicode_EncodeFSDefault(cpathname_tmp);
1299 Py_DECREF(cpathname_tmp);
1300 if (cpathbytes_tmp == NULL) {
1301 PyErr_Clear();
1302 return;
1303 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001304 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1305 if (cpathbytes == NULL) {
1306 PyErr_Clear();
1307 return;
1308 }
Charles-François Natali0c929d92011-11-10 19:12:29 +01001309 fd = open(PyBytes_AS_STRING(cpathbytes_tmp),
1310 O_CREAT | O_EXCL | O_WRONLY, 0666);
Charles-François Natalie695eec2011-10-31 20:47:31 +01001311 if (0 <= fd)
1312 fp = fdopen(fd, "wb");
1313 else
1314 fp = NULL;
Victor Stinner783c82c2011-04-20 03:27:51 +02001315#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 if (fp == NULL) {
1317 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001318 PySys_FormatStderr(
1319 "# can't create %R\n", cpathname);
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001320#ifdef MS_WINDOWS
1321 Py_DECREF(cpathname_tmp);
1322#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001323 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001324 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001325#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001326 return;
1327 }
1328 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1329 /* First write a 0 for mtime */
1330 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1331 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001332 fflush(fp);
1333 /* Now write the true mtime */
1334 fseek(fp, 4L, 0);
1335 assert(mtime < LONG_MAX);
1336 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001337 if (fflush(fp) != 0 || ferror(fp)) {
1338 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001339 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001340 /* Don't keep partial file */
1341 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001342#ifdef MS_WINDOWS
Victor Stinner1f795172011-11-17 00:45:54 +01001343 (void)DeleteFileW(wpathname_tmp);
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001344 Py_DECREF(cpathname_tmp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001345#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001346 (void) unlink(PyBytes_AS_STRING(cpathbytes_tmp));
Victor Stinner2f42ae52011-03-20 00:41:24 +01001347 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001348 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001349#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001350 return;
1351 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001352 fclose(fp);
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001353 /* Do a (hopefully) atomic rename */
1354#ifdef MS_WINDOWS
Victor Stinner1f795172011-11-17 00:45:54 +01001355 if (!MoveFileExW(wpathname_tmp, wpathname, MOVEFILE_REPLACE_EXISTING)) {
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001356 if (Py_VerboseFlag)
1357 PySys_FormatStderr("# can't write %R\n", cpathname);
1358 /* Don't keep tmp file */
Victor Stinner1f795172011-11-17 00:45:54 +01001359 (void) DeleteFileW(wpathname_tmp);
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001360 Py_DECREF(cpathname_tmp);
1361 return;
1362 }
1363 Py_DECREF(cpathname_tmp);
1364#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001365 if (rename(PyBytes_AS_STRING(cpathbytes_tmp),
1366 PyBytes_AS_STRING(cpathbytes))) {
1367 if (Py_VerboseFlag)
1368 PySys_FormatStderr("# can't write %R\n", cpathname);
1369 /* Don't keep tmp file */
1370 unlink(PyBytes_AS_STRING(cpathbytes_tmp));
1371 Py_DECREF(cpathbytes);
1372 Py_DECREF(cpathbytes_tmp);
1373 return;
1374 }
1375 Py_DECREF(cpathbytes);
1376 Py_DECREF(cpathbytes_tmp);
1377#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001378 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001379 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001380}
1381
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001382static void
1383update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1384{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001385 PyObject *constants, *tmp;
1386 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001388 if (PyUnicode_Compare(co->co_filename, oldname))
1389 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001390
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 tmp = co->co_filename;
1392 co->co_filename = newname;
1393 Py_INCREF(co->co_filename);
1394 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001395
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001396 constants = co->co_consts;
1397 n = PyTuple_GET_SIZE(constants);
1398 for (i = 0; i < n; i++) {
1399 tmp = PyTuple_GET_ITEM(constants, i);
1400 if (PyCode_Check(tmp))
1401 update_code_filenames((PyCodeObject *)tmp,
1402 oldname, newname);
1403 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001404}
1405
Victor Stinner2f42ae52011-03-20 00:41:24 +01001406static void
1407update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001408{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001409 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001410
Victor Stinner2f42ae52011-03-20 00:41:24 +01001411 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1412 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001413
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 oldname = co->co_filename;
1415 Py_INCREF(oldname);
1416 update_code_filenames(co, oldname, newname);
1417 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001418}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001419
Brett Cannon442c9b92011-03-23 16:14:42 -07001420static PyObject *
1421imp_fix_co_filename(PyObject *self, PyObject *args)
1422{
1423 PyObject *co;
1424 PyObject *file_path;
1425
1426 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
1427 return NULL;
1428
1429 if (!PyCode_Check(co)) {
1430 PyErr_SetString(PyExc_TypeError,
1431 "first argument must be a code object");
1432 return NULL;
1433 }
1434
1435 if (!PyUnicode_Check(file_path)) {
1436 PyErr_SetString(PyExc_TypeError,
1437 "second argument must be a string");
1438 return NULL;
1439 }
1440
1441 update_compiled_module((PyCodeObject*)co, file_path);
1442
1443 Py_RETURN_NONE;
1444}
1445
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001446/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001447 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1448 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001449
Guido van Rossum79f25d91997-04-29 20:08:16 +00001450static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001451load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001452{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001453 struct stat st;
1454 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001455 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001457 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001458
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001459 if (fstat(fileno(fp), &st) != 0) {
1460 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001461 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001462 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001463 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001464 }
Fred Drake4c82b232000-06-30 16:18:57 +00001465#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001466 /* Python's .pyc timestamp handling presumes that the timestamp fits
1467 in 4 bytes. This will be fine until sometime in the year 2038,
1468 when a 4-byte signed time_t will overflow.
1469 */
1470 if (st.st_mtime >> 32) {
1471 PyErr_SetString(PyExc_OverflowError,
1472 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001473 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 }
Fred Drake4c82b232000-06-30 16:18:57 +00001475#endif
Martin v. Löwis30260a72011-10-23 17:35:46 +02001476 if (PyUnicode_READY(pathname) < 0)
1477 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001478 cpathname = make_compiled_pathname(pathname, !Py_OptimizeFlag);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001479
1480 if (cpathname != NULL)
1481 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1482 else
1483 fpc = NULL;
1484
1485 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001486 co = read_compiled_module(cpathname, fpc);
1487 fclose(fpc);
1488 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001489 goto error;
1490 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001491 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001492 PySys_FormatStderr("import %U # precompiled from %R\n",
1493 name, cpathname);
1494 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1495 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 }
1497 else {
1498 co = parse_source_module(pathname, fp);
1499 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001500 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001501 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001502 PySys_FormatStderr("import %U # from %R\n",
Victor Stinner98dbba52011-03-14 15:15:47 -04001503 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001504 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1506 if (ro == NULL || !PyObject_IsTrue(ro))
1507 write_compiled_module(co, cpathname, &st);
1508 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001509 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1510 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001511 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001512 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001513
Victor Stinner2f42ae52011-03-20 00:41:24 +01001514error:
1515 Py_XDECREF(cpathbytes);
1516 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001517 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001518}
1519
Christian Heimes3b06e532008-01-07 20:12:44 +00001520/* Get source file -> unicode or None
1521 * Returns the path to the py file if available, else the given path
1522 */
1523static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001524get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001525{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001526 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001527 Py_UCS4 *fileuni;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001528 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001529 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001530
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001531 len = PyUnicode_GET_LENGTH(filename);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001532 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001533 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001534
Victor Stinnerc9abda02011-03-14 13:33:46 -04001535 /* don't match *.pyc or *.pyo? */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001536 fileuni = PyUnicode_AsUCS4Copy(filename);
1537 if (!fileuni)
1538 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001539 if (len < 5
1540 || fileuni[len-4] != '.'
1541 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1542 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1543 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001544
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001545 /* Start by trying to turn PEP 3147 path into source path. If that
1546 * fails, just chop off the trailing character, i.e. legacy pyc path
1547 * to py.
1548 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001549 py = make_source_pathname(filename);
1550 if (py == NULL) {
1551 PyErr_Clear();
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001552 py = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001553 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001554 if (py == NULL)
1555 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001556
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001557 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode)) {
1558 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001559 return py;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001560 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001561 Py_DECREF(py);
1562 goto unchanged;
1563
1564error:
1565 PyErr_Clear();
1566unchanged:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001567 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001568 Py_INCREF(filename);
1569 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001570}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001571
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001572/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001573static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001574static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001575 PyObject **, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001576static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001577
1578/* Load a package and return its module object WITH INCREMENTED
1579 REFERENCE COUNT */
1580
1581static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001582load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001583{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001584 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001585 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001586 int err;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001587 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001589
Victor Stinnerc9abda02011-03-14 13:33:46 -04001590 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001591 if (m == NULL)
1592 return NULL;
1593 if (Py_VerboseFlag)
Victor Stinner98dbba52011-03-14 15:15:47 -04001594 PySys_FormatStderr("import %U # directory %R\n",
1595 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 file = get_sourcefile(pathname);
1597 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001598 return NULL;
1599 path_list = Py_BuildValue("[O]", file);
1600 if (path_list == NULL) {
1601 Py_DECREF(file);
1602 return NULL;
1603 }
1604 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001605 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001606 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001607 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001608 err = PyDict_SetItemString(d, "__path__", path_list);
1609 if (err != 0) {
1610 Py_DECREF(path_list);
1611 return NULL;
1612 }
Victor Stinner533d7832011-03-14 13:22:54 -04001613 fdp = find_module(name, initstr, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001614 &bufobj, &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001615 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001616 if (fdp == NULL) {
1617 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1618 PyErr_Clear();
1619 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001620 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001621 }
1622 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001623 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001625 m = load_module(name, fp, bufobj, fdp->type, NULL);
1626 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001627 if (fp != NULL)
1628 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001630}
1631
1632
1633/* Helper to test for built-in module */
1634
1635static int
Victor Stinner95872862011-03-07 18:20:56 +01001636is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001637{
Victor Stinner95872862011-03-07 18:20:56 +01001638 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001639 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001640 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1641 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001642 if (PyImport_Inittab[i].initfunc == NULL)
1643 return -1;
1644 else
1645 return 1;
1646 }
1647 }
1648 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001649}
1650
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001651
Just van Rossum52e14d62002-12-30 22:08:05 +00001652/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1653 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001654 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001655 that can handle the path item. Return None if no hook could;
1656 this tells our caller it should fall back to the builtin
1657 import mechanism. Cache the result in path_importer_cache.
1658 Returns a borrowed reference. */
1659
1660static PyObject *
1661get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001663{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001664 PyObject *importer;
1665 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001666
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001667 /* These conditions are the caller's responsibility: */
1668 assert(PyList_Check(path_hooks));
1669 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001670
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001671 nhooks = PyList_Size(path_hooks);
1672 if (nhooks < 0)
1673 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001674
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001675 importer = PyDict_GetItem(path_importer_cache, p);
1676 if (importer != NULL)
1677 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001678
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001679 /* set path_importer_cache[p] to None to avoid recursion */
1680 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1681 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001682
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001683 for (j = 0; j < nhooks; j++) {
1684 PyObject *hook = PyList_GetItem(path_hooks, j);
1685 if (hook == NULL)
1686 return NULL;
1687 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1688 if (importer != NULL)
1689 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001691 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1692 return NULL;
1693 }
1694 PyErr_Clear();
1695 }
1696 if (importer == NULL) {
1697 importer = PyObject_CallFunctionObjArgs(
1698 (PyObject *)&PyNullImporter_Type, p, NULL
1699 );
1700 if (importer == NULL) {
1701 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1702 PyErr_Clear();
1703 return Py_None;
1704 }
1705 }
1706 }
1707 if (importer != NULL) {
1708 int err = PyDict_SetItem(path_importer_cache, p, importer);
1709 Py_DECREF(importer);
1710 if (err != 0)
1711 return NULL;
1712 }
1713 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001714}
1715
Christian Heimes9cd17752007-11-18 19:35:23 +00001716PyAPI_FUNC(PyObject *)
1717PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001718 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001719
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001720 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1721 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1722 importer = get_path_importer(path_importer_cache,
1723 path_hooks, path);
1724 }
1725 }
1726 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1727 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001728}
1729
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001730/* Search the path (default sys.path) for a module. Return the
1731 corresponding filedescr struct, and (via return arguments) the
1732 pathname and an open file. Return NULL if the module is not found. */
1733
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001734#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001735extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1736 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001737#endif
1738
Victor Stinner547a2a62011-03-20 03:07:28 +01001739/* Forward */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001740static int case_ok(PyObject *, Py_ssize_t, PyObject *);
Victor Stinner547a2a62011-03-20 03:07:28 +01001741static int find_init_module(PyObject *);
Just van Rossum52e14d62002-12-30 22:08:05 +00001742static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001743
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001744/* Get the path of a module: get its importer and call importer.find_module()
1745 hook, or check if the module if a package (if path/__init__.py exists).
1746
1747 -1: error: a Python error occurred
1748 0: ignore: an error occurred because of invalid data, but the error is not
1749 important enough to be reported.
1750 1: get path: module not found, but *buf contains its path
1751 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1752 and *buf is the path */
1753
1754static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001755find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001756 PyObject *path_hooks, PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001757 PyObject **p_path, PyObject **p_loader, struct filedescr **p_fd)
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001758{
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001759 PyObject *path_unicode, *filename = NULL;
1760 Py_ssize_t len, pos;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001761 struct stat statbuf;
1762 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001763 int result, addsep;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001764
1765 if (PyUnicode_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001766 Py_INCREF(path);
1767 path_unicode = path;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001768 }
1769 else if (PyBytes_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001770 path_unicode = PyUnicode_DecodeFSDefaultAndSize(
1771 PyBytes_AS_STRING(path), PyBytes_GET_SIZE(path));
1772 if (path_unicode == NULL)
1773 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001774 }
1775 else
1776 return 0;
1777
Victor Stinner46084ba2011-10-06 02:39:42 +02001778 if (PyUnicode_READY(path_unicode))
1779 return -1;
1780
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001781 len = PyUnicode_GET_LENGTH(path_unicode);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001782 if (PyUnicode_FindChar(path_unicode, 0, 0, len, 1) != -1) {
1783 result = 0;
1784 goto out; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001785 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001786
1787 /* sys.path_hooks import hook */
1788 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001789 _Py_IDENTIFIER(find_module);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001790 PyObject *importer;
1791
1792 importer = get_path_importer(path_importer_cache,
1793 path_hooks, path);
1794 if (importer == NULL) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001795 result = -1;
1796 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001797 }
1798 /* Note: importer is a borrowed reference */
1799 if (importer != Py_None) {
1800 PyObject *loader;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001801 loader = _PyObject_CallMethodId(importer,
1802 &PyId_find_module, "O", fullname);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001803 if (loader == NULL) {
1804 result = -1; /* error */
1805 goto out;
1806 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001807 if (loader != Py_None) {
1808 /* a loader was found */
1809 *p_loader = loader;
1810 *p_fd = &importhookdescr;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001811 result = 2;
1812 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001813 }
1814 Py_DECREF(loader);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001815 result = 0;
1816 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001817 }
1818 }
1819 /* no hook was found, use builtin import */
1820
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001821 addsep = 0;
1822 if (len > 0 && PyUnicode_READ_CHAR(path_unicode, len-1) != SEP
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001823#ifdef ALTSEP
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001824 && PyUnicode_READ_CHAR(path_unicode, len-1) != ALTSEP
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001825#endif
1826 )
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001827 addsep = 1;
1828 filename = PyUnicode_New(len + PyUnicode_GET_LENGTH(name) + addsep,
1829 Py_MAX(PyUnicode_MAX_CHAR_VALUE(path_unicode),
1830 PyUnicode_MAX_CHAR_VALUE(name)));
1831 if (filename == NULL) {
1832 result = -1;
1833 goto out;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001834 }
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001835 PyUnicode_CopyCharacters(filename, 0, path_unicode, 0, len);
1836 pos = len;
1837 if (addsep)
Victor Stinner1f795172011-11-17 00:45:54 +01001838 PyUnicode_WRITE(PyUnicode_KIND(filename),
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001839 PyUnicode_DATA(filename),
1840 pos++, SEP);
Victor Stinner1f795172011-11-17 00:45:54 +01001841 PyUnicode_CopyCharacters(filename, pos, name, 0,
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001842 PyUnicode_GET_LENGTH(name));
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001843
1844 /* Check for package import (buf holds a directory name,
1845 and there's an __init__ module in that directory */
1846#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001847 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001848 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1849 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001850 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001851
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001852 match = case_ok(filename, 0, name);
1853 if (match < 0) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001854 result = -1;
1855 goto out;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001856 }
1857 if (match) { /* case matches */
1858 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001859 *p_path = filename;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001860 filename = NULL;
Victor Stinnerd0296212011-03-14 14:04:10 -04001861 *p_fd = &fd_package;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001862 result = 2;
1863 goto out;
Victor Stinnerd0296212011-03-14 14:04:10 -04001864 }
1865 else {
1866 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001867 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001868 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001869 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001870 if (err) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001871 result = -1;
1872 goto out;
Victor Stinner547a2a62011-03-20 03:07:28 +01001873 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001874 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001875 }
1876 }
1877#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001878 *p_path = filename;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001879 filename = NULL;
1880 result = 1;
1881 out:
1882 Py_DECREF(path_unicode);
1883 Py_XDECREF(filename);
1884 return result;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001885}
1886
1887/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001888 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001889
1890 If the module is found, return a file descriptor, write the path in
1891 *p_filename, write the pointer to the file object into *p_fp, and (if
1892 p_loader is not NULL) the loader into *p_loader.
1893
1894 Otherwise, raise an exception and return NULL. */
1895
Victor Stinner37580282011-03-20 01:34:43 +01001896static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001897find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001898 PyObject *search_path_list, PyObject *path_hooks,
1899 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001900 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001901{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001902 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001903 struct filedescr *fdp = NULL;
1904 char *filemode;
1905 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001906 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001907 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001908
Victor Stinner37580282011-03-20 01:34:43 +01001909 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001910 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001911 PyObject *path;
1912 int ok;
1913
1914 path = PyList_GetItem(search_path_list, i);
1915 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001916 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001917
Victor Stinner2fd76e42011-03-14 15:19:39 -04001918 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001919 ok = find_module_path(fullname, name, path,
1920 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001921 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001922 if (ok < 0)
1923 return NULL;
1924 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001925 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001926 if (ok == 2) {
1927 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001928 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001929 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001930
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001931 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001932 struct stat statbuf;
1933
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001934 filemode = fdp->mode;
1935 if (filemode[0] == 'U')
1936 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001937
Victor Stinner2fd76e42011-03-14 15:19:39 -04001938 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1939 if (filename == NULL) {
1940 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001941 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001942 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001943
1944 if (Py_VerboseFlag > 1)
1945 PySys_FormatStderr("# trying %R\n", filename);
1946
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001947 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
1948 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1949 {
1950 Py_DECREF(filename);
1951 continue;
1952 }
1953
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001954 fp = _Py_fopen(filename, filemode);
1955 if (fp == NULL) {
1956 Py_DECREF(filename);
Victor Stinner925ef392011-06-20 15:01:10 +02001957 if (PyErr_Occurred()) {
1958 Py_DECREF(prefix);
1959 return NULL;
1960 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001961 continue;
1962 }
1963 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1964 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001965 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001966 Py_DECREF(filename);
1967 return NULL;
1968 }
1969 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001970 Py_DECREF(prefix);
1971 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001972 *p_fp = fp;
1973 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001974 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001975 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001976
1977 fclose(fp);
1978 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001979 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001980 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001981 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001982 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04001983 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04001984 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001985}
1986
Victor Stinner37580282011-03-20 01:34:43 +01001987/* Find a module:
1988
1989 - try find_module() of each sys.meta_path hook
1990 - try find_frozen()
1991 - try is_builtin()
1992 - try _PyWin_FindRegisteredModule() (Windows only)
1993 - otherwise, call find_module_path_list() with search_path_list (if not
1994 NULL) or sys.path
1995
Victor Stinner2fd76e42011-03-14 15:19:39 -04001996 fullname can be NULL, but only if p_loader is NULL.
1997
Victor Stinner37580282011-03-20 01:34:43 +01001998 Return:
1999
2000 - &fd_builtin (C_BUILTIN) if it is a builtin
2001 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04002002 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01002003 if it is a package
2004 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
2005 importer loader was found
2006 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
2007 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04002008 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01002009 - NULL on error
2010
Victor Stinner2fd76e42011-03-14 15:19:39 -04002011 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
2012 Eg. *p_path is set to NULL for a builtin package.
2013*/
Victor Stinner37580282011-03-20 01:34:43 +01002014
2015static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002016find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002017 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01002018{
2019 Py_ssize_t i, npath;
2020 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
2021 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
2022 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01002023
Victor Stinner2fd76e42011-03-14 15:19:39 -04002024 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01002025 *p_fp = NULL;
2026 if (p_loader != NULL)
2027 *p_loader = NULL;
2028
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002029 if (PyUnicode_GET_LENGTH(name) > MAXPATHLEN) {
2030 PyErr_SetString(PyExc_OverflowError,
2031 "module name is too long");
2032 return NULL;
2033 }
2034
Victor Stinner37580282011-03-20 01:34:43 +01002035 /* sys.meta_path import hook */
2036 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002037 _Py_IDENTIFIER(find_module);
Victor Stinner37580282011-03-20 01:34:43 +01002038 PyObject *meta_path;
2039
2040 meta_path = PySys_GetObject("meta_path");
2041 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02002042 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002043 "sys.meta_path must be a list of "
2044 "import hooks");
2045 return NULL;
2046 }
2047 Py_INCREF(meta_path); /* zap guard */
2048 npath = PyList_Size(meta_path);
2049 for (i = 0; i < npath; i++) {
2050 PyObject *loader;
2051 PyObject *hook = PyList_GetItem(meta_path, i);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002052 loader = _PyObject_CallMethodId(hook, &PyId_find_module,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002053 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01002054 search_path_list != NULL ?
2055 search_path_list : Py_None);
2056 if (loader == NULL) {
2057 Py_DECREF(meta_path);
2058 return NULL; /* true error */
2059 }
2060 if (loader != Py_None) {
2061 /* a loader was found */
2062 *p_loader = loader;
2063 Py_DECREF(meta_path);
2064 return &importhookdescr;
2065 }
2066 Py_DECREF(loader);
2067 }
2068 Py_DECREF(meta_path);
2069 }
2070
Victor Stinnerdf75a022011-03-14 13:40:04 -04002071 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002072 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01002073
2074 if (search_path_list == NULL) {
2075#ifdef MS_COREDLL
2076 FILE *fp;
2077 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01002078#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04002079 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01002080 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01002081#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04002082 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01002083 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01002084 *p_fp = fp;
2085 return fdp;
2086 }
2087 else if (PyErr_Occurred())
2088 return NULL;
2089#endif
Victor Stinner37580282011-03-20 01:34:43 +01002090 search_path_list = PySys_GetObject("path");
2091 }
2092
2093 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
Victor Stinner16191322011-09-15 19:28:05 +02002094 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002095 "sys.path must be a list of directory names");
2096 return NULL;
2097 }
2098
2099 path_hooks = PySys_GetObject("path_hooks");
2100 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02002101 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002102 "sys.path_hooks must be a list of "
2103 "import hooks");
2104 return NULL;
2105 }
2106 path_importer_cache = PySys_GetObject("path_importer_cache");
2107 if (path_importer_cache == NULL ||
2108 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02002109 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002110 "sys.path_importer_cache must be a dict");
2111 return NULL;
2112 }
2113
2114 return find_module_path_list(fullname, name,
2115 search_path_list, path_hooks,
2116 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002117 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002118}
2119
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002120/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002121 * The arguments here are tricky, best shown by example:
2122 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2123 * ^ ^ ^ ^
2124 * |--------------------- buf ---------------------|
2125 * |------------------- len ------------------|
2126 * |------ name -------|
2127 * |----- namelen -----|
2128 * buf is the full path, but len only counts up to (& exclusive of) the
2129 * extension. name is the module name, also exclusive of extension.
2130 *
2131 * We've already done a successful stat() or fopen() on buf, so know that
2132 * there's some match, possibly case-insensitive.
2133 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002134 * case_bytes() is to return 1 if there's a case-sensitive match for
2135 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002136 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002137 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002138 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002139 * on platforms with case-insensitive filesystems. It's trivial to implement
2140 * for case-sensitive filesystems. It's pretty much a cross-platform
2141 * nightmare for systems with case-insensitive filesystems.
2142 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002143
Tim Peters50d8d372001-02-28 05:34:27 +00002144/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002145 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002146 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002147#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002148#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002149
Tim Peters50d8d372001-02-28 05:34:27 +00002150#elif defined(DJGPP)
2151#include <dir.h>
2152
Jason Tishler7961aa62005-05-20 00:56:54 +00002153#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002154#include <sys/types.h>
2155#include <dirent.h>
2156
Andrew MacIntyred9400542002-02-26 11:41:34 +00002157#elif defined(PYOS_OS2)
2158#define INCL_DOS
2159#define INCL_DOSERRORS
2160#define INCL_NOPMAPI
2161#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002162#endif
2163
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002164#if defined(DJGPP) \
2165 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2166 && defined(HAVE_DIRENT_H)) \
2167 || defined(PYOS_OS2)
2168# define USE_CASE_OK_BYTES
2169#endif
2170
2171
2172#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002173static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002174case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002175{
Tim Peters50d8d372001-02-28 05:34:27 +00002176/* Pick a platform-specific implementation; the sequence of #if's here should
2177 * match the sequence just above.
2178 */
2179
Tim Peters50d8d372001-02-28 05:34:27 +00002180/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002181#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002182 struct ffblk ffblk;
2183 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002184
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002185 if (Py_GETENV("PYTHONCASEOK") != NULL)
2186 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002187
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002188 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2189 if (done) {
2190 PyErr_Format(PyExc_NameError,
2191 "Can't find file for module %.100s\n(filename %.300s)",
2192 name, buf);
Victor Stinner9c61e242011-03-22 01:22:27 +01002193 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002194 }
2195 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002196
Jason Tishler7961aa62005-05-20 00:56:54 +00002197/* new-fangled macintosh (macosx) or Cygwin */
2198#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002199 DIR *dirp;
2200 struct dirent *dp;
2201 char dirname[MAXPATHLEN + 1];
2202 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002203
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002204 if (Py_GETENV("PYTHONCASEOK") != NULL)
2205 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002206
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002207 /* Copy the dir component into dirname; substitute "." if empty */
2208 if (dirlen <= 0) {
2209 dirname[0] = '.';
2210 dirname[1] = '\0';
2211 }
2212 else {
2213 assert(dirlen <= MAXPATHLEN);
2214 memcpy(dirname, buf, dirlen);
2215 dirname[dirlen] = '\0';
2216 }
2217 /* Open the directory and search the entries for an exact match. */
2218 dirp = opendir(dirname);
2219 if (dirp) {
2220 char *nameWithExt = buf + len - namelen;
2221 while ((dp = readdir(dirp)) != NULL) {
2222 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002223#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002224 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002225#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002226 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002227#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002228 if (thislen >= namelen &&
2229 strcmp(dp->d_name, nameWithExt) == 0) {
2230 (void)closedir(dirp);
2231 return 1; /* Found */
2232 }
2233 }
2234 (void)closedir(dirp);
2235 }
2236 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002237
Andrew MacIntyred9400542002-02-26 11:41:34 +00002238/* OS/2 */
2239#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002240 HDIR hdir = 1;
2241 ULONG srchcnt = 1;
2242 FILEFINDBUF3 ffbuf;
2243 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002245 if (Py_GETENV("PYTHONCASEOK") != NULL)
2246 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002248 rc = DosFindFirst(buf,
2249 &hdir,
2250 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2251 &ffbuf, sizeof(ffbuf),
2252 &srchcnt,
2253 FIL_STANDARD);
2254 if (rc != NO_ERROR)
2255 return 0;
2256 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002257
Tim Peters50d8d372001-02-28 05:34:27 +00002258/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2259#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002260# error "USE_CASE_OK_BYTES is not correctly defined"
2261#endif
2262}
2263#endif
2264
2265/*
2266 * Check if a filename case matchs the name case. We've already done a
2267 * successful stat() or fopen() on buf, so know that there's some match,
2268 * possibly case-insensitive.
2269 *
2270 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2271 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2272 * if envar PYTHONCASEOK exists.
2273 *
2274 * case_ok() is used to implement case-sensitive import semantics even
2275 * on platforms with case-insensitive filesystems. It's trivial to implement
2276 * for case-sensitive filesystems. It's pretty much a cross-platform
2277 * nightmare for systems with case-insensitive filesystems.
2278 */
2279
2280static int
2281case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2282{
2283#ifdef MS_WINDOWS
2284 WIN32_FIND_DATAW data;
2285 HANDLE h;
2286 int cmp;
Victor Stinner1f795172011-11-17 00:45:54 +01002287 wchar_t *wfilename, *wname;
Victor Stinner8c981892011-10-11 22:27:13 +02002288 Py_ssize_t wname_len;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002289
2290 if (Py_GETENV("PYTHONCASEOK") != NULL)
2291 return 1;
2292
Victor Stinner1f795172011-11-17 00:45:54 +01002293 wfilename = PyUnicode_AsUnicode(filename);
2294 if (wfilename == NULL)
2295 return -1;
2296
2297 h = FindFirstFileW(wfilename, &data);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002298 if (h == INVALID_HANDLE_VALUE) {
2299 PyErr_Format(PyExc_NameError,
2300 "Can't find file for module %R\n(filename %R)",
2301 name, filename);
Victor Stinner1f795172011-11-17 00:45:54 +01002302 return -1;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002303 }
2304 FindClose(h);
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002305
2306 wname = PyUnicode_AsUnicodeAndSize(name, &wname_len);
2307 if (wname == NULL)
2308 return -1;
2309
2310 cmp = wcsncmp(data.cFileName, wname, wname_len);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002311 return cmp == 0;
2312#elif defined(USE_CASE_OK_BYTES)
2313 int match;
2314 PyObject *filebytes, *namebytes;
2315 filebytes = PyUnicode_EncodeFSDefault(filename);
2316 if (filebytes == NULL)
2317 return -1;
2318 namebytes = PyUnicode_EncodeFSDefault(name);
2319 if (namebytes == NULL) {
2320 Py_DECREF(filebytes);
2321 return -1;
2322 }
2323 match = case_bytes(
2324 PyBytes_AS_STRING(filebytes),
2325 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002326 PyBytes_GET_SIZE(namebytes),
2327 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002328 Py_DECREF(filebytes);
2329 Py_DECREF(namebytes);
2330 return match;
2331#else
2332 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002333 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002334
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002335#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002336}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002337
Guido van Rossum197346f1997-10-31 18:38:52 +00002338#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002339
Victor Stinner547a2a62011-03-20 03:07:28 +01002340/* Helper to look for __init__.py or __init__.py[co] in potential package.
2341 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002342static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002343find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002344{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002345 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002346 PyObject *filename;
2347 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002348
Victor Stinner547a2a62011-03-20 03:07:28 +01002349 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2350 if (filename == NULL)
2351 return -1;
2352 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002353 /* 3=len(".py") */
2354 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002355 if (match < 0) {
2356 Py_DECREF(filename);
2357 return -1;
2358 }
2359 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002360 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002361 return 1;
2362 }
2363 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002364 Py_DECREF(filename);
2365
2366 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2367 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2368 if (filename == NULL)
2369 return -1;
2370 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002371 /* 4=len(".pyc") */
2372 match = case_ok(filename, -4, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002373 if (match < 0) {
2374 Py_DECREF(filename);
2375 return -1;
2376 }
2377 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002378 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002379 return 1;
2380 }
2381 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002382 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002383 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002384}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002385
Guido van Rossum197346f1997-10-31 18:38:52 +00002386#endif /* HAVE_STAT */
2387
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002388
Victor Stinner95872862011-03-07 18:20:56 +01002389static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002390
Victor Stinner44c6c152010-08-09 00:59:10 +00002391static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002392load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002393{
2394 PyObject *m, *modules;
2395 int err;
2396
Victor Stinner44c6c152010-08-09 00:59:10 +00002397 if (type == C_BUILTIN)
2398 err = init_builtin(name);
2399 else
Victor Stinner95872862011-03-07 18:20:56 +01002400 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002401 if (err < 0)
2402 return NULL;
2403 if (err == 0) {
2404 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002405 "Purported %s module %R not found",
2406 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002407 name);
2408 return NULL;
2409 }
2410
2411 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002412 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002413 if (m == NULL) {
2414 PyErr_Format(
2415 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002416 "%s module %R not properly initialized",
2417 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002418 name);
2419 return NULL;
2420 }
2421 Py_INCREF(m);
2422 return m;
2423}
2424
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002425/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002426 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002427
Guido van Rossum79f25d91997-04-29 20:08:16 +00002428static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002429load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002430{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002431 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002432
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002433 /* First check that there's an open file (if we need one) */
2434 switch (type) {
2435 case PY_SOURCE:
2436 case PY_COMPILED:
2437 if (fp == NULL) {
2438 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002439 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002440 type);
2441 return NULL;
2442 }
2443 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002445 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002446
Victor Stinner41c5fec2011-03-13 21:46:30 -04002447 case PY_SOURCE:
2448 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002449 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002450
Victor Stinner41c5fec2011-03-13 21:46:30 -04002451 case PY_COMPILED:
2452 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002453 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002454
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002455#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002456 case C_EXTENSION:
2457 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002458 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002459#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002460
Victor Stinner41c5fec2011-03-13 21:46:30 -04002461 case PKG_DIRECTORY:
2462 m = load_package(name, pathname);
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 C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002466 case PY_FROZEN:
2467 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002468 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002469
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002470 case IMP_HOOK: {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002471 _Py_IDENTIFIER(load_module);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002472 if (loader == NULL) {
2473 PyErr_SetString(PyExc_ImportError,
2474 "import hook without loader");
2475 return NULL;
2476 }
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002477 m = _PyObject_CallMethodId(loader, &PyId_load_module, "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002478 break;
2479 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002480
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002481 default:
2482 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002483 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002484 name, type);
2485 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002486
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002487 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002488
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002489 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002490}
2491
2492
2493/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002494 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002495 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002496
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002497static int
Victor Stinner95872862011-03-07 18:20:56 +01002498init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002499{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002500 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002501
Victor Stinner95872862011-03-07 18:20:56 +01002502 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002503 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002505 for (p = PyImport_Inittab; p->name != NULL; p++) {
2506 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002507 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002508 if (p->initfunc == NULL) {
2509 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002510 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002511 name);
2512 return -1;
2513 }
2514 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002515 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002516 mod = (*p->initfunc)();
2517 if (mod == 0)
2518 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002519 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002520 return -1;
2521 /* FixupExtension has put the module into sys.modules,
2522 so we can release our own reference. */
2523 Py_DECREF(mod);
2524 return 1;
2525 }
2526 }
2527 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002528}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002529
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002530
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002531/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002532
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002533static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002534find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002535{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002536 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002537
Victor Stinner53dc7352011-03-20 01:50:21 +01002538 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002539 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 for (p = PyImport_FrozenModules; ; p++) {
2542 if (p->name == NULL)
2543 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002544 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002545 break;
2546 }
2547 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002548}
2549
Guido van Rossum79f25d91997-04-29 20:08:16 +00002550static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002551get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002552{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002553 struct _frozen *p = find_frozen(name);
2554 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002555
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002556 if (p == NULL) {
2557 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002558 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002559 name);
2560 return NULL;
2561 }
2562 if (p->code == NULL) {
2563 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002564 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002565 name);
2566 return NULL;
2567 }
2568 size = p->size;
2569 if (size < 0)
2570 size = -size;
2571 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002572}
2573
Brett Cannon8d110132009-03-15 02:20:16 +00002574static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002575is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002576{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002577 struct _frozen *p = find_frozen(name);
2578 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002579
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002580 if (p == NULL) {
2581 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002582 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002583 name);
2584 return NULL;
2585 }
Brett Cannon8d110132009-03-15 02:20:16 +00002586
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002587 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002589 if (size < 0)
2590 Py_RETURN_TRUE;
2591 else
2592 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002593}
2594
2595
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002596/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002597 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002598 an exception set if the initialization failed.
2599 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002600
2601int
Victor Stinner53dc7352011-03-20 01:50:21 +01002602PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002603{
Victor Stinner53dc7352011-03-20 01:50:21 +01002604 struct _frozen *p;
2605 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002606 int ispackage;
2607 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002608
Victor Stinner53dc7352011-03-20 01:50:21 +01002609 p = find_frozen(name);
2610
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002611 if (p == NULL)
2612 return 0;
2613 if (p->code == NULL) {
2614 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002615 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002616 name);
2617 return -1;
2618 }
2619 size = p->size;
2620 ispackage = (size < 0);
2621 if (ispackage)
2622 size = -size;
2623 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002624 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002625 name, ispackage ? " package" : "");
2626 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2627 if (co == NULL)
2628 return -1;
2629 if (!PyCode_Check(co)) {
2630 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002631 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002632 name);
2633 goto err_return;
2634 }
2635 if (ispackage) {
2636 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002637 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002638 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002639 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002640 if (m == NULL)
2641 goto err_return;
2642 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002643 l = PyList_New(1);
2644 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002645 goto err_return;
2646 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002647 Py_INCREF(name);
2648 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002649 err = PyDict_SetItemString(d, "__path__", l);
2650 Py_DECREF(l);
2651 if (err != 0)
2652 goto err_return;
2653 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002654 path = PyUnicode_FromString("<frozen>");
2655 if (path == NULL)
2656 goto err_return;
2657 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2658 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002659 if (m == NULL)
2660 goto err_return;
2661 Py_DECREF(co);
2662 Py_DECREF(m);
2663 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002664err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002665 Py_DECREF(co);
2666 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002667}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002668
Victor Stinner53dc7352011-03-20 01:50:21 +01002669int
2670PyImport_ImportFrozenModule(char *name)
2671{
2672 PyObject *nameobj;
2673 int ret;
2674 nameobj = PyUnicode_InternFromString(name);
2675 if (nameobj == NULL)
2676 return -1;
2677 ret = PyImport_ImportFrozenModuleObject(nameobj);
2678 Py_DECREF(nameobj);
2679 return ret;
2680}
2681
Guido van Rossum74e6a111994-08-29 12:54:38 +00002682
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002683/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002684 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002685
Guido van Rossum79f25d91997-04-29 20:08:16 +00002686PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002687PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002688{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002689 PyObject *pname;
2690 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002691
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002692 pname = PyUnicode_FromString(name);
2693 if (pname == NULL)
2694 return NULL;
2695 result = PyImport_Import(pname);
2696 Py_DECREF(pname);
2697 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002698}
2699
Christian Heimes072c0f12008-01-03 23:01:04 +00002700/* Import a module without blocking
2701 *
2702 * At first it tries to fetch the module from sys.modules. If the module was
2703 * never loaded before it loads it with PyImport_ImportModule() unless another
2704 * thread holds the import lock. In the latter case the function raises an
2705 * ImportError instead of blocking.
2706 *
2707 * Returns the module object with incremented ref count.
2708 */
2709PyObject *
2710PyImport_ImportModuleNoBlock(const char *name)
2711{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002712 PyObject *nameobj, *modules, *result;
Victor Stinner0af03062011-09-02 00:11:43 +02002713#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002714 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002715#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002716
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002717 /* Try to get the module from sys.modules[name] */
2718 modules = PyImport_GetModuleDict();
2719 if (modules == NULL)
2720 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002721
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002722 nameobj = PyUnicode_FromString(name);
2723 if (nameobj == NULL)
2724 return NULL;
2725 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002726 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002727 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002728 Py_INCREF(result);
2729 return result;
2730 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002731 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002732#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002733 /* check the import lock
2734 * me might be -1 but I ignore the error here, the lock function
2735 * takes care of the problem */
2736 me = PyThread_get_thread_ident();
2737 if (import_lock_thread == -1 || import_lock_thread == me) {
2738 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002739 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002740 }
2741 else {
2742 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002743 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002744 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002745 nameobj);
2746 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002747 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002748#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002749 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002750#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002751 Py_DECREF(nameobj);
2752 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002753}
2754
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002755/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002756static PyObject *get_parent(PyObject *globals,
2757 PyObject **p_name,
2758 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002759static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002760 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002761 PyObject **p_prefix);
Victor Stinner974389d2011-03-15 09:33:57 +01002762static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002763static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002764 PyObject *buf, int recursive);
2765static PyObject * import_submodule(PyObject *mod, PyObject *name,
2766 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002767
2768/* The Magnum Opus of dotted-name import :-) */
2769
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002770static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002771import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002772 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002773{
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002774 PyObject *parent, *next, *inputname, *outputname;
2775 PyObject *head = NULL;
2776 PyObject *tail = NULL;
2777 PyObject *prefix = NULL;
2778 PyObject *result = NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002779 Py_ssize_t sep, altsep;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002780
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002781 if (PyUnicode_READY(name))
2782 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002783
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002784 sep = PyUnicode_FindChar(name, SEP, 0, PyUnicode_GET_LENGTH(name), 1);
2785 if (sep == -2)
2786 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002787#ifdef ALTSEP
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002788 altsep = PyUnicode_FindChar(name, ALTSEP, 0, PyUnicode_GET_LENGTH(name), 1);
2789 if (altsep == -2)
2790 return NULL;
2791#else
2792 altsep = -1;
Christian Heimes454f37b2008-01-10 00:10:02 +00002793#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002794 if (sep != -1 || altsep != -1)
2795 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002796 PyErr_SetString(PyExc_ImportError,
2797 "Import by filename is not supported.");
2798 return NULL;
2799 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002800
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002801 parent = get_parent(globals, &prefix, level);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002802 if (parent == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002803 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002804 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002805
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002806 if (PyUnicode_READY(prefix))
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002807 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002808
2809 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002810 &prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002811 if (head == NULL)
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002812 goto out;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002813
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002814 tail = head;
2815 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002816
2817 if (outputname != NULL) {
2818 while (1) {
2819 inputname = outputname;
2820 next = load_next(tail, tail, inputname, &outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002821 &prefix);
2822 Py_CLEAR(tail);
2823 Py_CLEAR(inputname);
2824 if (next == NULL)
2825 goto out;
Victor Stinner974389d2011-03-15 09:33:57 +01002826 tail = next;
2827
2828 if (outputname == NULL) {
2829 break;
2830 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002831 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002832 }
2833 if (tail == Py_None) {
2834 /* If tail is Py_None, both get_parent and load_next found
2835 an empty module name: someone called __import__("") or
2836 doctored faulty bytecode */
Victor Stinner974389d2011-03-15 09:33:57 +01002837 PyErr_SetString(PyExc_ValueError, "Empty module name");
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002838 goto out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002839 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002840
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002841 if (fromlist != NULL) {
2842 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2843 fromlist = NULL;
2844 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002845
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002846 if (fromlist == NULL) {
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002847 result = head;
2848 Py_INCREF(result);
2849 goto out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002850 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002851
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002852 if (!ensure_fromlist(tail, fromlist, prefix, 0))
2853 goto out;
Victor Stinner1f795172011-11-17 00:45:54 +01002854
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002855 result = tail;
2856 Py_INCREF(result);
2857 out:
2858 Py_XDECREF(head);
2859 Py_XDECREF(tail);
2860 Py_XDECREF(prefix);
2861 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002862}
2863
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002864PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002865PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2866 PyObject *locals, PyObject *fromlist,
2867 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002868{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002869 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002870 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002871 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002872 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002873 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002874 PyErr_SetString(PyExc_RuntimeError,
2875 "not holding the import lock");
2876 return NULL;
2877 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002878 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002879}
2880
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002881PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05002882PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002883 PyObject *fromlist, int level)
2884{
2885 PyObject *nameobj, *mod;
2886 nameobj = PyUnicode_FromString(name);
2887 if (nameobj == NULL)
2888 return NULL;
2889 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2890 fromlist, level);
2891 Py_DECREF(nameobj);
2892 return mod;
2893}
2894
2895
Fred Drake87590902004-05-28 20:21:36 +00002896/* Return the package that an import is being performed in. If globals comes
2897 from the module foo.bar.bat (not itself a package), this returns the
2898 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002899 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002900
Victor Stinner974389d2011-03-15 09:33:57 +01002901 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002902
2903 If globals doesn't come from a package or a module in a package, or a
2904 corresponding entry is not found in sys.modules, Py_None is returned.
2905*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002906static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002907get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002908{
Victor Stinner974389d2011-03-15 09:33:57 +01002909 PyObject *nameobj;
2910
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002911 static PyObject *namestr = NULL;
2912 static PyObject *pathstr = NULL;
2913 static PyObject *pkgstr = NULL;
2914 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2915 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002916
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002917 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002918 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002919
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002920 if (namestr == NULL) {
2921 namestr = PyUnicode_InternFromString("__name__");
2922 if (namestr == NULL)
2923 return NULL;
2924 }
2925 if (pathstr == NULL) {
2926 pathstr = PyUnicode_InternFromString("__path__");
2927 if (pathstr == NULL)
2928 return NULL;
2929 }
2930 if (pkgstr == NULL) {
2931 pkgstr = PyUnicode_InternFromString("__package__");
2932 if (pkgstr == NULL)
2933 return NULL;
2934 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002935
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002936 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002937
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002938 if ((pkgname != NULL) && (pkgname != Py_None)) {
2939 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002940 if (!PyUnicode_Check(pkgname)) {
2941 PyErr_SetString(PyExc_ValueError,
2942 "__package__ set to non-string");
2943 return NULL;
2944 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002945 if (PyUnicode_GET_LENGTH(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002946 if (level > 0) {
2947 PyErr_SetString(PyExc_ValueError,
2948 "Attempted relative import in non-package");
2949 return NULL;
2950 }
Victor Stinner974389d2011-03-15 09:33:57 +01002951 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002952 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002953 Py_INCREF(pkgname);
2954 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002955 } else {
2956 /* __package__ not set, so figure it out and set it */
2957 modname = PyDict_GetItem(globals, namestr);
2958 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002959 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002960
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002961 modpath = PyDict_GetItem(globals, pathstr);
2962 if (modpath != NULL) {
2963 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002964 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002965
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002966 error = PyDict_SetItem(globals, pkgstr, modname);
2967 if (error) {
2968 PyErr_SetString(PyExc_ValueError,
2969 "Could not set __package__");
2970 return NULL;
2971 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002972 Py_INCREF(modname);
2973 nameobj = modname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002974 } else {
2975 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002976 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002977 len = PyUnicode_FindChar(modname, '.',
2978 0, PyUnicode_GET_LENGTH(modname), -1);
2979 if (len == -2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002980 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002981 if (len < 0) {
2982 if (level > 0) {
2983 PyErr_SetString(PyExc_ValueError,
2984 "Attempted relative import in non-package");
2985 return NULL;
2986 }
2987 if (PyDict_SetItem(globals, pkgstr, Py_None)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002988 PyErr_SetString(PyExc_ValueError,
2989 "Could not set __package__");
2990 return NULL;
2991 }
Victor Stinner974389d2011-03-15 09:33:57 +01002992 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002993 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002994 pkgname = PyUnicode_Substring(modname, 0, len);
2995 if (pkgname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002996 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002997 if (PyDict_SetItem(globals, pkgstr, pkgname)) {
2998 Py_DECREF(pkgname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002999 PyErr_SetString(PyExc_ValueError,
3000 "Could not set __package__");
3001 return NULL;
3002 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003003 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003004 }
3005 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003006 if (level > 1) {
3007 Py_ssize_t dot, end = PyUnicode_GET_LENGTH(nameobj);
3008 PyObject *newname;
3009 while (--level > 0) {
3010 dot = PyUnicode_FindChar(nameobj, '.', 0, end, -1);
3011 if (dot == -2) {
3012 Py_DECREF(nameobj);
3013 return NULL;
3014 }
3015 if (dot < 0) {
3016 Py_DECREF(nameobj);
3017 PyErr_SetString(PyExc_ValueError,
3018 "Attempted relative import beyond "
3019 "toplevel package");
3020 return NULL;
3021 }
3022 end = dot;
3023 }
3024 newname = PyUnicode_Substring(nameobj, 0, end);
3025 Py_DECREF(nameobj);
3026 if (newname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003027 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003028 nameobj = newname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003029 }
Victor Stinner974389d2011-03-15 09:33:57 +01003030
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003031 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003032 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003033 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003034 int err;
3035
3036 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003037 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01003038 "Parent module %R not loaded, "
3039 "cannot perform relative import", nameobj);
3040 Py_DECREF(nameobj);
3041 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003042 }
Victor Stinner974389d2011-03-15 09:33:57 +01003043
3044 err = PyErr_WarnFormat(
3045 PyExc_RuntimeWarning, 1,
3046 "Parent module %R not found while handling absolute import",
3047 nameobj);
3048 Py_DECREF(nameobj);
3049 if (err)
3050 return NULL;
3051
3052 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003053 }
Victor Stinner974389d2011-03-15 09:33:57 +01003054 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003055 return parent;
3056 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01003057 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003058 - parent.__dict__ is globals
3059 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01003060
3061return_none:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003062 nameobj = PyUnicode_New(0, 0);
Victor Stinner974389d2011-03-15 09:33:57 +01003063 if (nameobj == NULL)
3064 return NULL;
3065 *p_name = nameobj;
3066 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003067}
3068
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003069/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003070static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003071load_next(PyObject *mod, PyObject *altmod,
3072 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003073 PyObject **p_prefix)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003074{
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003075 Py_ssize_t dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003076 Py_ssize_t len;
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003077 PyObject *fullname, *name = NULL, *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003078
Victor Stinner974389d2011-03-15 09:33:57 +01003079 *p_outputname = NULL;
3080
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003081 len = PyUnicode_GET_LENGTH(inputname);
3082 if (len == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003083 /* completely empty module name should only happen in
3084 'from . import' (or '__import__("")')*/
3085 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003086 return mod;
3087 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00003088
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003089
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003090 dot = PyUnicode_FindChar(inputname, '.', 0, len, 1);
3091 if (dot >= 0) {
3092 len = dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003093 if (len == 0) {
3094 PyErr_SetString(PyExc_ValueError,
3095 "Empty module name");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003096 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003097 }
3098 }
Victor Stinner974389d2011-03-15 09:33:57 +01003099
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003100 /* name = inputname[:len] */
3101 name = PyUnicode_Substring(inputname, 0, len);
3102 if (name == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003103 goto error;
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003104
3105 if (PyUnicode_GET_LENGTH(*p_prefix)) {
3106 /* fullname = prefix + "." + name */
3107 fullname = PyUnicode_FromFormat("%U.%U", *p_prefix, name);
3108 if (fullname == NULL)
3109 goto error;
3110 }
3111 else {
3112 fullname = name;
3113 Py_INCREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003114 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003115
Victor Stinner974389d2011-03-15 09:33:57 +01003116 result = import_submodule(mod, name, fullname);
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003117 Py_DECREF(*p_prefix);
3118 /* Transfer reference. */
3119 *p_prefix = fullname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003120 if (result == Py_None && altmod != mod) {
3121 Py_DECREF(result);
3122 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003123 result = import_submodule(altmod, name, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003124 if (result != NULL && result != Py_None) {
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003125 if (mark_miss(*p_prefix) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003126 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003127 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003128 }
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003129 Py_DECREF(*p_prefix);
3130 *p_prefix = name;
3131 Py_INCREF(*p_prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003132 }
3133 }
3134 if (result == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003135 goto error;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003136
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003137 if (result == Py_None) {
3138 Py_DECREF(result);
3139 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003140 "No module named %R", inputname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003141 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003142 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003143
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003144 if (dot >= 0) {
3145 *p_outputname = PyUnicode_Substring(inputname, dot+1,
3146 PyUnicode_GET_LENGTH(inputname));
Victor Stinner974389d2011-03-15 09:33:57 +01003147 if (*p_outputname == NULL) {
3148 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003149 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003150 }
3151 }
3152
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003153 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003154 return result;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003155
3156error:
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003157 Py_XDECREF(name);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003158 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003159}
3160
3161static int
Victor Stinner974389d2011-03-15 09:33:57 +01003162mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003163{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003164 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003165 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003166}
3167
3168static int
Victor Stinner974389d2011-03-15 09:33:57 +01003169ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003170 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003171{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003172 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003173 PyObject *fullname;
3174 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003175
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003176 if (!_PyObject_HasAttrId(mod, &PyId___path__))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003177 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003178
Victor Stinner974389d2011-03-15 09:33:57 +01003179 fromlist_len = PySequence_Size(fromlist);
3180
3181 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003182 PyObject *item = PySequence_GetItem(fromlist, i);
3183 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003184 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003185 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003186 if (!PyUnicode_Check(item)) {
3187 PyErr_SetString(PyExc_TypeError,
3188 "Item in ``from list'' not a string");
3189 Py_DECREF(item);
3190 return 0;
3191 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003192 if (PyUnicode_READ_CHAR(item, 0) == '*') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003193 PyObject *all;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02003194 _Py_IDENTIFIER(__all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003195 Py_DECREF(item);
3196 /* See if the package defines __all__ */
3197 if (recursive)
3198 continue; /* Avoid endless recursion */
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003199 all = _PyObject_GetAttrId(mod, &PyId___all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003200 if (all == NULL)
3201 PyErr_Clear();
3202 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003203 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003204 Py_DECREF(all);
3205 if (!ret)
3206 return 0;
3207 }
3208 continue;
3209 }
3210 hasit = PyObject_HasAttr(mod, item);
3211 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003212 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003213 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3214 if (fullname != NULL) {
3215 submod = import_submodule(mod, item, fullname);
3216 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003217 }
Victor Stinner974389d2011-03-15 09:33:57 +01003218 else
3219 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003220 Py_XDECREF(submod);
3221 if (submod == NULL) {
3222 Py_DECREF(item);
3223 return 0;
3224 }
3225 }
3226 Py_DECREF(item);
3227 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003228
Victor Stinner974389d2011-03-15 09:33:57 +01003229 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003230}
3231
Neil Schemenauer00b09662003-06-16 21:03:07 +00003232static int
Victor Stinner974389d2011-03-15 09:33:57 +01003233add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3234 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003235{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003236 if (mod == Py_None)
3237 return 1;
3238 /* Irrespective of the success of this load, make a
3239 reference to it in the parent package module. A copy gets
3240 saved in the modules dictionary under the full name, so get a
3241 reference from there, if need be. (The exception is when the
3242 load failed with a SyntaxError -- then there's no trace in
3243 sys.modules. In that case, of course, do nothing extra.) */
3244 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003245 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003246 if (submod == NULL)
3247 return 1;
3248 }
3249 if (PyModule_Check(mod)) {
3250 /* We can't use setattr here since it can give a
3251 * spurious warning if the submodule name shadows a
3252 * builtin name */
3253 PyObject *dict = PyModule_GetDict(mod);
3254 if (!dict)
3255 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003256 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003257 return 0;
3258 }
3259 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003260 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003261 return 0;
3262 }
3263 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003264}
3265
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003266static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003267import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003268{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003269 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003270 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003271 struct filedescr *fdp;
3272 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003273
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003274 /* Require:
3275 if mod == None: subname == fullname
3276 else: mod.__name__ + "." + subname == fullname
3277 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003278
Victor Stinner974389d2011-03-15 09:33:57 +01003279 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003280 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003281 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003282 }
Victor Stinner9599de52011-03-13 22:38:38 -04003283
3284 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003285 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003286 else {
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003287 path_list = _PyObject_GetAttrId(mod, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003288 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003289 PyErr_Clear();
3290 Py_INCREF(Py_None);
3291 return Py_None;
3292 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003293 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003294
Victor Stinner533d7832011-03-14 13:22:54 -04003295 fdp = find_module(fullname, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003296 &bufobj, &fp, &loader);
Victor Stinner533d7832011-03-14 13:22:54 -04003297 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003298 if (fdp == NULL) {
3299 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3300 return NULL;
3301 PyErr_Clear();
3302 Py_INCREF(Py_None);
3303 return Py_None;
3304 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003305 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3306 Py_XDECREF(bufobj);
Victor Stinner9599de52011-03-13 22:38:38 -04003307 Py_XDECREF(loader);
3308 if (fp)
3309 fclose(fp);
3310 if (m == NULL)
3311 return NULL;
3312 if (!add_submodule(mod, m, fullname, subname, modules)) {
3313 Py_XDECREF(m);
3314 return NULL;
3315 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003316 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003317}
3318
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003319
3320/* Re-import a module of any kind and return its module object, WITH
3321 INCREMENTED REFERENCE COUNT */
3322
Guido van Rossum79f25d91997-04-29 20:08:16 +00003323PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003324PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003325{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003326 PyInterpreterState *interp = PyThreadState_Get()->interp;
3327 PyObject *modules_reloading = interp->modules_reloading;
3328 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003329 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003330 PyObject *name, *bufobj, *subname;
3331 Py_ssize_t subname_start;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003332 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003333 FILE *fp = NULL;
3334 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003335
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003336 if (modules_reloading == NULL) {
3337 Py_FatalError("PyImport_ReloadModule: "
3338 "no modules_reloading dictionary!");
3339 return NULL;
3340 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003341
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003342 if (m == NULL || !PyModule_Check(m)) {
3343 PyErr_SetString(PyExc_TypeError,
3344 "reload() argument must be module");
3345 return NULL;
3346 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003347 name = PyModule_GetNameObject(m);
3348 if (name == NULL || PyUnicode_READY(name) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003349 return NULL;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003350 if (m != PyDict_GetItem(modules, name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003351 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003352 "reload(): module %R not in sys.modules",
Martin v. Löwis796ea532011-10-30 09:07:07 +01003353 name);
3354 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003355 return NULL;
3356 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003357 existing_m = PyDict_GetItem(modules_reloading, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003358 if (existing_m != NULL) {
3359 /* Due to a recursive reload, this module is already
3360 being reloaded. */
Martin v. Löwis796ea532011-10-30 09:07:07 +01003361 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003362 Py_INCREF(existing_m);
3363 return existing_m;
3364 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003365 if (PyDict_SetItem(modules_reloading, name, m) < 0) {
3366 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003367 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003368 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003369
Martin v. Löwis796ea532011-10-30 09:07:07 +01003370 subname_start = PyUnicode_FindChar(name, '.', 0,
3371 PyUnicode_GET_LENGTH(name), -1);
3372 if (subname_start == -1) {
3373 Py_INCREF(name);
3374 subname = name;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003375 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003376 else {
3377 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003378 Py_ssize_t len;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003379 parentname = PyUnicode_Substring(name, 0, subname_start);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003380 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003381 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003382 }
3383 parent = PyDict_GetItem(modules, parentname);
3384 if (parent == NULL) {
3385 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003386 "reload(): parent %R not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003387 parentname);
3388 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003389 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003390 }
3391 Py_DECREF(parentname);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003392 path_list = _PyObject_GetAttrId(parent, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003393 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003394 PyErr_Clear();
Martin v. Löwis796ea532011-10-30 09:07:07 +01003395 subname_start++;
3396 len = PyUnicode_GET_LENGTH(name) - (subname_start + 1);
3397 subname = PyUnicode_Substring(name, subname_start, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003398 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003399 if (subname == NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003400 goto error;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003401 fdp = find_module(name, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003402 &bufobj, &fp, &loader);
Martin v. Löwis796ea532011-10-30 09:07:07 +01003403 Py_DECREF(subname);
Victor Stinner533d7832011-03-14 13:22:54 -04003404 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003406 if (fdp == NULL) {
3407 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003408 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003409 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003410
Martin v. Löwis796ea532011-10-30 09:07:07 +01003411 newm = load_module(name, fp, bufobj, fdp->type, loader);
Victor Stinner2fd76e42011-03-14 15:19:39 -04003412 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003413 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003415 if (fp)
3416 fclose(fp);
3417 if (newm == NULL) {
3418 /* load_module probably removed name from modules because of
3419 * the error. Put back the original module object. We're
3420 * going to return NULL in this case regardless of whether
3421 * replacing name succeeds, so the return value is ignored.
3422 */
Martin v. Löwis796ea532011-10-30 09:07:07 +01003423 PyDict_SetItem(modules, name, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003424 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003425
3426error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003427 imp_modules_reloading_clear();
Martin v. Löwis796ea532011-10-30 09:07:07 +01003428 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003429 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003430}
3431
3432
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003433/* Higher-level import emulator which emulates the "import" statement
3434 more accurately -- it invokes the __import__() function from the
3435 builtins of the current globals. This means that the import is
3436 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003437 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003438 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003439 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003440 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003441
3442PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003443PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003444{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003445 static PyObject *silly_list = NULL;
3446 static PyObject *builtins_str = NULL;
3447 static PyObject *import_str = NULL;
3448 PyObject *globals = NULL;
3449 PyObject *import = NULL;
3450 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003451 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003452 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003454 /* Initialize constant string objects */
3455 if (silly_list == NULL) {
3456 import_str = PyUnicode_InternFromString("__import__");
3457 if (import_str == NULL)
3458 return NULL;
3459 builtins_str = PyUnicode_InternFromString("__builtins__");
3460 if (builtins_str == NULL)
3461 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003462 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003463 if (silly_list == NULL)
3464 return NULL;
3465 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003466
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003467 /* Get the builtins from current globals */
3468 globals = PyEval_GetGlobals();
3469 if (globals != NULL) {
3470 Py_INCREF(globals);
3471 builtins = PyObject_GetItem(globals, builtins_str);
3472 if (builtins == NULL)
3473 goto err;
3474 }
3475 else {
3476 /* No globals -- use standard builtins, and fake globals */
3477 builtins = PyImport_ImportModuleLevel("builtins",
3478 NULL, NULL, NULL, 0);
3479 if (builtins == NULL)
3480 return NULL;
3481 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3482 if (globals == NULL)
3483 goto err;
3484 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003485
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003486 /* Get the __import__ function from the builtins */
3487 if (PyDict_Check(builtins)) {
3488 import = PyObject_GetItem(builtins, import_str);
3489 if (import == NULL)
3490 PyErr_SetObject(PyExc_KeyError, import_str);
3491 }
3492 else
3493 import = PyObject_GetAttr(builtins, import_str);
3494 if (import == NULL)
3495 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003496
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003497 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003498 Always use absolute import here.
3499 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003500 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3501 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003502 if (r == NULL)
3503 goto err;
3504 Py_DECREF(r);
3505
3506 modules = PyImport_GetModuleDict();
3507 r = PyDict_GetItem(modules, module_name);
3508 if (r != NULL)
3509 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003510
3511 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003512 Py_XDECREF(globals);
3513 Py_XDECREF(builtins);
3514 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003516 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003517}
3518
3519
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003520/* Module 'imp' provides Python access to the primitives used for
3521 importing modules.
3522*/
3523
Guido van Rossum79f25d91997-04-29 20:08:16 +00003524static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003525imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003526{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003527 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003529 buf[0] = (char) ((magic >> 0) & 0xff);
3530 buf[1] = (char) ((magic >> 8) & 0xff);
3531 buf[2] = (char) ((magic >> 16) & 0xff);
3532 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003533
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003534 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003535}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003536
3537static PyObject *
3538imp_get_magic(PyObject *self, PyObject *noargs)
3539{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003540 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003541}
3542
3543static PyObject *
3544imp_get_tag(PyObject *self, PyObject *noargs)
3545{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003546 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003547}
3548
Guido van Rossum79f25d91997-04-29 20:08:16 +00003549static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003550imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003551{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003552 PyObject *list;
3553 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003554
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003555 list = PyList_New(0);
3556 if (list == NULL)
3557 return NULL;
3558 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3559 PyObject *item = Py_BuildValue("ssi",
3560 fdp->suffix, fdp->mode, fdp->type);
3561 if (item == NULL) {
3562 Py_DECREF(list);
3563 return NULL;
3564 }
3565 if (PyList_Append(list, item) < 0) {
3566 Py_DECREF(list);
3567 Py_DECREF(item);
3568 return NULL;
3569 }
3570 Py_DECREF(item);
3571 }
3572 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003573}
3574
Guido van Rossum79f25d91997-04-29 20:08:16 +00003575static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003576call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003577{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003578 extern int fclose(FILE *);
3579 PyObject *fob, *ret;
3580 PyObject *pathobj;
3581 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003582 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003583 int fd = -1;
3584 char *found_encoding = NULL;
3585 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003586
Victor Stinner533d7832011-03-14 13:22:54 -04003587 if (path_list == Py_None)
3588 path_list = NULL;
3589 fdp = find_module(NULL, name, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003590 &pathobj, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003591 if (fdp == NULL)
3592 return NULL;
3593 if (fp != NULL) {
3594 fd = fileno(fp);
3595 if (fd != -1)
3596 fd = dup(fd);
3597 fclose(fp);
Victor Stinnerd417d012011-06-20 15:16:55 +02003598 if (fd == -1) {
3599 PyErr_SetFromErrno(PyExc_OSError);
3600 return NULL;
3601 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003602 fp = NULL;
3603 }
3604 if (fd != -1) {
3605 if (strchr(fdp->mode, 'b') == NULL) {
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003606 /* PyTokenizer_FindEncodingFilename() returns PyMem_MALLOC'ed
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003607 memory. */
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003608 found_encoding = PyTokenizer_FindEncodingFilename(fd, pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003609 lseek(fd, 0, 0); /* Reset position */
Victor Stinner2fd76e42011-03-14 15:19:39 -04003610 if (found_encoding == NULL && PyErr_Occurred()) {
3611 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003612 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04003613 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003614 encoding = (found_encoding != NULL) ? found_encoding :
3615 (char*)PyUnicode_GetDefaultEncoding();
3616 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003617 fob = PyFile_FromFd(fd, NULL, fdp->mode, -1,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003618 (char*)encoding, NULL, NULL, 1);
3619 if (fob == NULL) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04003620 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003621 close(fd);
3622 PyMem_FREE(found_encoding);
3623 return NULL;
3624 }
3625 }
3626 else {
3627 fob = Py_None;
3628 Py_INCREF(fob);
3629 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003630 if (pathobj == NULL) {
3631 Py_INCREF(Py_None);
3632 pathobj = Py_None;
3633 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003634 ret = Py_BuildValue("NN(ssi)",
3635 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3636 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003637
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003638 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003639}
3640
Guido van Rossum79f25d91997-04-29 20:08:16 +00003641static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003642imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003643{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003644 PyObject *name, *path_list = NULL;
3645 if (!PyArg_ParseTuple(args, "U|O:find_module",
3646 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003647 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003648 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003649}
3650
3651static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003652imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003653{
Victor Stinner95872862011-03-07 18:20:56 +01003654 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003655 int ret;
3656 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003657 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003658 return NULL;
3659 ret = init_builtin(name);
3660 if (ret < 0)
3661 return NULL;
3662 if (ret == 0) {
3663 Py_INCREF(Py_None);
3664 return Py_None;
3665 }
Victor Stinner95872862011-03-07 18:20:56 +01003666 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003667 Py_XINCREF(m);
3668 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003669}
3670
Guido van Rossum79f25d91997-04-29 20:08:16 +00003671static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003672imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003673{
Victor Stinner53dc7352011-03-20 01:50:21 +01003674 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003675 int ret;
3676 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003677 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003678 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003679 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003680 if (ret < 0)
3681 return NULL;
3682 if (ret == 0) {
3683 Py_INCREF(Py_None);
3684 return Py_None;
3685 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003686 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003687 Py_XINCREF(m);
3688 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003689}
3690
Guido van Rossum79f25d91997-04-29 20:08:16 +00003691static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003692imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003693{
Victor Stinner53dc7352011-03-20 01:50:21 +01003694 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003695
Victor Stinner53dc7352011-03-20 01:50:21 +01003696 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003697 return NULL;
3698 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003699}
3700
Guido van Rossum79f25d91997-04-29 20:08:16 +00003701static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003702imp_is_frozen_package(PyObject *self, PyObject *args)
3703{
Victor Stinner53dc7352011-03-20 01:50:21 +01003704 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003705
Victor Stinner53dc7352011-03-20 01:50:21 +01003706 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003707 return NULL;
3708 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003709}
3710
3711static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003712imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003713{
Victor Stinner95872862011-03-07 18:20:56 +01003714 PyObject *name;
3715 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003716 return NULL;
3717 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003718}
3719
Guido van Rossum79f25d91997-04-29 20:08:16 +00003720static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003721imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003722{
Victor Stinner53dc7352011-03-20 01:50:21 +01003723 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003724 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003725 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003726 return NULL;
3727 p = find_frozen(name);
3728 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003729}
3730
3731static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003732get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003733{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003734 FILE *fp;
3735 if (mode[0] == 'U')
3736 mode = "r" PY_STDIOTEXTMODE;
3737 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003738 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003739 }
3740 else {
3741 int fd = PyObject_AsFileDescriptor(fob);
3742 if (fd == -1)
3743 return NULL;
3744 if (!_PyVerify_fd(fd))
3745 goto error;
3746 /* the FILE struct gets a new fd, so that it can be closed
3747 * independently of the file descriptor given
3748 */
3749 fd = dup(fd);
3750 if (fd == -1)
3751 goto error;
3752 fp = fdopen(fd, mode);
3753 }
3754 if (fp)
3755 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003756error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003757 PyErr_SetFromErrno(PyExc_IOError);
3758 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003759}
3760
Guido van Rossum79f25d91997-04-29 20:08:16 +00003761static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003762imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003763{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003764 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003765 PyObject *fob = NULL;
3766 PyObject *m;
3767 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003768 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003769 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003770 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003771 &fob))
3772 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003773 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003774 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003775 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003776 return NULL;
3777 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003778 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003779 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003780 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003781 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003782}
3783
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003784#ifdef HAVE_DYNAMIC_LOADING
3785
Guido van Rossum79f25d91997-04-29 20:08:16 +00003786static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003787imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003788{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003789 PyObject *name, *pathname, *fob = NULL, *mod;
3790 FILE *fp;
3791
3792 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3793 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003794 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003795 if (fob != NULL) {
3796 fp = get_file(NULL, fob, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003797 if (fp == NULL) {
3798 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003799 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003800 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003801 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003802 else
3803 fp = NULL;
3804 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003805 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003806 if (fp)
3807 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003808 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003809}
3810
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003811#endif /* HAVE_DYNAMIC_LOADING */
3812
Guido van Rossum79f25d91997-04-29 20:08:16 +00003813static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003814imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003815{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003816 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003817 PyObject *fob = NULL;
3818 PyObject *m;
3819 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003820 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003821 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003822 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003823 &fob))
3824 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003825 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003826 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003827 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003828 return NULL;
3829 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003830 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003831 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003832 fclose(fp);
3833 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003834}
3835
Guido van Rossum79f25d91997-04-29 20:08:16 +00003836static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003837imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003838{
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003839 PyObject *name, *fob, *pathname, *pathname_obj, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003840 char *suffix; /* Unused */
3841 char *mode;
3842 int type;
3843 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003844
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003845 if (!PyArg_ParseTuple(args, "UOO(ssi):load_module",
3846 &name, &fob, &pathname_obj, &suffix, &mode, &type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003847 return NULL;
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003848 if (pathname_obj != Py_None) {
3849 if (!PyUnicode_FSDecoder(pathname_obj, &pathname))
3850 return NULL;
3851 }
3852 else
3853 pathname = NULL;
3854
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003855 if (*mode) {
3856 /* Mode must start with 'r' or 'U' and must not contain '+'.
3857 Implicit in this test is the assumption that the mode
3858 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003859
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003860 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3861 PyErr_Format(PyExc_ValueError,
3862 "invalid file open mode %.200s", mode);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003863 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003864 return NULL;
3865 }
3866 }
3867 if (fob == Py_None)
3868 fp = NULL;
3869 else {
3870 fp = get_file(NULL, fob, mode);
3871 if (fp == NULL) {
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003872 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003873 return NULL;
3874 }
3875 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003876 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003877 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003878 if (fp)
3879 fclose(fp);
3880 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003881}
3882
3883static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003884imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003885{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003886 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003887 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003888 if (!PyArg_ParseTuple(args, "UO&:load_package",
3889 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003890 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003891 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003892 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003893 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003894}
3895
3896static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003897imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003898{
Victor Stinnerfe19d212011-03-14 14:53:28 -04003899 PyObject *name;
3900 if (!PyArg_ParseTuple(args, "U:new_module", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003901 return NULL;
Victor Stinnerfe19d212011-03-14 14:53:28 -04003902 return PyModule_NewObject(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003903}
3904
Christian Heimes13a7a212008-01-07 17:13:09 +00003905static PyObject *
3906imp_reload(PyObject *self, PyObject *v)
3907{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003908 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003909}
3910
3911PyDoc_STRVAR(doc_reload,
3912"reload(module) -> module\n\
3913\n\
3914Reload the module. The module must have been successfully imported before.");
3915
Barry Warsaw28a691b2010-04-17 00:19:56 +00003916static PyObject *
3917imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3918{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003919 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003920
Victor Stinner2f42ae52011-03-20 00:41:24 +01003921 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003922 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003923 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003924
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003925 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003926 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003927 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003928 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003929
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003930 if (debug_override != NULL &&
3931 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003932 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003933 return NULL;
3934 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003935
Martin v. Löwis30260a72011-10-23 17:35:46 +02003936 if (PyUnicode_READY(pathname) < 0)
3937 return NULL;
3938
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003939 cpathname = make_compiled_pathname(pathname, debug);
Victor Stinner2f42ae52011-03-20 00:41:24 +01003940 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003941
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003942 if (cpathname == NULL) {
3943 PyErr_Format(PyExc_SystemError, "path buffer too short");
3944 return NULL;
3945 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003946 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003947}
3948
3949PyDoc_STRVAR(doc_cache_from_source,
Éric Araujo5df11082011-11-03 03:38:44 +01003950"cache_from_source(path, [debug_override]) -> path\n\
3951Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003952\n\
3953The .py file does not need to exist; this simply returns the path to the\n\
3954.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3955will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3956\n\
3957If debug_override is not None, then it must be a boolean and is taken as\n\
3958the value of __debug__ instead.");
3959
3960static PyObject *
3961imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3962{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003963 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003964 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003965
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003966 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003967 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003968 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003969 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003970
Victor Stinnerc9abda02011-03-14 13:33:46 -04003971 source = make_source_pathname(pathname);
3972 if (source == NULL) {
3973 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003974 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003975 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003976 return NULL;
3977 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003978 Py_DECREF(pathname);
3979 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003980}
3981
3982PyDoc_STRVAR(doc_source_from_cache,
Éric Araujo5df11082011-11-03 03:38:44 +01003983"source_from_cache(path) -> path\n\
3984Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003985\n\
3986The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3987the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3988does not conform to PEP 3147 format, ValueError will be raised.");
3989
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003990/* Doc strings */
3991
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003992PyDoc_STRVAR(doc_imp,
3993"This module provides the components needed to build your own\n\
3994__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003995
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003996PyDoc_STRVAR(doc_find_module,
3997"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003998Search for a module. If path is omitted or None, search for a\n\
3999built-in, frozen or special module and continue search in sys.path.\n\
4000The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004001package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004002
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004003PyDoc_STRVAR(doc_load_module,
4004"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004005Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004006The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004007
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004008PyDoc_STRVAR(doc_get_magic,
4009"get_magic() -> string\n\
4010Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004011
Barry Warsaw28a691b2010-04-17 00:19:56 +00004012PyDoc_STRVAR(doc_get_tag,
4013"get_tag() -> string\n\
4014Return the magic tag for .pyc or .pyo files.");
4015
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004016PyDoc_STRVAR(doc_get_suffixes,
4017"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004018Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004019that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004020
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004021PyDoc_STRVAR(doc_new_module,
4022"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004023Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004024The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004025
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004026PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00004027"lock_held() -> boolean\n\
4028Return True if the import lock is currently held, else False.\n\
4029On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00004030
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004031PyDoc_STRVAR(doc_acquire_lock,
4032"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00004033Acquires the interpreter's import lock for the current thread.\n\
4034This lock should be used by import hooks to ensure thread-safety\n\
4035when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004036On platforms without threads, this function does nothing.");
4037
4038PyDoc_STRVAR(doc_release_lock,
4039"release_lock() -> None\n\
4040Release the interpreter's import lock.\n\
4041On platforms without threads, this function does nothing.");
4042
Guido van Rossum79f25d91997-04-29 20:08:16 +00004043static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004044 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
4045 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
4046 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
4047 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
4048 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
4049 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
4050 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
4051 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
4052 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
4053 {"reload", imp_reload, METH_O, doc_reload},
4054 {"cache_from_source", (PyCFunction)imp_cache_from_source,
4055 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
4056 {"source_from_cache", (PyCFunction)imp_source_from_cache,
4057 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
4058 /* The rest are obsolete */
4059 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
4060 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
4061 {"init_builtin", imp_init_builtin, METH_VARARGS},
4062 {"init_frozen", imp_init_frozen, METH_VARARGS},
4063 {"is_builtin", imp_is_builtin, METH_VARARGS},
4064 {"is_frozen", imp_is_frozen, METH_VARARGS},
4065 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004066#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004067 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004068#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004069 {"load_package", imp_load_package, METH_VARARGS},
4070 {"load_source", imp_load_source, METH_VARARGS},
Brett Cannon442c9b92011-03-23 16:14:42 -07004071 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004072 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004073};
4074
Guido van Rossum1a8791e1998-08-04 22:46:29 +00004075static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004076setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004077{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004078 PyObject *v;
4079 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004080
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004081 v = PyLong_FromLong((long)value);
4082 err = PyDict_SetItemString(d, name, v);
4083 Py_XDECREF(v);
4084 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004085}
4086
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004087typedef struct {
4088 PyObject_HEAD
4089} NullImporter;
4090
4091static int
4092NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4093{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004094#ifndef MS_WINDOWS
4095 PyObject *path;
4096 struct stat statbuf;
4097 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004098
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004099 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4100 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004101
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004102 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4103 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004104 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004105
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004106 if (PyBytes_GET_SIZE(path) == 0) {
4107 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004108 PyErr_SetString(PyExc_ImportError, "empty pathname");
4109 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004110 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004111
4112 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4113 Py_DECREF(path);
4114 if (rv == 0) {
4115 /* it exists */
4116 if (S_ISDIR(statbuf.st_mode)) {
4117 /* it's a directory */
4118 PyErr_SetString(PyExc_ImportError, "existing directory");
4119 return -1;
4120 }
4121 }
4122#else /* MS_WINDOWS */
4123 PyObject *pathobj;
4124 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004125 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004126
4127 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4128 return -1;
4129
4130 if (!PyArg_ParseTuple(args, "U:NullImporter",
4131 &pathobj))
4132 return -1;
4133
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02004134 if (PyUnicode_GET_LENGTH(pathobj) == 0) {
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004135 PyErr_SetString(PyExc_ImportError, "empty pathname");
4136 return -1;
4137 }
4138
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004139 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004140 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004141 return -1;
4142 /* see issue1293 and issue3677:
4143 * stat() on Windows doesn't recognise paths like
4144 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4145 */
4146 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004147 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004148 if (rv != INVALID_FILE_ATTRIBUTES) {
4149 /* it exists */
4150 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4151 /* it's a directory */
4152 PyErr_SetString(PyExc_ImportError, "existing directory");
4153 return -1;
4154 }
4155 }
4156#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004157 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004158}
4159
4160static PyObject *
4161NullImporter_find_module(NullImporter *self, PyObject *args)
4162{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004163 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004164}
4165
4166static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004167 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4168 "Always return None"
4169 },
4170 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004171};
4172
4173
Christian Heimes9cd17752007-11-18 19:35:23 +00004174PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004175 PyVarObject_HEAD_INIT(NULL, 0)
4176 "imp.NullImporter", /*tp_name*/
4177 sizeof(NullImporter), /*tp_basicsize*/
4178 0, /*tp_itemsize*/
4179 0, /*tp_dealloc*/
4180 0, /*tp_print*/
4181 0, /*tp_getattr*/
4182 0, /*tp_setattr*/
4183 0, /*tp_reserved*/
4184 0, /*tp_repr*/
4185 0, /*tp_as_number*/
4186 0, /*tp_as_sequence*/
4187 0, /*tp_as_mapping*/
4188 0, /*tp_hash */
4189 0, /*tp_call*/
4190 0, /*tp_str*/
4191 0, /*tp_getattro*/
4192 0, /*tp_setattro*/
4193 0, /*tp_as_buffer*/
4194 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4195 "Null importer object", /* tp_doc */
4196 0, /* tp_traverse */
4197 0, /* tp_clear */
4198 0, /* tp_richcompare */
4199 0, /* tp_weaklistoffset */
4200 0, /* tp_iter */
4201 0, /* tp_iternext */
4202 NullImporter_methods, /* tp_methods */
4203 0, /* tp_members */
4204 0, /* tp_getset */
4205 0, /* tp_base */
4206 0, /* tp_dict */
4207 0, /* tp_descr_get */
4208 0, /* tp_descr_set */
4209 0, /* tp_dictoffset */
4210 (initproc)NullImporter_init, /* tp_init */
4211 0, /* tp_alloc */
4212 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004213};
4214
Martin v. Löwis1a214512008-06-11 05:26:20 +00004215static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004216 PyModuleDef_HEAD_INIT,
4217 "imp",
4218 doc_imp,
4219 0,
4220 imp_methods,
4221 NULL,
4222 NULL,
4223 NULL,
4224 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004225};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004226
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004227PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004228PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004229{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004230 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004231
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004232 if (PyType_Ready(&PyNullImporter_Type) < 0)
4233 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004235 m = PyModule_Create(&impmodule);
4236 if (m == NULL)
4237 goto failure;
4238 d = PyModule_GetDict(m);
4239 if (d == NULL)
4240 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004241
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004242 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4243 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4244 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4245 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4246 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4247 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4248 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4249 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4250 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4251 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004252
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004253 Py_INCREF(&PyNullImporter_Type);
4254 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4255 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004256 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004257 Py_XDECREF(m);
4258 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004259}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004260
4261
Guido van Rossumb18618d2000-05-03 23:44:39 +00004262/* API for embedding applications that want to add their own entries
4263 to the table of built-in modules. This should normally be called
4264 *before* Py_Initialize(). When the table resize fails, -1 is
4265 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004266
4267 After a similar function by Just van Rossum. */
4268
4269int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004270PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004271{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004272 static struct _inittab *our_copy = NULL;
4273 struct _inittab *p;
4274 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004275
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004276 /* Count the number of entries in both tables */
4277 for (n = 0; newtab[n].name != NULL; n++)
4278 ;
4279 if (n == 0)
4280 return 0; /* Nothing to do */
4281 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4282 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004283
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004284 /* Allocate new memory for the combined table */
4285 p = our_copy;
4286 PyMem_RESIZE(p, struct _inittab, i+n+1);
4287 if (p == NULL)
4288 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004289
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004290 /* Copy the tables into the new memory */
4291 if (our_copy != PyImport_Inittab)
4292 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4293 PyImport_Inittab = our_copy = p;
4294 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004295
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004296 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004297}
4298
4299/* Shorthand to add a single entry given a name and a function */
4300
4301int
Brett Cannona826f322009-04-02 03:41:46 +00004302PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004303{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004304 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004305
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004306 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004307
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004308 newtab[0].name = (char *)name;
4309 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004310
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004311 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004312}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004313
4314#ifdef __cplusplus
4315}
4316#endif