blob: 9366be0589563d13d3dde1ce79947e7508f8ea5c [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)
Tim Peters36515e22001-11-18 04:06:29 +0000105*/
Guido van Rossum3ddee711991-12-16 13:06:34 +0000106
Nick Coghlancd419ab2010-09-11 00:39:25 +0000107/* MAGIC must change whenever the bytecode emitted by the compiler may no
108 longer be understood by older implementations of the eval loop (usually
109 due to the addition of new opcodes)
110 TAG must change for each major Python release. The magic number will take
111 care of any bytecode changes that occur during development.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000112*/
Benjamin Peterson6246d6d2010-09-10 21:51:44 +0000113#define MAGIC (3180 | ((long)'\r'<<16) | ((long)'\n'<<24))
Barry Warsaw28a691b2010-04-17 00:19:56 +0000114#define TAG "cpython-32"
115#define CACHEDIR "__pycache__"
116/* Current magic word and string tag as globals. */
Guido van Rossum96774c12000-05-01 20:19:08 +0000117static long pyc_magic = MAGIC;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000118static const char *pyc_tag = TAG;
Guido van Rossum96774c12000-05-01 20:19:08 +0000119
Victor Stinner49d3f252010-10-17 01:24:53 +0000120/* See _PyImport_FixupExtensionUnicode() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +0000121static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000122
Guido van Rossum771c6c81997-10-31 18:37:24 +0000123/* This table is defined in config.c: */
124extern struct _inittab _PyImport_Inittab[];
125
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000126/* Method from Parser/tokenizer.c */
Guido van Rossum40d20bc2007-10-22 00:09:51 +0000127extern char * PyTokenizer_FindEncoding(int);
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000128
Guido van Rossum771c6c81997-10-31 18:37:24 +0000129struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +0000130
Guido van Rossumed1170e1999-12-20 21:23:41 +0000131/* these tables define the module suffixes that Python recognizes */
132struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000133
Guido van Rossumed1170e1999-12-20 21:23:41 +0000134static const struct filedescr _PyImport_StandardFiletab[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000135 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000136#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000137 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000138#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000139 {".pyc", "rb", PY_COMPILED},
140 {0, 0}
Guido van Rossumed1170e1999-12-20 21:23:41 +0000141};
142
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000143
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000144/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000145
146void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000147_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000148{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000149 const struct filedescr *scan;
150 struct filedescr *filetab;
151 int countD = 0;
152 int countS = 0;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000154 /* prepare _PyImport_Filetab: copy entries from
155 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
156 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000157#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000158 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
159 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000160#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000161 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
162 ++countS;
163 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
164 if (filetab == NULL)
165 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000166#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000167 memcpy(filetab, _PyImport_DynLoadFiletab,
168 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000169#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000170 memcpy(filetab + countD, _PyImport_StandardFiletab,
171 countS * sizeof(struct filedescr));
172 filetab[countD + countS].suffix = NULL;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000173
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000174 _PyImport_Filetab = filetab;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000175
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000176 if (Py_OptimizeFlag) {
177 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
178 for (; filetab->suffix != NULL; filetab++) {
179 if (strcmp(filetab->suffix, ".pyc") == 0)
180 filetab->suffix = ".pyo";
181 }
182 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000183}
184
Guido van Rossum25ce5661997-08-02 03:10:38 +0000185void
Just van Rossum52e14d62002-12-30 22:08:05 +0000186_PyImportHooks_Init(void)
187{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000188 PyObject *v, *path_hooks = NULL, *zimpimport;
189 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +0000190
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000191 /* adding sys.path_hooks and sys.path_importer_cache, setting up
192 zipimport */
193 if (PyType_Ready(&PyNullImporter_Type) < 0)
194 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000195
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000196 if (Py_VerboseFlag)
197 PySys_WriteStderr("# installing zipimport hook\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000198
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000199 v = PyList_New(0);
200 if (v == NULL)
201 goto error;
202 err = PySys_SetObject("meta_path", v);
203 Py_DECREF(v);
204 if (err)
205 goto error;
206 v = PyDict_New();
207 if (v == NULL)
208 goto error;
209 err = PySys_SetObject("path_importer_cache", v);
210 Py_DECREF(v);
211 if (err)
212 goto error;
213 path_hooks = PyList_New(0);
214 if (path_hooks == NULL)
215 goto error;
216 err = PySys_SetObject("path_hooks", path_hooks);
217 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +0000218 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000219 PyErr_Print();
220 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
221 "path_importer_cache, or NullImporter failed"
222 );
223 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000224
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000225 zimpimport = PyImport_ImportModule("zipimport");
226 if (zimpimport == NULL) {
227 PyErr_Clear(); /* No zip import module -- okay */
228 if (Py_VerboseFlag)
229 PySys_WriteStderr("# can't import zipimport\n");
230 }
231 else {
232 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
233 "zipimporter");
234 Py_DECREF(zimpimport);
235 if (zipimporter == NULL) {
236 PyErr_Clear(); /* No zipimporter object -- okay */
237 if (Py_VerboseFlag)
238 PySys_WriteStderr(
239 "# can't import zipimport.zipimporter\n");
240 }
241 else {
242 /* sys.path_hooks.append(zipimporter) */
243 err = PyList_Append(path_hooks, zipimporter);
244 Py_DECREF(zipimporter);
245 if (err)
246 goto error;
247 if (Py_VerboseFlag)
248 PySys_WriteStderr(
249 "# installed zipimport hook\n");
250 }
251 }
252 Py_DECREF(path_hooks);
Just van Rossum52e14d62002-12-30 22:08:05 +0000253}
254
255void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000256_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000257{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000258 Py_XDECREF(extensions);
259 extensions = NULL;
260 PyMem_DEL(_PyImport_Filetab);
261 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000262}
263
264
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000265/* Locking primitives to prevent parallel imports of the same module
266 in different threads to return with a partially loaded module.
267 These calls are serialized by the global interpreter lock. */
268
269#ifdef WITH_THREAD
270
Guido van Rossum49b56061998-10-01 20:42:43 +0000271#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000272
Guido van Rossum65d5b571998-12-21 19:32:43 +0000273static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000274static long import_lock_thread = -1;
275static int import_lock_level = 0;
276
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000277void
278_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000279{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000280 long me = PyThread_get_thread_ident();
281 if (me == -1)
282 return; /* Too bad */
283 if (import_lock == NULL) {
284 import_lock = PyThread_allocate_lock();
285 if (import_lock == NULL)
286 return; /* Nothing much we can do. */
287 }
288 if (import_lock_thread == me) {
289 import_lock_level++;
290 return;
291 }
292 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
293 {
294 PyThreadState *tstate = PyEval_SaveThread();
295 PyThread_acquire_lock(import_lock, 1);
296 PyEval_RestoreThread(tstate);
297 }
298 import_lock_thread = me;
299 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000300}
301
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000302int
303_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000304{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000305 long me = PyThread_get_thread_ident();
306 if (me == -1 || import_lock == NULL)
307 return 0; /* Too bad */
308 if (import_lock_thread != me)
309 return -1;
310 import_lock_level--;
311 if (import_lock_level == 0) {
312 import_lock_thread = -1;
313 PyThread_release_lock(import_lock);
314 }
315 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000316}
317
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000318/* This function is called from PyOS_AfterFork to ensure that newly
319 created child processes do not share locks with the parent.
320 We now acquire the import lock around fork() calls but on some platforms
321 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000322
323void
324_PyImport_ReInitLock(void)
325{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000326 if (import_lock != NULL)
327 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000328 if (import_lock_level > 1) {
329 /* Forked as a side effect of import */
330 long me = PyThread_get_thread_ident();
331 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100332 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000333 import_lock_thread = me;
334 import_lock_level--;
335 } else {
336 import_lock_thread = -1;
337 import_lock_level = 0;
338 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000339}
340
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000341#endif
342
Tim Peters69232342001-08-30 05:16:13 +0000343static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000344imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000345{
Tim Peters69232342001-08-30 05:16:13 +0000346#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000348#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000350#endif
351}
352
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000353static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000354imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000355{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000356#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000357 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000358#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000359 Py_INCREF(Py_None);
360 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000361}
362
363static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000364imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000365{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000366#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 if (_PyImport_ReleaseLock() < 0) {
368 PyErr_SetString(PyExc_RuntimeError,
369 "not holding the import lock");
370 return NULL;
371 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000372#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000373 Py_INCREF(Py_None);
374 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000375}
376
Guido van Rossumd8faa362007-04-27 19:54:29 +0000377static void
378imp_modules_reloading_clear(void)
379{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000380 PyInterpreterState *interp = PyThreadState_Get()->interp;
381 if (interp->modules_reloading != NULL)
382 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000383}
384
Guido van Rossum25ce5661997-08-02 03:10:38 +0000385/* Helper for sys */
386
387PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000388PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000389{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000390 PyInterpreterState *interp = PyThreadState_GET()->interp;
391 if (interp->modules == NULL)
392 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
393 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000394}
395
Guido van Rossum3f5da241990-12-20 15:06:42 +0000396
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000397/* List of names to clear in sys */
398static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000399 "path", "argv", "ps1", "ps2",
400 "last_type", "last_value", "last_traceback",
401 "path_hooks", "path_importer_cache", "meta_path",
402 /* misc stuff */
403 "flags", "float_info",
404 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000405};
406
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000407static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000408 "stdin", "__stdin__",
409 "stdout", "__stdout__",
410 "stderr", "__stderr__",
411 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000412};
413
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000414
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000415/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000416
Guido van Rossum3f5da241990-12-20 15:06:42 +0000417void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000418PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000419{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000420 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000421 PyObject *key, *value, *dict;
422 PyInterpreterState *interp = PyThreadState_GET()->interp;
423 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000424
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000425 if (modules == NULL)
426 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000428 /* Delete some special variables first. These are common
429 places where user values hide and people complain when their
430 destructors fail. Since the modules containing them are
431 deleted *last* of all, they would come too late in the normal
432 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000433
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000434 value = PyDict_GetItemString(modules, "builtins");
435 if (value != NULL && PyModule_Check(value)) {
436 dict = PyModule_GetDict(value);
437 if (Py_VerboseFlag)
438 PySys_WriteStderr("# clear builtins._\n");
439 PyDict_SetItemString(dict, "_", Py_None);
440 }
441 value = PyDict_GetItemString(modules, "sys");
442 if (value != NULL && PyModule_Check(value)) {
443 char **p;
444 PyObject *v;
445 dict = PyModule_GetDict(value);
446 for (p = sys_deletes; *p != NULL; p++) {
447 if (Py_VerboseFlag)
448 PySys_WriteStderr("# clear sys.%s\n", *p);
449 PyDict_SetItemString(dict, *p, Py_None);
450 }
451 for (p = sys_files; *p != NULL; p+=2) {
452 if (Py_VerboseFlag)
453 PySys_WriteStderr("# restore sys.%s\n", *p);
454 v = PyDict_GetItemString(dict, *(p+1));
455 if (v == NULL)
456 v = Py_None;
457 PyDict_SetItemString(dict, *p, v);
458 }
459 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000460
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000461 /* First, delete __main__ */
462 value = PyDict_GetItemString(modules, "__main__");
463 if (value != NULL && PyModule_Check(value)) {
464 if (Py_VerboseFlag)
465 PySys_WriteStderr("# cleanup __main__\n");
466 _PyModule_Clear(value);
467 PyDict_SetItemString(modules, "__main__", Py_None);
468 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000469
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000470 /* The special treatment of "builtins" here is because even
471 when it's not referenced as a module, its dictionary is
472 referenced by almost every module's __builtins__. Since
473 deleting a module clears its dictionary (even if there are
474 references left to it), we need to delete the "builtins"
475 module last. Likewise, we don't delete sys until the very
476 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000477
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000478 Also note that we 'delete' modules by replacing their entry
479 in the modules dict with None, rather than really deleting
480 them; this avoids a rehash of the modules dictionary and
481 also marks them as "non existent" so they won't be
482 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000484 /* Next, repeatedly delete modules with a reference count of
485 one (skipping builtins and sys) and delete them */
486 do {
487 ndone = 0;
488 pos = 0;
489 while (PyDict_Next(modules, &pos, &key, &value)) {
490 if (value->ob_refcnt != 1)
491 continue;
492 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100493 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000494 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100495 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000496 continue;
497 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100498 PySys_FormatStderr(
499 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000500 _PyModule_Clear(value);
501 PyDict_SetItem(modules, key, Py_None);
502 ndone++;
503 }
504 }
505 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000507 /* Next, delete all modules (still skipping builtins and sys) */
508 pos = 0;
509 while (PyDict_Next(modules, &pos, &key, &value)) {
510 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100511 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000512 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100513 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514 continue;
515 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100516 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000517 _PyModule_Clear(value);
518 PyDict_SetItem(modules, key, Py_None);
519 }
520 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000522 /* Next, delete sys and builtins (in that order) */
523 value = PyDict_GetItemString(modules, "sys");
524 if (value != NULL && PyModule_Check(value)) {
525 if (Py_VerboseFlag)
526 PySys_WriteStderr("# cleanup sys\n");
527 _PyModule_Clear(value);
528 PyDict_SetItemString(modules, "sys", Py_None);
529 }
530 value = PyDict_GetItemString(modules, "builtins");
531 if (value != NULL && PyModule_Check(value)) {
532 if (Py_VerboseFlag)
533 PySys_WriteStderr("# cleanup builtins\n");
534 _PyModule_Clear(value);
535 PyDict_SetItemString(modules, "builtins", Py_None);
536 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 /* Finally, clear and delete the modules directory */
539 PyDict_Clear(modules);
540 interp->modules = NULL;
541 Py_DECREF(modules);
542 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000543}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000544
545
Barry Warsaw28a691b2010-04-17 00:19:56 +0000546/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000547
548long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000549PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000550{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000551 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000552}
553
554
Barry Warsaw28a691b2010-04-17 00:19:56 +0000555const char *
556PyImport_GetMagicTag(void)
557{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000558 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000559}
560
Guido van Rossum25ce5661997-08-02 03:10:38 +0000561/* Magic for extension modules (built-in as well as dynamically
562 loaded). To prevent initializing an extension module more than
563 once, we keep a static dictionary 'extensions' keyed by module name
564 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000565 modules), containing these modules. A copy of the module's
Victor Stinner49d3f252010-10-17 01:24:53 +0000566 dictionary is stored by calling _PyImport_FixupExtensionUnicode()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000567 immediately after the module initialization function succeeds. A
568 copy can be retrieved from there by calling
Victor Stinner49d3f252010-10-17 01:24:53 +0000569 _PyImport_FindExtensionUnicode().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000570
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000571 Modules which do support multiple initialization set their m_size
572 field to a non-negative number (indicating the size of the
573 module-specific state). They are still recorded in the extensions
574 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000575*/
576
577int
Victor Stinner49d3f252010-10-17 01:24:53 +0000578_PyImport_FixupExtensionUnicode(PyObject *mod, char *name, PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000579{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000580 PyObject *modules, *dict;
581 struct PyModuleDef *def;
582 if (extensions == NULL) {
583 extensions = PyDict_New();
584 if (extensions == NULL)
585 return -1;
586 }
587 if (mod == NULL || !PyModule_Check(mod)) {
588 PyErr_BadInternalCall();
589 return -1;
590 }
591 def = PyModule_GetDef(mod);
592 if (!def) {
593 PyErr_BadInternalCall();
594 return -1;
595 }
596 modules = PyImport_GetModuleDict();
597 if (PyDict_SetItemString(modules, name, mod) < 0)
598 return -1;
599 if (_PyState_AddModule(mod, def) < 0) {
600 PyDict_DelItemString(modules, name);
601 return -1;
602 }
603 if (def->m_size == -1) {
604 if (def->m_base.m_copy) {
605 /* Somebody already imported the module,
606 likely under a different name.
607 XXX this should really not happen. */
608 Py_DECREF(def->m_base.m_copy);
609 def->m_base.m_copy = NULL;
610 }
611 dict = PyModule_GetDict(mod);
612 if (dict == NULL)
613 return -1;
614 def->m_base.m_copy = PyDict_Copy(dict);
615 if (def->m_base.m_copy == NULL)
616 return -1;
617 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000618 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000620}
621
Victor Stinner49d3f252010-10-17 01:24:53 +0000622int
623_PyImport_FixupBuiltin(PyObject *mod, char *name)
624{
625 int res;
626 PyObject *filename;
627 filename = PyUnicode_FromString(name);
628 if (filename == NULL)
629 return -1;
630 res = _PyImport_FixupExtensionUnicode(mod, name, filename);
631 Py_DECREF(filename);
632 return res;
633}
634
Guido van Rossum25ce5661997-08-02 03:10:38 +0000635PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000636_PyImport_FindExtensionUnicode(const char *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000637{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000638 PyObject *mod, *mdict;
639 PyModuleDef* def;
640 if (extensions == NULL)
641 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000642 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000643 if (def == NULL)
644 return NULL;
645 if (def->m_size == -1) {
646 /* Module does not support repeated initialization */
647 if (def->m_base.m_copy == NULL)
648 return NULL;
649 mod = PyImport_AddModule(name);
650 if (mod == NULL)
651 return NULL;
652 mdict = PyModule_GetDict(mod);
653 if (mdict == NULL)
654 return NULL;
655 if (PyDict_Update(mdict, def->m_base.m_copy))
656 return NULL;
657 }
658 else {
659 if (def->m_base.m_init == NULL)
660 return NULL;
661 mod = def->m_base.m_init();
662 if (mod == NULL)
663 return NULL;
664 PyDict_SetItemString(PyImport_GetModuleDict(), name, mod);
665 Py_DECREF(mod);
666 }
667 if (_PyState_AddModule(mod, def) < 0) {
668 PyDict_DelItemString(PyImport_GetModuleDict(), name);
669 Py_DECREF(mod);
670 return NULL;
671 }
672 if (Py_VerboseFlag)
Victor Stinner49d3f252010-10-17 01:24:53 +0000673 PySys_FormatStderr("import %s # previously loaded (%U)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000674 name, filename);
675 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000676
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000677}
678
Victor Stinner49d3f252010-10-17 01:24:53 +0000679PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000680_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000681{
682 PyObject *res, *filename;
683 filename = PyUnicode_FromString(name);
684 if (filename == NULL)
685 return NULL;
686 res = _PyImport_FindExtensionUnicode(name, filename);
687 Py_DECREF(filename);
688 return res;
689}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000690
691/* Get the module object corresponding to a module name.
692 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000693 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000694 Because the former action is most common, THIS DOES NOT RETURN A
695 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000696
Guido van Rossum79f25d91997-04-29 20:08:16 +0000697PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000698PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000699{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000700 PyObject *modules = PyImport_GetModuleDict();
701 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000702
Victor Stinner27ee0892011-03-04 12:57:09 +0000703 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000704 PyModule_Check(m))
705 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000706 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000707 if (m == NULL)
708 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000709 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000710 Py_DECREF(m);
711 return NULL;
712 }
713 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000714
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000715 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000716}
717
Victor Stinner27ee0892011-03-04 12:57:09 +0000718PyObject *
719PyImport_AddModule(const char *name)
720{
721 PyObject *nameobj, *module;
722 nameobj = PyUnicode_FromString(name);
723 if (nameobj == NULL)
724 return NULL;
725 module = PyImport_AddModuleObject(nameobj);
726 Py_DECREF(nameobj);
727 return module;
728}
729
730
Tim Peters1cd70172004-08-02 03:52:12 +0000731/* Remove name from sys.modules, if it's there. */
732static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000733remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000734{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000735 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000736 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000737 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000738 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000739 Py_FatalError("import: deleting existing key in"
740 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000741}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000742
Barry Warsaw28a691b2010-04-17 00:19:56 +0000743static PyObject * get_sourcefile(char *file);
744static char *make_source_pathname(char *pathname, char *buf);
745static char *make_compiled_pathname(char *pathname, char *buf, size_t buflen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000746 int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000747
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000748/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000749 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
750 * removed from sys.modules, to avoid leaving damaged module objects
751 * in sys.modules. The caller may wish to restore the original
752 * module object (if any) in this case; PyImport_ReloadModule is an
753 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000754 *
755 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
756 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000757 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000758PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000759PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000760{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000761 return PyImport_ExecCodeModuleWithPathnames(
762 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000763}
764
765PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000766PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000767{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000768 return PyImport_ExecCodeModuleWithPathnames(
769 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000770}
771
772PyObject *
773PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000774 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000775{
Victor Stinner27ee0892011-03-04 12:57:09 +0000776 PyObject *m = NULL;
777 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
778
779 nameobj = PyUnicode_FromString(name);
780 if (nameobj == NULL)
781 return NULL;
782
783 if (pathname != NULL) {
784 pathobj = PyUnicode_DecodeFSDefault(pathname);
785 if (pathobj == NULL)
786 goto error;
787 } else
788 pathobj = NULL;
789 if (cpathname != NULL) {
790 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
791 if (cpathobj == NULL)
792 goto error;
793 } else
794 cpathobj = NULL;
795 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
796error:
797 Py_DECREF(nameobj);
798 Py_XDECREF(pathobj);
799 Py_XDECREF(cpathobj);
800 return m;
801}
802
803PyObject*
804PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
805 PyObject *cpathname)
806{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000807 PyObject *modules = PyImport_GetModuleDict();
808 PyObject *m, *d, *v;
Victor Stinner27ee0892011-03-04 12:57:09 +0000809 PyObject *pathbytes;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000810
Victor Stinner27ee0892011-03-04 12:57:09 +0000811 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000812 if (m == NULL)
813 return NULL;
814 /* If the module is being reloaded, we get the old module back
815 and re-use its dict to exec the new code. */
816 d = PyModule_GetDict(m);
817 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
818 if (PyDict_SetItemString(d, "__builtins__",
819 PyEval_GetBuiltins()) != 0)
820 goto error;
821 }
822 /* Remember the filename as the __file__ attribute */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000823 if (pathname != NULL) {
Victor Stinner27ee0892011-03-04 12:57:09 +0000824 pathbytes = PyUnicode_EncodeFSDefault(pathname);
825 if (pathbytes != NULL) {
826 v = get_sourcefile(PyBytes_AS_STRING(pathbytes));
827 Py_DECREF(pathbytes);
828 } else
829 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000830 if (v == NULL)
831 PyErr_Clear();
832 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000833 else
834 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000835 if (v == NULL) {
836 v = ((PyCodeObject *)co)->co_filename;
837 Py_INCREF(v);
838 }
839 if (PyDict_SetItemString(d, "__file__", v) != 0)
840 PyErr_Clear(); /* Not important enough to report */
841 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000842
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000844 if (cpathname != NULL)
845 v = cpathname;
846 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000847 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000848 if (PyDict_SetItemString(d, "__cached__", v) != 0)
849 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000850
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000851 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000852 if (v == NULL)
853 goto error;
854 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000855
Victor Stinner27ee0892011-03-04 12:57:09 +0000856 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000857 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000858 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000859 name);
860 return NULL;
861 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000862
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000863 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000864
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000865 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000866
867 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000868 remove_module(name);
869 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000870}
871
872
Barry Warsaw28a691b2010-04-17 00:19:56 +0000873/* Like strrchr(string, '/') but searches for the rightmost of either SEP
874 or ALTSEP, if the latter is defined.
875*/
876static char *
877rightmost_sep(char *s)
878{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000879 char *found, c;
880 for (found = NULL; (c = *s); s++) {
881 if (c == SEP
Barry Warsaw28a691b2010-04-17 00:19:56 +0000882#ifdef ALTSEP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000883 || c == ALTSEP
Barry Warsaw28a691b2010-04-17 00:19:56 +0000884#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000885 )
886 {
887 found = s;
888 }
889 }
890 return found;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000891}
892
893
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000894/* Given a pathname for a Python source file, fill a buffer with the
895 pathname for the corresponding compiled file. Return the pathname
896 for the compiled file, or NULL if there's no space in the buffer.
897 Doesn't set an exception. */
898
899static char *
Barry Warsaw28a691b2010-04-17 00:19:56 +0000900make_compiled_pathname(char *pathname, char *buf, size_t buflen, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000901{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000902 /* foo.py -> __pycache__/foo.<tag>.pyc */
903 size_t len = strlen(pathname);
904 size_t i, save;
905 char *pos;
906 int sep = SEP;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000907
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000908 /* Sanity check that the buffer has roughly enough space to hold what
909 will eventually be the full path to the compiled file. The 5 extra
910 bytes include the slash afer __pycache__, the two extra dots, the
911 extra trailing character ('c' or 'o') and null. This isn't exact
912 because the contents of the buffer can affect how many actual
913 characters of the string get into the buffer. We'll do a final
914 sanity check before writing the extension to ensure we do not
915 overflow the buffer.
916 */
917 if (len + strlen(CACHEDIR) + strlen(pyc_tag) + 5 > buflen)
918 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000919
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000920 /* Find the last path separator and copy everything from the start of
921 the source string up to and including the separator.
922 */
923 if ((pos = rightmost_sep(pathname)) == NULL) {
924 i = 0;
925 }
926 else {
927 sep = *pos;
928 i = pos - pathname + 1;
929 strncpy(buf, pathname, i);
930 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000931
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000932 save = i;
933 buf[i++] = '\0';
934 /* Add __pycache__/ */
935 strcat(buf, CACHEDIR);
936 i += strlen(CACHEDIR) - 1;
937 buf[i++] = sep;
938 buf[i++] = '\0';
939 /* Add the base filename, but remove the .py or .pyw extension, since
940 the tag name must go before the extension.
941 */
942 strcat(buf, pathname + save);
943 if ((pos = strrchr(buf, '.')) != NULL)
944 *++pos = '\0';
945 strcat(buf, pyc_tag);
946 /* The length test above assumes that we're only adding one character
947 to the end of what would normally be the extension. What if there
948 is no extension, or the string ends in '.' or '.p', and otherwise
949 fills the buffer? By appending 4 more characters onto the string
950 here, we could overrun the buffer.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000951
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000952 As a simple example, let's say buflen=32 and the input string is
953 'xxx.py'. strlen() would be 6 and the test above would yield:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000954
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 (6 + 11 + 10 + 5 == 32) > 32
Barry Warsaw28a691b2010-04-17 00:19:56 +0000956
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000957 which is false and so the name mangling would continue. This would
958 be fine because we'd end up with this string in buf:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000959
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 __pycache__/xxx.cpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000961
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000962 strlen(of that) == 30 + the nul fits inside a 32 character buffer.
963 We can even handle an input string of say 'xxxxx' above because
964 that's (5 + 11 + 10 + 5 == 31) > 32 which is also false. Name
965 mangling that yields:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000966
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000967 __pycache__/xxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000968
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000969 which is 32 characters including the nul, and thus fits in the
970 buffer. However, an input string of 'xxxxxx' would yield a result
971 string of:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000972
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000973 __pycache__/xxxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000974
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000975 which is 33 characters long (including the nul), thus overflowing
976 the buffer, even though the first test would fail, i.e.: the input
977 string is also 6 characters long, so 32 > 32 is false.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000978
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000979 The reason the first test fails but we still overflow the buffer is
980 that the test above only expects to add one extra character to be
981 added to the extension, and here we're adding three (pyc). We
982 don't add the first dot, so that reclaims one of expected
983 positions, leaving us overflowing by 1 byte (3 extra - 1 reclaimed
984 dot - 1 expected extra == 1 overflowed).
Barry Warsaw28a691b2010-04-17 00:19:56 +0000985
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000986 The best we can do is ensure that we still have enough room in the
987 target buffer before we write the extension. Because it's always
988 only the extension that can cause the overflow, and never the other
989 path bytes we've written, it's sufficient to just do one more test
990 here. Still, the assertion that follows can't hurt.
991 */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000992#if 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000993 printf("strlen(buf): %d; buflen: %d\n", (int)strlen(buf), (int)buflen);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000994#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000995 if (strlen(buf) + 5 > buflen)
996 return NULL;
997 strcat(buf, debug ? ".pyc" : ".pyo");
998 assert(strlen(buf) < buflen);
999 return buf;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001000}
1001
1002
Barry Warsaw28a691b2010-04-17 00:19:56 +00001003/* Given a pathname to a Python byte compiled file, return the path to the
1004 source file, if the path matches the PEP 3147 format. This does not check
1005 for any file existence, however, if the pyc file name does not match PEP
1006 3147 style, NULL is returned. buf must be at least as big as pathname;
1007 the resulting path will always be shorter. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001008
Barry Warsaw28a691b2010-04-17 00:19:56 +00001009static char *
1010make_source_pathname(char *pathname, char *buf)
1011{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001012 /* __pycache__/foo.<tag>.pyc -> foo.py */
1013 size_t i, j;
1014 char *left, *right, *dot0, *dot1, sep;
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 */
1020 if ((right = rightmost_sep(pathname)) == NULL)
1021 return NULL;
1022 sep = *right;
1023 *right = '\0';
1024 left = rightmost_sep(pathname);
1025 *right = sep;
1026 if (left == NULL)
1027 left = pathname;
1028 else
1029 left++;
1030 if (right-left != strlen(CACHEDIR) ||
1031 strncmp(left, CACHEDIR, right-left) != 0)
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 */
1037 if ((dot0 = strchr(right + 1, '.')) == NULL)
1038 return NULL;
1039 if ((dot1 = strchr(dot0 + 1, '.')) == NULL)
1040 return NULL;
1041 /* Too many dots? */
1042 if (strchr(dot1 + 1, '.') != NULL)
1043 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001044
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001045 /* This is a PEP 3147 path. Start by copying everything from the
1046 start of pathname up to and including the leftmost slash. Then
1047 copy the file's basename, removing the magic tag and adding a .py
1048 suffix.
1049 */
1050 strncpy(buf, pathname, (i=left-pathname));
1051 strncpy(buf+i, right+1, (j=dot0-right));
1052 strcpy(buf+i+j, "py");
1053 return buf;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001054}
1055
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001056/* Given a pathname for a Python source file, its time of last
1057 modification, and a pathname for a compiled file, check whether the
1058 compiled file represents the same version of the source. If so,
1059 return a FILE pointer for the compiled file, positioned just after
1060 the header; if not, return NULL.
1061 Doesn't set an exception. */
1062
1063static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001064check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001065{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001066 FILE *fp;
1067 long magic;
1068 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001069
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001070 fp = fopen(cpathname, "rb");
1071 if (fp == NULL)
1072 return NULL;
1073 magic = PyMarshal_ReadLongFromFile(fp);
1074 if (magic != pyc_magic) {
1075 if (Py_VerboseFlag)
1076 PySys_WriteStderr("# %s has bad magic\n", cpathname);
1077 fclose(fp);
1078 return NULL;
1079 }
1080 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
1081 if (pyc_mtime != mtime) {
1082 if (Py_VerboseFlag)
1083 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
1084 fclose(fp);
1085 return NULL;
1086 }
1087 if (Py_VerboseFlag)
1088 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
1089 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001090}
1091
1092
1093/* Read a code object from a file and check it for validity */
1094
Guido van Rossum79f25d91997-04-29 20:08:16 +00001095static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001096read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001097{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001098 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001099
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001100 co = PyMarshal_ReadLastObjectFromFile(fp);
1101 if (co == NULL)
1102 return NULL;
1103 if (!PyCode_Check(co)) {
1104 PyErr_Format(PyExc_ImportError,
1105 "Non-code object in %.200s", cpathname);
1106 Py_DECREF(co);
1107 return NULL;
1108 }
1109 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001110}
1111
1112
1113/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001114 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001115
Guido van Rossum79f25d91997-04-29 20:08:16 +00001116static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001117load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001118{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001119 long magic;
1120 PyCodeObject *co;
1121 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001122
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001123 magic = PyMarshal_ReadLongFromFile(fp);
1124 if (magic != pyc_magic) {
1125 PyErr_Format(PyExc_ImportError,
1126 "Bad magic number in %.200s", cpathname);
1127 return NULL;
1128 }
1129 (void) PyMarshal_ReadLongFromFile(fp);
1130 co = read_compiled_module(cpathname, fp);
1131 if (co == NULL)
1132 return NULL;
1133 if (Py_VerboseFlag)
1134 PySys_WriteStderr("import %s # precompiled from %s\n",
1135 name, cpathname);
1136 m = PyImport_ExecCodeModuleWithPathnames(
1137 name, (PyObject *)co, cpathname, cpathname);
1138 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001140 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001141}
1142
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001143/* Parse a source file and return the corresponding code object */
1144
Guido van Rossum79f25d91997-04-29 20:08:16 +00001145static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001146parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001147{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001148 PyCodeObject *co = NULL;
1149 mod_ty mod;
1150 PyCompilerFlags flags;
1151 PyArena *arena = PyArena_New();
1152 if (arena == NULL)
1153 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001154
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001155 flags.cf_flags = 0;
1156 mod = PyParser_ASTFromFile(fp, pathname, NULL,
1157 Py_file_input, 0, 0, &flags,
1158 NULL, arena);
1159 if (mod) {
1160 co = PyAST_Compile(mod, pathname, NULL, arena);
1161 }
1162 PyArena_Free(arena);
1163 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001164}
1165
1166
Guido van Rossum55a83382000-09-20 20:31:38 +00001167/* Helper to open a bytecode file for writing in exclusive mode */
1168
1169static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +00001170open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +00001171{
1172#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001173 /* Use O_EXCL to avoid a race condition when another process tries to
1174 write the same file. When that happens, our open() call fails,
1175 which is just fine (since it's only a cache).
1176 XXX If the file exists and is writable but the directory is not
1177 writable, the file will never be written. Oh well.
1178 */
1179 int fd;
1180 (void) unlink(filename);
1181 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +00001182#ifdef O_BINARY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001183 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +00001184#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001185#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001186 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001187#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001188 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001189#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001190 );
1191 if (fd < 0)
1192 return NULL;
1193 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001194#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001195 /* Best we can do -- on Windows this can't happen anyway */
1196 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001197#endif
1198}
1199
1200
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001201/* Write a compiled module to a file, placing the time of last
1202 modification of its source into the header.
1203 Errors are ignored, if a write error occurs an attempt is made to
1204 remove the file. */
1205
1206static void
Christian Heimes05e8be12008-02-23 18:30:17 +00001207write_compiled_module(PyCodeObject *co, char *cpathname, struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001208{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001209 FILE *fp;
1210 char *dirpath;
1211 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001212#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001213 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001214#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
1216 mode_t dirmode = (srcstat->st_mode |
1217 S_IXUSR | S_IXGRP | S_IXOTH |
1218 S_IWUSR | S_IWGRP | S_IWOTH);
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001219#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001220 int saved;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001221
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001222 /* Ensure that the __pycache__ directory exists. */
1223 dirpath = rightmost_sep(cpathname);
1224 if (dirpath == NULL) {
1225 if (Py_VerboseFlag)
1226 PySys_WriteStderr(
1227 "# no %s path found %s\n",
1228 CACHEDIR, cpathname);
1229 return;
1230 }
1231 saved = *dirpath;
1232 *dirpath = '\0';
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001233
1234#ifdef MS_WINDOWS
1235 if (_mkdir(cpathname) < 0 && errno != EEXIST) {
1236#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001237 if (mkdir(cpathname, dirmode) < 0 && errno != EEXIST) {
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001238#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001239 *dirpath = saved;
1240 if (Py_VerboseFlag)
1241 PySys_WriteStderr(
1242 "# cannot create cache dir %s\n", cpathname);
1243 return;
1244 }
1245 *dirpath = saved;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001246
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001247 fp = open_exclusive(cpathname, mode);
1248 if (fp == NULL) {
1249 if (Py_VerboseFlag)
1250 PySys_WriteStderr(
1251 "# can't create %s\n", cpathname);
1252 return;
1253 }
1254 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1255 /* First write a 0 for mtime */
1256 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1257 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
1258 if (fflush(fp) != 0 || ferror(fp)) {
1259 if (Py_VerboseFlag)
1260 PySys_WriteStderr("# can't write %s\n", cpathname);
1261 /* Don't keep partial file */
1262 fclose(fp);
1263 (void) unlink(cpathname);
1264 return;
1265 }
1266 /* Now write the true mtime */
1267 fseek(fp, 4L, 0);
1268 assert(mtime < LONG_MAX);
1269 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
1270 fflush(fp);
1271 fclose(fp);
1272 if (Py_VerboseFlag)
1273 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001274}
1275
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001276static void
1277update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1278{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001279 PyObject *constants, *tmp;
1280 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001282 if (PyUnicode_Compare(co->co_filename, oldname))
1283 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001284
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001285 tmp = co->co_filename;
1286 co->co_filename = newname;
1287 Py_INCREF(co->co_filename);
1288 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001289
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001290 constants = co->co_consts;
1291 n = PyTuple_GET_SIZE(constants);
1292 for (i = 0; i < n; i++) {
1293 tmp = PyTuple_GET_ITEM(constants, i);
1294 if (PyCode_Check(tmp))
1295 update_code_filenames((PyCodeObject *)tmp,
1296 oldname, newname);
1297 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001298}
1299
1300static int
1301update_compiled_module(PyCodeObject *co, char *pathname)
1302{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001303 PyObject *oldname, *newname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001304
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001305 newname = PyUnicode_DecodeFSDefault(pathname);
1306 if (newname == NULL)
1307 return -1;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001308
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001309 if (!PyUnicode_Compare(co->co_filename, newname)) {
1310 Py_DECREF(newname);
1311 return 0;
1312 }
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001313
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001314 oldname = co->co_filename;
1315 Py_INCREF(oldname);
1316 update_code_filenames(co, oldname, newname);
1317 Py_DECREF(oldname);
1318 Py_DECREF(newname);
1319 return 1;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001320}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001321
1322/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001323 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1324 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001325
Guido van Rossum79f25d91997-04-29 20:08:16 +00001326static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001327load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001328{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001329 struct stat st;
1330 FILE *fpc;
1331 char buf[MAXPATHLEN+1];
1332 char *cpathname;
1333 PyCodeObject *co;
1334 PyObject *m;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001335
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001336 if (fstat(fileno(fp), &st) != 0) {
1337 PyErr_Format(PyExc_RuntimeError,
1338 "unable to get file status from '%s'",
1339 pathname);
1340 return NULL;
1341 }
Fred Drake4c82b232000-06-30 16:18:57 +00001342#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001343 /* Python's .pyc timestamp handling presumes that the timestamp fits
1344 in 4 bytes. This will be fine until sometime in the year 2038,
1345 when a 4-byte signed time_t will overflow.
1346 */
1347 if (st.st_mtime >> 32) {
1348 PyErr_SetString(PyExc_OverflowError,
1349 "modification time overflows a 4 byte field");
1350 return NULL;
1351 }
Fred Drake4c82b232000-06-30 16:18:57 +00001352#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353 cpathname = make_compiled_pathname(
1354 pathname, buf, (size_t)MAXPATHLEN + 1, !Py_OptimizeFlag);
1355 if (cpathname != NULL &&
1356 (fpc = check_compiled_module(pathname, st.st_mtime, cpathname))) {
1357 co = read_compiled_module(cpathname, fpc);
1358 fclose(fpc);
1359 if (co == NULL)
1360 return NULL;
1361 if (update_compiled_module(co, pathname) < 0)
1362 return NULL;
1363 if (Py_VerboseFlag)
1364 PySys_WriteStderr("import %s # precompiled from %s\n",
1365 name, cpathname);
1366 pathname = cpathname;
1367 }
1368 else {
1369 co = parse_source_module(pathname, fp);
1370 if (co == NULL)
1371 return NULL;
1372 if (Py_VerboseFlag)
1373 PySys_WriteStderr("import %s # from %s\n",
1374 name, pathname);
1375 if (cpathname) {
1376 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1377 if (ro == NULL || !PyObject_IsTrue(ro))
1378 write_compiled_module(co, cpathname, &st);
1379 }
1380 }
1381 m = PyImport_ExecCodeModuleWithPathnames(
1382 name, (PyObject *)co, pathname, cpathname);
1383 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001384
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001385 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001386}
1387
Christian Heimes3b06e532008-01-07 20:12:44 +00001388/* Get source file -> unicode or None
1389 * Returns the path to the py file if available, else the given path
1390 */
1391static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00001392get_sourcefile(char *file)
Christian Heimes3b06e532008-01-07 20:12:44 +00001393{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001394 char py[MAXPATHLEN + 1];
1395 Py_ssize_t len;
1396 PyObject *u;
1397 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001398
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001399 if (!file || !*file) {
1400 Py_RETURN_NONE;
1401 }
Christian Heimes3b06e532008-01-07 20:12:44 +00001402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001403 len = strlen(file);
1404 /* match '*.py?' */
1405 if (len > MAXPATHLEN || PyOS_strnicmp(&file[len-4], ".py", 3) != 0) {
1406 return PyUnicode_DecodeFSDefault(file);
1407 }
Christian Heimes3b06e532008-01-07 20:12:44 +00001408
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001409 /* Start by trying to turn PEP 3147 path into source path. If that
1410 * fails, just chop off the trailing character, i.e. legacy pyc path
1411 * to py.
1412 */
1413 if (make_source_pathname(file, py) == NULL) {
1414 strncpy(py, file, len-1);
1415 py[len-1] = '\0';
1416 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00001417
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001418 if (stat(py, &statbuf) == 0 &&
1419 S_ISREG(statbuf.st_mode)) {
1420 u = PyUnicode_DecodeFSDefault(py);
1421 }
1422 else {
1423 u = PyUnicode_DecodeFSDefault(file);
1424 }
1425 return u;
Christian Heimes3b06e532008-01-07 20:12:44 +00001426}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001427
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001428/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001429static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
1430static struct filedescr *find_module(char *, char *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001431 char *, size_t, FILE **, PyObject **);
Christian Heimes3b06e532008-01-07 20:12:44 +00001432static struct _frozen * find_frozen(char *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001433
1434/* Load a package and return its module object WITH INCREMENTED
1435 REFERENCE COUNT */
1436
1437static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001438load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001439{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001440 PyObject *m, *d;
1441 PyObject *file = NULL;
1442 PyObject *path = NULL;
1443 int err;
1444 char buf[MAXPATHLEN+1];
1445 FILE *fp = NULL;
1446 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 m = PyImport_AddModule(name);
1449 if (m == NULL)
1450 return NULL;
1451 if (Py_VerboseFlag)
1452 PySys_WriteStderr("import %s # directory %s\n",
1453 name, pathname);
1454 d = PyModule_GetDict(m);
1455 file = get_sourcefile(pathname);
1456 if (file == NULL)
1457 goto error;
1458 path = Py_BuildValue("[O]", file);
1459 if (path == NULL)
1460 goto error;
1461 err = PyDict_SetItemString(d, "__file__", file);
1462 if (err == 0)
1463 err = PyDict_SetItemString(d, "__path__", path);
1464 if (err != 0)
1465 goto error;
1466 buf[0] = '\0';
1467 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
1468 if (fdp == NULL) {
1469 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1470 PyErr_Clear();
1471 Py_INCREF(m);
1472 }
1473 else
1474 m = NULL;
1475 goto cleanup;
1476 }
1477 m = load_module(name, fp, buf, fdp->type, NULL);
1478 if (fp != NULL)
1479 fclose(fp);
1480 goto cleanup;
Tim Peters1cd70172004-08-02 03:52:12 +00001481
1482 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001483 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001484 cleanup:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001485 Py_XDECREF(path);
1486 Py_XDECREF(file);
1487 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001488}
1489
1490
1491/* Helper to test for built-in module */
1492
1493static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001494is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001495{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 int i;
1497 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1498 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1499 if (PyImport_Inittab[i].initfunc == NULL)
1500 return -1;
1501 else
1502 return 1;
1503 }
1504 }
1505 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001506}
1507
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001508
Just van Rossum52e14d62002-12-30 22:08:05 +00001509/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1510 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001511 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001512 that can handle the path item. Return None if no hook could;
1513 this tells our caller it should fall back to the builtin
1514 import mechanism. Cache the result in path_importer_cache.
1515 Returns a borrowed reference. */
1516
1517static PyObject *
1518get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001519 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001520{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001521 PyObject *importer;
1522 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001523
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001524 /* These conditions are the caller's responsibility: */
1525 assert(PyList_Check(path_hooks));
1526 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001528 nhooks = PyList_Size(path_hooks);
1529 if (nhooks < 0)
1530 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001532 importer = PyDict_GetItem(path_importer_cache, p);
1533 if (importer != NULL)
1534 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001535
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001536 /* set path_importer_cache[p] to None to avoid recursion */
1537 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1538 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001539
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001540 for (j = 0; j < nhooks; j++) {
1541 PyObject *hook = PyList_GetItem(path_hooks, j);
1542 if (hook == NULL)
1543 return NULL;
1544 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1545 if (importer != NULL)
1546 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001548 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1549 return NULL;
1550 }
1551 PyErr_Clear();
1552 }
1553 if (importer == NULL) {
1554 importer = PyObject_CallFunctionObjArgs(
1555 (PyObject *)&PyNullImporter_Type, p, NULL
1556 );
1557 if (importer == NULL) {
1558 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1559 PyErr_Clear();
1560 return Py_None;
1561 }
1562 }
1563 }
1564 if (importer != NULL) {
1565 int err = PyDict_SetItem(path_importer_cache, p, importer);
1566 Py_DECREF(importer);
1567 if (err != 0)
1568 return NULL;
1569 }
1570 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001571}
1572
Christian Heimes9cd17752007-11-18 19:35:23 +00001573PyAPI_FUNC(PyObject *)
1574PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001575 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001576
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001577 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1578 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1579 importer = get_path_importer(path_importer_cache,
1580 path_hooks, path);
1581 }
1582 }
1583 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1584 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001585}
1586
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001587/* Search the path (default sys.path) for a module. Return the
1588 corresponding filedescr struct, and (via return arguments) the
1589 pathname and an open file. Return NULL if the module is not found. */
1590
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001591#ifdef MS_COREDLL
Victor Stinner9b99b442011-02-22 23:12:28 +00001592extern FILE *_PyWin_FindRegisteredModule(const char *, struct filedescr **,
1593 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001594#endif
1595
Martin v. Löwis18e16552006-02-15 17:27:45 +00001596static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001597static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001598static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001599
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001600static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001601find_module(char *fullname, char *subname, PyObject *path, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001603{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 Py_ssize_t i, npath;
1605 size_t len, namelen;
1606 struct filedescr *fdp = NULL;
1607 char *filemode;
1608 FILE *fp = NULL;
1609 PyObject *path_hooks, *path_importer_cache;
1610 struct stat statbuf;
1611 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1612 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1613 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1614 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001615#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001616 size_t saved_len;
1617 size_t saved_namelen;
1618 char *saved_buf = NULL;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001619#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001620 if (p_loader != NULL)
1621 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001622
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 if (strlen(subname) > MAXPATHLEN) {
1624 PyErr_SetString(PyExc_OverflowError,
1625 "module name is too long");
1626 return NULL;
1627 }
1628 strcpy(name, subname);
Just van Rossum52e14d62002-12-30 22:08:05 +00001629
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001630 /* sys.meta_path import hook */
1631 if (p_loader != NULL) {
1632 PyObject *meta_path;
Just van Rossum52e14d62002-12-30 22:08:05 +00001633
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001634 meta_path = PySys_GetObject("meta_path");
1635 if (meta_path == NULL || !PyList_Check(meta_path)) {
1636 PyErr_SetString(PyExc_ImportError,
1637 "sys.meta_path must be a list of "
1638 "import hooks");
1639 return NULL;
1640 }
1641 Py_INCREF(meta_path); /* zap guard */
1642 npath = PyList_Size(meta_path);
1643 for (i = 0; i < npath; i++) {
1644 PyObject *loader;
1645 PyObject *hook = PyList_GetItem(meta_path, i);
1646 loader = PyObject_CallMethod(hook, "find_module",
1647 "sO", fullname,
1648 path != NULL ?
1649 path : Py_None);
1650 if (loader == NULL) {
1651 Py_DECREF(meta_path);
1652 return NULL; /* true error */
1653 }
1654 if (loader != Py_None) {
1655 /* a loader was found */
1656 *p_loader = loader;
1657 Py_DECREF(meta_path);
1658 return &importhookdescr;
1659 }
1660 Py_DECREF(loader);
1661 }
1662 Py_DECREF(meta_path);
1663 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001664
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001665 if (find_frozen(fullname) != NULL) {
1666 strcpy(buf, fullname);
1667 return &fd_frozen;
1668 }
Benjamin Petersond968e272008-11-05 22:48:33 +00001669
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001670 if (path == NULL) {
1671 if (is_builtin(name)) {
1672 strcpy(buf, name);
1673 return &fd_builtin;
1674 }
Guido van Rossumac279101996-08-22 23:10:58 +00001675#ifdef MS_COREDLL
Victor Stinner9b99b442011-02-22 23:12:28 +00001676 fp = _PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 if (fp != NULL) {
1678 *p_fp = fp;
1679 return fdp;
1680 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001681#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001682 path = PySys_GetObject("path");
1683 }
Benjamin Petersond968e272008-11-05 22:48:33 +00001684
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 if (path == NULL || !PyList_Check(path)) {
1686 PyErr_SetString(PyExc_ImportError,
1687 "sys.path must be a list of directory names");
1688 return NULL;
1689 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001691 path_hooks = PySys_GetObject("path_hooks");
1692 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1693 PyErr_SetString(PyExc_ImportError,
1694 "sys.path_hooks must be a list of "
1695 "import hooks");
1696 return NULL;
1697 }
1698 path_importer_cache = PySys_GetObject("path_importer_cache");
1699 if (path_importer_cache == NULL ||
1700 !PyDict_Check(path_importer_cache)) {
1701 PyErr_SetString(PyExc_ImportError,
1702 "sys.path_importer_cache must be a dict");
1703 return NULL;
1704 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001705
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001706 npath = PyList_Size(path);
1707 namelen = strlen(name);
1708 for (i = 0; i < npath; i++) {
1709 PyObject *v = PyList_GetItem(path, i);
1710 PyObject *origv = v;
1711 const char *base;
1712 Py_ssize_t size;
1713 if (!v)
1714 return NULL;
1715 if (PyUnicode_Check(v)) {
Victor Stinnerae6265f2010-05-15 16:27:27 +00001716 v = PyUnicode_EncodeFSDefault(v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001717 if (v == NULL)
1718 return NULL;
1719 }
1720 else if (!PyBytes_Check(v))
1721 continue;
1722 else
1723 Py_INCREF(v);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001724
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001725 base = PyBytes_AS_STRING(v);
1726 size = PyBytes_GET_SIZE(v);
1727 len = size;
1728 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1729 Py_DECREF(v);
1730 continue; /* Too long */
1731 }
1732 strcpy(buf, base);
1733 Py_DECREF(v);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001734
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001735 if (strlen(buf) != len) {
1736 continue; /* v contains '\0' */
1737 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001738
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001739 /* sys.path_hooks import hook */
1740 if (p_loader != NULL) {
1741 PyObject *importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001742
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001743 importer = get_path_importer(path_importer_cache,
1744 path_hooks, origv);
1745 if (importer == NULL) {
1746 return NULL;
1747 }
1748 /* Note: importer is a borrowed reference */
1749 if (importer != Py_None) {
1750 PyObject *loader;
1751 loader = PyObject_CallMethod(importer,
1752 "find_module",
1753 "s", fullname);
1754 if (loader == NULL)
1755 return NULL; /* error */
1756 if (loader != Py_None) {
1757 /* a loader was found */
1758 *p_loader = loader;
1759 return &importhookdescr;
1760 }
1761 Py_DECREF(loader);
1762 continue;
1763 }
1764 }
1765 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001766
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001767 if (len > 0 && buf[len-1] != SEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001768#ifdef ALTSEP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001769 && buf[len-1] != ALTSEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001770#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001771 )
1772 buf[len++] = SEP;
1773 strcpy(buf+len, name);
1774 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001775
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001776 /* Check for package import (buf holds a directory name,
1777 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001778#ifdef HAVE_STAT
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001779 if (stat(buf, &statbuf) == 0 && /* it exists */
1780 S_ISDIR(statbuf.st_mode) && /* it's a directory */
1781 case_ok(buf, len, namelen, name)) { /* case matches */
1782 if (find_init_module(buf)) { /* and has __init__.py */
1783 return &fd_package;
1784 }
1785 else {
Victor Stinnered7916d2010-10-17 02:07:09 +00001786 int err;
1787 PyObject *unicode = PyUnicode_DecodeFSDefault(buf);
1788 if (unicode == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001789 return NULL;
Victor Stinnered7916d2010-10-17 02:07:09 +00001790 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
1791 "Not importing directory '%U': missing __init__.py",
1792 unicode);
1793 Py_DECREF(unicode);
1794 if (err)
1795 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001796 }
1797 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001798#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001799#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001800 /* take a snapshot of the module spec for restoration
1801 * after the 8 character DLL hackery
1802 */
1803 saved_buf = strdup(buf);
1804 saved_len = len;
1805 saved_namelen = namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001806#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001807 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Guido van Rossum04110fb2007-08-24 16:32:05 +00001808#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001809 /* OS/2 limits DLLs to 8 character names (w/o
1810 extension)
1811 * so if the name is longer than that and its a
1812 * dynamically loaded module we're going to try,
1813 * truncate the name before trying
1814 */
1815 if (strlen(subname) > 8) {
1816 /* is this an attempt to load a C extension? */
1817 const struct filedescr *scan;
1818 scan = _PyImport_DynLoadFiletab;
1819 while (scan->suffix != NULL) {
1820 if (!strcmp(scan->suffix, fdp->suffix))
1821 break;
1822 else
1823 scan++;
1824 }
1825 if (scan->suffix != NULL) {
1826 /* yes, so truncate the name */
1827 namelen = 8;
1828 len -= strlen(subname) - namelen;
1829 buf[len] = '\0';
1830 }
1831 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001832#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001833 strcpy(buf+len, fdp->suffix);
1834 if (Py_VerboseFlag > 1)
1835 PySys_WriteStderr("# trying %s\n", buf);
1836 filemode = fdp->mode;
1837 if (filemode[0] == 'U')
1838 filemode = "r" PY_STDIOTEXTMODE;
1839 fp = fopen(buf, filemode);
1840 if (fp != NULL) {
1841 if (case_ok(buf, len, namelen, name))
1842 break;
1843 else { /* continue search */
1844 fclose(fp);
1845 fp = NULL;
1846 }
1847 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001848#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001849 /* restore the saved snapshot */
1850 strcpy(buf, saved_buf);
1851 len = saved_len;
1852 namelen = saved_namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001853#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001854 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001855#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001856 /* don't need/want the module name snapshot anymore */
1857 if (saved_buf)
1858 {
1859 free(saved_buf);
1860 saved_buf = NULL;
1861 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001862#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001863 if (fp != NULL)
1864 break;
1865 }
1866 if (fp == NULL) {
1867 PyErr_Format(PyExc_ImportError,
1868 "No module named %.200s", name);
1869 return NULL;
1870 }
1871 *p_fp = fp;
1872 return fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001873}
1874
Martin v. Löwis18e16552006-02-15 17:27:45 +00001875/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001876 * The arguments here are tricky, best shown by example:
1877 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1878 * ^ ^ ^ ^
1879 * |--------------------- buf ---------------------|
1880 * |------------------- len ------------------|
1881 * |------ name -------|
1882 * |----- namelen -----|
1883 * buf is the full path, but len only counts up to (& exclusive of) the
1884 * extension. name is the module name, also exclusive of extension.
1885 *
1886 * We've already done a successful stat() or fopen() on buf, so know that
1887 * there's some match, possibly case-insensitive.
1888 *
Tim Peters50d8d372001-02-28 05:34:27 +00001889 * case_ok() is to return 1 if there's a case-sensitive match for
1890 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1891 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001892 *
Tim Peters50d8d372001-02-28 05:34:27 +00001893 * case_ok() is used to implement case-sensitive import semantics even
1894 * on platforms with case-insensitive filesystems. It's trivial to implement
1895 * for case-sensitive filesystems. It's pretty much a cross-platform
1896 * nightmare for systems with case-insensitive filesystems.
1897 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001898
Tim Peters50d8d372001-02-28 05:34:27 +00001899/* First we may need a pile of platform-specific header files; the sequence
1900 * of #if's here should match the sequence in the body of case_ok().
1901 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001902#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001903#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001904
Tim Peters50d8d372001-02-28 05:34:27 +00001905#elif defined(DJGPP)
1906#include <dir.h>
1907
Jason Tishler7961aa62005-05-20 00:56:54 +00001908#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001909#include <sys/types.h>
1910#include <dirent.h>
1911
Andrew MacIntyred9400542002-02-26 11:41:34 +00001912#elif defined(PYOS_OS2)
1913#define INCL_DOS
1914#define INCL_DOSERRORS
1915#define INCL_NOPMAPI
1916#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001917#endif
1918
Guido van Rossum0980bd91998-02-13 17:18:36 +00001919static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001920case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001921{
Tim Peters50d8d372001-02-28 05:34:27 +00001922/* Pick a platform-specific implementation; the sequence of #if's here should
1923 * match the sequence just above.
1924 */
1925
Jason Tishler7961aa62005-05-20 00:56:54 +00001926/* MS_WINDOWS */
1927#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001928 WIN32_FIND_DATA data;
1929 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001930
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001931 if (Py_GETENV("PYTHONCASEOK") != NULL)
1932 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001933
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001934 h = FindFirstFile(buf, &data);
1935 if (h == INVALID_HANDLE_VALUE) {
1936 PyErr_Format(PyExc_NameError,
1937 "Can't find file for module %.100s\n(filename %.300s)",
1938 name, buf);
1939 return 0;
1940 }
1941 FindClose(h);
1942 return strncmp(data.cFileName, name, namelen) == 0;
Tim Peters50d8d372001-02-28 05:34:27 +00001943
1944/* DJGPP */
1945#elif defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001946 struct ffblk ffblk;
1947 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00001948
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001949 if (Py_GETENV("PYTHONCASEOK") != NULL)
1950 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001951
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001952 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1953 if (done) {
1954 PyErr_Format(PyExc_NameError,
1955 "Can't find file for module %.100s\n(filename %.300s)",
1956 name, buf);
1957 return 0;
1958 }
1959 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001960
Jason Tishler7961aa62005-05-20 00:56:54 +00001961/* new-fangled macintosh (macosx) or Cygwin */
1962#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001963 DIR *dirp;
1964 struct dirent *dp;
1965 char dirname[MAXPATHLEN + 1];
1966 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001967
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001968 if (Py_GETENV("PYTHONCASEOK") != NULL)
1969 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001970
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001971 /* Copy the dir component into dirname; substitute "." if empty */
1972 if (dirlen <= 0) {
1973 dirname[0] = '.';
1974 dirname[1] = '\0';
1975 }
1976 else {
1977 assert(dirlen <= MAXPATHLEN);
1978 memcpy(dirname, buf, dirlen);
1979 dirname[dirlen] = '\0';
1980 }
1981 /* Open the directory and search the entries for an exact match. */
1982 dirp = opendir(dirname);
1983 if (dirp) {
1984 char *nameWithExt = buf + len - namelen;
1985 while ((dp = readdir(dirp)) != NULL) {
1986 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001987#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001988 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001989#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001990 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001991#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001992 if (thislen >= namelen &&
1993 strcmp(dp->d_name, nameWithExt) == 0) {
1994 (void)closedir(dirp);
1995 return 1; /* Found */
1996 }
1997 }
1998 (void)closedir(dirp);
1999 }
2000 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002001
Andrew MacIntyred9400542002-02-26 11:41:34 +00002002/* OS/2 */
2003#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002004 HDIR hdir = 1;
2005 ULONG srchcnt = 1;
2006 FILEFINDBUF3 ffbuf;
2007 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002008
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002009 if (Py_GETENV("PYTHONCASEOK") != NULL)
2010 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002011
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002012 rc = DosFindFirst(buf,
2013 &hdir,
2014 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2015 &ffbuf, sizeof(ffbuf),
2016 &srchcnt,
2017 FIL_STANDARD);
2018 if (rc != NO_ERROR)
2019 return 0;
2020 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002021
Tim Peters50d8d372001-02-28 05:34:27 +00002022/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2023#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002024 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002025
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002026#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002027}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002028
Guido van Rossum197346f1997-10-31 18:38:52 +00002029#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002030
Guido van Rossum197346f1997-10-31 18:38:52 +00002031/* Helper to look for __init__.py or __init__.py[co] in potential package */
2032static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002033find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00002034{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002035 const size_t save_len = strlen(buf);
2036 size_t i = save_len;
2037 char *pname; /* pointer to start of __init__ */
2038 struct stat statbuf;
Guido van Rossum197346f1997-10-31 18:38:52 +00002039
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002040/* For calling case_ok(buf, len, namelen, name):
2041 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2042 * ^ ^ ^ ^
2043 * |--------------------- buf ---------------------|
2044 * |------------------- len ------------------|
2045 * |------ name -------|
2046 * |----- namelen -----|
Tim Peters0f9431f2001-07-05 03:47:53 +00002047 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002048 if (save_len + 13 >= MAXPATHLEN)
2049 return 0;
2050 buf[i++] = SEP;
2051 pname = buf + i;
2052 strcpy(pname, "__init__.py");
2053 if (stat(buf, &statbuf) == 0) {
2054 if (case_ok(buf,
2055 save_len + 9, /* len("/__init__") */
2056 8, /* len("__init__") */
2057 pname)) {
2058 buf[save_len] = '\0';
2059 return 1;
2060 }
2061 }
2062 i += strlen(pname);
2063 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
2064 if (stat(buf, &statbuf) == 0) {
2065 if (case_ok(buf,
2066 save_len + 9, /* len("/__init__") */
2067 8, /* len("__init__") */
2068 pname)) {
2069 buf[save_len] = '\0';
2070 return 1;
2071 }
2072 }
2073 buf[save_len] = '\0';
2074 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002075}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002076
Guido van Rossum197346f1997-10-31 18:38:52 +00002077#endif /* HAVE_STAT */
2078
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002079
Tim Petersdbd9ba62000-07-09 03:09:57 +00002080static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002081
Victor Stinner44c6c152010-08-09 00:59:10 +00002082static PyObject*
2083load_builtin(char *name, char *pathname, int type)
2084{
2085 PyObject *m, *modules;
2086 int err;
2087
2088 if (pathname != NULL && pathname[0] != '\0')
2089 name = pathname;
2090
2091 if (type == C_BUILTIN)
2092 err = init_builtin(name);
2093 else
2094 err = PyImport_ImportFrozenModule(name);
2095 if (err < 0)
2096 return NULL;
2097 if (err == 0) {
2098 PyErr_Format(PyExc_ImportError,
2099 "Purported %s module %.200s not found",
2100 type == C_BUILTIN ?
2101 "builtin" : "frozen",
2102 name);
2103 return NULL;
2104 }
2105
2106 modules = PyImport_GetModuleDict();
2107 m = PyDict_GetItemString(modules, name);
2108 if (m == NULL) {
2109 PyErr_Format(
2110 PyExc_ImportError,
2111 "%s module %.200s not properly initialized",
2112 type == C_BUILTIN ?
2113 "builtin" : "frozen",
2114 name);
2115 return NULL;
2116 }
2117 Py_INCREF(m);
2118 return m;
2119}
2120
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002121/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002122 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002123
Guido van Rossum79f25d91997-04-29 20:08:16 +00002124static PyObject *
Alexandre Vassalottie223eb82009-07-29 20:12:15 +00002125load_module(char *name, FILE *fp, char *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002126{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002127 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002128
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002129 /* First check that there's an open file (if we need one) */
2130 switch (type) {
2131 case PY_SOURCE:
2132 case PY_COMPILED:
2133 if (fp == NULL) {
2134 PyErr_Format(PyExc_ValueError,
2135 "file object required for import (type code %d)",
2136 type);
2137 return NULL;
2138 }
2139 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002140
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002141 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002142
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002143 case PY_SOURCE:
2144 m = load_source_module(name, pathname, fp);
2145 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002146
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002147 case PY_COMPILED:
2148 m = load_compiled_module(name, pathname, fp);
2149 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002150
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002151#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002152 case C_EXTENSION:
2153 m = _PyImport_LoadDynamicModule(name, pathname, fp);
2154 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002155#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002156
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002157 case PKG_DIRECTORY:
2158 m = load_package(name, pathname);
2159 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002160
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002161 case C_BUILTIN:
2162 case PY_FROZEN:
Victor Stinner44c6c152010-08-09 00:59:10 +00002163 m = load_builtin(name, pathname, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002164 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002165
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002166 case IMP_HOOK: {
2167 if (loader == NULL) {
2168 PyErr_SetString(PyExc_ImportError,
2169 "import hook without loader");
2170 return NULL;
2171 }
2172 m = PyObject_CallMethod(loader, "load_module", "s", name);
2173 break;
2174 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002175
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002176 default:
2177 PyErr_Format(PyExc_ImportError,
2178 "Don't know how to import %.200s (type code %d)",
2179 name, type);
2180 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002181
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002182 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002184 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002185}
2186
2187
2188/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002189 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002190 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002191
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002192static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002193init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002194{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002195 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002196
Victor Stinner49d3f252010-10-17 01:24:53 +00002197 if (_PyImport_FindBuiltin(name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002198 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002199
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002200 for (p = PyImport_Inittab; p->name != NULL; p++) {
2201 PyObject *mod;
2202 if (strcmp(name, p->name) == 0) {
2203 if (p->initfunc == NULL) {
2204 PyErr_Format(PyExc_ImportError,
2205 "Cannot re-init internal module %.200s",
2206 name);
2207 return -1;
2208 }
2209 if (Py_VerboseFlag)
2210 PySys_WriteStderr("import %s # builtin\n", name);
2211 mod = (*p->initfunc)();
2212 if (mod == 0)
2213 return -1;
Victor Stinner49d3f252010-10-17 01:24:53 +00002214 if (_PyImport_FixupBuiltin(mod, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002215 return -1;
2216 /* FixupExtension has put the module into sys.modules,
2217 so we can release our own reference. */
2218 Py_DECREF(mod);
2219 return 1;
2220 }
2221 }
2222 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002223}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002224
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002225
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002226/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002227
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002228static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002229find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002230{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002231 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002232
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002233 if (!name)
2234 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002235
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002236 for (p = PyImport_FrozenModules; ; p++) {
2237 if (p->name == NULL)
2238 return NULL;
2239 if (strcmp(p->name, name) == 0)
2240 break;
2241 }
2242 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002243}
2244
Guido van Rossum79f25d91997-04-29 20:08:16 +00002245static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002246get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002247{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002248 struct _frozen *p = find_frozen(name);
2249 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002250
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002251 if (p == NULL) {
2252 PyErr_Format(PyExc_ImportError,
2253 "No such frozen object named %.200s",
2254 name);
2255 return NULL;
2256 }
2257 if (p->code == NULL) {
2258 PyErr_Format(PyExc_ImportError,
2259 "Excluded frozen object named %.200s",
2260 name);
2261 return NULL;
2262 }
2263 size = p->size;
2264 if (size < 0)
2265 size = -size;
2266 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002267}
2268
Brett Cannon8d110132009-03-15 02:20:16 +00002269static PyObject *
2270is_frozen_package(char *name)
2271{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002272 struct _frozen *p = find_frozen(name);
2273 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002274
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002275 if (p == NULL) {
2276 PyErr_Format(PyExc_ImportError,
2277 "No such frozen object named %.200s",
2278 name);
2279 return NULL;
2280 }
Brett Cannon8d110132009-03-15 02:20:16 +00002281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002282 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002283
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002284 if (size < 0)
2285 Py_RETURN_TRUE;
2286 else
2287 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002288}
2289
2290
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002291/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002292 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002293 an exception set if the initialization failed.
2294 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002295
2296int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002297PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002298{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002299 struct _frozen *p = find_frozen(name);
2300 PyObject *co;
2301 PyObject *m;
2302 int ispackage;
2303 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002304
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002305 if (p == NULL)
2306 return 0;
2307 if (p->code == NULL) {
2308 PyErr_Format(PyExc_ImportError,
2309 "Excluded frozen object named %.200s",
2310 name);
2311 return -1;
2312 }
2313 size = p->size;
2314 ispackage = (size < 0);
2315 if (ispackage)
2316 size = -size;
2317 if (Py_VerboseFlag)
2318 PySys_WriteStderr("import %s # frozen%s\n",
2319 name, ispackage ? " package" : "");
2320 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2321 if (co == NULL)
2322 return -1;
2323 if (!PyCode_Check(co)) {
2324 PyErr_Format(PyExc_TypeError,
2325 "frozen object %.200s is not a code object",
2326 name);
2327 goto err_return;
2328 }
2329 if (ispackage) {
2330 /* Set __path__ to the package name */
2331 PyObject *d, *s, *l;
2332 int err;
2333 m = PyImport_AddModule(name);
2334 if (m == NULL)
2335 goto err_return;
2336 d = PyModule_GetDict(m);
2337 s = PyUnicode_InternFromString(name);
2338 if (s == NULL)
2339 goto err_return;
2340 l = PyList_New(1);
2341 if (l == NULL) {
2342 Py_DECREF(s);
2343 goto err_return;
2344 }
2345 PyList_SET_ITEM(l, 0, s);
2346 err = PyDict_SetItemString(d, "__path__", l);
2347 Py_DECREF(l);
2348 if (err != 0)
2349 goto err_return;
2350 }
2351 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
2352 if (m == NULL)
2353 goto err_return;
2354 Py_DECREF(co);
2355 Py_DECREF(m);
2356 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002357err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002358 Py_DECREF(co);
2359 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002360}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002361
2362
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002363/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002364 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002365
Guido van Rossum79f25d91997-04-29 20:08:16 +00002366PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002367PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002368{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002369 PyObject *pname;
2370 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002372 pname = PyUnicode_FromString(name);
2373 if (pname == NULL)
2374 return NULL;
2375 result = PyImport_Import(pname);
2376 Py_DECREF(pname);
2377 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002378}
2379
Christian Heimes072c0f12008-01-03 23:01:04 +00002380/* Import a module without blocking
2381 *
2382 * At first it tries to fetch the module from sys.modules. If the module was
2383 * never loaded before it loads it with PyImport_ImportModule() unless another
2384 * thread holds the import lock. In the latter case the function raises an
2385 * ImportError instead of blocking.
2386 *
2387 * Returns the module object with incremented ref count.
2388 */
2389PyObject *
2390PyImport_ImportModuleNoBlock(const char *name)
2391{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002392 PyObject *result;
2393 PyObject *modules;
2394 long me;
Christian Heimes072c0f12008-01-03 23:01:04 +00002395
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002396 /* Try to get the module from sys.modules[name] */
2397 modules = PyImport_GetModuleDict();
2398 if (modules == NULL)
2399 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002400
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002401 result = PyDict_GetItemString(modules, name);
2402 if (result != NULL) {
2403 Py_INCREF(result);
2404 return result;
2405 }
2406 else {
2407 PyErr_Clear();
2408 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002409#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002410 /* check the import lock
2411 * me might be -1 but I ignore the error here, the lock function
2412 * takes care of the problem */
2413 me = PyThread_get_thread_ident();
2414 if (import_lock_thread == -1 || import_lock_thread == me) {
2415 /* no thread or me is holding the lock */
2416 return PyImport_ImportModule(name);
2417 }
2418 else {
2419 PyErr_Format(PyExc_ImportError,
2420 "Failed to import %.200s because the import lock"
2421 "is held by another thread.",
2422 name);
2423 return NULL;
2424 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002425#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002426 return PyImport_ImportModule(name);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002427#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002428}
2429
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002430/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002431static PyObject *get_parent(PyObject *globals, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002432 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002433static PyObject *load_next(PyObject *mod, PyObject *altmod,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002434 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002435static int mark_miss(char *name);
2436static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002437 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002438static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002439
2440/* The Magnum Opus of dotted-name import :-) */
2441
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002442static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002443import_module_level(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002445{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002446 char buf[MAXPATHLEN+1];
2447 Py_ssize_t buflen = 0;
2448 PyObject *parent, *head, *next, *tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002450 if (strchr(name, '/') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002451#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002452 || strchr(name, '\\') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002453#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002454 ) {
2455 PyErr_SetString(PyExc_ImportError,
2456 "Import by filename is not supported.");
2457 return NULL;
2458 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002460 parent = get_parent(globals, buf, &buflen, level);
2461 if (parent == NULL)
2462 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002463
Benjamin Peterson556d8002010-06-27 22:37:28 +00002464 head = load_next(parent, level < 0 ? Py_None : parent, &name, buf,
2465 &buflen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 if (head == NULL)
2467 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 tail = head;
2470 Py_INCREF(tail);
2471 while (name) {
2472 next = load_next(tail, tail, &name, buf, &buflen);
2473 Py_DECREF(tail);
2474 if (next == NULL) {
2475 Py_DECREF(head);
2476 return NULL;
2477 }
2478 tail = next;
2479 }
2480 if (tail == Py_None) {
2481 /* If tail is Py_None, both get_parent and load_next found
2482 an empty module name: someone called __import__("") or
2483 doctored faulty bytecode */
2484 Py_DECREF(tail);
2485 Py_DECREF(head);
2486 PyErr_SetString(PyExc_ValueError,
2487 "Empty module name");
2488 return NULL;
2489 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002490
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002491 if (fromlist != NULL) {
2492 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2493 fromlist = NULL;
2494 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002495
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002496 if (fromlist == NULL) {
2497 Py_DECREF(tail);
2498 return head;
2499 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002500
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002501 Py_DECREF(head);
2502 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
2503 Py_DECREF(tail);
2504 return NULL;
2505 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002507 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002508}
2509
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002510PyObject *
2511PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002512 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002513{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002514 PyObject *result;
2515 _PyImport_AcquireLock();
2516 result = import_module_level(name, globals, locals, fromlist, level);
2517 if (_PyImport_ReleaseLock() < 0) {
2518 Py_XDECREF(result);
2519 PyErr_SetString(PyExc_RuntimeError,
2520 "not holding the import lock");
2521 return NULL;
2522 }
2523 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002524}
2525
Fred Drake87590902004-05-28 20:21:36 +00002526/* Return the package that an import is being performed in. If globals comes
2527 from the module foo.bar.bat (not itself a package), this returns the
2528 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002529 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002530
2531 The *name* of the returned package is returned in buf, with the length of
2532 the name in *p_buflen.
2533
2534 If globals doesn't come from a package or a module in a package, or a
2535 corresponding entry is not found in sys.modules, Py_None is returned.
2536*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002537static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002538get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002539{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002540 static PyObject *namestr = NULL;
2541 static PyObject *pathstr = NULL;
2542 static PyObject *pkgstr = NULL;
2543 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2544 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002545
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002546 if (globals == NULL || !PyDict_Check(globals) || !level)
2547 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002548
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002549 if (namestr == NULL) {
2550 namestr = PyUnicode_InternFromString("__name__");
2551 if (namestr == NULL)
2552 return NULL;
2553 }
2554 if (pathstr == NULL) {
2555 pathstr = PyUnicode_InternFromString("__path__");
2556 if (pathstr == NULL)
2557 return NULL;
2558 }
2559 if (pkgstr == NULL) {
2560 pkgstr = PyUnicode_InternFromString("__package__");
2561 if (pkgstr == NULL)
2562 return NULL;
2563 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002564
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002565 *buf = '\0';
2566 *p_buflen = 0;
2567 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002568
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002569 if ((pkgname != NULL) && (pkgname != Py_None)) {
2570 /* __package__ is set, so use it */
2571 char *pkgname_str;
2572 Py_ssize_t len;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002573
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002574 if (!PyUnicode_Check(pkgname)) {
2575 PyErr_SetString(PyExc_ValueError,
2576 "__package__ set to non-string");
2577 return NULL;
2578 }
2579 pkgname_str = _PyUnicode_AsStringAndSize(pkgname, &len);
2580 if (len == 0) {
2581 if (level > 0) {
2582 PyErr_SetString(PyExc_ValueError,
2583 "Attempted relative import in non-package");
2584 return NULL;
2585 }
2586 return Py_None;
2587 }
2588 if (len > MAXPATHLEN) {
2589 PyErr_SetString(PyExc_ValueError,
2590 "Package name too long");
2591 return NULL;
2592 }
2593 strcpy(buf, pkgname_str);
2594 } else {
2595 /* __package__ not set, so figure it out and set it */
2596 modname = PyDict_GetItem(globals, namestr);
2597 if (modname == NULL || !PyUnicode_Check(modname))
2598 return Py_None;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002599
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002600 modpath = PyDict_GetItem(globals, pathstr);
2601 if (modpath != NULL) {
2602 /* __path__ is set, so modname is already the package name */
2603 char *modname_str;
2604 Py_ssize_t len;
2605 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002606
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002607 modname_str = _PyUnicode_AsStringAndSize(modname, &len);
2608 if (len > MAXPATHLEN) {
2609 PyErr_SetString(PyExc_ValueError,
2610 "Module name too long");
2611 return NULL;
2612 }
2613 strcpy(buf, modname_str);
2614 error = PyDict_SetItem(globals, pkgstr, modname);
2615 if (error) {
2616 PyErr_SetString(PyExc_ValueError,
2617 "Could not set __package__");
2618 return NULL;
2619 }
2620 } else {
2621 /* Normal module, so work out the package name if any */
2622 char *start = _PyUnicode_AsString(modname);
2623 char *lastdot = strrchr(start, '.');
2624 size_t len;
2625 int error;
2626 if (lastdot == NULL && level > 0) {
2627 PyErr_SetString(PyExc_ValueError,
2628 "Attempted relative import in non-package");
2629 return NULL;
2630 }
2631 if (lastdot == NULL) {
2632 error = PyDict_SetItem(globals, pkgstr, Py_None);
2633 if (error) {
2634 PyErr_SetString(PyExc_ValueError,
2635 "Could not set __package__");
2636 return NULL;
2637 }
2638 return Py_None;
2639 }
2640 len = lastdot - start;
2641 if (len >= MAXPATHLEN) {
2642 PyErr_SetString(PyExc_ValueError,
2643 "Module name too long");
2644 return NULL;
2645 }
2646 strncpy(buf, start, len);
2647 buf[len] = '\0';
2648 pkgname = PyUnicode_FromString(buf);
2649 if (pkgname == NULL) {
2650 return NULL;
2651 }
2652 error = PyDict_SetItem(globals, pkgstr, pkgname);
2653 Py_DECREF(pkgname);
2654 if (error) {
2655 PyErr_SetString(PyExc_ValueError,
2656 "Could not set __package__");
2657 return NULL;
2658 }
2659 }
2660 }
2661 while (--level > 0) {
2662 char *dot = strrchr(buf, '.');
2663 if (dot == NULL) {
2664 PyErr_SetString(PyExc_ValueError,
2665 "Attempted relative import beyond "
2666 "toplevel package");
2667 return NULL;
2668 }
2669 *dot = '\0';
2670 }
2671 *p_buflen = strlen(buf);
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002672
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002673 modules = PyImport_GetModuleDict();
2674 parent = PyDict_GetItemString(modules, buf);
2675 if (parent == NULL) {
2676 if (orig_level < 1) {
2677 PyObject *err_msg = PyBytes_FromFormat(
2678 "Parent module '%.200s' not found "
2679 "while handling absolute import", buf);
2680 if (err_msg == NULL) {
2681 return NULL;
2682 }
2683 if (!PyErr_WarnEx(PyExc_RuntimeWarning,
2684 PyBytes_AsString(err_msg), 1)) {
2685 *buf = '\0';
2686 *p_buflen = 0;
2687 parent = Py_None;
2688 }
2689 Py_DECREF(err_msg);
2690 } else {
2691 PyErr_Format(PyExc_SystemError,
2692 "Parent module '%.200s' not loaded, "
2693 "cannot perform relative import", buf);
2694 }
2695 }
2696 return parent;
2697 /* We expect, but can't guarantee, if parent != None, that:
2698 - parent.__name__ == buf
2699 - parent.__dict__ is globals
2700 If this is violated... Who cares? */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002701}
2702
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002703/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002704static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002705load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002706 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002707{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002708 char *name = *p_name;
2709 char *dot = strchr(name, '.');
2710 size_t len;
2711 char *p;
2712 PyObject *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002713
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002714 if (strlen(name) == 0) {
2715 /* completely empty module name should only happen in
2716 'from . import' (or '__import__("")')*/
2717 Py_INCREF(mod);
2718 *p_name = NULL;
2719 return mod;
2720 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002721
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002722 if (dot == NULL) {
2723 *p_name = NULL;
2724 len = strlen(name);
2725 }
2726 else {
2727 *p_name = dot+1;
2728 len = dot-name;
2729 }
2730 if (len == 0) {
2731 PyErr_SetString(PyExc_ValueError,
2732 "Empty module name");
2733 return NULL;
2734 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002735
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002736 p = buf + *p_buflen;
2737 if (p != buf)
2738 *p++ = '.';
2739 if (p+len-buf >= MAXPATHLEN) {
2740 PyErr_SetString(PyExc_ValueError,
2741 "Module name too long");
2742 return NULL;
2743 }
2744 strncpy(p, name, len);
2745 p[len] = '\0';
2746 *p_buflen = p+len-buf;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002747
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002748 result = import_submodule(mod, p, buf);
2749 if (result == Py_None && altmod != mod) {
2750 Py_DECREF(result);
2751 /* Here, altmod must be None and mod must not be None */
2752 result = import_submodule(altmod, p, p);
2753 if (result != NULL && result != Py_None) {
2754 if (mark_miss(buf) != 0) {
2755 Py_DECREF(result);
2756 return NULL;
2757 }
2758 strncpy(buf, name, len);
2759 buf[len] = '\0';
2760 *p_buflen = len;
2761 }
2762 }
2763 if (result == NULL)
2764 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002765
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002766 if (result == Py_None) {
2767 Py_DECREF(result);
2768 PyErr_Format(PyExc_ImportError,
2769 "No module named %.200s", name);
2770 return NULL;
2771 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002772
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002773 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002774}
2775
2776static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002777mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002778{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002779 PyObject *modules = PyImport_GetModuleDict();
2780 return PyDict_SetItemString(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002781}
2782
2783static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002784ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002785 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002786{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002787 int i;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002788
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002789 if (!PyObject_HasAttrString(mod, "__path__"))
2790 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002791
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002792 for (i = 0; ; i++) {
2793 PyObject *item = PySequence_GetItem(fromlist, i);
2794 int hasit;
2795 if (item == NULL) {
2796 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2797 PyErr_Clear();
2798 return 1;
2799 }
2800 return 0;
2801 }
2802 if (!PyUnicode_Check(item)) {
2803 PyErr_SetString(PyExc_TypeError,
2804 "Item in ``from list'' not a string");
2805 Py_DECREF(item);
2806 return 0;
2807 }
2808 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
2809 PyObject *all;
2810 Py_DECREF(item);
2811 /* See if the package defines __all__ */
2812 if (recursive)
2813 continue; /* Avoid endless recursion */
2814 all = PyObject_GetAttrString(mod, "__all__");
2815 if (all == NULL)
2816 PyErr_Clear();
2817 else {
2818 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
2819 Py_DECREF(all);
2820 if (!ret)
2821 return 0;
2822 }
2823 continue;
2824 }
2825 hasit = PyObject_HasAttr(mod, item);
2826 if (!hasit) {
2827 PyObject *item8;
2828 char *subname;
2829 PyObject *submod;
2830 char *p;
Victor Stinnerae6265f2010-05-15 16:27:27 +00002831 item8 = PyUnicode_EncodeFSDefault(item);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002832 if (!item8) {
2833 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2834 return 0;
2835 }
2836 subname = PyBytes_AS_STRING(item8);
2837 if (buflen + strlen(subname) >= MAXPATHLEN) {
2838 PyErr_SetString(PyExc_ValueError,
2839 "Module name too long");
2840 Py_DECREF(item);
2841 return 0;
2842 }
2843 p = buf + buflen;
2844 *p++ = '.';
2845 strcpy(p, subname);
2846 submod = import_submodule(mod, subname, buf);
2847 Py_DECREF(item8);
2848 Py_XDECREF(submod);
2849 if (submod == NULL) {
2850 Py_DECREF(item);
2851 return 0;
2852 }
2853 }
2854 Py_DECREF(item);
2855 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002856
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002857 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002858}
2859
Neil Schemenauer00b09662003-06-16 21:03:07 +00002860static int
2861add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002862 PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00002863{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002864 if (mod == Py_None)
2865 return 1;
2866 /* Irrespective of the success of this load, make a
2867 reference to it in the parent package module. A copy gets
2868 saved in the modules dictionary under the full name, so get a
2869 reference from there, if need be. (The exception is when the
2870 load failed with a SyntaxError -- then there's no trace in
2871 sys.modules. In that case, of course, do nothing extra.) */
2872 if (submod == NULL) {
2873 submod = PyDict_GetItemString(modules, fullname);
2874 if (submod == NULL)
2875 return 1;
2876 }
2877 if (PyModule_Check(mod)) {
2878 /* We can't use setattr here since it can give a
2879 * spurious warning if the submodule name shadows a
2880 * builtin name */
2881 PyObject *dict = PyModule_GetDict(mod);
2882 if (!dict)
2883 return 0;
2884 if (PyDict_SetItemString(dict, subname, submod) < 0)
2885 return 0;
2886 }
2887 else {
2888 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2889 return 0;
2890 }
2891 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00002892}
2893
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002894static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002895import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002896{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002897 PyObject *modules = PyImport_GetModuleDict();
2898 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002899
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002900 /* Require:
2901 if mod == None: subname == fullname
2902 else: mod.__name__ + "." + subname == fullname
2903 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002904
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002905 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
2906 Py_INCREF(m);
2907 }
2908 else {
2909 PyObject *path, *loader = NULL;
2910 char buf[MAXPATHLEN+1];
2911 struct filedescr *fdp;
2912 FILE *fp = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002913
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002914 if (mod == Py_None)
2915 path = NULL;
2916 else {
2917 path = PyObject_GetAttrString(mod, "__path__");
2918 if (path == NULL) {
2919 PyErr_Clear();
2920 Py_INCREF(Py_None);
2921 return Py_None;
2922 }
2923 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002924
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002925 buf[0] = '\0';
2926 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2927 &fp, &loader);
2928 Py_XDECREF(path);
2929 if (fdp == NULL) {
2930 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2931 return NULL;
2932 PyErr_Clear();
2933 Py_INCREF(Py_None);
2934 return Py_None;
2935 }
2936 m = load_module(fullname, fp, buf, fdp->type, loader);
2937 Py_XDECREF(loader);
2938 if (fp)
2939 fclose(fp);
2940 if (!add_submodule(mod, m, fullname, subname, modules)) {
2941 Py_XDECREF(m);
2942 m = NULL;
2943 }
2944 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002945
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002946 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002947}
2948
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002949
2950/* Re-import a module of any kind and return its module object, WITH
2951 INCREMENTED REFERENCE COUNT */
2952
Guido van Rossum79f25d91997-04-29 20:08:16 +00002953PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002954PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002955{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002956 PyInterpreterState *interp = PyThreadState_Get()->interp;
2957 PyObject *modules_reloading = interp->modules_reloading;
2958 PyObject *modules = PyImport_GetModuleDict();
2959 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
2960 char *name, *subname;
2961 char buf[MAXPATHLEN+1];
2962 struct filedescr *fdp;
2963 FILE *fp = NULL;
2964 PyObject *newm;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002965
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002966 if (modules_reloading == NULL) {
2967 Py_FatalError("PyImport_ReloadModule: "
2968 "no modules_reloading dictionary!");
2969 return NULL;
2970 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002971
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002972 if (m == NULL || !PyModule_Check(m)) {
2973 PyErr_SetString(PyExc_TypeError,
2974 "reload() argument must be module");
2975 return NULL;
2976 }
2977 name = (char*)PyModule_GetName(m);
2978 if (name == NULL)
2979 return NULL;
2980 if (m != PyDict_GetItemString(modules, name)) {
2981 PyErr_Format(PyExc_ImportError,
2982 "reload(): module %.200s not in sys.modules",
2983 name);
2984 return NULL;
2985 }
2986 existing_m = PyDict_GetItemString(modules_reloading, name);
2987 if (existing_m != NULL) {
2988 /* Due to a recursive reload, this module is already
2989 being reloaded. */
2990 Py_INCREF(existing_m);
2991 return existing_m;
2992 }
2993 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2994 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002995
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002996 subname = strrchr(name, '.');
2997 if (subname == NULL)
2998 subname = name;
2999 else {
3000 PyObject *parentname, *parent;
3001 parentname = PyUnicode_FromStringAndSize(name, (subname-name));
3002 if (parentname == NULL) {
3003 imp_modules_reloading_clear();
3004 return NULL;
3005 }
3006 parent = PyDict_GetItem(modules, parentname);
3007 if (parent == NULL) {
3008 PyErr_Format(PyExc_ImportError,
3009 "reload(): parent %U not in sys.modules",
3010 parentname);
3011 Py_DECREF(parentname);
3012 imp_modules_reloading_clear();
3013 return NULL;
3014 }
3015 Py_DECREF(parentname);
3016 subname++;
3017 path = PyObject_GetAttrString(parent, "__path__");
3018 if (path == NULL)
3019 PyErr_Clear();
3020 }
3021 buf[0] = '\0';
3022 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
3023 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003024
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003025 if (fdp == NULL) {
3026 Py_XDECREF(loader);
3027 imp_modules_reloading_clear();
3028 return NULL;
3029 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003030
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003031 newm = load_module(name, fp, buf, fdp->type, loader);
3032 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003033
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003034 if (fp)
3035 fclose(fp);
3036 if (newm == NULL) {
3037 /* load_module probably removed name from modules because of
3038 * the error. Put back the original module object. We're
3039 * going to return NULL in this case regardless of whether
3040 * replacing name succeeds, so the return value is ignored.
3041 */
3042 PyDict_SetItemString(modules, name, m);
3043 }
3044 imp_modules_reloading_clear();
3045 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003046}
3047
3048
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003049/* Higher-level import emulator which emulates the "import" statement
3050 more accurately -- it invokes the __import__() function from the
3051 builtins of the current globals. This means that the import is
3052 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003053 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003054 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003055 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003056 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003057
3058PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003059PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003060{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003061 static PyObject *silly_list = NULL;
3062 static PyObject *builtins_str = NULL;
3063 static PyObject *import_str = NULL;
3064 PyObject *globals = NULL;
3065 PyObject *import = NULL;
3066 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003067 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003068 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003069
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003070 /* Initialize constant string objects */
3071 if (silly_list == NULL) {
3072 import_str = PyUnicode_InternFromString("__import__");
3073 if (import_str == NULL)
3074 return NULL;
3075 builtins_str = PyUnicode_InternFromString("__builtins__");
3076 if (builtins_str == NULL)
3077 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003078 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003079 if (silly_list == NULL)
3080 return NULL;
3081 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003082
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003083 /* Get the builtins from current globals */
3084 globals = PyEval_GetGlobals();
3085 if (globals != NULL) {
3086 Py_INCREF(globals);
3087 builtins = PyObject_GetItem(globals, builtins_str);
3088 if (builtins == NULL)
3089 goto err;
3090 }
3091 else {
3092 /* No globals -- use standard builtins, and fake globals */
3093 builtins = PyImport_ImportModuleLevel("builtins",
3094 NULL, NULL, NULL, 0);
3095 if (builtins == NULL)
3096 return NULL;
3097 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3098 if (globals == NULL)
3099 goto err;
3100 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003101
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003102 /* Get the __import__ function from the builtins */
3103 if (PyDict_Check(builtins)) {
3104 import = PyObject_GetItem(builtins, import_str);
3105 if (import == NULL)
3106 PyErr_SetObject(PyExc_KeyError, import_str);
3107 }
3108 else
3109 import = PyObject_GetAttr(builtins, import_str);
3110 if (import == NULL)
3111 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003112
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003113 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003114 Always use absolute import here.
3115 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003116 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3117 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003118 if (r == NULL)
3119 goto err;
3120 Py_DECREF(r);
3121
3122 modules = PyImport_GetModuleDict();
3123 r = PyDict_GetItem(modules, module_name);
3124 if (r != NULL)
3125 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003126
3127 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003128 Py_XDECREF(globals);
3129 Py_XDECREF(builtins);
3130 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003131
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003132 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003133}
3134
3135
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003136/* Module 'imp' provides Python access to the primitives used for
3137 importing modules.
3138*/
3139
Guido van Rossum79f25d91997-04-29 20:08:16 +00003140static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003141imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003142{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003143 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003145 buf[0] = (char) ((magic >> 0) & 0xff);
3146 buf[1] = (char) ((magic >> 8) & 0xff);
3147 buf[2] = (char) ((magic >> 16) & 0xff);
3148 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003149
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003150 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003151}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003152
3153static PyObject *
3154imp_get_magic(PyObject *self, PyObject *noargs)
3155{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003156 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003157}
3158
3159static PyObject *
3160imp_get_tag(PyObject *self, PyObject *noargs)
3161{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003162 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003163}
3164
Guido van Rossum79f25d91997-04-29 20:08:16 +00003165static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003166imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003167{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003168 PyObject *list;
3169 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003170
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003171 list = PyList_New(0);
3172 if (list == NULL)
3173 return NULL;
3174 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3175 PyObject *item = Py_BuildValue("ssi",
3176 fdp->suffix, fdp->mode, fdp->type);
3177 if (item == NULL) {
3178 Py_DECREF(list);
3179 return NULL;
3180 }
3181 if (PyList_Append(list, item) < 0) {
3182 Py_DECREF(list);
3183 Py_DECREF(item);
3184 return NULL;
3185 }
3186 Py_DECREF(item);
3187 }
3188 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003189}
3190
Guido van Rossum79f25d91997-04-29 20:08:16 +00003191static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003192call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003193{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003194 extern int fclose(FILE *);
3195 PyObject *fob, *ret;
3196 PyObject *pathobj;
3197 struct filedescr *fdp;
3198 char pathname[MAXPATHLEN+1];
3199 FILE *fp = NULL;
3200 int fd = -1;
3201 char *found_encoding = NULL;
3202 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003203
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003204 pathname[0] = '\0';
3205 if (path == Py_None)
3206 path = NULL;
3207 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
3208 if (fdp == NULL)
3209 return NULL;
3210 if (fp != NULL) {
3211 fd = fileno(fp);
3212 if (fd != -1)
3213 fd = dup(fd);
3214 fclose(fp);
3215 fp = NULL;
3216 }
3217 if (fd != -1) {
3218 if (strchr(fdp->mode, 'b') == NULL) {
3219 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3220 memory. */
3221 found_encoding = PyTokenizer_FindEncoding(fd);
3222 lseek(fd, 0, 0); /* Reset position */
3223 if (found_encoding == NULL && PyErr_Occurred())
3224 return NULL;
3225 encoding = (found_encoding != NULL) ? found_encoding :
3226 (char*)PyUnicode_GetDefaultEncoding();
3227 }
3228 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
3229 (char*)encoding, NULL, NULL, 1);
3230 if (fob == NULL) {
3231 close(fd);
3232 PyMem_FREE(found_encoding);
3233 return NULL;
3234 }
3235 }
3236 else {
3237 fob = Py_None;
3238 Py_INCREF(fob);
3239 }
3240 pathobj = PyUnicode_DecodeFSDefault(pathname);
3241 ret = Py_BuildValue("NN(ssi)",
3242 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3243 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003245 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003246}
3247
Guido van Rossum79f25d91997-04-29 20:08:16 +00003248static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003249imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003250{
Victor Stinnerebc00522010-12-03 17:06:43 +00003251 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003252 PyObject *ret, *path = NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003253 if (!PyArg_ParseTuple(args, "O&|O:find_module",
3254 PyUnicode_FSConverter, &name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003255 &path))
3256 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003257 ret = call_find_module(PyBytes_AS_STRING(name), path);
3258 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003259 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003260}
3261
3262static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003263imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003264{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003265 char *name;
3266 int ret;
3267 PyObject *m;
3268 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
3269 return NULL;
3270 ret = init_builtin(name);
3271 if (ret < 0)
3272 return NULL;
3273 if (ret == 0) {
3274 Py_INCREF(Py_None);
3275 return Py_None;
3276 }
3277 m = PyImport_AddModule(name);
3278 Py_XINCREF(m);
3279 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003280}
3281
Guido van Rossum79f25d91997-04-29 20:08:16 +00003282static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003283imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003284{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003285 char *name;
3286 int ret;
3287 PyObject *m;
3288 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
3289 return NULL;
3290 ret = PyImport_ImportFrozenModule(name);
3291 if (ret < 0)
3292 return NULL;
3293 if (ret == 0) {
3294 Py_INCREF(Py_None);
3295 return Py_None;
3296 }
3297 m = PyImport_AddModule(name);
3298 Py_XINCREF(m);
3299 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003300}
3301
Guido van Rossum79f25d91997-04-29 20:08:16 +00003302static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003303imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003304{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003305 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003307 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
3308 return NULL;
3309 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003310}
3311
Guido van Rossum79f25d91997-04-29 20:08:16 +00003312static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003313imp_is_frozen_package(PyObject *self, PyObject *args)
3314{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003315 char *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003316
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003317 if (!PyArg_ParseTuple(args, "s:is_frozen_package", &name))
3318 return NULL;
3319 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003320}
3321
3322static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003323imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003324{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003325 char *name;
3326 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
3327 return NULL;
3328 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003329}
3330
Guido van Rossum79f25d91997-04-29 20:08:16 +00003331static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003332imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003333{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003334 char *name;
3335 struct _frozen *p;
3336 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
3337 return NULL;
3338 p = find_frozen(name);
3339 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003340}
3341
3342static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003343get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003344{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003345 FILE *fp;
3346 if (mode[0] == 'U')
3347 mode = "r" PY_STDIOTEXTMODE;
3348 if (fob == NULL) {
3349 fp = fopen(pathname, mode);
3350 }
3351 else {
3352 int fd = PyObject_AsFileDescriptor(fob);
3353 if (fd == -1)
3354 return NULL;
3355 if (!_PyVerify_fd(fd))
3356 goto error;
3357 /* the FILE struct gets a new fd, so that it can be closed
3358 * independently of the file descriptor given
3359 */
3360 fd = dup(fd);
3361 if (fd == -1)
3362 goto error;
3363 fp = fdopen(fd, mode);
3364 }
3365 if (fp)
3366 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003367error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003368 PyErr_SetFromErrno(PyExc_IOError);
3369 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003370}
3371
Guido van Rossum79f25d91997-04-29 20:08:16 +00003372static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003373imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003374{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003375 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003376 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003377 PyObject *fob = NULL;
3378 PyObject *m;
3379 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003380 if (!PyArg_ParseTuple(args, "sO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003381 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003382 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003383 &fob))
3384 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003385 fp = get_file(PyBytes_AS_STRING(pathname), fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003386 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003387 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003388 return NULL;
3389 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003390 m = load_compiled_module(name, PyBytes_AS_STRING(pathname), fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003391 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003392 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003393 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003394}
3395
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003396#ifdef HAVE_DYNAMIC_LOADING
3397
Guido van Rossum79f25d91997-04-29 20:08:16 +00003398static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003399imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003400{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003401 char *name;
Victor Stinner8dbf6292010-10-15 12:48:01 +00003402 PyObject *pathbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003403 char *pathname;
3404 PyObject *fob = NULL;
3405 PyObject *m;
3406 FILE *fp = NULL;
Victor Stinner8dbf6292010-10-15 12:48:01 +00003407 if (!PyArg_ParseTuple(args, "sO&|O:load_dynamic",
3408 &name, PyUnicode_FSConverter, &pathbytes, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003409 return NULL;
Victor Stinner8dbf6292010-10-15 12:48:01 +00003410 pathname = PyBytes_AS_STRING(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003411 if (fob) {
3412 fp = get_file(pathname, fob, "r");
3413 if (fp == NULL) {
Victor Stinner8dbf6292010-10-15 12:48:01 +00003414 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003415 return NULL;
3416 }
3417 }
3418 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinner8dbf6292010-10-15 12:48:01 +00003419 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003420 if (fp)
3421 fclose(fp);
3422 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003423}
3424
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003425#endif /* HAVE_DYNAMIC_LOADING */
3426
Guido van Rossum79f25d91997-04-29 20:08:16 +00003427static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003428imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003429{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003430 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003431 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003432 PyObject *fob = NULL;
3433 PyObject *m;
3434 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003435 if (!PyArg_ParseTuple(args, "sO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003436 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003437 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003438 &fob))
3439 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003440 fp = get_file(PyBytes_AS_STRING(pathname), fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003441 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003442 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003443 return NULL;
3444 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003445 m = load_source_module(name, PyBytes_AS_STRING(pathname), fp);
3446 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003447 fclose(fp);
3448 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003449}
3450
Guido van Rossum79f25d91997-04-29 20:08:16 +00003451static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003452imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003453{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003454 char *name;
3455 PyObject *fob;
Victor Stinner1a563032010-10-15 22:43:10 +00003456 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003457 PyObject * ret;
3458 char *suffix; /* Unused */
3459 char *mode;
3460 int type;
3461 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003462
Victor Stinner1a563032010-10-15 22:43:10 +00003463 if (!PyArg_ParseTuple(args, "sOO&(ssi):load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003464 &name, &fob,
Victor Stinner1a563032010-10-15 22:43:10 +00003465 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003466 &suffix, &mode, &type))
3467 return NULL;
3468 if (*mode) {
3469 /* Mode must start with 'r' or 'U' and must not contain '+'.
3470 Implicit in this test is the assumption that the mode
3471 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003472
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003473 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3474 PyErr_Format(PyExc_ValueError,
3475 "invalid file open mode %.200s", mode);
Victor Stinner1a563032010-10-15 22:43:10 +00003476 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003477 return NULL;
3478 }
3479 }
3480 if (fob == Py_None)
3481 fp = NULL;
3482 else {
3483 fp = get_file(NULL, fob, mode);
3484 if (fp == NULL) {
Victor Stinner1a563032010-10-15 22:43:10 +00003485 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003486 return NULL;
3487 }
3488 }
Victor Stinner1a563032010-10-15 22:43:10 +00003489 ret = load_module(name, fp, PyBytes_AS_STRING(pathname), type, NULL);
3490 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003491 if (fp)
3492 fclose(fp);
3493 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003494}
3495
3496static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003497imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003498{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003499 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003500 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003501 PyObject * ret;
Victor Stinnerebc00522010-12-03 17:06:43 +00003502 if (!PyArg_ParseTuple(args, "sO&:load_package",
3503 &name, PyUnicode_FSConverter, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003504 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003505 ret = load_package(name, PyBytes_AS_STRING(pathname));
3506 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003507 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003508}
3509
3510static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003511imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003512{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003513 char *name;
3514 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3515 return NULL;
3516 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003517}
3518
Christian Heimes13a7a212008-01-07 17:13:09 +00003519static PyObject *
3520imp_reload(PyObject *self, PyObject *v)
3521{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003522 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003523}
3524
3525PyDoc_STRVAR(doc_reload,
3526"reload(module) -> module\n\
3527\n\
3528Reload the module. The module must have been successfully imported before.");
3529
Barry Warsaw28a691b2010-04-17 00:19:56 +00003530static PyObject *
3531imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3532{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003533 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003534
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003535 char buf[MAXPATHLEN+1];
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003536 PyObject *pathbytes;
3537 char *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003538 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003539 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003541 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003542 args, kws, "O&|O", kwlist,
3543 PyUnicode_FSConverter, &pathbytes, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003544 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003545
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003546 if (debug_override != NULL &&
3547 (debug = PyObject_IsTrue(debug_override)) < 0) {
3548 Py_DECREF(pathbytes);
3549 return NULL;
3550 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003551
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003552 cpathname = make_compiled_pathname(
3553 PyBytes_AS_STRING(pathbytes),
3554 buf, MAXPATHLEN+1, debug);
3555 Py_DECREF(pathbytes);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003556
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003557 if (cpathname == NULL) {
3558 PyErr_Format(PyExc_SystemError, "path buffer too short");
3559 return NULL;
3560 }
Victor Stinner88bd8912010-10-15 22:46:07 +00003561 return PyUnicode_DecodeFSDefault(buf);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003562}
3563
3564PyDoc_STRVAR(doc_cache_from_source,
3565"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3566\n\
3567The .py file does not need to exist; this simply returns the path to the\n\
3568.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3569will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3570\n\
3571If debug_override is not None, then it must be a boolean and is taken as\n\
3572the value of __debug__ instead.");
3573
3574static PyObject *
3575imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3576{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003577 static char *kwlist[] = {"path", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003578
Victor Stinnerebc00522010-12-03 17:06:43 +00003579 PyObject *pathname_obj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003580 char *pathname;
3581 char buf[MAXPATHLEN+1];
Barry Warsaw28a691b2010-04-17 00:19:56 +00003582
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003583 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003584 args, kws, "O&", kwlist,
3585 PyUnicode_FSConverter, &pathname_obj))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003586 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003587
Victor Stinnerebc00522010-12-03 17:06:43 +00003588 pathname = PyBytes_AS_STRING(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003589 if (make_source_pathname(pathname, buf) == NULL) {
3590 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %s",
3591 pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003592 Py_DECREF(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003593 return NULL;
3594 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003595 Py_DECREF(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003596 return PyUnicode_FromString(buf);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003597}
3598
3599PyDoc_STRVAR(doc_source_from_cache,
3600"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
3601\n\
3602The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3603the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3604does not conform to PEP 3147 format, ValueError will be raised.");
3605
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003606/* Doc strings */
3607
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003608PyDoc_STRVAR(doc_imp,
3609"This module provides the components needed to build your own\n\
3610__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003611
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003612PyDoc_STRVAR(doc_find_module,
3613"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003614Search for a module. If path is omitted or None, search for a\n\
3615built-in, frozen or special module and continue search in sys.path.\n\
3616The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003617package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003618
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003619PyDoc_STRVAR(doc_load_module,
3620"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003621Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003622The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003623
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003624PyDoc_STRVAR(doc_get_magic,
3625"get_magic() -> string\n\
3626Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003627
Barry Warsaw28a691b2010-04-17 00:19:56 +00003628PyDoc_STRVAR(doc_get_tag,
3629"get_tag() -> string\n\
3630Return the magic tag for .pyc or .pyo files.");
3631
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003632PyDoc_STRVAR(doc_get_suffixes,
3633"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003634Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003635that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003636
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003637PyDoc_STRVAR(doc_new_module,
3638"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003639Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003640The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003641
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003642PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003643"lock_held() -> boolean\n\
3644Return True if the import lock is currently held, else False.\n\
3645On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003646
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003647PyDoc_STRVAR(doc_acquire_lock,
3648"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003649Acquires the interpreter's import lock for the current thread.\n\
3650This lock should be used by import hooks to ensure thread-safety\n\
3651when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003652On platforms without threads, this function does nothing.");
3653
3654PyDoc_STRVAR(doc_release_lock,
3655"release_lock() -> None\n\
3656Release the interpreter's import lock.\n\
3657On platforms without threads, this function does nothing.");
3658
Guido van Rossum79f25d91997-04-29 20:08:16 +00003659static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003660 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3661 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3662 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3663 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3664 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3665 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3666 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3667 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3668 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3669 {"reload", imp_reload, METH_O, doc_reload},
3670 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3671 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3672 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3673 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3674 /* The rest are obsolete */
3675 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3676 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3677 {"init_builtin", imp_init_builtin, METH_VARARGS},
3678 {"init_frozen", imp_init_frozen, METH_VARARGS},
3679 {"is_builtin", imp_is_builtin, METH_VARARGS},
3680 {"is_frozen", imp_is_frozen, METH_VARARGS},
3681 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003682#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003683 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003684#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003685 {"load_package", imp_load_package, METH_VARARGS},
3686 {"load_source", imp_load_source, METH_VARARGS},
3687 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003688};
3689
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003690static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003691setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003692{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003693 PyObject *v;
3694 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003695
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003696 v = PyLong_FromLong((long)value);
3697 err = PyDict_SetItemString(d, name, v);
3698 Py_XDECREF(v);
3699 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003700}
3701
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003702typedef struct {
3703 PyObject_HEAD
3704} NullImporter;
3705
3706static int
3707NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3708{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003709#ifndef MS_WINDOWS
3710 PyObject *path;
3711 struct stat statbuf;
3712 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003713
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003714 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3715 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003716
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003717 if (!PyArg_ParseTuple(args, "O&:NullImporter",
3718 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003719 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003720
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003721 if (PyBytes_GET_SIZE(path) == 0) {
3722 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003723 PyErr_SetString(PyExc_ImportError, "empty pathname");
3724 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003725 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003726
3727 rv = stat(PyBytes_AS_STRING(path), &statbuf);
3728 Py_DECREF(path);
3729 if (rv == 0) {
3730 /* it exists */
3731 if (S_ISDIR(statbuf.st_mode)) {
3732 /* it's a directory */
3733 PyErr_SetString(PyExc_ImportError, "existing directory");
3734 return -1;
3735 }
3736 }
3737#else /* MS_WINDOWS */
3738 PyObject *pathobj;
3739 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00003740 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003741
3742 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3743 return -1;
3744
3745 if (!PyArg_ParseTuple(args, "U:NullImporter",
3746 &pathobj))
3747 return -1;
3748
3749 if (PyUnicode_GET_SIZE(pathobj) == 0) {
3750 PyErr_SetString(PyExc_ImportError, "empty pathname");
3751 return -1;
3752 }
3753
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00003754 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003755 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003756 return -1;
3757 /* see issue1293 and issue3677:
3758 * stat() on Windows doesn't recognise paths like
3759 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3760 */
3761 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003762 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003763 if (rv != INVALID_FILE_ATTRIBUTES) {
3764 /* it exists */
3765 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
3766 /* it's a directory */
3767 PyErr_SetString(PyExc_ImportError, "existing directory");
3768 return -1;
3769 }
3770 }
3771#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003772 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003773}
3774
3775static PyObject *
3776NullImporter_find_module(NullImporter *self, PyObject *args)
3777{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003778 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003779}
3780
3781static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003782 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3783 "Always return None"
3784 },
3785 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003786};
3787
3788
Christian Heimes9cd17752007-11-18 19:35:23 +00003789PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003790 PyVarObject_HEAD_INIT(NULL, 0)
3791 "imp.NullImporter", /*tp_name*/
3792 sizeof(NullImporter), /*tp_basicsize*/
3793 0, /*tp_itemsize*/
3794 0, /*tp_dealloc*/
3795 0, /*tp_print*/
3796 0, /*tp_getattr*/
3797 0, /*tp_setattr*/
3798 0, /*tp_reserved*/
3799 0, /*tp_repr*/
3800 0, /*tp_as_number*/
3801 0, /*tp_as_sequence*/
3802 0, /*tp_as_mapping*/
3803 0, /*tp_hash */
3804 0, /*tp_call*/
3805 0, /*tp_str*/
3806 0, /*tp_getattro*/
3807 0, /*tp_setattro*/
3808 0, /*tp_as_buffer*/
3809 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3810 "Null importer object", /* tp_doc */
3811 0, /* tp_traverse */
3812 0, /* tp_clear */
3813 0, /* tp_richcompare */
3814 0, /* tp_weaklistoffset */
3815 0, /* tp_iter */
3816 0, /* tp_iternext */
3817 NullImporter_methods, /* tp_methods */
3818 0, /* tp_members */
3819 0, /* tp_getset */
3820 0, /* tp_base */
3821 0, /* tp_dict */
3822 0, /* tp_descr_get */
3823 0, /* tp_descr_set */
3824 0, /* tp_dictoffset */
3825 (initproc)NullImporter_init, /* tp_init */
3826 0, /* tp_alloc */
3827 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003828};
3829
Martin v. Löwis1a214512008-06-11 05:26:20 +00003830static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003831 PyModuleDef_HEAD_INIT,
3832 "imp",
3833 doc_imp,
3834 0,
3835 imp_methods,
3836 NULL,
3837 NULL,
3838 NULL,
3839 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00003840};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003841
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003842PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00003843PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003844{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003845 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003846
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003847 if (PyType_Ready(&PyNullImporter_Type) < 0)
3848 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003849
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003850 m = PyModule_Create(&impmodule);
3851 if (m == NULL)
3852 goto failure;
3853 d = PyModule_GetDict(m);
3854 if (d == NULL)
3855 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003856
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003857 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3858 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3859 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3860 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3861 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3862 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3863 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3864 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
3865 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
3866 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003867
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003868 Py_INCREF(&PyNullImporter_Type);
3869 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
3870 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003871 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003872 Py_XDECREF(m);
3873 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003874}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003875
3876
Guido van Rossumb18618d2000-05-03 23:44:39 +00003877/* API for embedding applications that want to add their own entries
3878 to the table of built-in modules. This should normally be called
3879 *before* Py_Initialize(). When the table resize fails, -1 is
3880 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003881
3882 After a similar function by Just van Rossum. */
3883
3884int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003885PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003886{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003887 static struct _inittab *our_copy = NULL;
3888 struct _inittab *p;
3889 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003890
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003891 /* Count the number of entries in both tables */
3892 for (n = 0; newtab[n].name != NULL; n++)
3893 ;
3894 if (n == 0)
3895 return 0; /* Nothing to do */
3896 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3897 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003898
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003899 /* Allocate new memory for the combined table */
3900 p = our_copy;
3901 PyMem_RESIZE(p, struct _inittab, i+n+1);
3902 if (p == NULL)
3903 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003904
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003905 /* Copy the tables into the new memory */
3906 if (our_copy != PyImport_Inittab)
3907 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3908 PyImport_Inittab = our_copy = p;
3909 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003910
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003911 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003912}
3913
3914/* Shorthand to add a single entry given a name and a function */
3915
3916int
Brett Cannona826f322009-04-02 03:41:46 +00003917PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003918{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003919 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003921 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003922
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003923 newtab[0].name = (char *)name;
3924 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003926 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003927}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003928
3929#ifdef __cplusplus
3930}
3931#endif