5 Various bits of information used by the interpreter are collected in
8 - exit(sts): raise SystemExit
10 - stdin, stdout, stderr: standard file objects
11 - modules: the table of modules (dictionary)
12 - path: module search path (list of strings)
13 - argv: script arguments (list of strings)
14 - ps1, ps2: optional primary and secondary prompts (strings)
18 #include "structseq.h"
20 #include "frameobject.h"
26 #define WIN32_LEAN_AND_MEAN
28 #endif /* MS_WINDOWS */
31 extern void *PyWin_DLLhModule
;
32 /* A string loaded from the DLL at startup: */
33 extern const char *PyWin_DLLVersionString
;
44 #ifdef HAVE_LANGINFO_H
50 PySys_GetObject(char *name
)
52 PyThreadState
*tstate
= PyThreadState_GET();
53 PyObject
*sd
= tstate
->interp
->sysdict
;
56 return PyDict_GetItemString(sd
, name
);
60 PySys_GetFile(char *name
, FILE *def
)
63 PyObject
*v
= PySys_GetObject(name
);
64 if (v
!= NULL
&& PyFile_Check(v
))
65 fp
= PyFile_AsFile(v
);
72 PySys_SetObject(char *name
, PyObject
*v
)
74 PyThreadState
*tstate
= PyThreadState_GET();
75 PyObject
*sd
= tstate
->interp
->sysdict
;
77 if (PyDict_GetItemString(sd
, name
) == NULL
)
80 return PyDict_DelItemString(sd
, name
);
83 return PyDict_SetItemString(sd
, name
, v
);
87 sys_displayhook(PyObject
*self
, PyObject
*o
)
90 PyInterpreterState
*interp
= PyThreadState_GET()->interp
;
91 PyObject
*modules
= interp
->modules
;
92 PyObject
*builtins
= PyDict_GetItemString(modules
, "__builtin__");
94 if (builtins
== NULL
) {
95 PyErr_SetString(PyExc_RuntimeError
, "lost __builtin__");
99 /* Print value except if None */
100 /* After printing, also assign to '_' */
101 /* Before, set '_' to None to avoid recursion */
106 if (PyObject_SetAttrString(builtins
, "_", Py_None
) != 0)
108 if (Py_FlushLine() != 0)
110 outf
= PySys_GetObject("stdout");
112 PyErr_SetString(PyExc_RuntimeError
, "lost sys.stdout");
115 if (PyFile_WriteObject(o
, outf
, 0) != 0)
117 PyFile_SoftSpace(outf
, 1);
118 if (Py_FlushLine() != 0)
120 if (PyObject_SetAttrString(builtins
, "_", o
) != 0)
126 PyDoc_STRVAR(displayhook_doc
,
127 "displayhook(object) -> None\n"
129 "Print an object to sys.stdout and also save it in __builtin__.\n"
133 sys_excepthook(PyObject
* self
, PyObject
* args
)
135 PyObject
*exc
, *value
, *tb
;
136 if (!PyArg_UnpackTuple(args
, "excepthook", 3, 3, &exc
, &value
, &tb
))
138 PyErr_Display(exc
, value
, tb
);
143 PyDoc_STRVAR(excepthook_doc
,
144 "excepthook(exctype, value, traceback) -> None\n"
146 "Handle an exception by displaying it with a traceback on sys.stderr.\n"
150 sys_exc_info(PyObject
*self
, PyObject
*noargs
)
152 PyThreadState
*tstate
;
153 tstate
= PyThreadState_GET();
154 return Py_BuildValue(
156 tstate
->exc_type
!= NULL
? tstate
->exc_type
: Py_None
,
157 tstate
->exc_value
!= NULL
? tstate
->exc_value
: Py_None
,
158 tstate
->exc_traceback
!= NULL
?
159 tstate
->exc_traceback
: Py_None
);
162 PyDoc_STRVAR(exc_info_doc
,
163 "exc_info() -> (type, value, traceback)\n\
165 Return information about the most recent exception caught by an except\n\
166 clause in the current stack frame or in an older stack frame."
170 sys_exc_clear(PyObject
*self
, PyObject
*noargs
)
172 PyThreadState
*tstate
;
173 PyObject
*tmp_type
, *tmp_value
, *tmp_tb
;
175 if (PyErr_WarnPy3k("sys.exc_clear() not supported in 3.x; "
176 "use except clauses", 1) < 0)
179 tstate
= PyThreadState_GET();
180 tmp_type
= tstate
->exc_type
;
181 tmp_value
= tstate
->exc_value
;
182 tmp_tb
= tstate
->exc_traceback
;
183 tstate
->exc_type
= NULL
;
184 tstate
->exc_value
= NULL
;
185 tstate
->exc_traceback
= NULL
;
186 Py_XDECREF(tmp_type
);
187 Py_XDECREF(tmp_value
);
189 /* For b/w compatibility */
190 PySys_SetObject("exc_type", Py_None
);
191 PySys_SetObject("exc_value", Py_None
);
192 PySys_SetObject("exc_traceback", Py_None
);
197 PyDoc_STRVAR(exc_clear_doc
,
198 "exc_clear() -> None\n\
200 Clear global information on the current exception. Subsequent calls to\n\
201 exc_info() will return (None,None,None) until another exception is raised\n\
202 in the current thread or the execution stack returns to a frame where\n\
203 another exception is being handled."
207 sys_exit(PyObject
*self
, PyObject
*args
)
209 PyObject
*exit_code
= 0;
210 if (!PyArg_UnpackTuple(args
, "exit", 0, 1, &exit_code
))
212 /* Raise SystemExit so callers may catch it or clean up. */
213 PyErr_SetObject(PyExc_SystemExit
, exit_code
);
217 PyDoc_STRVAR(exit_doc
,
220 Exit the interpreter by raising SystemExit(status).\n\
221 If the status is omitted or None, it defaults to zero (i.e., success).\n\
222 If the status is numeric, it will be used as the system exit status.\n\
223 If it is another kind of object, it will be printed and the system\n\
224 exit status will be one (i.e., failure)."
227 #ifdef Py_USING_UNICODE
230 sys_getdefaultencoding(PyObject
*self
)
232 return PyString_FromString(PyUnicode_GetDefaultEncoding());
235 PyDoc_STRVAR(getdefaultencoding_doc
,
236 "getdefaultencoding() -> string\n\
238 Return the current default string encoding used by the Unicode \n\
243 sys_setdefaultencoding(PyObject
*self
, PyObject
*args
)
246 if (!PyArg_ParseTuple(args
, "s:setdefaultencoding", &encoding
))
248 if (PyUnicode_SetDefaultEncoding(encoding
))
254 PyDoc_STRVAR(setdefaultencoding_doc
,
255 "setdefaultencoding(encoding)\n\
257 Set the current default string encoding used by the Unicode implementation."
261 sys_getfilesystemencoding(PyObject
*self
)
263 if (Py_FileSystemDefaultEncoding
)
264 return PyString_FromString(Py_FileSystemDefaultEncoding
);
269 PyDoc_STRVAR(getfilesystemencoding_doc
,
270 "getfilesystemencoding() -> string\n\
272 Return the encoding used to convert Unicode filenames in\n\
273 operating system filenames."
279 * Cached interned string objects used for calling the profile and
280 * trace functions. Initialized by trace_init().
282 static PyObject
*whatstrings
[7] = {NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
};
287 static char *whatnames
[7] = {"call", "exception", "line", "return",
288 "c_call", "c_exception", "c_return"};
291 for (i
= 0; i
< 7; ++i
) {
292 if (whatstrings
[i
] == NULL
) {
293 name
= PyString_InternFromString(whatnames
[i
]);
296 whatstrings
[i
] = name
;
304 call_trampoline(PyThreadState
*tstate
, PyObject
* callback
,
305 PyFrameObject
*frame
, int what
, PyObject
*arg
)
307 PyObject
*args
= PyTuple_New(3);
314 whatstr
= whatstrings
[what
];
319 PyTuple_SET_ITEM(args
, 0, (PyObject
*)frame
);
320 PyTuple_SET_ITEM(args
, 1, whatstr
);
321 PyTuple_SET_ITEM(args
, 2, arg
);
323 /* call the Python-level function */
324 PyFrame_FastToLocals(frame
);
325 result
= PyEval_CallObject(callback
, args
);
326 PyFrame_LocalsToFast(frame
, 1);
328 PyTraceBack_Here(frame
);
336 profile_trampoline(PyObject
*self
, PyFrameObject
*frame
,
337 int what
, PyObject
*arg
)
339 PyThreadState
*tstate
= frame
->f_tstate
;
344 result
= call_trampoline(tstate
, self
, frame
, what
, arg
);
345 if (result
== NULL
) {
346 PyEval_SetProfile(NULL
, NULL
);
354 trace_trampoline(PyObject
*self
, PyFrameObject
*frame
,
355 int what
, PyObject
*arg
)
357 PyThreadState
*tstate
= frame
->f_tstate
;
361 if (what
== PyTrace_CALL
)
364 callback
= frame
->f_trace
;
365 if (callback
== NULL
)
367 result
= call_trampoline(tstate
, callback
, frame
, what
, arg
);
368 if (result
== NULL
) {
369 PyEval_SetTrace(NULL
, NULL
);
370 Py_XDECREF(frame
->f_trace
);
371 frame
->f_trace
= NULL
;
374 if (result
!= Py_None
) {
375 PyObject
*temp
= frame
->f_trace
;
376 frame
->f_trace
= NULL
;
378 frame
->f_trace
= result
;
387 sys_settrace(PyObject
*self
, PyObject
*args
)
389 if (trace_init() == -1)
392 PyEval_SetTrace(NULL
, NULL
);
394 PyEval_SetTrace(trace_trampoline
, args
);
399 PyDoc_STRVAR(settrace_doc
,
400 "settrace(function)\n\
402 Set the global debug tracing function. It will be called on each\n\
403 function call. See the debugger chapter in the library manual."
407 sys_gettrace(PyObject
*self
, PyObject
*args
)
409 PyThreadState
*tstate
= PyThreadState_GET();
410 PyObject
*temp
= tstate
->c_traceobj
;
418 PyDoc_STRVAR(gettrace_doc
,
421 Return the global debug tracing function set with sys.settrace.\n\
422 See the debugger chapter in the library manual."
426 sys_setprofile(PyObject
*self
, PyObject
*args
)
428 if (trace_init() == -1)
431 PyEval_SetProfile(NULL
, NULL
);
433 PyEval_SetProfile(profile_trampoline
, args
);
438 PyDoc_STRVAR(setprofile_doc
,
439 "setprofile(function)\n\
441 Set the profiling function. It will be called on each function call\n\
442 and return. See the profiler chapter in the library manual."
446 sys_getprofile(PyObject
*self
, PyObject
*args
)
448 PyThreadState
*tstate
= PyThreadState_GET();
449 PyObject
*temp
= tstate
->c_profileobj
;
457 PyDoc_STRVAR(getprofile_doc
,
460 Return the profiling function set with sys.setprofile.\n\
461 See the profiler chapter in the library manual."
465 sys_setcheckinterval(PyObject
*self
, PyObject
*args
)
467 if (!PyArg_ParseTuple(args
, "i:setcheckinterval", &_Py_CheckInterval
))
473 PyDoc_STRVAR(setcheckinterval_doc
,
474 "setcheckinterval(n)\n\
476 Tell the Python interpreter to check for asynchronous events every\n\
477 n instructions. This also affects how often thread switches occur."
481 sys_getcheckinterval(PyObject
*self
, PyObject
*args
)
483 return PyInt_FromLong(_Py_CheckInterval
);
486 PyDoc_STRVAR(getcheckinterval_doc
,
487 "getcheckinterval() -> current check interval; see setcheckinterval()."
492 sys_settscdump(PyObject
*self
, PyObject
*args
)
495 PyThreadState
*tstate
= PyThreadState_Get();
497 if (!PyArg_ParseTuple(args
, "i:settscdump", &bool))
500 tstate
->interp
->tscdump
= 1;
502 tstate
->interp
->tscdump
= 0;
508 PyDoc_STRVAR(settscdump_doc
,
511 If true, tell the Python interpreter to dump VM measurements to\n\
512 stderr. If false, turn off dump. The measurements are based on the\n\
513 processor's time-stamp counter."
518 sys_setrecursionlimit(PyObject
*self
, PyObject
*args
)
521 if (!PyArg_ParseTuple(args
, "i:setrecursionlimit", &new_limit
))
523 if (new_limit
<= 0) {
524 PyErr_SetString(PyExc_ValueError
,
525 "recursion limit must be positive");
528 Py_SetRecursionLimit(new_limit
);
533 PyDoc_STRVAR(setrecursionlimit_doc
,
534 "setrecursionlimit(n)\n\
536 Set the maximum depth of the Python interpreter stack to n. This\n\
537 limit prevents infinite recursion from causing an overflow of the C\n\
538 stack and crashing Python. The highest possible limit is platform-\n\
543 sys_getrecursionlimit(PyObject
*self
)
545 return PyInt_FromLong(Py_GetRecursionLimit());
548 PyDoc_STRVAR(getrecursionlimit_doc
,
549 "getrecursionlimit()\n\
551 Return the current value of the recursion limit, the maximum depth\n\
552 of the Python interpreter stack. This limit prevents infinite\n\
553 recursion from causing an overflow of the C stack and crashing Python."
557 PyDoc_STRVAR(getwindowsversion_doc
,
558 "getwindowsversion()\n\
560 Return information about the running version of Windows.\n\
561 The result is a tuple of (major, minor, build, platform, text)\n\
562 All elements are numbers, except text which is a string.\n\
563 Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP\n\
568 sys_getwindowsversion(PyObject
*self
)
571 ver
.dwOSVersionInfoSize
= sizeof(ver
);
572 if (!GetVersionEx(&ver
))
573 return PyErr_SetFromWindowsErr(0);
574 return Py_BuildValue("HHHHs",
582 #endif /* MS_WINDOWS */
586 sys_setdlopenflags(PyObject
*self
, PyObject
*args
)
589 PyThreadState
*tstate
= PyThreadState_GET();
590 if (!PyArg_ParseTuple(args
, "i:setdlopenflags", &new_val
))
594 tstate
->interp
->dlopenflags
= new_val
;
599 PyDoc_STRVAR(setdlopenflags_doc
,
600 "setdlopenflags(n) -> None\n\
602 Set the flags that will be used for dlopen() calls. Among other\n\
603 things, this will enable a lazy resolving of symbols when importing\n\
604 a module, if called as sys.setdlopenflags(0)\n\
605 To share symbols across extension modules, call as\n\
606 sys.setdlopenflags(dl.RTLD_NOW|dl.RTLD_GLOBAL)"
610 sys_getdlopenflags(PyObject
*self
, PyObject
*args
)
612 PyThreadState
*tstate
= PyThreadState_GET();
615 return PyInt_FromLong(tstate
->interp
->dlopenflags
);
618 PyDoc_STRVAR(getdlopenflags_doc
,
619 "getdlopenflags() -> int\n\
621 Return the current value of the flags that are used for dlopen()\n\
622 calls. The flag constants are defined in the dl module."
627 /* Link with -lmalloc (or -lmpc) on an SGI */
631 sys_mdebug(PyObject
*self
, PyObject
*args
)
634 if (!PyArg_ParseTuple(args
, "i:mdebug", &flag
))
636 mallopt(M_DEBUG
, flag
);
640 #endif /* USE_MALLOPT */
643 sys_getsizeof(PyObject
*self
, PyObject
*args
, PyObject
*kwds
)
645 PyObject
*res
= NULL
;
646 static PyObject
*str__sizeof__
, *gc_head_size
= NULL
;
647 static char *kwlist
[] = {"object", "default", 0};
648 PyObject
*o
, *dflt
= NULL
;
650 if (!PyArg_ParseTupleAndKeywords(args
, kwds
, "O|O:getsizeof",
654 /* Initialize static variable needed by _PyType_Lookup */
655 if (str__sizeof__
== NULL
) {
656 str__sizeof__
= PyString_InternFromString("__sizeof__");
657 if (str__sizeof__
== NULL
)
661 /* Initialize static variable for GC head size */
662 if (gc_head_size
== NULL
) {
663 gc_head_size
= PyInt_FromSsize_t(sizeof(PyGC_Head
));
664 if (gc_head_size
== NULL
)
668 /* Make sure the type is initialized. float gets initialized late */
669 if (PyType_Ready(Py_TYPE(o
)) < 0)
672 /* Instance of old-style class */
673 if (PyInstance_Check(o
))
674 res
= PyInt_FromSsize_t(PyInstance_Type
.tp_basicsize
);
675 /* all other objects */
677 PyObject
*method
= _PyType_Lookup(Py_TYPE(o
),
680 PyErr_Format(PyExc_TypeError
,
681 "Type %.100s doesn't define __sizeof__",
682 Py_TYPE(o
)->tp_name
);
684 res
= PyObject_CallFunctionObjArgs(method
, o
, NULL
);
687 /* Has a default value been given? */
688 if ((res
== NULL
) && (dflt
!= NULL
) &&
689 PyErr_ExceptionMatches(PyExc_TypeError
))
695 else if (res
== NULL
)
698 /* add gc_head size */
699 if (PyObject_IS_GC(o
)) {
701 res
= PyNumber_Add(tmp
, gc_head_size
);
707 PyDoc_STRVAR(getsizeof_doc
,
708 "getsizeof(object, default) -> int\n\
710 Return the size of object in bytes.");
713 sys_getrefcount(PyObject
*self
, PyObject
*arg
)
715 return PyInt_FromSsize_t(arg
->ob_refcnt
);
720 sys_gettotalrefcount(PyObject
*self
)
722 return PyInt_FromSsize_t(_Py_GetRefTotal());
724 #endif /* Py_REF_DEBUG */
726 PyDoc_STRVAR(getrefcount_doc
,
727 "getrefcount(object) -> integer\n\
729 Return the reference count of object. The count returned is generally\n\
730 one higher than you might expect, because it includes the (temporary)\n\
731 reference as an argument to getrefcount()."
736 sys_getcounts(PyObject
*self
)
738 extern PyObject
*get_counts(void);
744 PyDoc_STRVAR(getframe_doc
,
745 "_getframe([depth]) -> frameobject\n\
747 Return a frame object from the call stack. If optional integer depth is\n\
748 given, return the frame object that many calls below the top of the stack.\n\
749 If that is deeper than the call stack, ValueError is raised. The default\n\
750 for depth is zero, returning the frame at the top of the call stack.\n\
752 This function should be used for internal and specialized\n\
757 sys_getframe(PyObject
*self
, PyObject
*args
)
759 PyFrameObject
*f
= PyThreadState_GET()->frame
;
762 if (!PyArg_ParseTuple(args
, "|i:_getframe", &depth
))
765 while (depth
> 0 && f
!= NULL
) {
770 PyErr_SetString(PyExc_ValueError
,
771 "call stack is not deep enough");
778 PyDoc_STRVAR(current_frames_doc
,
779 "_current_frames() -> dictionary\n\
781 Return a dictionary mapping each current thread T's thread id to T's\n\
782 current stack frame.\n\
784 This function should be used for specialized purposes only."
788 sys_current_frames(PyObject
*self
, PyObject
*noargs
)
790 return _PyThread_CurrentFrames();
793 PyDoc_STRVAR(call_tracing_doc
,
794 "call_tracing(func, args) -> object\n\
796 Call func(*args), while tracing is enabled. The tracing state is\n\
797 saved, and restored afterwards. This is intended to be called from\n\
798 a debugger from a checkpoint, to recursively debug some other code."
802 sys_call_tracing(PyObject
*self
, PyObject
*args
)
804 PyObject
*func
, *funcargs
;
805 if (!PyArg_UnpackTuple(args
, "call_tracing", 2, 2, &func
, &funcargs
))
807 return _PyEval_CallTracing(func
, funcargs
);
810 PyDoc_STRVAR(callstats_doc
,
811 "callstats() -> tuple of integers\n\
813 Return a tuple of function call statistics, if CALL_PROFILE was defined\n\
814 when Python was built. Otherwise, return None.\n\
816 When enabled, this function returns detailed, implementation-specific\n\
817 details about the number of function calls executed. The return value is\n\
818 a 11-tuple where the entries in the tuple are counts of:\n\
819 0. all function calls\n\
820 1. calls to PyFunction_Type objects\n\
821 2. PyFunction calls that do not create an argument tuple\n\
822 3. PyFunction calls that do not create an argument tuple\n\
823 and bypass PyEval_EvalCodeEx()\n\
825 5. PyMethod calls on bound methods\n\
827 7. PyCFunction calls\n\
828 8. generator calls\n\
829 9. All other calls\n\
830 10. Number of stack pops performed by call_function()"
838 /* Defined in objects.c because it uses static globals if that file */
839 extern PyObject
*_Py_GetObjects(PyObject
*, PyObject
*);
842 #ifdef DYNAMIC_EXECUTION_PROFILE
843 /* Defined in ceval.c because it uses static globals if that file */
844 extern PyObject
*_Py_GetDXProfile(PyObject
*, PyObject
*);
852 sys_clear_type_cache(PyObject
* self
, PyObject
* args
)
858 PyDoc_STRVAR(sys_clear_type_cache__doc__
,
859 "_clear_type_cache() -> None\n\
860 Clear the internal type lookup cache.");
863 static PyMethodDef sys_methods
[] = {
864 /* Might as well keep this in alphabetic order */
865 {"callstats", (PyCFunction
)PyEval_GetCallStats
, METH_NOARGS
,
867 {"_clear_type_cache", sys_clear_type_cache
, METH_NOARGS
,
868 sys_clear_type_cache__doc__
},
869 {"_current_frames", sys_current_frames
, METH_NOARGS
,
871 {"displayhook", sys_displayhook
, METH_O
, displayhook_doc
},
872 {"exc_info", sys_exc_info
, METH_NOARGS
, exc_info_doc
},
873 {"exc_clear", sys_exc_clear
, METH_NOARGS
, exc_clear_doc
},
874 {"excepthook", sys_excepthook
, METH_VARARGS
, excepthook_doc
},
875 {"exit", sys_exit
, METH_VARARGS
, exit_doc
},
876 #ifdef Py_USING_UNICODE
877 {"getdefaultencoding", (PyCFunction
)sys_getdefaultencoding
,
878 METH_NOARGS
, getdefaultencoding_doc
},
881 {"getdlopenflags", (PyCFunction
)sys_getdlopenflags
, METH_NOARGS
,
885 {"getcounts", (PyCFunction
)sys_getcounts
, METH_NOARGS
},
887 #ifdef DYNAMIC_EXECUTION_PROFILE
888 {"getdxp", _Py_GetDXProfile
, METH_VARARGS
},
890 #ifdef Py_USING_UNICODE
891 {"getfilesystemencoding", (PyCFunction
)sys_getfilesystemencoding
,
892 METH_NOARGS
, getfilesystemencoding_doc
},
895 {"getobjects", _Py_GetObjects
, METH_VARARGS
},
898 {"gettotalrefcount", (PyCFunction
)sys_gettotalrefcount
, METH_NOARGS
},
900 {"getrefcount", (PyCFunction
)sys_getrefcount
, METH_O
, getrefcount_doc
},
901 {"getrecursionlimit", (PyCFunction
)sys_getrecursionlimit
, METH_NOARGS
,
902 getrecursionlimit_doc
},
903 {"getsizeof", (PyCFunction
)sys_getsizeof
,
904 METH_VARARGS
| METH_KEYWORDS
, getsizeof_doc
},
905 {"_getframe", sys_getframe
, METH_VARARGS
, getframe_doc
},
907 {"getwindowsversion", (PyCFunction
)sys_getwindowsversion
, METH_NOARGS
,
908 getwindowsversion_doc
},
909 #endif /* MS_WINDOWS */
911 {"mdebug", sys_mdebug
, METH_VARARGS
},
913 #ifdef Py_USING_UNICODE
914 {"setdefaultencoding", sys_setdefaultencoding
, METH_VARARGS
,
915 setdefaultencoding_doc
},
917 {"setcheckinterval", sys_setcheckinterval
, METH_VARARGS
,
918 setcheckinterval_doc
},
919 {"getcheckinterval", sys_getcheckinterval
, METH_NOARGS
,
920 getcheckinterval_doc
},
922 {"setdlopenflags", sys_setdlopenflags
, METH_VARARGS
,
925 {"setprofile", sys_setprofile
, METH_O
, setprofile_doc
},
926 {"getprofile", sys_getprofile
, METH_NOARGS
, getprofile_doc
},
927 {"setrecursionlimit", sys_setrecursionlimit
, METH_VARARGS
,
928 setrecursionlimit_doc
},
930 {"settscdump", sys_settscdump
, METH_VARARGS
, settscdump_doc
},
932 {"settrace", sys_settrace
, METH_O
, settrace_doc
},
933 {"gettrace", sys_gettrace
, METH_NOARGS
, gettrace_doc
},
934 {"call_tracing", sys_call_tracing
, METH_VARARGS
, call_tracing_doc
},
935 {NULL
, NULL
} /* sentinel */
939 list_builtin_module_names(void)
941 PyObject
*list
= PyList_New(0);
945 for (i
= 0; PyImport_Inittab
[i
].name
!= NULL
; i
++) {
946 PyObject
*name
= PyString_FromString(
947 PyImport_Inittab
[i
].name
);
950 PyList_Append(list
, name
);
953 if (PyList_Sort(list
) != 0) {
958 PyObject
*v
= PyList_AsTuple(list
);
965 static PyObject
*warnoptions
= NULL
;
968 PySys_ResetWarnOptions(void)
970 if (warnoptions
== NULL
|| !PyList_Check(warnoptions
))
972 PyList_SetSlice(warnoptions
, 0, PyList_GET_SIZE(warnoptions
), NULL
);
976 PySys_AddWarnOption(char *s
)
980 if (warnoptions
== NULL
|| !PyList_Check(warnoptions
)) {
981 Py_XDECREF(warnoptions
);
982 warnoptions
= PyList_New(0);
983 if (warnoptions
== NULL
)
986 str
= PyString_FromString(s
);
988 PyList_Append(warnoptions
, str
);
994 PySys_HasWarnOptions(void)
996 return (warnoptions
!= NULL
&& (PyList_Size(warnoptions
) > 0)) ? 1 : 0;
999 /* XXX This doc string is too long to be a single string literal in VC++ 5.0.
1000 Two literals concatenated works just fine. If you have a K&R compiler
1001 or other abomination that however *does* understand longer strings,
1002 get rid of the !!! comment in the middle and the quotes that surround it. */
1003 PyDoc_VAR(sys_doc
) =
1005 "This module provides access to some objects used or maintained by the\n\
1006 interpreter and to functions that interact strongly with the interpreter.\n\
1010 argv -- command line arguments; argv[0] is the script pathname if known\n\
1011 path -- module search path; path[0] is the script directory, else ''\n\
1012 modules -- dictionary of loaded modules\n\
1014 displayhook -- called to show results in an interactive session\n\
1015 excepthook -- called to handle any uncaught exception other than SystemExit\n\
1016 To customize printing in an interactive session or to install a custom\n\
1017 top-level exception handler, assign other functions to replace these.\n\
1019 exitfunc -- if sys.exitfunc exists, this routine is called when Python exits\n\
1020 Assigning to sys.exitfunc is deprecated; use the atexit module instead.\n\
1022 stdin -- standard input file object; used by raw_input() and input()\n\
1023 stdout -- standard output file object; used by the print statement\n\
1024 stderr -- standard error object; used for error messages\n\
1025 By assigning other file objects (or objects that behave like files)\n\
1026 to these, it is possible to redirect all of the interpreter's I/O.\n\
1028 last_type -- type of last uncaught exception\n\
1029 last_value -- value of last uncaught exception\n\
1030 last_traceback -- traceback of last uncaught exception\n\
1031 These three are only available in an interactive session after a\n\
1032 traceback has been printed.\n\
1034 exc_type -- type of exception currently being handled\n\
1035 exc_value -- value of exception currently being handled\n\
1036 exc_traceback -- traceback of exception currently being handled\n\
1037 The function exc_info() should be used instead of these three,\n\
1038 because it is thread-safe.\n\
1041 /* concatenating string here */
1046 maxint -- the largest supported integer (the smallest is -maxint-1)\n\
1047 maxsize -- the largest supported length of containers.\n\
1048 maxunicode -- the largest supported character\n\
1049 builtin_module_names -- tuple of module names built into this interpreter\n\
1050 version -- the version of this interpreter as a string\n\
1051 version_info -- version information as a tuple\n\
1052 hexversion -- version information encoded as a single integer\n\
1053 copyright -- copyright notice pertaining to this interpreter\n\
1054 platform -- platform identifier\n\
1055 executable -- pathname of this Python interpreter\n\
1056 prefix -- prefix used to find the Python library\n\
1057 exec_prefix -- prefix used to find the machine-specific Python library\n\
1061 /* concatenating string here */
1063 "dllhandle -- [Windows only] integer handle of the Python DLL\n\
1064 winver -- [Windows only] version number of the Python DLL\n\
1067 #endif /* MS_WINDOWS */
1069 "__stdin__ -- the original stdin; don't touch!\n\
1070 __stdout__ -- the original stdout; don't touch!\n\
1071 __stderr__ -- the original stderr; don't touch!\n\
1072 __displayhook__ -- the original displayhook; don't touch!\n\
1073 __excepthook__ -- the original excepthook; don't touch!\n\
1077 displayhook() -- print an object to the screen, and save it in __builtin__._\n\
1078 excepthook() -- print an exception and its traceback to sys.stderr\n\
1079 exc_info() -- return thread-safe information about the current exception\n\
1080 exc_clear() -- clear the exception state for the current thread\n\
1081 exit() -- exit the interpreter by raising SystemExit\n\
1082 getdlopenflags() -- returns flags to be used for dlopen() calls\n\
1083 getprofile() -- get the global profiling function\n\
1084 getrefcount() -- return the reference count for an object (plus one :-)\n\
1085 getrecursionlimit() -- return the max recursion depth for the interpreter\n\
1086 getsizeof() -- return the size of an object in bytes\n\
1087 gettrace() -- get the global debug tracing function\n\
1088 setcheckinterval() -- control how often the interpreter checks for events\n\
1089 setdlopenflags() -- set the flags to be used for dlopen() calls\n\
1090 setprofile() -- set the global profiling function\n\
1091 setrecursionlimit() -- set the max recursion depth for the interpreter\n\
1092 settrace() -- set the global debug tracing function\n\
1095 /* end of sys_doc */ ;
1098 _check_and_flush (FILE *stream
)
1100 int prev_fail
= ferror (stream
);
1101 return fflush (stream
) || prev_fail
? EOF
: 0;
1104 /* Subversion branch and revision management */
1105 static const char _patchlevel_revision
[] = PY_PATCHLEVEL_REVISION
;
1106 static const char headurl
[] = "$HeadURL$";
1107 static int svn_initialized
;
1108 static char patchlevel_revision
[50]; /* Just the number */
1109 static char branch
[50];
1110 static char shortbranch
[50];
1111 static const char *svn_revision
;
1114 svnversion_init(void)
1116 const char *python
, *br_start
, *br_end
, *br_end2
, *svnversion
;
1120 if (svn_initialized
)
1123 python
= strstr(headurl
, "/python/");
1125 /* XXX quick hack to get bzr working */
1126 *patchlevel_revision
= '\0';
1128 strcpy(shortbranch
, "unknown");
1131 /* Py_FatalError("subversion keywords missing"); */
1134 br_start
= python
+ 8;
1135 br_end
= strchr(br_start
, '/');
1138 /* Works even for trunk,
1139 as we are in trunk/Python/sysmodule.c */
1140 br_end2
= strchr(br_end
+1, '/');
1142 istag
= strncmp(br_start
, "tags", 4) == 0;
1143 if (strncmp(br_start
, "trunk", 5) == 0) {
1144 strcpy(branch
, "trunk");
1145 strcpy(shortbranch
, "trunk");
1148 else if (istag
|| strncmp(br_start
, "branches", 8) == 0) {
1149 len
= br_end2
- br_start
;
1150 strncpy(branch
, br_start
, len
);
1153 len
= br_end2
- (br_end
+ 1);
1154 strncpy(shortbranch
, br_end
+ 1, len
);
1155 shortbranch
[len
] = '\0';
1158 Py_FatalError("bad HeadURL");
1163 svnversion
= _Py_svnversion();
1164 if (strcmp(svnversion
, "exported") != 0)
1165 svn_revision
= svnversion
;
1167 len
= strlen(_patchlevel_revision
);
1169 assert(len
< (sizeof(patchlevel_revision
) + 13));
1170 strncpy(patchlevel_revision
, _patchlevel_revision
+ 11,
1172 patchlevel_revision
[len
- 13] = '\0';
1173 svn_revision
= patchlevel_revision
;
1178 svn_initialized
= 1;
1181 /* Return svnversion output if available.
1182 Else return Revision of patchlevel.h if on branch.
1183 Else return empty string */
1185 Py_SubversionRevision()
1188 return svn_revision
;
1192 Py_SubversionShortBranch()
1199 PyDoc_STRVAR(flags__doc__
,
1202 Flags provided through command line arguments or environment vars.");
1204 static PyTypeObject FlagsType
= {0, 0, 0, 0, 0, 0};
1206 static PyStructSequence_Field flags_fields
[] = {
1208 {"py3k_warning", "-3"},
1209 {"division_warning", "-Q"},
1210 {"division_new", "-Qnew"},
1212 {"interactive", "-i"},
1213 {"optimize", "-O or -OO"},
1214 {"dont_write_bytecode", "-B"},
1215 {"no_user_site", "-s"},
1217 {"ignore_environment", "-E"},
1218 {"tabcheck", "-t or -tt"},
1221 {"riscos_wimp", "???"},
1223 /* {"unbuffered", "-u"}, */
1225 /* {"skip_first", "-x"}, */
1226 {"bytes_warning", "-b"},
1230 static PyStructSequence_Desc flags_desc
= {
1231 "sys.flags", /* name */
1232 flags__doc__
, /* doc */
1233 flags_fields
, /* fields */
1247 seq
= PyStructSequence_New(&FlagsType
);
1251 #define SetFlag(flag) \
1252 PyStructSequence_SET_ITEM(seq, pos++, PyInt_FromLong(flag))
1254 SetFlag(Py_DebugFlag
);
1255 SetFlag(Py_Py3kWarningFlag
);
1256 SetFlag(Py_DivisionWarningFlag
);
1257 SetFlag(_Py_QnewFlag
);
1258 SetFlag(Py_InspectFlag
);
1259 SetFlag(Py_InteractiveFlag
);
1260 SetFlag(Py_OptimizeFlag
);
1261 SetFlag(Py_DontWriteBytecodeFlag
);
1262 SetFlag(Py_NoUserSiteDirectory
);
1263 SetFlag(Py_NoSiteFlag
);
1264 SetFlag(Py_IgnoreEnvironmentFlag
);
1265 SetFlag(Py_TabcheckFlag
);
1266 SetFlag(Py_VerboseFlag
);
1268 SetFlag(Py_RISCOSWimpFlag
);
1270 /* SetFlag(saw_unbuffered_flag); */
1271 SetFlag(Py_UnicodeFlag
);
1272 /* SetFlag(skipfirstline); */
1273 SetFlag(Py_BytesWarningFlag
);
1276 if (PyErr_Occurred()) {
1285 PyObject
*m
, *v
, *sysdict
;
1286 PyObject
*sysin
, *sysout
, *syserr
;
1289 m
= Py_InitModule3("sys", sys_methods
, sys_doc
);
1292 sysdict
= PyModule_GetDict(m
);
1293 #define SET_SYS_FROM_STRING(key, value) \
1296 PyDict_SetItemString(sysdict, key, v); \
1300 /* XXX: does this work on Win/Win64? (see posix_fstat) */
1302 if (fstat(fileno(stdin
), &sb
) == 0 &&
1303 S_ISDIR(sb
.st_mode
)) {
1304 /* There's nothing more we can do. */
1305 /* Py_FatalError() will core dump, so just exit. */
1306 PySys_WriteStderr("Python error: <stdin> is a directory, cannot continue\n");
1311 /* Closing the standard FILE* if sys.std* goes aways causes problems
1312 * for embedded Python usages. Closing them when somebody explicitly
1313 * invokes .close() might be possible, but the FAQ promises they get
1314 * never closed. However, we still need to get write errors when
1315 * writing fails (e.g. because stdout is redirected), so we flush the
1316 * streams and check for errors before the file objects are deleted.
1317 * On OS X, fflush()ing stdin causes an error, so we exempt stdin
1318 * from that procedure.
1320 sysin
= PyFile_FromFile(stdin
, "<stdin>", "r", NULL
);
1321 sysout
= PyFile_FromFile(stdout
, "<stdout>", "w", _check_and_flush
);
1322 syserr
= PyFile_FromFile(stderr
, "<stderr>", "w", _check_and_flush
);
1323 if (PyErr_Occurred())
1326 PyDict_SetItemString(sysdict
, "stdin", sysin
);
1327 PyDict_SetItemString(sysdict
, "stdout", sysout
);
1328 PyDict_SetItemString(sysdict
, "stderr", syserr
);
1329 /* Make backup copies for cleanup */
1330 PyDict_SetItemString(sysdict
, "__stdin__", sysin
);
1331 PyDict_SetItemString(sysdict
, "__stdout__", sysout
);
1332 PyDict_SetItemString(sysdict
, "__stderr__", syserr
);
1333 PyDict_SetItemString(sysdict
, "__displayhook__",
1334 PyDict_GetItemString(sysdict
, "displayhook"));
1335 PyDict_SetItemString(sysdict
, "__excepthook__",
1336 PyDict_GetItemString(sysdict
, "excepthook"));
1341 SET_SYS_FROM_STRING("version",
1342 PyString_FromString(Py_GetVersion()));
1343 SET_SYS_FROM_STRING("hexversion",
1344 PyInt_FromLong(PY_VERSION_HEX
));
1346 SET_SYS_FROM_STRING("subversion",
1347 Py_BuildValue("(ssz)", "CPython", branch
,
1349 SET_SYS_FROM_STRING("dont_write_bytecode",
1350 PyBool_FromLong(Py_DontWriteBytecodeFlag
));
1352 * These release level checks are mutually exclusive and cover
1353 * the field, so don't get too fancy with the pre-processor!
1355 #if PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_ALPHA
1357 #elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_BETA
1359 #elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_GAMMA
1361 #elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_FINAL
1365 SET_SYS_FROM_STRING("version_info",
1366 Py_BuildValue("iiisi", PY_MAJOR_VERSION
,
1368 PY_MICRO_VERSION
, s
,
1369 PY_RELEASE_SERIAL
));
1370 SET_SYS_FROM_STRING("api_version",
1371 PyInt_FromLong(PYTHON_API_VERSION
));
1372 SET_SYS_FROM_STRING("copyright",
1373 PyString_FromString(Py_GetCopyright()));
1374 SET_SYS_FROM_STRING("platform",
1375 PyString_FromString(Py_GetPlatform()));
1376 SET_SYS_FROM_STRING("executable",
1377 PyString_FromString(Py_GetProgramFullPath()));
1378 SET_SYS_FROM_STRING("prefix",
1379 PyString_FromString(Py_GetPrefix()));
1380 SET_SYS_FROM_STRING("exec_prefix",
1381 PyString_FromString(Py_GetExecPrefix()));
1382 SET_SYS_FROM_STRING("maxsize",
1383 PyInt_FromSsize_t(PY_SSIZE_T_MAX
));
1384 SET_SYS_FROM_STRING("maxint",
1385 PyInt_FromLong(PyInt_GetMax()));
1386 SET_SYS_FROM_STRING("py3kwarning",
1387 PyBool_FromLong(Py_Py3kWarningFlag
));
1388 SET_SYS_FROM_STRING("float_info",
1390 #ifdef Py_USING_UNICODE
1391 SET_SYS_FROM_STRING("maxunicode",
1392 PyInt_FromLong(PyUnicode_GetMax()));
1394 SET_SYS_FROM_STRING("builtin_module_names",
1395 list_builtin_module_names());
1397 /* Assumes that longs are at least 2 bytes long.
1399 unsigned long number
= 1;
1402 s
= (char *) &number
;
1407 SET_SYS_FROM_STRING("byteorder",
1408 PyString_FromString(value
));
1411 SET_SYS_FROM_STRING("dllhandle",
1412 PyLong_FromVoidPtr(PyWin_DLLhModule
));
1413 SET_SYS_FROM_STRING("winver",
1414 PyString_FromString(PyWin_DLLVersionString
));
1416 if (warnoptions
== NULL
) {
1417 warnoptions
= PyList_New(0);
1420 Py_INCREF(warnoptions
);
1422 if (warnoptions
!= NULL
) {
1423 PyDict_SetItemString(sysdict
, "warnoptions", warnoptions
);
1426 if (FlagsType
.tp_name
== 0)
1427 PyStructSequence_InitType(&FlagsType
, &flags_desc
);
1428 SET_SYS_FROM_STRING("flags", make_flags());
1429 /* prevent user from creating new instances */
1430 FlagsType
.tp_init
= NULL
;
1431 FlagsType
.tp_new
= NULL
;
1433 #undef SET_SYS_FROM_STRING
1434 if (PyErr_Occurred())
1440 makepathobject(char *path
, int delim
)
1448 while ((p
= strchr(p
, delim
)) != NULL
) {
1455 for (i
= 0; ; i
++) {
1456 p
= strchr(path
, delim
);
1458 p
= strchr(path
, '\0'); /* End of string */
1459 w
= PyString_FromStringAndSize(path
, (Py_ssize_t
) (p
- path
));
1464 PyList_SetItem(v
, i
, w
);
1473 PySys_SetPath(char *path
)
1476 if ((v
= makepathobject(path
, DELIM
)) == NULL
)
1477 Py_FatalError("can't create sys.path");
1478 if (PySys_SetObject("path", v
) != 0)
1479 Py_FatalError("can't assign sys.path");
1484 makeargvobject(int argc
, char **argv
)
1487 if (argc
<= 0 || argv
== NULL
) {
1488 /* Ensure at least one (empty) argument is seen */
1489 static char *empty_argv
[1] = {""};
1493 av
= PyList_New(argc
);
1496 for (i
= 0; i
< argc
; i
++) {
1500 /* argv[0] is the script pathname if known */
1502 char* fn
= decc$
translate_vms(argv
[0]);
1503 if ((fn
== (char *)0) || fn
== (char *)-1)
1504 v
= PyString_FromString(argv
[0]);
1506 v
= PyString_FromString(
1507 decc$
translate_vms(argv
[0]));
1509 v
= PyString_FromString(argv
[i
]);
1511 PyObject
*v
= PyString_FromString(argv
[i
]);
1518 PyList_SetItem(av
, i
, v
);
1525 PySys_SetArgv(int argc
, char **argv
)
1527 #if defined(HAVE_REALPATH)
1528 char fullpath
[MAXPATHLEN
];
1529 #elif defined(MS_WINDOWS)
1530 char fullpath
[MAX_PATH
];
1532 PyObject
*av
= makeargvobject(argc
, argv
);
1533 PyObject
*path
= PySys_GetObject("path");
1535 Py_FatalError("no mem for sys.argv");
1536 if (PySys_SetObject("argv", av
) != 0)
1537 Py_FatalError("can't assign sys.argv");
1539 char *argv0
= argv
[0];
1543 #ifdef HAVE_READLINK
1544 char link
[MAXPATHLEN
+1];
1545 char argv0copy
[2*MAXPATHLEN
+1];
1547 if (argc
> 0 && argv0
!= NULL
&& strcmp(argv0
, "-c") != 0)
1548 nr
= readlink(argv0
, link
, MAXPATHLEN
);
1550 /* It's a symlink */
1553 argv0
= link
; /* Link to absolute path */
1554 else if (strchr(link
, SEP
) == NULL
)
1555 ; /* Link without path */
1557 /* Must join(dirname(argv0), link) */
1558 char *q
= strrchr(argv0
, SEP
);
1560 argv0
= link
; /* argv0 without path */
1562 /* Must make a copy */
1563 strcpy(argv0copy
, argv0
);
1564 q
= strrchr(argv0copy
, SEP
);
1570 #endif /* HAVE_READLINK */
1571 #if SEP == '\\' /* Special case for MS filename syntax */
1572 if (argc
> 0 && argv0
!= NULL
&& strcmp(argv0
, "-c") != 0) {
1576 if (GetFullPathName(argv0
,
1583 p
= strrchr(argv0
, SEP
);
1584 /* Test for alternate separator */
1585 q
= strrchr(p
? p
: argv0
, '/');
1590 if (n
> 1 && p
[-1] != ':')
1591 n
--; /* Drop trailing separator */
1594 #else /* All other filename syntaxes */
1595 if (argc
> 0 && argv0
!= NULL
&& strcmp(argv0
, "-c") != 0) {
1596 #if defined(HAVE_REALPATH)
1597 if (realpath(argv0
, fullpath
)) {
1601 p
= strrchr(argv0
, SEP
);
1606 #else /* don't include trailing separator */
1609 #if SEP == '/' /* Special case for Unix filename syntax */
1611 n
--; /* Drop trailing separator */
1614 #endif /* All others */
1615 a
= PyString_FromStringAndSize(argv0
, n
);
1617 Py_FatalError("no mem for sys.path insertion");
1618 if (PyList_Insert(path
, 0, a
) < 0)
1619 Py_FatalError("sys.path.insert(0) failed");
1626 /* APIs to write to sys.stdout or sys.stderr using a printf-like interface.
1627 Adapted from code submitted by Just van Rossum.
1629 PySys_WriteStdout(format, ...)
1630 PySys_WriteStderr(format, ...)
1632 The first function writes to sys.stdout; the second to sys.stderr. When
1633 there is a problem, they write to the real (C level) stdout or stderr;
1634 no exceptions are raised.
1636 Both take a printf-style format string as their first argument followed
1637 by a variable length argument list determined by the format string.
1641 The format should limit the total size of the formatted output string to
1642 1000 bytes. In particular, this means that no unrestricted "%s" formats
1643 should occur; these should be limited using "%.<N>s where <N> is a
1644 decimal number calculated so that <N> plus the maximum size of other
1645 formatted text does not exceed 1000 bytes. Also watch out for "%f",
1646 which can print hundreds of digits for very large numbers.
1651 mywrite(char *name
, FILE *fp
, const char *format
, va_list va
)
1654 PyObject
*error_type
, *error_value
, *error_traceback
;
1656 PyErr_Fetch(&error_type
, &error_value
, &error_traceback
);
1657 file
= PySys_GetObject(name
);
1658 if (file
== NULL
|| PyFile_AsFile(file
) == fp
)
1659 vfprintf(fp
, format
, va
);
1662 const int written
= PyOS_vsnprintf(buffer
, sizeof(buffer
),
1664 if (PyFile_WriteString(buffer
, file
) != 0) {
1668 if (written
< 0 || (size_t)written
>= sizeof(buffer
)) {
1669 const char *truncated
= "... truncated";
1670 if (PyFile_WriteString(truncated
, file
) != 0) {
1672 fputs(truncated
, fp
);
1676 PyErr_Restore(error_type
, error_value
, error_traceback
);
1680 PySys_WriteStdout(const char *format
, ...)
1684 va_start(va
, format
);
1685 mywrite("stdout", stdout
, format
, va
);
1690 PySys_WriteStderr(const char *format
, ...)
1694 va_start(va
, format
);
1695 mywrite("stderr", stderr
, format
, va
);