blob: 0efffe91492c0a746c3e86f7a0d60e15852b3855 [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)
Victor Stinner2f42ae52011-03-20 00:41:24 +0100110 TAG and PYC_TAG_UNICODE must change for each major Python release. The magic
111 number will take 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__"
Victor Stinnerc9abda02011-03-14 13:33:46 -0400116static const Py_UNICODE CACHEDIR_UNICODE[] = {
117 '_', '_', 'p', 'y', 'c', 'a', 'c', 'h', 'e', '_', '_', '\0'};
Barry Warsaw28a691b2010-04-17 00:19:56 +0000118/* Current magic word and string tag as globals. */
Guido van Rossum96774c12000-05-01 20:19:08 +0000119static long pyc_magic = MAGIC;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000120static const char *pyc_tag = TAG;
Victor Stinner2f42ae52011-03-20 00:41:24 +0100121static const Py_UNICODE PYC_TAG_UNICODE[] = {
122 'c', 'p', 'y', 't', 'h', 'o', 'n', '-', '3', '2', '\0'};
Guido van Rossum96774c12000-05-01 20:19:08 +0000123
Victor Stinner95872862011-03-07 18:20:56 +0100124/* See _PyImport_FixupExtensionObject() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +0000125static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000126
Guido van Rossum771c6c81997-10-31 18:37:24 +0000127/* This table is defined in config.c: */
128extern struct _inittab _PyImport_Inittab[];
129
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000130/* Method from Parser/tokenizer.c */
Guido van Rossum40d20bc2007-10-22 00:09:51 +0000131extern char * PyTokenizer_FindEncoding(int);
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000132
Guido van Rossum771c6c81997-10-31 18:37:24 +0000133struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +0000134
Guido van Rossumed1170e1999-12-20 21:23:41 +0000135/* these tables define the module suffixes that Python recognizes */
136struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000137
Guido van Rossumed1170e1999-12-20 21:23:41 +0000138static const struct filedescr _PyImport_StandardFiletab[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000139 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000140#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000141 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000142#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000143 {".pyc", "rb", PY_COMPILED},
144 {0, 0}
Guido van Rossumed1170e1999-12-20 21:23:41 +0000145};
146
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000147
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000148/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000149
150void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000151_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000152{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000153 const struct filedescr *scan;
154 struct filedescr *filetab;
155 int countD = 0;
156 int countS = 0;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000157
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000158 /* prepare _PyImport_Filetab: copy entries from
159 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
160 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000161#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000162 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
163 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000164#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000165 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
166 ++countS;
167 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
168 if (filetab == NULL)
169 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000170#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000171 memcpy(filetab, _PyImport_DynLoadFiletab,
172 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000173#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000174 memcpy(filetab + countD, _PyImport_StandardFiletab,
175 countS * sizeof(struct filedescr));
176 filetab[countD + countS].suffix = NULL;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000177
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000178 _PyImport_Filetab = filetab;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000179
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000180 if (Py_OptimizeFlag) {
181 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
182 for (; filetab->suffix != NULL; filetab++) {
183 if (strcmp(filetab->suffix, ".pyc") == 0)
184 filetab->suffix = ".pyo";
185 }
186 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000187}
188
Guido van Rossum25ce5661997-08-02 03:10:38 +0000189void
Just van Rossum52e14d62002-12-30 22:08:05 +0000190_PyImportHooks_Init(void)
191{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000192 PyObject *v, *path_hooks = NULL, *zimpimport;
193 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +0000194
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000195 /* adding sys.path_hooks and sys.path_importer_cache, setting up
196 zipimport */
197 if (PyType_Ready(&PyNullImporter_Type) < 0)
198 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000199
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000200 if (Py_VerboseFlag)
201 PySys_WriteStderr("# installing zipimport hook\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000202
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000203 v = PyList_New(0);
204 if (v == NULL)
205 goto error;
206 err = PySys_SetObject("meta_path", v);
207 Py_DECREF(v);
208 if (err)
209 goto error;
210 v = PyDict_New();
211 if (v == NULL)
212 goto error;
213 err = PySys_SetObject("path_importer_cache", v);
214 Py_DECREF(v);
215 if (err)
216 goto error;
217 path_hooks = PyList_New(0);
218 if (path_hooks == NULL)
219 goto error;
220 err = PySys_SetObject("path_hooks", path_hooks);
221 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +0000222 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000223 PyErr_Print();
224 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
225 "path_importer_cache, or NullImporter failed"
226 );
227 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000228
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000229 zimpimport = PyImport_ImportModule("zipimport");
230 if (zimpimport == NULL) {
231 PyErr_Clear(); /* No zip import module -- okay */
232 if (Py_VerboseFlag)
233 PySys_WriteStderr("# can't import zipimport\n");
234 }
235 else {
236 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
237 "zipimporter");
238 Py_DECREF(zimpimport);
239 if (zipimporter == NULL) {
240 PyErr_Clear(); /* No zipimporter object -- okay */
241 if (Py_VerboseFlag)
242 PySys_WriteStderr(
243 "# can't import zipimport.zipimporter\n");
244 }
245 else {
246 /* sys.path_hooks.append(zipimporter) */
247 err = PyList_Append(path_hooks, zipimporter);
248 Py_DECREF(zipimporter);
249 if (err)
250 goto error;
251 if (Py_VerboseFlag)
252 PySys_WriteStderr(
253 "# installed zipimport hook\n");
254 }
255 }
256 Py_DECREF(path_hooks);
Just van Rossum52e14d62002-12-30 22:08:05 +0000257}
258
259void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000260_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000261{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000262 Py_XDECREF(extensions);
263 extensions = NULL;
264 PyMem_DEL(_PyImport_Filetab);
265 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000266}
267
268
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000269/* Locking primitives to prevent parallel imports of the same module
270 in different threads to return with a partially loaded module.
271 These calls are serialized by the global interpreter lock. */
272
273#ifdef WITH_THREAD
274
Guido van Rossum49b56061998-10-01 20:42:43 +0000275#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000276
Guido van Rossum65d5b571998-12-21 19:32:43 +0000277static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000278static long import_lock_thread = -1;
279static int import_lock_level = 0;
280
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000281void
282_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000283{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000284 long me = PyThread_get_thread_ident();
285 if (me == -1)
286 return; /* Too bad */
287 if (import_lock == NULL) {
288 import_lock = PyThread_allocate_lock();
289 if (import_lock == NULL)
290 return; /* Nothing much we can do. */
291 }
292 if (import_lock_thread == me) {
293 import_lock_level++;
294 return;
295 }
296 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
297 {
298 PyThreadState *tstate = PyEval_SaveThread();
299 PyThread_acquire_lock(import_lock, 1);
300 PyEval_RestoreThread(tstate);
301 }
302 import_lock_thread = me;
303 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000304}
305
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000306int
307_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000308{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000309 long me = PyThread_get_thread_ident();
310 if (me == -1 || import_lock == NULL)
311 return 0; /* Too bad */
312 if (import_lock_thread != me)
313 return -1;
314 import_lock_level--;
315 if (import_lock_level == 0) {
316 import_lock_thread = -1;
317 PyThread_release_lock(import_lock);
318 }
319 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000320}
321
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000322/* This function is called from PyOS_AfterFork to ensure that newly
323 created child processes do not share locks with the parent.
324 We now acquire the import lock around fork() calls but on some platforms
325 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000326
327void
328_PyImport_ReInitLock(void)
329{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000330 if (import_lock != NULL)
331 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000332 if (import_lock_level > 1) {
333 /* Forked as a side effect of import */
334 long me = PyThread_get_thread_ident();
335 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100336 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000337 import_lock_thread = me;
338 import_lock_level--;
339 } else {
340 import_lock_thread = -1;
341 import_lock_level = 0;
342 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000343}
344
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000345#endif
346
Tim Peters69232342001-08-30 05:16:13 +0000347static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000348imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000349{
Tim Peters69232342001-08-30 05:16:13 +0000350#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000351 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000352#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000353 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000354#endif
355}
356
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000357static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000358imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000359{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000360#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000361 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000362#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000363 Py_INCREF(Py_None);
364 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000365}
366
367static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000368imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000369{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000370#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000371 if (_PyImport_ReleaseLock() < 0) {
372 PyErr_SetString(PyExc_RuntimeError,
373 "not holding the import lock");
374 return NULL;
375 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000376#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 Py_INCREF(Py_None);
378 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000379}
380
Guido van Rossumd8faa362007-04-27 19:54:29 +0000381static void
382imp_modules_reloading_clear(void)
383{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000384 PyInterpreterState *interp = PyThreadState_Get()->interp;
385 if (interp->modules_reloading != NULL)
386 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000387}
388
Guido van Rossum25ce5661997-08-02 03:10:38 +0000389/* Helper for sys */
390
391PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000392PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000393{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000394 PyInterpreterState *interp = PyThreadState_GET()->interp;
395 if (interp->modules == NULL)
396 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
397 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000398}
399
Guido van Rossum3f5da241990-12-20 15:06:42 +0000400
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000401/* List of names to clear in sys */
402static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000403 "path", "argv", "ps1", "ps2",
404 "last_type", "last_value", "last_traceback",
405 "path_hooks", "path_importer_cache", "meta_path",
406 /* misc stuff */
407 "flags", "float_info",
408 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000409};
410
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000411static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000412 "stdin", "__stdin__",
413 "stdout", "__stdout__",
414 "stderr", "__stderr__",
415 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000416};
417
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000418
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000419/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000420
Guido van Rossum3f5da241990-12-20 15:06:42 +0000421void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000422PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000423{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000424 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000425 PyObject *key, *value, *dict;
426 PyInterpreterState *interp = PyThreadState_GET()->interp;
427 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000428
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000429 if (modules == NULL)
430 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000431
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000432 /* Delete some special variables first. These are common
433 places where user values hide and people complain when their
434 destructors fail. Since the modules containing them are
435 deleted *last* of all, they would come too late in the normal
436 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000438 value = PyDict_GetItemString(modules, "builtins");
439 if (value != NULL && PyModule_Check(value)) {
440 dict = PyModule_GetDict(value);
441 if (Py_VerboseFlag)
442 PySys_WriteStderr("# clear builtins._\n");
443 PyDict_SetItemString(dict, "_", Py_None);
444 }
445 value = PyDict_GetItemString(modules, "sys");
446 if (value != NULL && PyModule_Check(value)) {
447 char **p;
448 PyObject *v;
449 dict = PyModule_GetDict(value);
450 for (p = sys_deletes; *p != NULL; p++) {
451 if (Py_VerboseFlag)
452 PySys_WriteStderr("# clear sys.%s\n", *p);
453 PyDict_SetItemString(dict, *p, Py_None);
454 }
455 for (p = sys_files; *p != NULL; p+=2) {
456 if (Py_VerboseFlag)
457 PySys_WriteStderr("# restore sys.%s\n", *p);
458 v = PyDict_GetItemString(dict, *(p+1));
459 if (v == NULL)
460 v = Py_None;
461 PyDict_SetItemString(dict, *p, v);
462 }
463 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000464
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000465 /* First, delete __main__ */
466 value = PyDict_GetItemString(modules, "__main__");
467 if (value != NULL && PyModule_Check(value)) {
468 if (Py_VerboseFlag)
469 PySys_WriteStderr("# cleanup __main__\n");
470 _PyModule_Clear(value);
471 PyDict_SetItemString(modules, "__main__", Py_None);
472 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000474 /* The special treatment of "builtins" here is because even
475 when it's not referenced as a module, its dictionary is
476 referenced by almost every module's __builtins__. Since
477 deleting a module clears its dictionary (even if there are
478 references left to it), we need to delete the "builtins"
479 module last. Likewise, we don't delete sys until the very
480 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000482 Also note that we 'delete' modules by replacing their entry
483 in the modules dict with None, rather than really deleting
484 them; this avoids a rehash of the modules dictionary and
485 also marks them as "non existent" so they won't be
486 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000488 /* Next, repeatedly delete modules with a reference count of
489 one (skipping builtins and sys) and delete them */
490 do {
491 ndone = 0;
492 pos = 0;
493 while (PyDict_Next(modules, &pos, &key, &value)) {
494 if (value->ob_refcnt != 1)
495 continue;
496 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100497 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000498 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100499 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000500 continue;
501 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100502 PySys_FormatStderr(
503 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000504 _PyModule_Clear(value);
505 PyDict_SetItem(modules, key, Py_None);
506 ndone++;
507 }
508 }
509 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000510
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000511 /* Next, delete all modules (still skipping builtins and sys) */
512 pos = 0;
513 while (PyDict_Next(modules, &pos, &key, &value)) {
514 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100515 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000516 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100517 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000518 continue;
519 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100520 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000521 _PyModule_Clear(value);
522 PyDict_SetItem(modules, key, Py_None);
523 }
524 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000525
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000526 /* Next, delete sys and builtins (in that order) */
527 value = PyDict_GetItemString(modules, "sys");
528 if (value != NULL && PyModule_Check(value)) {
529 if (Py_VerboseFlag)
530 PySys_WriteStderr("# cleanup sys\n");
531 _PyModule_Clear(value);
532 PyDict_SetItemString(modules, "sys", Py_None);
533 }
534 value = PyDict_GetItemString(modules, "builtins");
535 if (value != NULL && PyModule_Check(value)) {
536 if (Py_VerboseFlag)
537 PySys_WriteStderr("# cleanup builtins\n");
538 _PyModule_Clear(value);
539 PyDict_SetItemString(modules, "builtins", Py_None);
540 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000541
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000542 /* Finally, clear and delete the modules directory */
543 PyDict_Clear(modules);
544 interp->modules = NULL;
545 Py_DECREF(modules);
546 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000547}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000548
549
Barry Warsaw28a691b2010-04-17 00:19:56 +0000550/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000551
552long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000553PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000554{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000555 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000556}
557
558
Barry Warsaw28a691b2010-04-17 00:19:56 +0000559const char *
560PyImport_GetMagicTag(void)
561{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000562 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000563}
564
Guido van Rossum25ce5661997-08-02 03:10:38 +0000565/* Magic for extension modules (built-in as well as dynamically
566 loaded). To prevent initializing an extension module more than
567 once, we keep a static dictionary 'extensions' keyed by module name
568 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000569 modules), containing these modules. A copy of the module's
Victor Stinner95872862011-03-07 18:20:56 +0100570 dictionary is stored by calling _PyImport_FixupExtensionObject()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000571 immediately after the module initialization function succeeds. A
572 copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100573 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000574
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000575 Modules which do support multiple initialization set their m_size
576 field to a non-negative number (indicating the size of the
577 module-specific state). They are still recorded in the extensions
578 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000579*/
580
581int
Victor Stinner95872862011-03-07 18:20:56 +0100582_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
583 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000584{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000585 PyObject *modules, *dict;
586 struct PyModuleDef *def;
587 if (extensions == NULL) {
588 extensions = PyDict_New();
589 if (extensions == NULL)
590 return -1;
591 }
592 if (mod == NULL || !PyModule_Check(mod)) {
593 PyErr_BadInternalCall();
594 return -1;
595 }
596 def = PyModule_GetDef(mod);
597 if (!def) {
598 PyErr_BadInternalCall();
599 return -1;
600 }
601 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100602 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000603 return -1;
604 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100605 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000606 return -1;
607 }
608 if (def->m_size == -1) {
609 if (def->m_base.m_copy) {
610 /* Somebody already imported the module,
611 likely under a different name.
612 XXX this should really not happen. */
613 Py_DECREF(def->m_base.m_copy);
614 def->m_base.m_copy = NULL;
615 }
616 dict = PyModule_GetDict(mod);
617 if (dict == NULL)
618 return -1;
619 def->m_base.m_copy = PyDict_Copy(dict);
620 if (def->m_base.m_copy == NULL)
621 return -1;
622 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000623 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000624 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000625}
626
Victor Stinner49d3f252010-10-17 01:24:53 +0000627int
628_PyImport_FixupBuiltin(PyObject *mod, char *name)
629{
630 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100631 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100632 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100633 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000634 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100635 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
636 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000637 return res;
638}
639
Guido van Rossum25ce5661997-08-02 03:10:38 +0000640PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100641_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000642{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000643 PyObject *mod, *mdict;
644 PyModuleDef* def;
645 if (extensions == NULL)
646 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000647 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000648 if (def == NULL)
649 return NULL;
650 if (def->m_size == -1) {
651 /* Module does not support repeated initialization */
652 if (def->m_base.m_copy == NULL)
653 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100654 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000655 if (mod == NULL)
656 return NULL;
657 mdict = PyModule_GetDict(mod);
658 if (mdict == NULL)
659 return NULL;
660 if (PyDict_Update(mdict, def->m_base.m_copy))
661 return NULL;
662 }
663 else {
664 if (def->m_base.m_init == NULL)
665 return NULL;
666 mod = def->m_base.m_init();
667 if (mod == NULL)
668 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100669 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000670 Py_DECREF(mod);
671 }
672 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100673 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000674 Py_DECREF(mod);
675 return NULL;
676 }
677 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100678 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000679 name, filename);
680 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000681
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000682}
683
Victor Stinner49d3f252010-10-17 01:24:53 +0000684PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000685_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000686{
Victor Stinner95872862011-03-07 18:20:56 +0100687 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100688 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100689 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000690 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100691 res = _PyImport_FindExtensionObject(nameobj, nameobj);
692 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000693 return res;
694}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000695
696/* Get the module object corresponding to a module name.
697 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000698 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000699 Because the former action is most common, THIS DOES NOT RETURN A
700 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000701
Guido van Rossum79f25d91997-04-29 20:08:16 +0000702PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000703PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000704{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000705 PyObject *modules = PyImport_GetModuleDict();
706 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000707
Victor Stinner27ee0892011-03-04 12:57:09 +0000708 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000709 PyModule_Check(m))
710 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000711 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000712 if (m == NULL)
713 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000714 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000715 Py_DECREF(m);
716 return NULL;
717 }
718 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000719
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000720 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000721}
722
Victor Stinner27ee0892011-03-04 12:57:09 +0000723PyObject *
724PyImport_AddModule(const char *name)
725{
726 PyObject *nameobj, *module;
727 nameobj = PyUnicode_FromString(name);
728 if (nameobj == NULL)
729 return NULL;
730 module = PyImport_AddModuleObject(nameobj);
731 Py_DECREF(nameobj);
732 return module;
733}
734
735
Tim Peters1cd70172004-08-02 03:52:12 +0000736/* Remove name from sys.modules, if it's there. */
737static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000738remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000739{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000741 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000742 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000743 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000744 Py_FatalError("import: deleting existing key in"
745 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000746}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000747
Victor Stinnerc9abda02011-03-14 13:33:46 -0400748static PyObject * get_sourcefile(PyObject *filename);
749static PyObject *make_source_pathname(PyObject *pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +0100750static PyObject* make_compiled_pathname(Py_UNICODE *pathname, int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000751
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000752/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000753 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
754 * removed from sys.modules, to avoid leaving damaged module objects
755 * in sys.modules. The caller may wish to restore the original
756 * module object (if any) in this case; PyImport_ReloadModule is an
757 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000758 *
759 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
760 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000761 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000762PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000763PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000764{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000765 return PyImport_ExecCodeModuleWithPathnames(
766 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000767}
768
769PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000770PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000771{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000772 return PyImport_ExecCodeModuleWithPathnames(
773 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000774}
775
776PyObject *
777PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000779{
Victor Stinner27ee0892011-03-04 12:57:09 +0000780 PyObject *m = NULL;
781 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
782
783 nameobj = PyUnicode_FromString(name);
784 if (nameobj == NULL)
785 return NULL;
786
787 if (pathname != NULL) {
788 pathobj = PyUnicode_DecodeFSDefault(pathname);
789 if (pathobj == NULL)
790 goto error;
791 } else
792 pathobj = NULL;
793 if (cpathname != NULL) {
794 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
795 if (cpathobj == NULL)
796 goto error;
797 } else
798 cpathobj = NULL;
799 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
800error:
801 Py_DECREF(nameobj);
802 Py_XDECREF(pathobj);
803 Py_XDECREF(cpathobj);
804 return m;
805}
806
807PyObject*
808PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
809 PyObject *cpathname)
810{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000811 PyObject *modules = PyImport_GetModuleDict();
812 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000813
Victor Stinner27ee0892011-03-04 12:57:09 +0000814 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000815 if (m == NULL)
816 return NULL;
817 /* If the module is being reloaded, we get the old module back
818 and re-use its dict to exec the new code. */
819 d = PyModule_GetDict(m);
820 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
821 if (PyDict_SetItemString(d, "__builtins__",
822 PyEval_GetBuiltins()) != 0)
823 goto error;
824 }
825 /* Remember the filename as the __file__ attribute */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000826 if (pathname != NULL) {
Victor Stinnerc9abda02011-03-14 13:33:46 -0400827 v = get_sourcefile(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 if (v == NULL)
829 PyErr_Clear();
830 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000831 else
832 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000833 if (v == NULL) {
834 v = ((PyCodeObject *)co)->co_filename;
835 Py_INCREF(v);
836 }
837 if (PyDict_SetItemString(d, "__file__", v) != 0)
838 PyErr_Clear(); /* Not important enough to report */
839 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000840
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000841 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000842 if (cpathname != NULL)
843 v = cpathname;
844 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000845 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000846 if (PyDict_SetItemString(d, "__cached__", v) != 0)
847 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000848
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000849 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000850 if (v == NULL)
851 goto error;
852 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000853
Victor Stinner27ee0892011-03-04 12:57:09 +0000854 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000855 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000856 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000857 name);
858 return NULL;
859 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000860
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000862
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000863 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000864
865 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000866 remove_module(name);
867 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000868}
869
870
Barry Warsaw28a691b2010-04-17 00:19:56 +0000871/* Like strrchr(string, '/') but searches for the rightmost of either SEP
872 or ALTSEP, if the latter is defined.
873*/
Victor Stinnerc9abda02011-03-14 13:33:46 -0400874static Py_UNICODE*
Victor Stinner2f42ae52011-03-20 00:41:24 +0100875rightmost_sep(Py_UNICODE *s)
Victor Stinnerc9abda02011-03-14 13:33:46 -0400876{
877 Py_UNICODE *found, c;
878 for (found = NULL; (c = *s); s++) {
879 if (c == SEP
880#ifdef ALTSEP
881 || c == ALTSEP
882#endif
883 )
884 {
885 found = s;
886 }
887 }
888 return found;
889}
890
891
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000892/* Given a pathname for a Python source file, fill a buffer with the
893 pathname for the corresponding compiled file. Return the pathname
894 for the compiled file, or NULL if there's no space in the buffer.
Victor Stinner2f42ae52011-03-20 00:41:24 +0100895 Doesn't set an exception.
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000896
Victor Stinner2f42ae52011-03-20 00:41:24 +0100897 foo.py -> __pycache__/foo.<tag>.pyc */
898
899static PyObject*
900make_compiled_pathname(Py_UNICODE *pathname, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000901{
Victor Stinner2f42ae52011-03-20 00:41:24 +0100902 Py_UNICODE buf[MAXPATHLEN];
903 size_t buflen = (size_t)MAXPATHLEN;
904 size_t len = Py_UNICODE_strlen(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 size_t i, save;
Victor Stinner2f42ae52011-03-20 00:41:24 +0100906 Py_UNICODE *pos;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000907 int sep = SEP;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000909 /* Sanity check that the buffer has roughly enough space to hold what
910 will eventually be the full path to the compiled file. The 5 extra
911 bytes include the slash afer __pycache__, the two extra dots, the
912 extra trailing character ('c' or 'o') and null. This isn't exact
913 because the contents of the buffer can affect how many actual
914 characters of the string get into the buffer. We'll do a final
915 sanity check before writing the extension to ensure we do not
916 overflow the buffer.
917 */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100918 if (len + Py_UNICODE_strlen(CACHEDIR_UNICODE) + Py_UNICODE_strlen(PYC_TAG_UNICODE) + 5 > buflen)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000919 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000921 /* Find the last path separator and copy everything from the start of
922 the source string up to and including the separator.
923 */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100924 pos = rightmost_sep(pathname);
925 if (pos == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000926 i = 0;
927 }
928 else {
929 sep = *pos;
930 i = pos - pathname + 1;
Victor Stinner2f42ae52011-03-20 00:41:24 +0100931 Py_UNICODE_strncpy(buf, pathname, i);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000932 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000933
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000934 save = i;
935 buf[i++] = '\0';
936 /* Add __pycache__/ */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100937 Py_UNICODE_strcat(buf, CACHEDIR_UNICODE);
938 i += Py_UNICODE_strlen(CACHEDIR_UNICODE) - 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000939 buf[i++] = sep;
940 buf[i++] = '\0';
941 /* Add the base filename, but remove the .py or .pyw extension, since
942 the tag name must go before the extension.
943 */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100944 Py_UNICODE_strcat(buf, pathname + save);
945 pos = Py_UNICODE_strrchr(buf, '.');
946 if (pos != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000947 *++pos = '\0';
Victor Stinner2f42ae52011-03-20 00:41:24 +0100948 Py_UNICODE_strcat(buf, PYC_TAG_UNICODE);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000949 /* The length test above assumes that we're only adding one character
950 to the end of what would normally be the extension. What if there
951 is no extension, or the string ends in '.' or '.p', and otherwise
952 fills the buffer? By appending 4 more characters onto the string
953 here, we could overrun the buffer.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000954
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 As a simple example, let's say buflen=32 and the input string is
956 'xxx.py'. strlen() would be 6 and the test above would yield:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000957
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 (6 + 11 + 10 + 5 == 32) > 32
Barry Warsaw28a691b2010-04-17 00:19:56 +0000959
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 which is false and so the name mangling would continue. This would
961 be fine because we'd end up with this string in buf:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000962
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000963 __pycache__/xxx.cpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000964
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000965 strlen(of that) == 30 + the nul fits inside a 32 character buffer.
966 We can even handle an input string of say 'xxxxx' above because
967 that's (5 + 11 + 10 + 5 == 31) > 32 which is also false. Name
968 mangling that yields:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000969
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 __pycache__/xxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000971
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000972 which is 32 characters including the nul, and thus fits in the
973 buffer. However, an input string of 'xxxxxx' would yield a result
974 string of:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000975
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000976 __pycache__/xxxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 which is 33 characters long (including the nul), thus overflowing
979 the buffer, even though the first test would fail, i.e.: the input
980 string is also 6 characters long, so 32 > 32 is false.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000981
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 The reason the first test fails but we still overflow the buffer is
983 that the test above only expects to add one extra character to be
984 added to the extension, and here we're adding three (pyc). We
985 don't add the first dot, so that reclaims one of expected
986 positions, leaving us overflowing by 1 byte (3 extra - 1 reclaimed
987 dot - 1 expected extra == 1 overflowed).
Barry Warsaw28a691b2010-04-17 00:19:56 +0000988
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000989 The best we can do is ensure that we still have enough room in the
990 target buffer before we write the extension. Because it's always
991 only the extension that can cause the overflow, and never the other
992 path bytes we've written, it's sufficient to just do one more test
993 here. Still, the assertion that follows can't hurt.
994 */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000995#if 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000996 printf("strlen(buf): %d; buflen: %d\n", (int)strlen(buf), (int)buflen);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000997#endif
Victor Stinner2f42ae52011-03-20 00:41:24 +0100998 len = Py_UNICODE_strlen(buf);
999 if (len + 5 > buflen)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001000 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001001 buf[len] = '.'; len++;
1002 buf[len] = 'p'; len++;
1003 buf[len] = 'y'; len++;
1004 buf[len] = debug ? 'c' : 'o'; len++;
1005 assert(len <= buflen);
1006 return PyUnicode_FromUnicode(buf, len);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001007}
1008
1009
Barry Warsaw28a691b2010-04-17 00:19:56 +00001010/* Given a pathname to a Python byte compiled file, return the path to the
1011 source file, if the path matches the PEP 3147 format. This does not check
1012 for any file existence, however, if the pyc file name does not match PEP
1013 3147 style, NULL is returned. buf must be at least as big as pathname;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001014 the resulting path will always be shorter.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001015
Victor Stinnerc9abda02011-03-14 13:33:46 -04001016 (...)/__pycache__/foo.<tag>.pyc -> (...)/foo.py */
1017
1018static PyObject*
1019make_source_pathname(PyObject *pathobj)
Barry Warsaw28a691b2010-04-17 00:19:56 +00001020{
Victor Stinnerc9abda02011-03-14 13:33:46 -04001021 Py_UNICODE buf[MAXPATHLEN];
1022 Py_UNICODE *pathname;
1023 Py_UNICODE *left, *right, *dot0, *dot1, sep;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001024 size_t i, j;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001025
1026 if (PyUnicode_GET_SIZE(pathobj) > MAXPATHLEN)
1027 return NULL;
1028 pathname = PyUnicode_AS_UNICODE(pathobj);
Barry Warsaw28a691b2010-04-17 00:19:56 +00001029
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001030 /* Look back two slashes from the end. In between these two slashes
1031 must be the string __pycache__ or this is not a PEP 3147 style
1032 path. It's possible for there to be only one slash.
1033 */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001034 right = rightmost_sep(pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001035 if (right == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 return NULL;
1037 sep = *right;
1038 *right = '\0';
Victor Stinner2f42ae52011-03-20 00:41:24 +01001039 left = rightmost_sep(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001040 *right = sep;
1041 if (left == NULL)
1042 left = pathname;
1043 else
1044 left++;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001045 if (right-left != Py_UNICODE_strlen(CACHEDIR_UNICODE) ||
1046 Py_UNICODE_strncmp(left, CACHEDIR_UNICODE, right-left) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001047 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001048
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001049 /* Now verify that the path component to the right of the last slash
1050 has two dots in it.
1051 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001052 if ((dot0 = Py_UNICODE_strchr(right + 1, '.')) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001054 if ((dot1 = Py_UNICODE_strchr(dot0 + 1, '.')) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 return NULL;
1056 /* Too many dots? */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001057 if (Py_UNICODE_strchr(dot1 + 1, '.') != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001058 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001060 /* This is a PEP 3147 path. Start by copying everything from the
1061 start of pathname up to and including the leftmost slash. Then
1062 copy the file's basename, removing the magic tag and adding a .py
1063 suffix.
1064 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001065 Py_UNICODE_strncpy(buf, pathname, (i=left-pathname));
1066 Py_UNICODE_strncpy(buf+i, right+1, (j=dot0-right));
1067 buf[i+j] = 'p';
1068 buf[i+j+1] = 'y';
1069 return PyUnicode_FromUnicode(buf, i+j+2);
Barry Warsaw28a691b2010-04-17 00:19:56 +00001070}
1071
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001072/* Given a pathname for a Python source file, its time of last
1073 modification, and a pathname for a compiled file, check whether the
1074 compiled file represents the same version of the source. If so,
1075 return a FILE pointer for the compiled file, positioned just after
1076 the header; if not, return NULL.
1077 Doesn't set an exception. */
1078
1079static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001080check_compiled_module(PyObject *pathname, time_t mtime, PyObject *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001081{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001082 FILE *fp;
1083 long magic;
1084 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001085
Victor Stinner2f42ae52011-03-20 00:41:24 +01001086 fp = _Py_fopen(cpathname, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001087 if (fp == NULL)
1088 return NULL;
1089 magic = PyMarshal_ReadLongFromFile(fp);
1090 if (magic != pyc_magic) {
1091 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001092 PySys_FormatStderr("# %R has bad magic\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 fclose(fp);
1094 return NULL;
1095 }
1096 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
1097 if (pyc_mtime != mtime) {
1098 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001099 PySys_FormatStderr("# %R has bad mtime\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001100 fclose(fp);
1101 return NULL;
1102 }
1103 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001104 PySys_FormatStderr("# %R matches %R\n", cpathname, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001105 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001106}
1107
1108
1109/* Read a code object from a file and check it for validity */
1110
Guido van Rossum79f25d91997-04-29 20:08:16 +00001111static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001112read_compiled_module(PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001113{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001114 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001115
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001116 co = PyMarshal_ReadLastObjectFromFile(fp);
1117 if (co == NULL)
1118 return NULL;
1119 if (!PyCode_Check(co)) {
1120 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001121 "Non-code object in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 Py_DECREF(co);
1123 return NULL;
1124 }
1125 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001126}
1127
1128
1129/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001130 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001131
Guido van Rossum79f25d91997-04-29 20:08:16 +00001132static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001133load_compiled_module(PyObject *name, PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001134{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001135 long magic;
1136 PyCodeObject *co;
1137 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001139 magic = PyMarshal_ReadLongFromFile(fp);
1140 if (magic != pyc_magic) {
1141 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001142 "Bad magic number in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001143 return NULL;
1144 }
1145 (void) PyMarshal_ReadLongFromFile(fp);
1146 co = read_compiled_module(cpathname, fp);
1147 if (co == NULL)
1148 return NULL;
1149 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001150 PySys_FormatStderr("import %U # precompiled from %R\n",
1151 name, cpathname);
1152 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1153 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001154 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001155
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001156 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001157}
1158
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001159/* Parse a source file and return the corresponding code object */
1160
Guido van Rossum79f25d91997-04-29 20:08:16 +00001161static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001162parse_source_module(PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001163{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001164 PyCodeObject *co;
1165 PyObject *pathbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 mod_ty mod;
1167 PyCompilerFlags flags;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001168 PyArena *arena;
1169
1170 pathbytes = PyUnicode_EncodeFSDefault(pathname);
1171 if (pathbytes == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001172 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001173
Victor Stinner2f42ae52011-03-20 00:41:24 +01001174 arena = PyArena_New();
1175 if (arena == NULL) {
1176 Py_DECREF(pathbytes);
1177 return NULL;
1178 }
1179
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001180 flags.cf_flags = 0;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001181 mod = PyParser_ASTFromFile(fp, PyBytes_AS_STRING(pathbytes), NULL,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001182 Py_file_input, 0, 0, &flags,
1183 NULL, arena);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001184 if (mod != NULL)
1185 co = PyAST_Compile(mod, PyBytes_AS_STRING(pathbytes), NULL, arena);
1186 else
1187 co = NULL;
1188 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 PyArena_Free(arena);
1190 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001191}
1192
Guido van Rossum55a83382000-09-20 20:31:38 +00001193/* Helper to open a bytecode file for writing in exclusive mode */
1194
1195static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +00001196open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +00001197{
1198#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001199 /* Use O_EXCL to avoid a race condition when another process tries to
1200 write the same file. When that happens, our open() call fails,
1201 which is just fine (since it's only a cache).
1202 XXX If the file exists and is writable but the directory is not
1203 writable, the file will never be written. Oh well.
1204 */
1205 int fd;
1206 (void) unlink(filename);
1207 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +00001208#ifdef O_BINARY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001209 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +00001210#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001211#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001212 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001213#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001214 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001215#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001216 );
1217 if (fd < 0)
1218 return NULL;
1219 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001220#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001221 /* Best we can do -- on Windows this can't happen anyway */
1222 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001223#endif
1224}
1225
1226
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001227/* Write a compiled module to a file, placing the time of last
1228 modification of its source into the header.
1229 Errors are ignored, if a write error occurs an attempt is made to
1230 remove the file. */
1231
1232static void
Victor Stinner2f42ae52011-03-20 00:41:24 +01001233write_compiled_module(PyCodeObject *co, PyObject *cpathname,
1234 struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001235{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001236 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001237 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001238#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001239 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001240#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001241 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
1242 mode_t dirmode = (srcstat->st_mode |
1243 S_IXUSR | S_IXGRP | S_IXOTH |
1244 S_IWUSR | S_IWGRP | S_IWOTH);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001245 PyObject *dirbytes;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001246#endif
Victor Stinner2f42ae52011-03-20 00:41:24 +01001247 PyObject *cpathbytes, *dirname;
1248 Py_UNICODE *dirsep;
1249 int res, ok;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001250
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001251 /* Ensure that the __pycache__ directory exists. */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001252 dirsep = rightmost_sep(PyUnicode_AS_UNICODE(cpathname));
1253 if (dirsep == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001254 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001255 PySys_FormatStderr("# no %s path found %R\n", CACHEDIR, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001256 return;
1257 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001258 dirname = PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(cpathname),
1259 dirsep - PyUnicode_AS_UNICODE(cpathname));
1260 if (dirname == NULL) {
1261 PyErr_Clear();
1262 return;
1263 }
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001264
1265#ifdef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001266 res = CreateDirectoryW(PyUnicode_AS_UNICODE(dirname), NULL);
1267 ok = (res != 0);
1268 if (!ok && GetLastError() == ERROR_ALREADY_EXISTS)
1269 ok = 1;
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001270#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001271 dirbytes = PyUnicode_EncodeFSDefault(dirname);
1272 if (dirbytes == NULL) {
1273 PyErr_Clear();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001274 return;
1275 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001276 res = mkdir(PyBytes_AS_STRING(dirbytes), dirmode);
1277 Py_DECREF(dirbytes);
1278 if (0 <= res)
1279 ok = 1;
1280 else
1281 ok = (errno == EEXIST);
1282#endif
1283 if (!ok) {
1284 if (Py_VerboseFlag)
1285 PySys_FormatStderr("# cannot create cache dir %R\n", dirname);
1286 Py_DECREF(dirname);
1287 return;
1288 }
1289 Py_DECREF(dirname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001290
Victor Stinner2f42ae52011-03-20 00:41:24 +01001291 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1292 if (cpathbytes == NULL) {
1293 PyErr_Clear();
1294 return;
1295 }
1296
1297 fp = open_exclusive(PyBytes_AS_STRING(cpathbytes), mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001298 if (fp == NULL) {
1299 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001300 PySys_FormatStderr(
1301 "# can't create %R\n", cpathname);
1302 Py_DECREF(cpathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001303 return;
1304 }
1305 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1306 /* First write a 0 for mtime */
1307 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1308 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
1309 if (fflush(fp) != 0 || ferror(fp)) {
1310 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001311 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001312 /* Don't keep partial file */
1313 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001314#ifdef MS_WINDOWS
1315 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1316#else
1317 (void) unlink(PyBytes_AS_STRING(cpathbytes));
1318#endif
1319 Py_DECREF(cpathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001320 return;
1321 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001322 Py_DECREF(cpathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001323 /* Now write the true mtime */
1324 fseek(fp, 4L, 0);
1325 assert(mtime < LONG_MAX);
1326 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
1327 fflush(fp);
1328 fclose(fp);
1329 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001330 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001331}
1332
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001333static void
1334update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1335{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001336 PyObject *constants, *tmp;
1337 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001338
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001339 if (PyUnicode_Compare(co->co_filename, oldname))
1340 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001341
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001342 tmp = co->co_filename;
1343 co->co_filename = newname;
1344 Py_INCREF(co->co_filename);
1345 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 constants = co->co_consts;
1348 n = PyTuple_GET_SIZE(constants);
1349 for (i = 0; i < n; i++) {
1350 tmp = PyTuple_GET_ITEM(constants, i);
1351 if (PyCode_Check(tmp))
1352 update_code_filenames((PyCodeObject *)tmp,
1353 oldname, newname);
1354 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001355}
1356
Victor Stinner2f42ae52011-03-20 00:41:24 +01001357static void
1358update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001359{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001360 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001361
Victor Stinner2f42ae52011-03-20 00:41:24 +01001362 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1363 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001364
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001365 oldname = co->co_filename;
1366 Py_INCREF(oldname);
1367 update_code_filenames(co, oldname, newname);
1368 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001369}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001370
1371/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001372 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1373 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001374
Guido van Rossum79f25d91997-04-29 20:08:16 +00001375static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001376load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001377{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001378 struct stat st;
1379 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001380 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001381 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001382 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001383
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001384 if (fstat(fileno(fp), &st) != 0) {
1385 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001386 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001387 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001388 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001389 }
Fred Drake4c82b232000-06-30 16:18:57 +00001390#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 /* Python's .pyc timestamp handling presumes that the timestamp fits
1392 in 4 bytes. This will be fine until sometime in the year 2038,
1393 when a 4-byte signed time_t will overflow.
1394 */
1395 if (st.st_mtime >> 32) {
1396 PyErr_SetString(PyExc_OverflowError,
1397 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001398 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001399 }
Fred Drake4c82b232000-06-30 16:18:57 +00001400#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001401 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01001402 PyUnicode_AS_UNICODE(pathname),
1403 !Py_OptimizeFlag);
1404
1405 if (cpathname != NULL)
1406 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1407 else
1408 fpc = NULL;
1409
1410 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001411 co = read_compiled_module(cpathname, fpc);
1412 fclose(fpc);
1413 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001414 goto error;
1415 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001416 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001417 PySys_FormatStderr("import %U # precompiled from %R\n",
1418 name, cpathname);
1419 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1420 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001421 }
1422 else {
1423 co = parse_source_module(pathname, fp);
1424 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001425 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001426 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001427 PySys_FormatStderr("import %U # from %R\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001429 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001430 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1431 if (ro == NULL || !PyObject_IsTrue(ro))
1432 write_compiled_module(co, cpathname, &st);
1433 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001434 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1435 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001437 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001438
Victor Stinner2f42ae52011-03-20 00:41:24 +01001439error:
1440 Py_XDECREF(cpathbytes);
1441 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001442 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001443}
1444
Christian Heimes3b06e532008-01-07 20:12:44 +00001445/* Get source file -> unicode or None
1446 * Returns the path to the py file if available, else the given path
1447 */
1448static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001449get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001450{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001451 Py_ssize_t len;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001452 Py_UNICODE *fileuni;
1453 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001455
Victor Stinnerc9abda02011-03-14 13:33:46 -04001456 len = PyUnicode_GET_SIZE(filename);
1457 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001458 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001459
Victor Stinnerc9abda02011-03-14 13:33:46 -04001460 /* don't match *.pyc or *.pyo? */
1461 fileuni = PyUnicode_AS_UNICODE(filename);
1462 if (len < 5
1463 || fileuni[len-4] != '.'
1464 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1465 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1466 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001467
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001468 /* Start by trying to turn PEP 3147 path into source path. If that
1469 * fails, just chop off the trailing character, i.e. legacy pyc path
1470 * to py.
1471 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001472 py = make_source_pathname(filename);
1473 if (py == NULL) {
1474 PyErr_Clear();
1475 py = PyUnicode_FromUnicode(fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001476 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001477 if (py == NULL)
1478 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001479
Victor Stinnerc9abda02011-03-14 13:33:46 -04001480 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode))
1481 return py;
1482 Py_DECREF(py);
1483 goto unchanged;
1484
1485error:
1486 PyErr_Clear();
1487unchanged:
1488 Py_INCREF(filename);
1489 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001490}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001491
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001492/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001493static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
Victor Stinnerc6963162011-03-12 09:26:54 -05001494static struct filedescr *find_module(char *, const char *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001495 char *, size_t, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001496static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001497
1498/* Load a package and return its module object WITH INCREMENTED
1499 REFERENCE COUNT */
1500
1501static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001502load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001503{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001504 PyObject *m, *d;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001505 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001506 int err;
1507 char buf[MAXPATHLEN+1];
Victor Stinnerc9abda02011-03-14 13:33:46 -04001508 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001509 struct filedescr *fdp;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001510 char *namestr;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001511
Victor Stinnerc9abda02011-03-14 13:33:46 -04001512 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001513 if (m == NULL)
1514 return NULL;
1515 if (Py_VerboseFlag)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001516 PySys_FormatStderr("import %U # directory %U\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001517 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 file = get_sourcefile(pathname);
1519 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001520 return NULL;
1521 path_list = Py_BuildValue("[O]", file);
1522 if (path_list == NULL) {
1523 Py_DECREF(file);
1524 return NULL;
1525 }
1526 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001527 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001528 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001529 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001530 err = PyDict_SetItemString(d, "__path__", path_list);
1531 if (err != 0) {
1532 Py_DECREF(path_list);
1533 return NULL;
1534 }
1535 namestr = _PyUnicode_AsString(name);
1536 if (namestr == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001537 goto error;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001538 fdp = find_module(namestr, "__init__", path_list, buf, sizeof(buf), &fp, NULL);
1539 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001540 if (fdp == NULL) {
1541 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1542 PyErr_Clear();
1543 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001544 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001545 }
1546 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001547 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001548 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001549 m = load_module(namestr, fp, buf, fdp->type, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001550 if (fp != NULL)
1551 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001552 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001553}
1554
1555
1556/* Helper to test for built-in module */
1557
1558static int
Victor Stinner95872862011-03-07 18:20:56 +01001559is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001560{
Victor Stinner95872862011-03-07 18:20:56 +01001561 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001562 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001563 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1564 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001565 if (PyImport_Inittab[i].initfunc == NULL)
1566 return -1;
1567 else
1568 return 1;
1569 }
1570 }
1571 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001572}
1573
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001574
Just van Rossum52e14d62002-12-30 22:08:05 +00001575/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1576 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001577 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001578 that can handle the path item. Return None if no hook could;
1579 this tells our caller it should fall back to the builtin
1580 import mechanism. Cache the result in path_importer_cache.
1581 Returns a borrowed reference. */
1582
1583static PyObject *
1584get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001586{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001587 PyObject *importer;
1588 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001589
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 /* These conditions are the caller's responsibility: */
1591 assert(PyList_Check(path_hooks));
1592 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001593
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001594 nhooks = PyList_Size(path_hooks);
1595 if (nhooks < 0)
1596 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001597
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001598 importer = PyDict_GetItem(path_importer_cache, p);
1599 if (importer != NULL)
1600 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001601
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 /* set path_importer_cache[p] to None to avoid recursion */
1603 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1604 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001605
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001606 for (j = 0; j < nhooks; j++) {
1607 PyObject *hook = PyList_GetItem(path_hooks, j);
1608 if (hook == NULL)
1609 return NULL;
1610 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1611 if (importer != NULL)
1612 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001613
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001614 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1615 return NULL;
1616 }
1617 PyErr_Clear();
1618 }
1619 if (importer == NULL) {
1620 importer = PyObject_CallFunctionObjArgs(
1621 (PyObject *)&PyNullImporter_Type, p, NULL
1622 );
1623 if (importer == NULL) {
1624 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1625 PyErr_Clear();
1626 return Py_None;
1627 }
1628 }
1629 }
1630 if (importer != NULL) {
1631 int err = PyDict_SetItem(path_importer_cache, p, importer);
1632 Py_DECREF(importer);
1633 if (err != 0)
1634 return NULL;
1635 }
1636 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001637}
1638
Christian Heimes9cd17752007-11-18 19:35:23 +00001639PyAPI_FUNC(PyObject *)
1640PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001641 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001642
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1644 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1645 importer = get_path_importer(path_importer_cache,
1646 path_hooks, path);
1647 }
1648 }
1649 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1650 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001651}
1652
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001653/* Search the path (default sys.path) for a module. Return the
1654 corresponding filedescr struct, and (via return arguments) the
1655 pathname and an open file. Return NULL if the module is not found. */
1656
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001657#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001658extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1659 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001660#endif
1661
Victor Stinnerc6963162011-03-12 09:26:54 -05001662static int case_ok(char *, Py_ssize_t, Py_ssize_t, const char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001663static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001664static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001665
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001666/* Get the path of a module: get its importer and call importer.find_module()
1667 hook, or check if the module if a package (if path/__init__.py exists).
1668
1669 -1: error: a Python error occurred
1670 0: ignore: an error occurred because of invalid data, but the error is not
1671 important enough to be reported.
1672 1: get path: module not found, but *buf contains its path
1673 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1674 and *buf is the path */
1675
1676static int
1677find_module_path(char *fullname, const char *name, PyObject *path,
1678 PyObject *path_hooks, PyObject *path_importer_cache,
1679 char *buf, size_t buflen,
1680 PyObject **p_loader, struct filedescr **p_fd)
1681{
1682 PyObject *path_bytes;
1683 const char *base;
1684 Py_ssize_t len;
1685 size_t namelen;
1686 struct stat statbuf;
1687 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1688
1689 if (PyUnicode_Check(path)) {
1690 path_bytes = PyUnicode_EncodeFSDefault(path);
1691 if (path_bytes == NULL)
1692 return -1;
1693 }
1694 else if (PyBytes_Check(path)) {
1695 Py_INCREF(path);
1696 path_bytes = path;
1697 }
1698 else
1699 return 0;
1700
1701 namelen = strlen(name);
1702 base = PyBytes_AS_STRING(path_bytes);
1703 len = PyBytes_GET_SIZE(path_bytes);
1704 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1705 Py_DECREF(path_bytes);
1706 return 0; /* Too long */
1707 }
1708 strcpy(buf, base);
1709 Py_DECREF(path_bytes);
1710
1711 if (strlen(buf) != len) {
1712 return 0; /* path_bytes contains '\0' */
1713 }
1714
1715 /* sys.path_hooks import hook */
1716 if (p_loader != NULL) {
1717 PyObject *importer;
1718
1719 importer = get_path_importer(path_importer_cache,
1720 path_hooks, path);
1721 if (importer == NULL) {
1722 return -1;
1723 }
1724 /* Note: importer is a borrowed reference */
1725 if (importer != Py_None) {
1726 PyObject *loader;
1727 loader = PyObject_CallMethod(importer,
1728 "find_module",
1729 "s", fullname);
1730 if (loader == NULL)
1731 return -1; /* error */
1732 if (loader != Py_None) {
1733 /* a loader was found */
1734 *p_loader = loader;
1735 *p_fd = &importhookdescr;
1736 return 2;
1737 }
1738 Py_DECREF(loader);
1739 return 0;
1740 }
1741 }
1742 /* no hook was found, use builtin import */
1743
1744 if (len > 0 && buf[len-1] != SEP
1745#ifdef ALTSEP
1746 && buf[len-1] != ALTSEP
1747#endif
1748 )
1749 buf[len++] = SEP;
1750 strcpy(buf+len, name);
1751 len += namelen;
1752
1753 /* Check for package import (buf holds a directory name,
1754 and there's an __init__ module in that directory */
1755#ifdef HAVE_STAT
1756 if (stat(buf, &statbuf) == 0 && /* it exists */
1757 S_ISDIR(statbuf.st_mode) && /* it's a directory */
1758 case_ok(buf, len, namelen, name)) { /* case matches */
1759 if (find_init_module(buf)) { /* and has __init__.py */
1760 *p_fd = &fd_package;
1761 return 2;
1762 }
1763 else {
1764 int err;
1765 PyObject *unicode = PyUnicode_DecodeFSDefault(buf);
1766 if (unicode == NULL)
1767 return -1;
1768 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
1769 "Not importing directory '%U': missing __init__.py",
1770 unicode);
1771 Py_DECREF(unicode);
1772 if (err)
1773 return -1;
1774 }
1775 }
1776#endif
1777 return 1;
1778}
1779
1780/* Find a module in search_path_list. For each path, try
1781 find_module_filename() or try each _PyImport_Filetab suffix.
1782
1783 If the module is found, return a file descriptor, write the path in
1784 *p_filename, write the pointer to the file object into *p_fp, and (if
1785 p_loader is not NULL) the loader into *p_loader.
1786
1787 Otherwise, raise an exception and return NULL. */
1788
Victor Stinner37580282011-03-20 01:34:43 +01001789static struct filedescr*
1790find_module_path_list(char *fullname, const char *name,
1791 PyObject *search_path_list, PyObject *path_hooks,
1792 PyObject *path_importer_cache,
1793 char *buf, size_t buflen,
1794 FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001795{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001796 Py_ssize_t i, npath;
1797 size_t len, namelen;
1798 struct filedescr *fdp = NULL;
1799 char *filemode;
1800 FILE *fp = NULL;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001801#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001802 size_t saved_len;
1803 size_t saved_namelen;
1804 char *saved_buf = NULL;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001805#endif
Victor Stinner53dc7352011-03-20 01:50:21 +01001806
Victor Stinner37580282011-03-20 01:34:43 +01001807 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001808 namelen = strlen(name);
1809 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001810 PyObject *path;
1811 int ok;
1812
1813 path = PyList_GetItem(search_path_list, i);
1814 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001815 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001816
1817 ok = find_module_path(fullname, name, path,
1818 path_hooks, path_importer_cache,
1819 buf, buflen,
1820 p_loader, &fdp);
1821 if (ok < 0)
1822 return NULL;
1823 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001824 continue;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001825 if (ok == 2)
1826 return fdp;
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001827
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001828 len = strlen(buf);
Andrew MacIntyred9400542002-02-26 11:41:34 +00001829#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001830 /* take a snapshot of the module spec for restoration
1831 * after the 8 character DLL hackery
1832 */
1833 saved_buf = strdup(buf);
1834 saved_len = len;
1835 saved_namelen = namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001836#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001837 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Guido van Rossum04110fb2007-08-24 16:32:05 +00001838#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001839 /* OS/2 limits DLLs to 8 character names (w/o
1840 extension)
1841 * so if the name is longer than that and its a
1842 * dynamically loaded module we're going to try,
1843 * truncate the name before trying
1844 */
Victor Stinnerc6963162011-03-12 09:26:54 -05001845 if (strlen(name) > 8) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001846 /* is this an attempt to load a C extension? */
1847 const struct filedescr *scan;
1848 scan = _PyImport_DynLoadFiletab;
1849 while (scan->suffix != NULL) {
1850 if (!strcmp(scan->suffix, fdp->suffix))
1851 break;
1852 else
1853 scan++;
1854 }
1855 if (scan->suffix != NULL) {
1856 /* yes, so truncate the name */
1857 namelen = 8;
Victor Stinnerc6963162011-03-12 09:26:54 -05001858 len -= strlen(name) - namelen;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001859 buf[len] = '\0';
1860 }
1861 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001862#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001863 strcpy(buf+len, fdp->suffix);
1864 if (Py_VerboseFlag > 1)
1865 PySys_WriteStderr("# trying %s\n", buf);
1866 filemode = fdp->mode;
1867 if (filemode[0] == 'U')
1868 filemode = "r" PY_STDIOTEXTMODE;
1869 fp = fopen(buf, filemode);
1870 if (fp != NULL) {
1871 if (case_ok(buf, len, namelen, name))
1872 break;
1873 else { /* continue search */
1874 fclose(fp);
1875 fp = NULL;
1876 }
1877 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001878#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001879 /* restore the saved snapshot */
1880 strcpy(buf, saved_buf);
1881 len = saved_len;
1882 namelen = saved_namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001883#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001884 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001885#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001886 /* don't need/want the module name snapshot anymore */
1887 if (saved_buf)
1888 {
1889 free(saved_buf);
1890 saved_buf = NULL;
1891 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001892#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001893 if (fp != NULL)
1894 break;
1895 }
1896 if (fp == NULL) {
1897 PyErr_Format(PyExc_ImportError,
1898 "No module named %.200s", name);
1899 return NULL;
1900 }
1901 *p_fp = fp;
1902 return fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001903}
1904
Victor Stinner37580282011-03-20 01:34:43 +01001905/* Find a module:
1906
1907 - try find_module() of each sys.meta_path hook
1908 - try find_frozen()
1909 - try is_builtin()
1910 - try _PyWin_FindRegisteredModule() (Windows only)
1911 - otherwise, call find_module_path_list() with search_path_list (if not
1912 NULL) or sys.path
1913
1914 Return:
1915
1916 - &fd_builtin (C_BUILTIN) if it is a builtin
1917 - &fd_frozen (PY_FROZEN) if it is frozen
1918 - &fd_package (PKG_DIRECTORY) and write the filename into *buf
1919 if it is a package
1920 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1921 importer loader was found
1922 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1923 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
1924 *buf and the pointer to the open file into *p_fp
1925 - NULL on error
1926
1927 By default, write an empty string into *buf, and *p_fp and *p_loader (if
1928 set) are set to NULL. Eg. *buf is an empty string for a builtin package. */
1929
1930static struct filedescr *
1931find_module(char *fullname, const char *name, PyObject *search_path_list,
1932 char *buf, size_t buflen, FILE **p_fp, PyObject **p_loader)
1933{
1934 Py_ssize_t i, npath;
1935 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1936 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1937 PyObject *path_hooks, *path_importer_cache;
1938 PyObject *fullname_obj, *nameobj;
1939
1940 *buf = '\0';
1941 *p_fp = NULL;
1942 if (p_loader != NULL)
1943 *p_loader = NULL;
1944
1945 if (strlen(name) > MAXPATHLEN) {
1946 PyErr_SetString(PyExc_OverflowError,
1947 "module name is too long");
1948 return NULL;
1949 }
1950
1951 /* sys.meta_path import hook */
1952 if (p_loader != NULL) {
1953 PyObject *meta_path;
1954
1955 meta_path = PySys_GetObject("meta_path");
1956 if (meta_path == NULL || !PyList_Check(meta_path)) {
1957 PyErr_SetString(PyExc_ImportError,
1958 "sys.meta_path must be a list of "
1959 "import hooks");
1960 return NULL;
1961 }
1962 Py_INCREF(meta_path); /* zap guard */
1963 npath = PyList_Size(meta_path);
1964 for (i = 0; i < npath; i++) {
1965 PyObject *loader;
1966 PyObject *hook = PyList_GetItem(meta_path, i);
1967 loader = PyObject_CallMethod(hook, "find_module",
1968 "sO", fullname,
1969 search_path_list != NULL ?
1970 search_path_list : Py_None);
1971 if (loader == NULL) {
1972 Py_DECREF(meta_path);
1973 return NULL; /* true error */
1974 }
1975 if (loader != Py_None) {
1976 /* a loader was found */
1977 *p_loader = loader;
1978 Py_DECREF(meta_path);
1979 return &importhookdescr;
1980 }
1981 Py_DECREF(loader);
1982 }
1983 Py_DECREF(meta_path);
1984 }
1985
1986 if (fullname != NULL) {
1987 fullname_obj = PyUnicode_FromString(fullname);
1988 if (fullname == NULL)
1989 return NULL;
1990 if (find_frozen(fullname_obj) != NULL) {
1991 Py_DECREF(fullname_obj);
1992 strcpy(buf, fullname);
1993 return &fd_frozen;
1994 }
1995 Py_DECREF(fullname_obj);
1996 }
1997
1998 if (search_path_list == NULL) {
1999#ifdef MS_COREDLL
2000 FILE *fp;
2001 struct filedescr *fdp;
2002 PyObject *filename, *filename_bytes;
2003#endif
2004 nameobj = PyUnicode_FromString(name);
2005 if (nameobj == NULL)
2006 return NULL;
2007 if (is_builtin(nameobj)) {
2008 Py_DECREF(nameobj);
2009 strcpy(buf, name);
2010 return &fd_builtin;
2011 }
2012#ifdef MS_COREDLL
2013 fp = _PyWin_FindRegisteredModule(nameobj, &fdp, &filename);
2014 if (fp != NULL) {
2015 Py_DECREF(nameobj);
2016 filename_bytes = PyUnicode_EncodeFSDefault(filename);
2017 Py_DECREF(filename);
2018 if (filename_bytes == NULL)
2019 return NULL;
2020 strncpy(buf, PyBytes_AS_STRING(filename_bytes), buflen);
2021 buf[buflen-1] = '\0';
2022 Py_DECREF(filename_bytes);
2023 *p_fp = fp;
2024 return fdp;
2025 }
2026 else if (PyErr_Occurred())
2027 return NULL;
2028#endif
2029 Py_DECREF(nameobj);
2030 search_path_list = PySys_GetObject("path");
2031 }
2032
2033 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
2034 PyErr_SetString(PyExc_ImportError,
2035 "sys.path must be a list of directory names");
2036 return NULL;
2037 }
2038
2039 path_hooks = PySys_GetObject("path_hooks");
2040 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
2041 PyErr_SetString(PyExc_ImportError,
2042 "sys.path_hooks must be a list of "
2043 "import hooks");
2044 return NULL;
2045 }
2046 path_importer_cache = PySys_GetObject("path_importer_cache");
2047 if (path_importer_cache == NULL ||
2048 !PyDict_Check(path_importer_cache)) {
2049 PyErr_SetString(PyExc_ImportError,
2050 "sys.path_importer_cache must be a dict");
2051 return NULL;
2052 }
2053
2054 return find_module_path_list(fullname, name,
2055 search_path_list, path_hooks,
2056 path_importer_cache,
2057 buf, buflen,
2058 p_fp, p_loader);
2059}
2060
Martin v. Löwis18e16552006-02-15 17:27:45 +00002061/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002062 * The arguments here are tricky, best shown by example:
2063 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2064 * ^ ^ ^ ^
2065 * |--------------------- buf ---------------------|
2066 * |------------------- len ------------------|
2067 * |------ name -------|
2068 * |----- namelen -----|
2069 * buf is the full path, but len only counts up to (& exclusive of) the
2070 * extension. name is the module name, also exclusive of extension.
2071 *
2072 * We've already done a successful stat() or fopen() on buf, so know that
2073 * there's some match, possibly case-insensitive.
2074 *
Tim Peters50d8d372001-02-28 05:34:27 +00002075 * case_ok() is to return 1 if there's a case-sensitive match for
2076 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
2077 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002078 *
Tim Peters50d8d372001-02-28 05:34:27 +00002079 * case_ok() is used to implement case-sensitive import semantics even
2080 * on platforms with case-insensitive filesystems. It's trivial to implement
2081 * for case-sensitive filesystems. It's pretty much a cross-platform
2082 * nightmare for systems with case-insensitive filesystems.
2083 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002084
Tim Peters50d8d372001-02-28 05:34:27 +00002085/* First we may need a pile of platform-specific header files; the sequence
2086 * of #if's here should match the sequence in the body of case_ok().
2087 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002088#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002089#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002090
Tim Peters50d8d372001-02-28 05:34:27 +00002091#elif defined(DJGPP)
2092#include <dir.h>
2093
Jason Tishler7961aa62005-05-20 00:56:54 +00002094#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002095#include <sys/types.h>
2096#include <dirent.h>
2097
Andrew MacIntyred9400542002-02-26 11:41:34 +00002098#elif defined(PYOS_OS2)
2099#define INCL_DOS
2100#define INCL_DOSERRORS
2101#define INCL_NOPMAPI
2102#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002103#endif
2104
Guido van Rossum0980bd91998-02-13 17:18:36 +00002105static int
Victor Stinnerc6963162011-03-12 09:26:54 -05002106case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002107{
Tim Peters50d8d372001-02-28 05:34:27 +00002108/* Pick a platform-specific implementation; the sequence of #if's here should
2109 * match the sequence just above.
2110 */
2111
Jason Tishler7961aa62005-05-20 00:56:54 +00002112/* MS_WINDOWS */
2113#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002114 WIN32_FIND_DATA data;
2115 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00002116
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002117 if (Py_GETENV("PYTHONCASEOK") != NULL)
2118 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002119
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002120 h = FindFirstFile(buf, &data);
2121 if (h == INVALID_HANDLE_VALUE) {
2122 PyErr_Format(PyExc_NameError,
2123 "Can't find file for module %.100s\n(filename %.300s)",
2124 name, buf);
2125 return 0;
2126 }
2127 FindClose(h);
2128 return strncmp(data.cFileName, name, namelen) == 0;
Tim Peters50d8d372001-02-28 05:34:27 +00002129
2130/* DJGPP */
2131#elif defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002132 struct ffblk ffblk;
2133 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002134
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002135 if (Py_GETENV("PYTHONCASEOK") != NULL)
2136 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002137
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002138 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2139 if (done) {
2140 PyErr_Format(PyExc_NameError,
2141 "Can't find file for module %.100s\n(filename %.300s)",
2142 name, buf);
2143 return 0;
2144 }
2145 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002146
Jason Tishler7961aa62005-05-20 00:56:54 +00002147/* new-fangled macintosh (macosx) or Cygwin */
2148#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002149 DIR *dirp;
2150 struct dirent *dp;
2151 char dirname[MAXPATHLEN + 1];
2152 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002154 if (Py_GETENV("PYTHONCASEOK") != NULL)
2155 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002156
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002157 /* Copy the dir component into dirname; substitute "." if empty */
2158 if (dirlen <= 0) {
2159 dirname[0] = '.';
2160 dirname[1] = '\0';
2161 }
2162 else {
2163 assert(dirlen <= MAXPATHLEN);
2164 memcpy(dirname, buf, dirlen);
2165 dirname[dirlen] = '\0';
2166 }
2167 /* Open the directory and search the entries for an exact match. */
2168 dirp = opendir(dirname);
2169 if (dirp) {
2170 char *nameWithExt = buf + len - namelen;
2171 while ((dp = readdir(dirp)) != NULL) {
2172 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002173#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002174 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002175#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002176 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002177#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002178 if (thislen >= namelen &&
2179 strcmp(dp->d_name, nameWithExt) == 0) {
2180 (void)closedir(dirp);
2181 return 1; /* Found */
2182 }
2183 }
2184 (void)closedir(dirp);
2185 }
2186 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002187
Andrew MacIntyred9400542002-02-26 11:41:34 +00002188/* OS/2 */
2189#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002190 HDIR hdir = 1;
2191 ULONG srchcnt = 1;
2192 FILEFINDBUF3 ffbuf;
2193 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002194
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002195 if (Py_GETENV("PYTHONCASEOK") != NULL)
2196 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002197
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002198 rc = DosFindFirst(buf,
2199 &hdir,
2200 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2201 &ffbuf, sizeof(ffbuf),
2202 &srchcnt,
2203 FIL_STANDARD);
2204 if (rc != NO_ERROR)
2205 return 0;
2206 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002207
Tim Peters50d8d372001-02-28 05:34:27 +00002208/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2209#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002210 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002211
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002212#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002213}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002214
Guido van Rossum197346f1997-10-31 18:38:52 +00002215#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002216
Guido van Rossum197346f1997-10-31 18:38:52 +00002217/* Helper to look for __init__.py or __init__.py[co] in potential package */
2218static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002219find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00002220{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002221 const size_t save_len = strlen(buf);
2222 size_t i = save_len;
2223 char *pname; /* pointer to start of __init__ */
2224 struct stat statbuf;
Guido van Rossum197346f1997-10-31 18:38:52 +00002225
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002226/* For calling case_ok(buf, len, namelen, name):
2227 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2228 * ^ ^ ^ ^
2229 * |--------------------- buf ---------------------|
2230 * |------------------- len ------------------|
2231 * |------ name -------|
2232 * |----- namelen -----|
Tim Peters0f9431f2001-07-05 03:47:53 +00002233 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002234 if (save_len + 13 >= MAXPATHLEN)
2235 return 0;
2236 buf[i++] = SEP;
2237 pname = buf + i;
2238 strcpy(pname, "__init__.py");
2239 if (stat(buf, &statbuf) == 0) {
2240 if (case_ok(buf,
2241 save_len + 9, /* len("/__init__") */
2242 8, /* len("__init__") */
2243 pname)) {
2244 buf[save_len] = '\0';
2245 return 1;
2246 }
2247 }
2248 i += strlen(pname);
2249 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
2250 if (stat(buf, &statbuf) == 0) {
2251 if (case_ok(buf,
2252 save_len + 9, /* len("/__init__") */
2253 8, /* len("__init__") */
2254 pname)) {
2255 buf[save_len] = '\0';
2256 return 1;
2257 }
2258 }
2259 buf[save_len] = '\0';
2260 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002261}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002262
Guido van Rossum197346f1997-10-31 18:38:52 +00002263#endif /* HAVE_STAT */
2264
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002265
Victor Stinner95872862011-03-07 18:20:56 +01002266static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002267
Victor Stinner44c6c152010-08-09 00:59:10 +00002268static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002269load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002270{
2271 PyObject *m, *modules;
2272 int err;
2273
Victor Stinner44c6c152010-08-09 00:59:10 +00002274 if (type == C_BUILTIN)
2275 err = init_builtin(name);
2276 else
Victor Stinner95872862011-03-07 18:20:56 +01002277 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002278 if (err < 0)
2279 return NULL;
2280 if (err == 0) {
2281 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002282 "Purported %s module %R not found",
2283 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002284 name);
2285 return NULL;
2286 }
2287
2288 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002289 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002290 if (m == NULL) {
2291 PyErr_Format(
2292 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002293 "%s module %R not properly initialized",
2294 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002295 name);
2296 return NULL;
2297 }
2298 Py_INCREF(m);
2299 return m;
2300}
2301
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002302/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002303 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002304
Guido van Rossum79f25d91997-04-29 20:08:16 +00002305static PyObject *
Alexandre Vassalottie223eb82009-07-29 20:12:15 +00002306load_module(char *name, FILE *fp, char *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002307{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002308 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002309
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002310 /* First check that there's an open file (if we need one) */
2311 switch (type) {
2312 case PY_SOURCE:
2313 case PY_COMPILED:
2314 if (fp == NULL) {
2315 PyErr_Format(PyExc_ValueError,
2316 "file object required for import (type code %d)",
2317 type);
2318 return NULL;
2319 }
2320 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002321
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002322 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002323
Victor Stinner2f42ae52011-03-20 00:41:24 +01002324 case PY_SOURCE: {
2325 PyObject *nameobj, *pathobj;
2326 nameobj = PyUnicode_FromString(name);
2327 if (nameobj == NULL)
2328 return NULL;
2329 pathobj = PyUnicode_DecodeFSDefault(pathname);
2330 if (pathobj == NULL) {
2331 Py_DECREF(nameobj);
2332 return NULL;
2333 }
2334 m = load_source_module(nameobj, pathobj, fp);
2335 Py_DECREF(nameobj);
2336 Py_DECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002337 break;
Victor Stinner2f42ae52011-03-20 00:41:24 +01002338 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002339
Victor Stinner2f42ae52011-03-20 00:41:24 +01002340 case PY_COMPILED: {
2341 PyObject *nameobj, *pathobj;
2342 nameobj = PyUnicode_FromString(name);
2343 if (nameobj == NULL)
2344 return NULL;
2345 pathobj = PyUnicode_DecodeFSDefault(pathname);
2346 if (pathobj == NULL) {
2347 Py_DECREF(nameobj);
2348 return NULL;
2349 }
2350 m = load_compiled_module(nameobj, pathobj, fp);
2351 Py_DECREF(nameobj);
2352 Py_DECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002353 break;
Victor Stinner2f42ae52011-03-20 00:41:24 +01002354 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002355
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002356#ifdef HAVE_DYNAMIC_LOADING
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002357 case C_EXTENSION: {
2358 PyObject *nameobj, *pathobj;
2359 nameobj = PyUnicode_FromString(name);
2360 if (nameobj == NULL)
2361 return NULL;
2362 pathobj = PyUnicode_DecodeFSDefault(pathname);
2363 if (pathobj == NULL) {
2364 Py_DECREF(nameobj);
2365 return NULL;
2366 }
2367 m = _PyImport_LoadDynamicModule(nameobj, pathobj, fp);
2368 Py_DECREF(nameobj);
2369 Py_DECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002370 break;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002371 }
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002372#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002373
Victor Stinnerc9abda02011-03-14 13:33:46 -04002374 case PKG_DIRECTORY: {
2375 PyObject *nameobj, *pathobj;
2376 nameobj = PyUnicode_FromString(name);
2377 if (nameobj == NULL)
2378 return NULL;
2379 pathobj = PyUnicode_DecodeFSDefault(pathname);
2380 if (pathobj == NULL) {
2381 Py_DECREF(nameobj);
2382 return NULL;
2383 }
2384 m = load_package(nameobj, pathobj);
2385 Py_DECREF(nameobj);
2386 Py_DECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002387 break;
Victor Stinnerc9abda02011-03-14 13:33:46 -04002388 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002390 case C_BUILTIN:
Victor Stinner95872862011-03-07 18:20:56 +01002391 case PY_FROZEN: {
2392 PyObject *nameobj = PyUnicode_FromString(name);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002393 if (nameobj == NULL)
2394 return NULL;
2395 m = load_builtin(nameobj, type);
2396 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002397 break;
Victor Stinner95872862011-03-07 18:20:56 +01002398 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002399
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002400 case IMP_HOOK: {
2401 if (loader == NULL) {
2402 PyErr_SetString(PyExc_ImportError,
2403 "import hook without loader");
2404 return NULL;
2405 }
2406 m = PyObject_CallMethod(loader, "load_module", "s", name);
2407 break;
2408 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002409
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002410 default:
2411 PyErr_Format(PyExc_ImportError,
2412 "Don't know how to import %.200s (type code %d)",
2413 name, type);
2414 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002415
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002416 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002417
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002418 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002419}
2420
2421
2422/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002423 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002424 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002425
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002426static int
Victor Stinner95872862011-03-07 18:20:56 +01002427init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002428{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002429 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002430
Victor Stinner95872862011-03-07 18:20:56 +01002431 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002432 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002433
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002434 for (p = PyImport_Inittab; p->name != NULL; p++) {
2435 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002436 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002437 if (p->initfunc == NULL) {
2438 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002439 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002440 name);
2441 return -1;
2442 }
2443 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002444 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002445 mod = (*p->initfunc)();
2446 if (mod == 0)
2447 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002448 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002449 return -1;
2450 /* FixupExtension has put the module into sys.modules,
2451 so we can release our own reference. */
2452 Py_DECREF(mod);
2453 return 1;
2454 }
2455 }
2456 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002457}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002458
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002459
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002460/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002461
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002462static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002463find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002464{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002465 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002466
Victor Stinner53dc7352011-03-20 01:50:21 +01002467 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002468 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002469
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002470 for (p = PyImport_FrozenModules; ; p++) {
2471 if (p->name == NULL)
2472 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002473 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002474 break;
2475 }
2476 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002477}
2478
Guido van Rossum79f25d91997-04-29 20:08:16 +00002479static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002480get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002481{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002482 struct _frozen *p = find_frozen(name);
2483 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002484
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002485 if (p == NULL) {
2486 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002487 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002488 name);
2489 return NULL;
2490 }
2491 if (p->code == NULL) {
2492 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002493 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002494 name);
2495 return NULL;
2496 }
2497 size = p->size;
2498 if (size < 0)
2499 size = -size;
2500 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002501}
2502
Brett Cannon8d110132009-03-15 02:20:16 +00002503static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002504is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002505{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002506 struct _frozen *p = find_frozen(name);
2507 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002508
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002509 if (p == NULL) {
2510 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002511 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002512 name);
2513 return NULL;
2514 }
Brett Cannon8d110132009-03-15 02:20:16 +00002515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002516 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002517
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002518 if (size < 0)
2519 Py_RETURN_TRUE;
2520 else
2521 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002522}
2523
2524
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002525/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002526 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002527 an exception set if the initialization failed.
2528 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002529
2530int
Victor Stinner53dc7352011-03-20 01:50:21 +01002531PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002532{
Victor Stinner53dc7352011-03-20 01:50:21 +01002533 struct _frozen *p;
2534 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002535 int ispackage;
2536 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002537
Victor Stinner53dc7352011-03-20 01:50:21 +01002538 p = find_frozen(name);
2539
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002540 if (p == NULL)
2541 return 0;
2542 if (p->code == NULL) {
2543 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002544 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002545 name);
2546 return -1;
2547 }
2548 size = p->size;
2549 ispackage = (size < 0);
2550 if (ispackage)
2551 size = -size;
2552 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002553 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002554 name, ispackage ? " package" : "");
2555 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2556 if (co == NULL)
2557 return -1;
2558 if (!PyCode_Check(co)) {
2559 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002560 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002561 name);
2562 goto err_return;
2563 }
2564 if (ispackage) {
2565 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002566 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002567 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002568 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002569 if (m == NULL)
2570 goto err_return;
2571 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002572 l = PyList_New(1);
2573 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002574 goto err_return;
2575 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002576 Py_INCREF(name);
2577 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002578 err = PyDict_SetItemString(d, "__path__", l);
2579 Py_DECREF(l);
2580 if (err != 0)
2581 goto err_return;
2582 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002583 path = PyUnicode_FromString("<frozen>");
2584 if (path == NULL)
2585 goto err_return;
2586 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2587 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002588 if (m == NULL)
2589 goto err_return;
2590 Py_DECREF(co);
2591 Py_DECREF(m);
2592 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002593err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002594 Py_DECREF(co);
2595 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002596}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002597
Victor Stinner53dc7352011-03-20 01:50:21 +01002598int
2599PyImport_ImportFrozenModule(char *name)
2600{
2601 PyObject *nameobj;
2602 int ret;
2603 nameobj = PyUnicode_InternFromString(name);
2604 if (nameobj == NULL)
2605 return -1;
2606 ret = PyImport_ImportFrozenModuleObject(nameobj);
2607 Py_DECREF(nameobj);
2608 return ret;
2609}
2610
Guido van Rossum74e6a111994-08-29 12:54:38 +00002611
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002612/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002613 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002614
Guido van Rossum79f25d91997-04-29 20:08:16 +00002615PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002616PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002617{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002618 PyObject *pname;
2619 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002620
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002621 pname = PyUnicode_FromString(name);
2622 if (pname == NULL)
2623 return NULL;
2624 result = PyImport_Import(pname);
2625 Py_DECREF(pname);
2626 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002627}
2628
Christian Heimes072c0f12008-01-03 23:01:04 +00002629/* Import a module without blocking
2630 *
2631 * At first it tries to fetch the module from sys.modules. If the module was
2632 * never loaded before it loads it with PyImport_ImportModule() unless another
2633 * thread holds the import lock. In the latter case the function raises an
2634 * ImportError instead of blocking.
2635 *
2636 * Returns the module object with incremented ref count.
2637 */
2638PyObject *
2639PyImport_ImportModuleNoBlock(const char *name)
2640{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002641 PyObject *result;
2642 PyObject *modules;
2643 long me;
Christian Heimes072c0f12008-01-03 23:01:04 +00002644
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002645 /* Try to get the module from sys.modules[name] */
2646 modules = PyImport_GetModuleDict();
2647 if (modules == NULL)
2648 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002649
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002650 result = PyDict_GetItemString(modules, name);
2651 if (result != NULL) {
2652 Py_INCREF(result);
2653 return result;
2654 }
2655 else {
2656 PyErr_Clear();
2657 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002658#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002659 /* check the import lock
2660 * me might be -1 but I ignore the error here, the lock function
2661 * takes care of the problem */
2662 me = PyThread_get_thread_ident();
2663 if (import_lock_thread == -1 || import_lock_thread == me) {
2664 /* no thread or me is holding the lock */
2665 return PyImport_ImportModule(name);
2666 }
2667 else {
2668 PyErr_Format(PyExc_ImportError,
2669 "Failed to import %.200s because the import lock"
2670 "is held by another thread.",
2671 name);
2672 return NULL;
2673 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002674#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002675 return PyImport_ImportModule(name);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002676#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002677}
2678
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002679/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002680static PyObject *get_parent(PyObject *globals, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002681 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002682static PyObject *load_next(PyObject *mod, PyObject *altmod,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002683 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002684static int mark_miss(char *name);
2685static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002686 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002687static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002688
2689/* The Magnum Opus of dotted-name import :-) */
2690
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002691static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002692import_module_level(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002693 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002694{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002695 char buf[MAXPATHLEN+1];
2696 Py_ssize_t buflen = 0;
2697 PyObject *parent, *head, *next, *tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002699 if (strchr(name, '/') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002700#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002701 || strchr(name, '\\') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002702#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002703 ) {
2704 PyErr_SetString(PyExc_ImportError,
2705 "Import by filename is not supported.");
2706 return NULL;
2707 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002708
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002709 parent = get_parent(globals, buf, &buflen, level);
2710 if (parent == NULL)
2711 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002712
Benjamin Peterson556d8002010-06-27 22:37:28 +00002713 head = load_next(parent, level < 0 ? Py_None : parent, &name, buf,
2714 &buflen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002715 if (head == NULL)
2716 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002717
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002718 tail = head;
2719 Py_INCREF(tail);
2720 while (name) {
2721 next = load_next(tail, tail, &name, buf, &buflen);
2722 Py_DECREF(tail);
2723 if (next == NULL) {
2724 Py_DECREF(head);
2725 return NULL;
2726 }
2727 tail = next;
2728 }
2729 if (tail == Py_None) {
2730 /* If tail is Py_None, both get_parent and load_next found
2731 an empty module name: someone called __import__("") or
2732 doctored faulty bytecode */
2733 Py_DECREF(tail);
2734 Py_DECREF(head);
2735 PyErr_SetString(PyExc_ValueError,
2736 "Empty module name");
2737 return NULL;
2738 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002739
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002740 if (fromlist != NULL) {
2741 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2742 fromlist = NULL;
2743 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002744
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002745 if (fromlist == NULL) {
2746 Py_DECREF(tail);
2747 return head;
2748 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002749
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002750 Py_DECREF(head);
2751 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
2752 Py_DECREF(tail);
2753 return NULL;
2754 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002755
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002756 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002757}
2758
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002759PyObject *
2760PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002761 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002762{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002763 PyObject *result;
2764 _PyImport_AcquireLock();
2765 result = import_module_level(name, globals, locals, fromlist, level);
2766 if (_PyImport_ReleaseLock() < 0) {
2767 Py_XDECREF(result);
2768 PyErr_SetString(PyExc_RuntimeError,
2769 "not holding the import lock");
2770 return NULL;
2771 }
2772 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002773}
2774
Fred Drake87590902004-05-28 20:21:36 +00002775/* Return the package that an import is being performed in. If globals comes
2776 from the module foo.bar.bat (not itself a package), this returns the
2777 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002778 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002779
2780 The *name* of the returned package is returned in buf, with the length of
2781 the name in *p_buflen.
2782
2783 If globals doesn't come from a package or a module in a package, or a
2784 corresponding entry is not found in sys.modules, Py_None is returned.
2785*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002786static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002787get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002788{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002789 static PyObject *namestr = NULL;
2790 static PyObject *pathstr = NULL;
2791 static PyObject *pkgstr = NULL;
2792 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2793 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002794
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002795 if (globals == NULL || !PyDict_Check(globals) || !level)
2796 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002797
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002798 if (namestr == NULL) {
2799 namestr = PyUnicode_InternFromString("__name__");
2800 if (namestr == NULL)
2801 return NULL;
2802 }
2803 if (pathstr == NULL) {
2804 pathstr = PyUnicode_InternFromString("__path__");
2805 if (pathstr == NULL)
2806 return NULL;
2807 }
2808 if (pkgstr == NULL) {
2809 pkgstr = PyUnicode_InternFromString("__package__");
2810 if (pkgstr == NULL)
2811 return NULL;
2812 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002813
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002814 *buf = '\0';
2815 *p_buflen = 0;
2816 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002817
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002818 if ((pkgname != NULL) && (pkgname != Py_None)) {
2819 /* __package__ is set, so use it */
2820 char *pkgname_str;
2821 Py_ssize_t len;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002822
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002823 if (!PyUnicode_Check(pkgname)) {
2824 PyErr_SetString(PyExc_ValueError,
2825 "__package__ set to non-string");
2826 return NULL;
2827 }
2828 pkgname_str = _PyUnicode_AsStringAndSize(pkgname, &len);
2829 if (len == 0) {
2830 if (level > 0) {
2831 PyErr_SetString(PyExc_ValueError,
2832 "Attempted relative import in non-package");
2833 return NULL;
2834 }
2835 return Py_None;
2836 }
2837 if (len > MAXPATHLEN) {
2838 PyErr_SetString(PyExc_ValueError,
2839 "Package name too long");
2840 return NULL;
2841 }
2842 strcpy(buf, pkgname_str);
2843 } else {
2844 /* __package__ not set, so figure it out and set it */
2845 modname = PyDict_GetItem(globals, namestr);
2846 if (modname == NULL || !PyUnicode_Check(modname))
2847 return Py_None;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002848
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002849 modpath = PyDict_GetItem(globals, pathstr);
2850 if (modpath != NULL) {
2851 /* __path__ is set, so modname is already the package name */
2852 char *modname_str;
2853 Py_ssize_t len;
2854 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002855
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002856 modname_str = _PyUnicode_AsStringAndSize(modname, &len);
2857 if (len > MAXPATHLEN) {
2858 PyErr_SetString(PyExc_ValueError,
2859 "Module name too long");
2860 return NULL;
2861 }
2862 strcpy(buf, modname_str);
2863 error = PyDict_SetItem(globals, pkgstr, modname);
2864 if (error) {
2865 PyErr_SetString(PyExc_ValueError,
2866 "Could not set __package__");
2867 return NULL;
2868 }
2869 } else {
2870 /* Normal module, so work out the package name if any */
2871 char *start = _PyUnicode_AsString(modname);
2872 char *lastdot = strrchr(start, '.');
2873 size_t len;
2874 int error;
2875 if (lastdot == NULL && level > 0) {
2876 PyErr_SetString(PyExc_ValueError,
2877 "Attempted relative import in non-package");
2878 return NULL;
2879 }
2880 if (lastdot == NULL) {
2881 error = PyDict_SetItem(globals, pkgstr, Py_None);
2882 if (error) {
2883 PyErr_SetString(PyExc_ValueError,
2884 "Could not set __package__");
2885 return NULL;
2886 }
2887 return Py_None;
2888 }
2889 len = lastdot - start;
2890 if (len >= MAXPATHLEN) {
2891 PyErr_SetString(PyExc_ValueError,
2892 "Module name too long");
2893 return NULL;
2894 }
2895 strncpy(buf, start, len);
2896 buf[len] = '\0';
2897 pkgname = PyUnicode_FromString(buf);
2898 if (pkgname == NULL) {
2899 return NULL;
2900 }
2901 error = PyDict_SetItem(globals, pkgstr, pkgname);
2902 Py_DECREF(pkgname);
2903 if (error) {
2904 PyErr_SetString(PyExc_ValueError,
2905 "Could not set __package__");
2906 return NULL;
2907 }
2908 }
2909 }
2910 while (--level > 0) {
2911 char *dot = strrchr(buf, '.');
2912 if (dot == NULL) {
2913 PyErr_SetString(PyExc_ValueError,
2914 "Attempted relative import beyond "
2915 "toplevel package");
2916 return NULL;
2917 }
2918 *dot = '\0';
2919 }
2920 *p_buflen = strlen(buf);
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002921
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002922 modules = PyImport_GetModuleDict();
2923 parent = PyDict_GetItemString(modules, buf);
2924 if (parent == NULL) {
2925 if (orig_level < 1) {
2926 PyObject *err_msg = PyBytes_FromFormat(
2927 "Parent module '%.200s' not found "
2928 "while handling absolute import", buf);
2929 if (err_msg == NULL) {
2930 return NULL;
2931 }
2932 if (!PyErr_WarnEx(PyExc_RuntimeWarning,
2933 PyBytes_AsString(err_msg), 1)) {
2934 *buf = '\0';
2935 *p_buflen = 0;
2936 parent = Py_None;
2937 }
2938 Py_DECREF(err_msg);
2939 } else {
2940 PyErr_Format(PyExc_SystemError,
2941 "Parent module '%.200s' not loaded, "
2942 "cannot perform relative import", buf);
2943 }
2944 }
2945 return parent;
2946 /* We expect, but can't guarantee, if parent != None, that:
2947 - parent.__name__ == buf
2948 - parent.__dict__ is globals
2949 If this is violated... Who cares? */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002950}
2951
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002952/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002953static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002954load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002955 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002956{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002957 char *name = *p_name;
2958 char *dot = strchr(name, '.');
2959 size_t len;
2960 char *p;
2961 PyObject *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002962
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002963 if (strlen(name) == 0) {
2964 /* completely empty module name should only happen in
2965 'from . import' (or '__import__("")')*/
2966 Py_INCREF(mod);
2967 *p_name = NULL;
2968 return mod;
2969 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002970
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002971 if (dot == NULL) {
2972 *p_name = NULL;
2973 len = strlen(name);
2974 }
2975 else {
2976 *p_name = dot+1;
2977 len = dot-name;
2978 }
2979 if (len == 0) {
2980 PyErr_SetString(PyExc_ValueError,
2981 "Empty module name");
2982 return NULL;
2983 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002984
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002985 p = buf + *p_buflen;
2986 if (p != buf)
2987 *p++ = '.';
2988 if (p+len-buf >= MAXPATHLEN) {
2989 PyErr_SetString(PyExc_ValueError,
2990 "Module name too long");
2991 return NULL;
2992 }
2993 strncpy(p, name, len);
2994 p[len] = '\0';
2995 *p_buflen = p+len-buf;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002996
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002997 result = import_submodule(mod, p, buf);
2998 if (result == Py_None && altmod != mod) {
2999 Py_DECREF(result);
3000 /* Here, altmod must be None and mod must not be None */
3001 result = import_submodule(altmod, p, p);
3002 if (result != NULL && result != Py_None) {
3003 if (mark_miss(buf) != 0) {
3004 Py_DECREF(result);
3005 return NULL;
3006 }
3007 strncpy(buf, name, len);
3008 buf[len] = '\0';
3009 *p_buflen = len;
3010 }
3011 }
3012 if (result == NULL)
3013 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003014
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003015 if (result == Py_None) {
3016 Py_DECREF(result);
3017 PyErr_Format(PyExc_ImportError,
3018 "No module named %.200s", name);
3019 return NULL;
3020 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003021
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003022 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003023}
3024
3025static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003026mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003027{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003028 PyObject *modules = PyImport_GetModuleDict();
3029 return PyDict_SetItemString(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003030}
3031
3032static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00003033ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003034 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003035{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003036 int i;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003037
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003038 if (!PyObject_HasAttrString(mod, "__path__"))
3039 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003040
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003041 for (i = 0; ; i++) {
3042 PyObject *item = PySequence_GetItem(fromlist, i);
3043 int hasit;
3044 if (item == NULL) {
3045 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
3046 PyErr_Clear();
3047 return 1;
3048 }
3049 return 0;
3050 }
3051 if (!PyUnicode_Check(item)) {
3052 PyErr_SetString(PyExc_TypeError,
3053 "Item in ``from list'' not a string");
3054 Py_DECREF(item);
3055 return 0;
3056 }
3057 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
3058 PyObject *all;
3059 Py_DECREF(item);
3060 /* See if the package defines __all__ */
3061 if (recursive)
3062 continue; /* Avoid endless recursion */
3063 all = PyObject_GetAttrString(mod, "__all__");
3064 if (all == NULL)
3065 PyErr_Clear();
3066 else {
3067 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
3068 Py_DECREF(all);
3069 if (!ret)
3070 return 0;
3071 }
3072 continue;
3073 }
3074 hasit = PyObject_HasAttr(mod, item);
3075 if (!hasit) {
3076 PyObject *item8;
3077 char *subname;
3078 PyObject *submod;
3079 char *p;
Victor Stinnerae6265f2010-05-15 16:27:27 +00003080 item8 = PyUnicode_EncodeFSDefault(item);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003081 if (!item8) {
3082 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
3083 return 0;
3084 }
3085 subname = PyBytes_AS_STRING(item8);
3086 if (buflen + strlen(subname) >= MAXPATHLEN) {
3087 PyErr_SetString(PyExc_ValueError,
3088 "Module name too long");
3089 Py_DECREF(item);
3090 return 0;
3091 }
3092 p = buf + buflen;
3093 *p++ = '.';
3094 strcpy(p, subname);
3095 submod = import_submodule(mod, subname, buf);
3096 Py_DECREF(item8);
3097 Py_XDECREF(submod);
3098 if (submod == NULL) {
3099 Py_DECREF(item);
3100 return 0;
3101 }
3102 }
3103 Py_DECREF(item);
3104 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003105
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003106 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003107}
3108
Neil Schemenauer00b09662003-06-16 21:03:07 +00003109static int
3110add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003111 PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003112{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003113 if (mod == Py_None)
3114 return 1;
3115 /* Irrespective of the success of this load, make a
3116 reference to it in the parent package module. A copy gets
3117 saved in the modules dictionary under the full name, so get a
3118 reference from there, if need be. (The exception is when the
3119 load failed with a SyntaxError -- then there's no trace in
3120 sys.modules. In that case, of course, do nothing extra.) */
3121 if (submod == NULL) {
3122 submod = PyDict_GetItemString(modules, fullname);
3123 if (submod == NULL)
3124 return 1;
3125 }
3126 if (PyModule_Check(mod)) {
3127 /* We can't use setattr here since it can give a
3128 * spurious warning if the submodule name shadows a
3129 * builtin name */
3130 PyObject *dict = PyModule_GetDict(mod);
3131 if (!dict)
3132 return 0;
3133 if (PyDict_SetItemString(dict, subname, submod) < 0)
3134 return 0;
3135 }
3136 else {
3137 if (PyObject_SetAttrString(mod, subname, submod) < 0)
3138 return 0;
3139 }
3140 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003141}
3142
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003143static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003144import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003145{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003146 PyObject *modules = PyImport_GetModuleDict();
3147 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003148
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003149 /* Require:
3150 if mod == None: subname == fullname
3151 else: mod.__name__ + "." + subname == fullname
3152 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003154 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
3155 Py_INCREF(m);
3156 }
3157 else {
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003158 PyObject *path, *loader;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003159 char buf[MAXPATHLEN+1];
3160 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003161 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003162
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003163 if (mod == Py_None)
3164 path = NULL;
3165 else {
3166 path = PyObject_GetAttrString(mod, "__path__");
3167 if (path == NULL) {
3168 PyErr_Clear();
3169 Py_INCREF(Py_None);
3170 return Py_None;
3171 }
3172 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003173
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003174 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
3175 &fp, &loader);
3176 Py_XDECREF(path);
3177 if (fdp == NULL) {
3178 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3179 return NULL;
3180 PyErr_Clear();
3181 Py_INCREF(Py_None);
3182 return Py_None;
3183 }
3184 m = load_module(fullname, fp, buf, fdp->type, loader);
3185 Py_XDECREF(loader);
3186 if (fp)
3187 fclose(fp);
3188 if (!add_submodule(mod, m, fullname, subname, modules)) {
3189 Py_XDECREF(m);
3190 m = NULL;
3191 }
3192 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003193
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003194 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003195}
3196
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003197
3198/* Re-import a module of any kind and return its module object, WITH
3199 INCREMENTED REFERENCE COUNT */
3200
Guido van Rossum79f25d91997-04-29 20:08:16 +00003201PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003202PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003203{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003204 PyInterpreterState *interp = PyThreadState_Get()->interp;
3205 PyObject *modules_reloading = interp->modules_reloading;
3206 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003207 PyObject *path = NULL, *loader, *existing_m = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003208 char *name, *subname;
3209 char buf[MAXPATHLEN+1];
3210 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003211 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003212 PyObject *newm;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003213
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003214 if (modules_reloading == NULL) {
3215 Py_FatalError("PyImport_ReloadModule: "
3216 "no modules_reloading dictionary!");
3217 return NULL;
3218 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003219
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003220 if (m == NULL || !PyModule_Check(m)) {
3221 PyErr_SetString(PyExc_TypeError,
3222 "reload() argument must be module");
3223 return NULL;
3224 }
3225 name = (char*)PyModule_GetName(m);
3226 if (name == NULL)
3227 return NULL;
3228 if (m != PyDict_GetItemString(modules, name)) {
3229 PyErr_Format(PyExc_ImportError,
3230 "reload(): module %.200s not in sys.modules",
3231 name);
3232 return NULL;
3233 }
3234 existing_m = PyDict_GetItemString(modules_reloading, name);
3235 if (existing_m != NULL) {
3236 /* Due to a recursive reload, this module is already
3237 being reloaded. */
3238 Py_INCREF(existing_m);
3239 return existing_m;
3240 }
3241 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
3242 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00003243
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003244 subname = strrchr(name, '.');
3245 if (subname == NULL)
3246 subname = name;
3247 else {
3248 PyObject *parentname, *parent;
3249 parentname = PyUnicode_FromStringAndSize(name, (subname-name));
3250 if (parentname == NULL) {
3251 imp_modules_reloading_clear();
3252 return NULL;
3253 }
3254 parent = PyDict_GetItem(modules, parentname);
3255 if (parent == NULL) {
3256 PyErr_Format(PyExc_ImportError,
3257 "reload(): parent %U not in sys.modules",
3258 parentname);
3259 Py_DECREF(parentname);
3260 imp_modules_reloading_clear();
3261 return NULL;
3262 }
3263 Py_DECREF(parentname);
3264 subname++;
3265 path = PyObject_GetAttrString(parent, "__path__");
3266 if (path == NULL)
3267 PyErr_Clear();
3268 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003269 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
3270 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003271
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003272 if (fdp == NULL) {
3273 Py_XDECREF(loader);
3274 imp_modules_reloading_clear();
3275 return NULL;
3276 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003277
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003278 newm = load_module(name, fp, buf, fdp->type, loader);
3279 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003280
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003281 if (fp)
3282 fclose(fp);
3283 if (newm == NULL) {
3284 /* load_module probably removed name from modules because of
3285 * the error. Put back the original module object. We're
3286 * going to return NULL in this case regardless of whether
3287 * replacing name succeeds, so the return value is ignored.
3288 */
3289 PyDict_SetItemString(modules, name, m);
3290 }
3291 imp_modules_reloading_clear();
3292 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003293}
3294
3295
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003296/* Higher-level import emulator which emulates the "import" statement
3297 more accurately -- it invokes the __import__() function from the
3298 builtins of the current globals. This means that the import is
3299 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003300 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003301 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003302 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003303 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003304
3305PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003306PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003307{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003308 static PyObject *silly_list = NULL;
3309 static PyObject *builtins_str = NULL;
3310 static PyObject *import_str = NULL;
3311 PyObject *globals = NULL;
3312 PyObject *import = NULL;
3313 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003314 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003315 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003316
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003317 /* Initialize constant string objects */
3318 if (silly_list == NULL) {
3319 import_str = PyUnicode_InternFromString("__import__");
3320 if (import_str == NULL)
3321 return NULL;
3322 builtins_str = PyUnicode_InternFromString("__builtins__");
3323 if (builtins_str == NULL)
3324 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003325 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003326 if (silly_list == NULL)
3327 return NULL;
3328 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003329
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003330 /* Get the builtins from current globals */
3331 globals = PyEval_GetGlobals();
3332 if (globals != NULL) {
3333 Py_INCREF(globals);
3334 builtins = PyObject_GetItem(globals, builtins_str);
3335 if (builtins == NULL)
3336 goto err;
3337 }
3338 else {
3339 /* No globals -- use standard builtins, and fake globals */
3340 builtins = PyImport_ImportModuleLevel("builtins",
3341 NULL, NULL, NULL, 0);
3342 if (builtins == NULL)
3343 return NULL;
3344 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3345 if (globals == NULL)
3346 goto err;
3347 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003348
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003349 /* Get the __import__ function from the builtins */
3350 if (PyDict_Check(builtins)) {
3351 import = PyObject_GetItem(builtins, import_str);
3352 if (import == NULL)
3353 PyErr_SetObject(PyExc_KeyError, import_str);
3354 }
3355 else
3356 import = PyObject_GetAttr(builtins, import_str);
3357 if (import == NULL)
3358 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003359
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003360 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003361 Always use absolute import here.
3362 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003363 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3364 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003365 if (r == NULL)
3366 goto err;
3367 Py_DECREF(r);
3368
3369 modules = PyImport_GetModuleDict();
3370 r = PyDict_GetItem(modules, module_name);
3371 if (r != NULL)
3372 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003373
3374 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003375 Py_XDECREF(globals);
3376 Py_XDECREF(builtins);
3377 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003379 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003380}
3381
3382
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003383/* Module 'imp' provides Python access to the primitives used for
3384 importing modules.
3385*/
3386
Guido van Rossum79f25d91997-04-29 20:08:16 +00003387static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003388imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003389{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003390 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003391
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003392 buf[0] = (char) ((magic >> 0) & 0xff);
3393 buf[1] = (char) ((magic >> 8) & 0xff);
3394 buf[2] = (char) ((magic >> 16) & 0xff);
3395 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003396
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003397 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003398}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003399
3400static PyObject *
3401imp_get_magic(PyObject *self, PyObject *noargs)
3402{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003403 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003404}
3405
3406static PyObject *
3407imp_get_tag(PyObject *self, PyObject *noargs)
3408{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003409 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003410}
3411
Guido van Rossum79f25d91997-04-29 20:08:16 +00003412static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003413imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003414{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003415 PyObject *list;
3416 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003417
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003418 list = PyList_New(0);
3419 if (list == NULL)
3420 return NULL;
3421 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3422 PyObject *item = Py_BuildValue("ssi",
3423 fdp->suffix, fdp->mode, fdp->type);
3424 if (item == NULL) {
3425 Py_DECREF(list);
3426 return NULL;
3427 }
3428 if (PyList_Append(list, item) < 0) {
3429 Py_DECREF(list);
3430 Py_DECREF(item);
3431 return NULL;
3432 }
3433 Py_DECREF(item);
3434 }
3435 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003436}
3437
Guido van Rossum79f25d91997-04-29 20:08:16 +00003438static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003439call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003440{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003441 extern int fclose(FILE *);
3442 PyObject *fob, *ret;
3443 PyObject *pathobj;
3444 struct filedescr *fdp;
3445 char pathname[MAXPATHLEN+1];
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003446 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003447 int fd = -1;
3448 char *found_encoding = NULL;
3449 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003450
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003451 pathname[0] = '\0';
3452 if (path == Py_None)
3453 path = NULL;
3454 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
3455 if (fdp == NULL)
3456 return NULL;
3457 if (fp != NULL) {
3458 fd = fileno(fp);
3459 if (fd != -1)
3460 fd = dup(fd);
3461 fclose(fp);
3462 fp = NULL;
3463 }
3464 if (fd != -1) {
3465 if (strchr(fdp->mode, 'b') == NULL) {
3466 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3467 memory. */
3468 found_encoding = PyTokenizer_FindEncoding(fd);
3469 lseek(fd, 0, 0); /* Reset position */
3470 if (found_encoding == NULL && PyErr_Occurred())
3471 return NULL;
3472 encoding = (found_encoding != NULL) ? found_encoding :
3473 (char*)PyUnicode_GetDefaultEncoding();
3474 }
3475 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
3476 (char*)encoding, NULL, NULL, 1);
3477 if (fob == NULL) {
3478 close(fd);
3479 PyMem_FREE(found_encoding);
3480 return NULL;
3481 }
3482 }
3483 else {
3484 fob = Py_None;
3485 Py_INCREF(fob);
3486 }
3487 pathobj = PyUnicode_DecodeFSDefault(pathname);
3488 ret = Py_BuildValue("NN(ssi)",
3489 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3490 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003491
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003492 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003493}
3494
Guido van Rossum79f25d91997-04-29 20:08:16 +00003495static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003496imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003497{
Victor Stinnerebc00522010-12-03 17:06:43 +00003498 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003499 PyObject *ret, *path = NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003500 if (!PyArg_ParseTuple(args, "O&|O:find_module",
3501 PyUnicode_FSConverter, &name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003502 &path))
3503 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003504 ret = call_find_module(PyBytes_AS_STRING(name), path);
3505 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003506 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003507}
3508
3509static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003510imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003511{
Victor Stinner95872862011-03-07 18:20:56 +01003512 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003513 int ret;
3514 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003515 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003516 return NULL;
3517 ret = init_builtin(name);
3518 if (ret < 0)
3519 return NULL;
3520 if (ret == 0) {
3521 Py_INCREF(Py_None);
3522 return Py_None;
3523 }
Victor Stinner95872862011-03-07 18:20:56 +01003524 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003525 Py_XINCREF(m);
3526 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003527}
3528
Guido van Rossum79f25d91997-04-29 20:08:16 +00003529static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003530imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003531{
Victor Stinner53dc7352011-03-20 01:50:21 +01003532 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003533 int ret;
3534 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003535 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003536 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003537 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003538 if (ret < 0)
3539 return NULL;
3540 if (ret == 0) {
3541 Py_INCREF(Py_None);
3542 return Py_None;
3543 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003544 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003545 Py_XINCREF(m);
3546 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003547}
3548
Guido van Rossum79f25d91997-04-29 20:08:16 +00003549static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003550imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003551{
Victor Stinner53dc7352011-03-20 01:50:21 +01003552 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003553
Victor Stinner53dc7352011-03-20 01:50:21 +01003554 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003555 return NULL;
3556 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003557}
3558
Guido van Rossum79f25d91997-04-29 20:08:16 +00003559static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003560imp_is_frozen_package(PyObject *self, PyObject *args)
3561{
Victor Stinner53dc7352011-03-20 01:50:21 +01003562 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003563
Victor Stinner53dc7352011-03-20 01:50:21 +01003564 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003565 return NULL;
3566 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003567}
3568
3569static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003570imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003571{
Victor Stinner95872862011-03-07 18:20:56 +01003572 PyObject *name;
3573 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003574 return NULL;
3575 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003576}
3577
Guido van Rossum79f25d91997-04-29 20:08:16 +00003578static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003579imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003580{
Victor Stinner53dc7352011-03-20 01:50:21 +01003581 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003582 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003583 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003584 return NULL;
3585 p = find_frozen(name);
3586 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003587}
3588
3589static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003590get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003591{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003592 FILE *fp;
3593 if (mode[0] == 'U')
3594 mode = "r" PY_STDIOTEXTMODE;
3595 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003596 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003597 }
3598 else {
3599 int fd = PyObject_AsFileDescriptor(fob);
3600 if (fd == -1)
3601 return NULL;
3602 if (!_PyVerify_fd(fd))
3603 goto error;
3604 /* the FILE struct gets a new fd, so that it can be closed
3605 * independently of the file descriptor given
3606 */
3607 fd = dup(fd);
3608 if (fd == -1)
3609 goto error;
3610 fp = fdopen(fd, mode);
3611 }
3612 if (fp)
3613 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003614error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003615 PyErr_SetFromErrno(PyExc_IOError);
3616 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003617}
3618
Guido van Rossum79f25d91997-04-29 20:08:16 +00003619static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003620imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003621{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003622 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003623 PyObject *fob = NULL;
3624 PyObject *m;
3625 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003626 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003627 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003628 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003629 &fob))
3630 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003631 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003632 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003633 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003634 return NULL;
3635 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003636 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003637 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003638 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003639 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003640}
3641
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003642#ifdef HAVE_DYNAMIC_LOADING
3643
Guido van Rossum79f25d91997-04-29 20:08:16 +00003644static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003645imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003646{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003647 PyObject *name, *pathname, *fob = NULL, *mod;
3648 FILE *fp;
3649
3650 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3651 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003652 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003653 if (fob != NULL) {
3654 fp = get_file(NULL, fob, "r");
3655 if (fp == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003656 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003657 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003658 else
3659 fp = NULL;
3660 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003661 if (fp)
3662 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003663 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003664}
3665
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003666#endif /* HAVE_DYNAMIC_LOADING */
3667
Guido van Rossum79f25d91997-04-29 20:08:16 +00003668static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003669imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003670{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003671 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003672 PyObject *fob = NULL;
3673 PyObject *m;
3674 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003675 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003676 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003677 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003678 &fob))
3679 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003680 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003681 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003682 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003683 return NULL;
3684 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003685 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003686 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003687 fclose(fp);
3688 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003689}
3690
Guido van Rossum79f25d91997-04-29 20:08:16 +00003691static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003692imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003693{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003694 char *name;
3695 PyObject *fob;
Victor Stinner1a563032010-10-15 22:43:10 +00003696 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003697 PyObject * ret;
3698 char *suffix; /* Unused */
3699 char *mode;
3700 int type;
3701 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003702
Victor Stinner1a563032010-10-15 22:43:10 +00003703 if (!PyArg_ParseTuple(args, "sOO&(ssi):load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003704 &name, &fob,
Victor Stinner1a563032010-10-15 22:43:10 +00003705 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003706 &suffix, &mode, &type))
3707 return NULL;
3708 if (*mode) {
3709 /* Mode must start with 'r' or 'U' and must not contain '+'.
3710 Implicit in this test is the assumption that the mode
3711 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003712
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003713 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3714 PyErr_Format(PyExc_ValueError,
3715 "invalid file open mode %.200s", mode);
Victor Stinner1a563032010-10-15 22:43:10 +00003716 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003717 return NULL;
3718 }
3719 }
3720 if (fob == Py_None)
3721 fp = NULL;
3722 else {
3723 fp = get_file(NULL, fob, mode);
3724 if (fp == NULL) {
Victor Stinner1a563032010-10-15 22:43:10 +00003725 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003726 return NULL;
3727 }
3728 }
Victor Stinner1a563032010-10-15 22:43:10 +00003729 ret = load_module(name, fp, PyBytes_AS_STRING(pathname), type, NULL);
3730 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003731 if (fp)
3732 fclose(fp);
3733 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003734}
3735
3736static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003737imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003738{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003739 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003740 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003741 if (!PyArg_ParseTuple(args, "UO&:load_package",
3742 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003743 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003744 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003745 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003746 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003747}
3748
3749static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003750imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003751{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003752 char *name;
3753 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3754 return NULL;
3755 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003756}
3757
Christian Heimes13a7a212008-01-07 17:13:09 +00003758static PyObject *
3759imp_reload(PyObject *self, PyObject *v)
3760{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003761 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003762}
3763
3764PyDoc_STRVAR(doc_reload,
3765"reload(module) -> module\n\
3766\n\
3767Reload the module. The module must have been successfully imported before.");
3768
Barry Warsaw28a691b2010-04-17 00:19:56 +00003769static PyObject *
3770imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3771{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003772 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003773
Victor Stinner2f42ae52011-03-20 00:41:24 +01003774 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003775 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003776 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003777
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003778 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003779 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003780 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003781 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003782
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003783 if (debug_override != NULL &&
3784 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003785 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003786 return NULL;
3787 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003788
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003789 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01003790 PyUnicode_AS_UNICODE(pathname),
3791 debug);
3792 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003793
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003794 if (cpathname == NULL) {
3795 PyErr_Format(PyExc_SystemError, "path buffer too short");
3796 return NULL;
3797 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003798 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003799}
3800
3801PyDoc_STRVAR(doc_cache_from_source,
3802"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3803\n\
3804The .py file does not need to exist; this simply returns the path to the\n\
3805.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3806will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3807\n\
3808If debug_override is not None, then it must be a boolean and is taken as\n\
3809the value of __debug__ instead.");
3810
3811static PyObject *
3812imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3813{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003814 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003815 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003816
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003817 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003818 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003819 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003820 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003821
Victor Stinnerc9abda02011-03-14 13:33:46 -04003822 source = make_source_pathname(pathname);
3823 if (source == NULL) {
3824 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003825 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003826 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003827 return NULL;
3828 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003829 Py_DECREF(pathname);
3830 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003831}
3832
3833PyDoc_STRVAR(doc_source_from_cache,
3834"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
3835\n\
3836The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3837the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3838does not conform to PEP 3147 format, ValueError will be raised.");
3839
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003840/* Doc strings */
3841
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003842PyDoc_STRVAR(doc_imp,
3843"This module provides the components needed to build your own\n\
3844__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003845
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003846PyDoc_STRVAR(doc_find_module,
3847"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003848Search for a module. If path is omitted or None, search for a\n\
3849built-in, frozen or special module and continue search in sys.path.\n\
3850The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003851package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003852
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003853PyDoc_STRVAR(doc_load_module,
3854"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003855Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003856The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003857
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003858PyDoc_STRVAR(doc_get_magic,
3859"get_magic() -> string\n\
3860Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003861
Barry Warsaw28a691b2010-04-17 00:19:56 +00003862PyDoc_STRVAR(doc_get_tag,
3863"get_tag() -> string\n\
3864Return the magic tag for .pyc or .pyo files.");
3865
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003866PyDoc_STRVAR(doc_get_suffixes,
3867"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003868Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003869that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003870
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003871PyDoc_STRVAR(doc_new_module,
3872"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003873Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003874The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003875
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003876PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003877"lock_held() -> boolean\n\
3878Return True if the import lock is currently held, else False.\n\
3879On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003880
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003881PyDoc_STRVAR(doc_acquire_lock,
3882"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003883Acquires the interpreter's import lock for the current thread.\n\
3884This lock should be used by import hooks to ensure thread-safety\n\
3885when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003886On platforms without threads, this function does nothing.");
3887
3888PyDoc_STRVAR(doc_release_lock,
3889"release_lock() -> None\n\
3890Release the interpreter's import lock.\n\
3891On platforms without threads, this function does nothing.");
3892
Guido van Rossum79f25d91997-04-29 20:08:16 +00003893static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003894 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3895 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3896 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3897 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3898 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3899 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3900 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3901 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3902 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3903 {"reload", imp_reload, METH_O, doc_reload},
3904 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3905 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3906 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3907 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3908 /* The rest are obsolete */
3909 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3910 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3911 {"init_builtin", imp_init_builtin, METH_VARARGS},
3912 {"init_frozen", imp_init_frozen, METH_VARARGS},
3913 {"is_builtin", imp_is_builtin, METH_VARARGS},
3914 {"is_frozen", imp_is_frozen, METH_VARARGS},
3915 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003916#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003917 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003918#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003919 {"load_package", imp_load_package, METH_VARARGS},
3920 {"load_source", imp_load_source, METH_VARARGS},
3921 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003922};
3923
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003924static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003925setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003926{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003927 PyObject *v;
3928 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003929
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003930 v = PyLong_FromLong((long)value);
3931 err = PyDict_SetItemString(d, name, v);
3932 Py_XDECREF(v);
3933 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003934}
3935
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003936typedef struct {
3937 PyObject_HEAD
3938} NullImporter;
3939
3940static int
3941NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3942{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003943#ifndef MS_WINDOWS
3944 PyObject *path;
3945 struct stat statbuf;
3946 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003947
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003948 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3949 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003950
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003951 if (!PyArg_ParseTuple(args, "O&:NullImporter",
3952 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003953 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003954
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003955 if (PyBytes_GET_SIZE(path) == 0) {
3956 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003957 PyErr_SetString(PyExc_ImportError, "empty pathname");
3958 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003959 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003960
3961 rv = stat(PyBytes_AS_STRING(path), &statbuf);
3962 Py_DECREF(path);
3963 if (rv == 0) {
3964 /* it exists */
3965 if (S_ISDIR(statbuf.st_mode)) {
3966 /* it's a directory */
3967 PyErr_SetString(PyExc_ImportError, "existing directory");
3968 return -1;
3969 }
3970 }
3971#else /* MS_WINDOWS */
3972 PyObject *pathobj;
3973 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00003974 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003975
3976 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3977 return -1;
3978
3979 if (!PyArg_ParseTuple(args, "U:NullImporter",
3980 &pathobj))
3981 return -1;
3982
3983 if (PyUnicode_GET_SIZE(pathobj) == 0) {
3984 PyErr_SetString(PyExc_ImportError, "empty pathname");
3985 return -1;
3986 }
3987
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00003988 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003989 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003990 return -1;
3991 /* see issue1293 and issue3677:
3992 * stat() on Windows doesn't recognise paths like
3993 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3994 */
3995 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003996 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003997 if (rv != INVALID_FILE_ATTRIBUTES) {
3998 /* it exists */
3999 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4000 /* it's a directory */
4001 PyErr_SetString(PyExc_ImportError, "existing directory");
4002 return -1;
4003 }
4004 }
4005#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004006 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004007}
4008
4009static PyObject *
4010NullImporter_find_module(NullImporter *self, PyObject *args)
4011{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004012 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004013}
4014
4015static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004016 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4017 "Always return None"
4018 },
4019 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004020};
4021
4022
Christian Heimes9cd17752007-11-18 19:35:23 +00004023PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004024 PyVarObject_HEAD_INIT(NULL, 0)
4025 "imp.NullImporter", /*tp_name*/
4026 sizeof(NullImporter), /*tp_basicsize*/
4027 0, /*tp_itemsize*/
4028 0, /*tp_dealloc*/
4029 0, /*tp_print*/
4030 0, /*tp_getattr*/
4031 0, /*tp_setattr*/
4032 0, /*tp_reserved*/
4033 0, /*tp_repr*/
4034 0, /*tp_as_number*/
4035 0, /*tp_as_sequence*/
4036 0, /*tp_as_mapping*/
4037 0, /*tp_hash */
4038 0, /*tp_call*/
4039 0, /*tp_str*/
4040 0, /*tp_getattro*/
4041 0, /*tp_setattro*/
4042 0, /*tp_as_buffer*/
4043 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4044 "Null importer object", /* tp_doc */
4045 0, /* tp_traverse */
4046 0, /* tp_clear */
4047 0, /* tp_richcompare */
4048 0, /* tp_weaklistoffset */
4049 0, /* tp_iter */
4050 0, /* tp_iternext */
4051 NullImporter_methods, /* tp_methods */
4052 0, /* tp_members */
4053 0, /* tp_getset */
4054 0, /* tp_base */
4055 0, /* tp_dict */
4056 0, /* tp_descr_get */
4057 0, /* tp_descr_set */
4058 0, /* tp_dictoffset */
4059 (initproc)NullImporter_init, /* tp_init */
4060 0, /* tp_alloc */
4061 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004062};
4063
Martin v. Löwis1a214512008-06-11 05:26:20 +00004064static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004065 PyModuleDef_HEAD_INIT,
4066 "imp",
4067 doc_imp,
4068 0,
4069 imp_methods,
4070 NULL,
4071 NULL,
4072 NULL,
4073 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004074};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004075
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004076PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004077PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004078{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004079 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004080
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004081 if (PyType_Ready(&PyNullImporter_Type) < 0)
4082 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004083
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004084 m = PyModule_Create(&impmodule);
4085 if (m == NULL)
4086 goto failure;
4087 d = PyModule_GetDict(m);
4088 if (d == NULL)
4089 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004090
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004091 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4092 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4093 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4094 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4095 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4096 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4097 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4098 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4099 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4100 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004101
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004102 Py_INCREF(&PyNullImporter_Type);
4103 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4104 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004105 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004106 Py_XDECREF(m);
4107 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004108}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004109
4110
Guido van Rossumb18618d2000-05-03 23:44:39 +00004111/* API for embedding applications that want to add their own entries
4112 to the table of built-in modules. This should normally be called
4113 *before* Py_Initialize(). When the table resize fails, -1 is
4114 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004115
4116 After a similar function by Just van Rossum. */
4117
4118int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004119PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004120{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004121 static struct _inittab *our_copy = NULL;
4122 struct _inittab *p;
4123 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004124
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004125 /* Count the number of entries in both tables */
4126 for (n = 0; newtab[n].name != NULL; n++)
4127 ;
4128 if (n == 0)
4129 return 0; /* Nothing to do */
4130 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4131 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004132
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004133 /* Allocate new memory for the combined table */
4134 p = our_copy;
4135 PyMem_RESIZE(p, struct _inittab, i+n+1);
4136 if (p == NULL)
4137 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004139 /* Copy the tables into the new memory */
4140 if (our_copy != PyImport_Inittab)
4141 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4142 PyImport_Inittab = our_copy = p;
4143 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004145 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004146}
4147
4148/* Shorthand to add a single entry given a name and a function */
4149
4150int
Brett Cannona826f322009-04-02 03:41:46 +00004151PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004152{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004153 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004154
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004155 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004156
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004157 newtab[0].name = (char *)name;
4158 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004159
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004160 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004161}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004162
4163#ifdef __cplusplus
4164}
4165#endif