Fix argument order in pure python version of nsmallest() and nlargest().
[python/dscho.git] / Python / sysmodule.c
blobd246a5998ffa9df22887cf445929ecbdcf5430c6
2 /* System module */
4 /*
5 Various bits of information used by the interpreter are collected in
6 module 'sys'.
7 Function member:
8 - exit(sts): raise SystemExit
9 Data members:
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)
17 #include "Python.h"
18 #include "compile.h"
19 #include "frameobject.h"
20 #include "eval.h"
22 #include "osdefs.h"
24 #ifdef MS_WINDOWS
25 #define WIN32_LEAN_AND_MEAN
26 #include "windows.h"
27 #endif /* MS_WINDOWS */
29 #ifdef MS_COREDLL
30 extern void *PyWin_DLLhModule;
31 /* A string loaded from the DLL at startup: */
32 extern const char *PyWin_DLLVersionString;
33 #endif
35 #ifdef __VMS
36 #include <unixlib.h>
37 #endif
39 #ifdef MS_WINDOWS
40 #include <windows.h>
41 #endif
43 #ifdef HAVE_LANGINFO_H
44 #include <locale.h>
45 #include <langinfo.h>
46 #endif
48 PyObject *
49 PySys_GetObject(char *name)
51 PyThreadState *tstate = PyThreadState_GET();
52 PyObject *sd = tstate->interp->sysdict;
53 if (sd == NULL)
54 return NULL;
55 return PyDict_GetItemString(sd, name);
58 FILE *
59 PySys_GetFile(char *name, FILE *def)
61 FILE *fp = NULL;
62 PyObject *v = PySys_GetObject(name);
63 if (v != NULL && PyFile_Check(v))
64 fp = PyFile_AsFile(v);
65 if (fp == NULL)
66 fp = def;
67 return fp;
70 int
71 PySys_SetObject(char *name, PyObject *v)
73 PyThreadState *tstate = PyThreadState_GET();
74 PyObject *sd = tstate->interp->sysdict;
75 if (v == NULL) {
76 if (PyDict_GetItemString(sd, name) == NULL)
77 return 0;
78 else
79 return PyDict_DelItemString(sd, name);
81 else
82 return PyDict_SetItemString(sd, name, v);
85 static PyObject *
86 sys_displayhook(PyObject *self, PyObject *o)
88 PyObject *outf;
89 PyInterpreterState *interp = PyThreadState_GET()->interp;
90 PyObject *modules = interp->modules;
91 PyObject *builtins = PyDict_GetItemString(modules, "__builtin__");
93 if (builtins == NULL) {
94 PyErr_SetString(PyExc_RuntimeError, "lost __builtin__");
95 return NULL;
98 /* Print value except if None */
99 /* After printing, also assign to '_' */
100 /* Before, set '_' to None to avoid recursion */
101 if (o == Py_None) {
102 Py_INCREF(Py_None);
103 return Py_None;
105 if (PyObject_SetAttrString(builtins, "_", Py_None) != 0)
106 return NULL;
107 if (Py_FlushLine() != 0)
108 return NULL;
109 outf = PySys_GetObject("stdout");
110 if (outf == NULL) {
111 PyErr_SetString(PyExc_RuntimeError, "lost sys.stdout");
112 return NULL;
114 if (PyFile_WriteObject(o, outf, 0) != 0)
115 return NULL;
116 PyFile_SoftSpace(outf, 1);
117 if (Py_FlushLine() != 0)
118 return NULL;
119 if (PyObject_SetAttrString(builtins, "_", o) != 0)
120 return NULL;
121 Py_INCREF(Py_None);
122 return Py_None;
125 PyDoc_STRVAR(displayhook_doc,
126 "displayhook(object) -> None\n"
127 "\n"
128 "Print an object to sys.stdout and also save it in __builtin__._\n"
131 static PyObject *
132 sys_excepthook(PyObject* self, PyObject* args)
134 PyObject *exc, *value, *tb;
135 if (!PyArg_UnpackTuple(args, "excepthook", 3, 3, &exc, &value, &tb))
136 return NULL;
137 PyErr_Display(exc, value, tb);
138 Py_INCREF(Py_None);
139 return Py_None;
142 PyDoc_STRVAR(excepthook_doc,
143 "excepthook(exctype, value, traceback) -> None\n"
144 "\n"
145 "Handle an exception by displaying it with a traceback on sys.stderr.\n"
148 static PyObject *
149 sys_exc_info(PyObject *self, PyObject *noargs)
151 PyThreadState *tstate;
152 tstate = PyThreadState_GET();
153 return Py_BuildValue(
154 "(OOO)",
155 tstate->exc_type != NULL ? tstate->exc_type : Py_None,
156 tstate->exc_value != NULL ? tstate->exc_value : Py_None,
157 tstate->exc_traceback != NULL ?
158 tstate->exc_traceback : Py_None);
161 PyDoc_STRVAR(exc_info_doc,
162 "exc_info() -> (type, value, traceback)\n\
164 Return information about the most recent exception caught by an except\n\
165 clause in the current stack frame or in an older stack frame."
168 static PyObject *
169 sys_exc_clear(PyObject *self, PyObject *noargs)
171 PyThreadState *tstate = PyThreadState_GET();
172 PyObject *tmp_type, *tmp_value, *tmp_tb;
173 tmp_type = tstate->exc_type;
174 tmp_value = tstate->exc_value;
175 tmp_tb = tstate->exc_traceback;
176 tstate->exc_type = NULL;
177 tstate->exc_value = NULL;
178 tstate->exc_traceback = NULL;
179 Py_XDECREF(tmp_type);
180 Py_XDECREF(tmp_value);
181 Py_XDECREF(tmp_tb);
182 /* For b/w compatibility */
183 PySys_SetObject("exc_type", Py_None);
184 PySys_SetObject("exc_value", Py_None);
185 PySys_SetObject("exc_traceback", Py_None);
186 Py_INCREF(Py_None);
187 return Py_None;
190 PyDoc_STRVAR(exc_clear_doc,
191 "exc_clear() -> None\n\
193 Clear global information on the current exception. Subsequent calls to\n\
194 exc_info() will return (None,None,None) until another exception is raised\n\
195 in the current thread or the execution stack returns to a frame where\n\
196 another exception is being handled."
199 static PyObject *
200 sys_exit(PyObject *self, PyObject *args)
202 PyObject *exit_code = 0;
203 if (!PyArg_ParseTuple(args, "|O:exit", &exit_code))
204 return NULL;
205 /* Raise SystemExit so callers may catch it or clean up. */
206 PyErr_SetObject(PyExc_SystemExit, exit_code);
207 return NULL;
210 PyDoc_STRVAR(exit_doc,
211 "exit([status])\n\
213 Exit the interpreter by raising SystemExit(status).\n\
214 If the status is omitted or None, it defaults to zero (i.e., success).\n\
215 If the status is numeric, it will be used as the system exit status.\n\
216 If it is another kind of object, it will be printed and the system\n\
217 exit status will be one (i.e., failure)."
220 #ifdef Py_USING_UNICODE
222 static PyObject *
223 sys_getdefaultencoding(PyObject *self)
225 return PyString_FromString(PyUnicode_GetDefaultEncoding());
228 PyDoc_STRVAR(getdefaultencoding_doc,
229 "getdefaultencoding() -> string\n\
231 Return the current default string encoding used by the Unicode \n\
232 implementation."
235 static PyObject *
236 sys_setdefaultencoding(PyObject *self, PyObject *args)
238 char *encoding;
239 if (!PyArg_ParseTuple(args, "s:setdefaultencoding", &encoding))
240 return NULL;
241 if (PyUnicode_SetDefaultEncoding(encoding))
242 return NULL;
243 Py_INCREF(Py_None);
244 return Py_None;
247 PyDoc_STRVAR(setdefaultencoding_doc,
248 "setdefaultencoding(encoding)\n\
250 Set the current default string encoding used by the Unicode implementation."
253 static PyObject *
254 sys_getfilesystemencoding(PyObject *self)
256 if (Py_FileSystemDefaultEncoding)
257 return PyString_FromString(Py_FileSystemDefaultEncoding);
258 Py_INCREF(Py_None);
259 return Py_None;
262 PyDoc_STRVAR(getfilesystemencoding_doc,
263 "getfilesystemencoding() -> string\n\
265 Return the encoding used to convert Unicode filenames in\n\
266 operating system filenames."
269 #endif
272 * Cached interned string objects used for calling the profile and
273 * trace functions. Initialized by trace_init().
275 static PyObject *whatstrings[7] = {NULL, NULL, NULL, NULL, NULL, NULL, NULL};
277 static int
278 trace_init(void)
280 static char *whatnames[7] = {"call", "exception", "line", "return",
281 "c_call", "c_exception", "c_return"};
282 PyObject *name;
283 int i;
284 for (i = 0; i < 7; ++i) {
285 if (whatstrings[i] == NULL) {
286 name = PyString_InternFromString(whatnames[i]);
287 if (name == NULL)
288 return -1;
289 whatstrings[i] = name;
292 return 0;
296 static PyObject *
297 call_trampoline(PyThreadState *tstate, PyObject* callback,
298 PyFrameObject *frame, int what, PyObject *arg)
300 PyObject *args = PyTuple_New(3);
301 PyObject *whatstr;
302 PyObject *result;
304 if (args == NULL)
305 return NULL;
306 Py_INCREF(frame);
307 whatstr = whatstrings[what];
308 Py_INCREF(whatstr);
309 if (arg == NULL)
310 arg = Py_None;
311 Py_INCREF(arg);
312 PyTuple_SET_ITEM(args, 0, (PyObject *)frame);
313 PyTuple_SET_ITEM(args, 1, whatstr);
314 PyTuple_SET_ITEM(args, 2, arg);
316 /* call the Python-level function */
317 PyFrame_FastToLocals(frame);
318 result = PyEval_CallObject(callback, args);
319 PyFrame_LocalsToFast(frame, 1);
320 if (result == NULL)
321 PyTraceBack_Here(frame);
323 /* cleanup */
324 Py_DECREF(args);
325 return result;
328 static int
329 profile_trampoline(PyObject *self, PyFrameObject *frame,
330 int what, PyObject *arg)
332 PyThreadState *tstate = frame->f_tstate;
333 PyObject *result;
335 if (arg == NULL)
336 arg = Py_None;
337 result = call_trampoline(tstate, self, frame, what, arg);
338 if (result == NULL) {
339 PyEval_SetProfile(NULL, NULL);
340 return -1;
342 Py_DECREF(result);
343 return 0;
346 static int
347 trace_trampoline(PyObject *self, PyFrameObject *frame,
348 int what, PyObject *arg)
350 PyThreadState *tstate = frame->f_tstate;
351 PyObject *callback;
352 PyObject *result;
354 if (what == PyTrace_CALL)
355 callback = self;
356 else
357 callback = frame->f_trace;
358 if (callback == NULL)
359 return 0;
360 result = call_trampoline(tstate, callback, frame, what, arg);
361 if (result == NULL) {
362 PyEval_SetTrace(NULL, NULL);
363 Py_XDECREF(frame->f_trace);
364 frame->f_trace = NULL;
365 return -1;
367 if (result != Py_None) {
368 PyObject *temp = frame->f_trace;
369 frame->f_trace = NULL;
370 Py_XDECREF(temp);
371 frame->f_trace = result;
373 else {
374 Py_DECREF(result);
376 return 0;
379 static PyObject *
380 sys_settrace(PyObject *self, PyObject *args)
382 if (trace_init() == -1)
383 return NULL;
384 if (args == Py_None)
385 PyEval_SetTrace(NULL, NULL);
386 else
387 PyEval_SetTrace(trace_trampoline, args);
388 Py_INCREF(Py_None);
389 return Py_None;
392 PyDoc_STRVAR(settrace_doc,
393 "settrace(function)\n\
395 Set the global debug tracing function. It will be called on each\n\
396 function call. See the debugger chapter in the library manual."
399 static PyObject *
400 sys_setprofile(PyObject *self, PyObject *args)
402 if (trace_init() == -1)
403 return NULL;
404 if (args == Py_None)
405 PyEval_SetProfile(NULL, NULL);
406 else
407 PyEval_SetProfile(profile_trampoline, args);
408 Py_INCREF(Py_None);
409 return Py_None;
412 PyDoc_STRVAR(setprofile_doc,
413 "setprofile(function)\n\
415 Set the profiling function. It will be called on each function call\n\
416 and return. See the profiler chapter in the library manual."
419 static PyObject *
420 sys_setcheckinterval(PyObject *self, PyObject *args)
422 if (!PyArg_ParseTuple(args, "i:setcheckinterval", &_Py_CheckInterval))
423 return NULL;
424 Py_INCREF(Py_None);
425 return Py_None;
428 PyDoc_STRVAR(setcheckinterval_doc,
429 "setcheckinterval(n)\n\
431 Tell the Python interpreter to check for asynchronous events every\n\
432 n instructions. This also affects how often thread switches occur."
435 static PyObject *
436 sys_getcheckinterval(PyObject *self, PyObject *args)
438 return PyInt_FromLong(_Py_CheckInterval);
441 PyDoc_STRVAR(getcheckinterval_doc,
442 "getcheckinterval() -> current check interval; see setcheckinterval()."
445 #ifdef WITH_TSC
446 static PyObject *
447 sys_settscdump(PyObject *self, PyObject *args)
449 int bool;
450 PyThreadState *tstate = PyThreadState_Get();
452 if (!PyArg_ParseTuple(args, "i:settscdump", &bool))
453 return NULL;
454 if (bool)
455 tstate->interp->tscdump = 1;
456 else
457 tstate->interp->tscdump = 0;
458 Py_INCREF(Py_None);
459 return Py_None;
463 PyDoc_STRVAR(settscdump_doc,
464 "settscdump(bool)\n\
466 If true, tell the Python interpreter to dump VM measurements to\n\
467 stderr. If false, turn off dump. The measurements are based on the\n\
468 processor's time-stamp counter."
470 #endif /* TSC */
472 static PyObject *
473 sys_setrecursionlimit(PyObject *self, PyObject *args)
475 int new_limit;
476 if (!PyArg_ParseTuple(args, "i:setrecursionlimit", &new_limit))
477 return NULL;
478 if (new_limit <= 0) {
479 PyErr_SetString(PyExc_ValueError,
480 "recursion limit must be positive");
481 return NULL;
483 Py_SetRecursionLimit(new_limit);
484 Py_INCREF(Py_None);
485 return Py_None;
488 PyDoc_STRVAR(setrecursionlimit_doc,
489 "setrecursionlimit(n)\n\
491 Set the maximum depth of the Python interpreter stack to n. This\n\
492 limit prevents infinite recursion from causing an overflow of the C\n\
493 stack and crashing Python. The highest possible limit is platform-\n\
494 dependent."
497 static PyObject *
498 sys_getrecursionlimit(PyObject *self)
500 return PyInt_FromLong(Py_GetRecursionLimit());
503 PyDoc_STRVAR(getrecursionlimit_doc,
504 "getrecursionlimit()\n\
506 Return the current value of the recursion limit, the maximum depth\n\
507 of the Python interpreter stack. This limit prevents infinite\n\
508 recursion from causing an overflow of the C stack and crashing Python."
511 #ifdef MS_WINDOWS
512 PyDoc_STRVAR(getwindowsversion_doc,
513 "getwindowsversion()\n\
515 Return information about the running version of Windows.\n\
516 The result is a tuple of (major, minor, build, platform, text)\n\
517 All elements are numbers, except text which is a string.\n\
518 Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP\n\
522 static PyObject *
523 sys_getwindowsversion(PyObject *self)
525 OSVERSIONINFO ver;
526 ver.dwOSVersionInfoSize = sizeof(ver);
527 if (!GetVersionEx(&ver))
528 return PyErr_SetFromWindowsErr(0);
529 return Py_BuildValue("HHHHs",
530 ver.dwMajorVersion,
531 ver.dwMinorVersion,
532 ver.dwBuildNumber,
533 ver.dwPlatformId,
534 ver.szCSDVersion);
537 #endif /* MS_WINDOWS */
539 #ifdef HAVE_DLOPEN
540 static PyObject *
541 sys_setdlopenflags(PyObject *self, PyObject *args)
543 int new_val;
544 PyThreadState *tstate = PyThreadState_GET();
545 if (!PyArg_ParseTuple(args, "i:setdlopenflags", &new_val))
546 return NULL;
547 if (!tstate)
548 return NULL;
549 tstate->interp->dlopenflags = new_val;
550 Py_INCREF(Py_None);
551 return Py_None;
554 PyDoc_STRVAR(setdlopenflags_doc,
555 "setdlopenflags(n) -> None\n\
557 Set the flags that will be used for dlopen() calls. Among other\n\
558 things, this will enable a lazy resolving of symbols when importing\n\
559 a module, if called as sys.setdlopenflags(0)\n\
560 To share symbols across extension modules, call as\n\
561 sys.setdlopenflags(dl.RTLD_NOW|dl.RTLD_GLOBAL)"
564 static PyObject *
565 sys_getdlopenflags(PyObject *self, PyObject *args)
567 PyThreadState *tstate = PyThreadState_GET();
568 if (!tstate)
569 return NULL;
570 return PyInt_FromLong(tstate->interp->dlopenflags);
573 PyDoc_STRVAR(getdlopenflags_doc,
574 "getdlopenflags() -> int\n\
576 Return the current value of the flags that are used for dlopen()\n\
577 calls. The flag constants are defined in the dl module."
579 #endif
581 #ifdef USE_MALLOPT
582 /* Link with -lmalloc (or -lmpc) on an SGI */
583 #include <malloc.h>
585 static PyObject *
586 sys_mdebug(PyObject *self, PyObject *args)
588 int flag;
589 if (!PyArg_ParseTuple(args, "i:mdebug", &flag))
590 return NULL;
591 mallopt(M_DEBUG, flag);
592 Py_INCREF(Py_None);
593 return Py_None;
595 #endif /* USE_MALLOPT */
597 static PyObject *
598 sys_getrefcount(PyObject *self, PyObject *arg)
600 return PyInt_FromLong(arg->ob_refcnt);
603 #ifdef Py_REF_DEBUG
604 static PyObject *
605 sys_gettotalrefcount(PyObject *self)
607 return PyInt_FromLong(_Py_RefTotal);
610 #endif /* Py_TRACE_REFS */
612 PyDoc_STRVAR(getrefcount_doc,
613 "getrefcount(object) -> integer\n\
615 Return the reference count of object. The count returned is generally\n\
616 one higher than you might expect, because it includes the (temporary)\n\
617 reference as an argument to getrefcount()."
620 #ifdef COUNT_ALLOCS
621 static PyObject *
622 sys_getcounts(PyObject *self)
624 extern PyObject *get_counts(void);
626 return get_counts();
628 #endif
630 PyDoc_STRVAR(getframe_doc,
631 "_getframe([depth]) -> frameobject\n\
633 Return a frame object from the call stack. If optional integer depth is\n\
634 given, return the frame object that many calls below the top of the stack.\n\
635 If that is deeper than the call stack, ValueError is raised. The default\n\
636 for depth is zero, returning the frame at the top of the call stack.\n\
638 This function should be used for internal and specialized\n\
639 purposes only."
642 static PyObject *
643 sys_getframe(PyObject *self, PyObject *args)
645 PyFrameObject *f = PyThreadState_GET()->frame;
646 int depth = -1;
648 if (!PyArg_ParseTuple(args, "|i:_getframe", &depth))
649 return NULL;
651 while (depth > 0 && f != NULL) {
652 f = f->f_back;
653 --depth;
655 if (f == NULL) {
656 PyErr_SetString(PyExc_ValueError,
657 "call stack is not deep enough");
658 return NULL;
660 Py_INCREF(f);
661 return (PyObject*)f;
664 PyDoc_STRVAR(call_tracing_doc,
665 "call_tracing(func, args) -> object\n\
667 Call func(*args), while tracing is enabled. The tracing state is\n\
668 saved, and restored afterwards. This is intended to be called from\n\
669 a debugger from a checkpoint, to recursively debug some other code."
672 static PyObject *
673 sys_call_tracing(PyObject *self, PyObject *args)
675 PyObject *func, *funcargs;
676 if (!PyArg_ParseTuple(args, "OO:call_tracing", &func, &funcargs))
677 return NULL;
678 return _PyEval_CallTracing(func, funcargs);
681 PyDoc_STRVAR(callstats_doc,
682 "callstats() -> tuple of integers\n\
684 Return a tuple of function call statistics, if CALL_PROFILE was defined\n\
685 when Python was built. Otherwise, return None.\n\
687 When enabled, this function returns detailed, implementation-specific\n\
688 details about the number of function calls executed. The return value is\n\
689 a 11-tuple where the entries in the tuple are counts of:\n\
690 0. all function calls\n\
691 1. calls to PyFunction_Type objects\n\
692 2. PyFunction calls that do not create an argument tuple\n\
693 3. PyFunction calls that do not create an argument tuple\n\
694 and bypass PyEval_EvalCodeEx()\n\
695 4. PyMethod calls\n\
696 5. PyMethod calls on bound methods\n\
697 6. PyType calls\n\
698 7. PyCFunction calls\n\
699 8. generator calls\n\
700 9. All other calls\n\
701 10. Number of stack pops performed by call_function()"
704 #ifdef Py_TRACE_REFS
705 /* Defined in objects.c because it uses static globals if that file */
706 extern PyObject *_Py_GetObjects(PyObject *, PyObject *);
707 #endif
709 #ifdef DYNAMIC_EXECUTION_PROFILE
710 /* Defined in ceval.c because it uses static globals if that file */
711 extern PyObject *_Py_GetDXProfile(PyObject *, PyObject *);
712 #endif
714 static PyMethodDef sys_methods[] = {
715 /* Might as well keep this in alphabetic order */
716 {"callstats", (PyCFunction)PyEval_GetCallStats, METH_NOARGS,
717 callstats_doc},
718 {"displayhook", sys_displayhook, METH_O, displayhook_doc},
719 {"exc_info", sys_exc_info, METH_NOARGS, exc_info_doc},
720 {"exc_clear", sys_exc_clear, METH_NOARGS, exc_clear_doc},
721 {"excepthook", sys_excepthook, METH_VARARGS, excepthook_doc},
722 {"exit", sys_exit, METH_VARARGS, exit_doc},
723 #ifdef Py_USING_UNICODE
724 {"getdefaultencoding", (PyCFunction)sys_getdefaultencoding,
725 METH_NOARGS, getdefaultencoding_doc},
726 #endif
727 #ifdef HAVE_DLOPEN
728 {"getdlopenflags", (PyCFunction)sys_getdlopenflags, METH_NOARGS,
729 getdlopenflags_doc},
730 #endif
731 #ifdef COUNT_ALLOCS
732 {"getcounts", (PyCFunction)sys_getcounts, METH_NOARGS},
733 #endif
734 #ifdef DYNAMIC_EXECUTION_PROFILE
735 {"getdxp", _Py_GetDXProfile, METH_VARARGS},
736 #endif
737 #ifdef Py_USING_UNICODE
738 {"getfilesystemencoding", (PyCFunction)sys_getfilesystemencoding,
739 METH_NOARGS, getfilesystemencoding_doc},
740 #endif
741 #ifdef Py_TRACE_REFS
742 {"getobjects", _Py_GetObjects, METH_VARARGS},
743 #endif
744 #ifdef Py_REF_DEBUG
745 {"gettotalrefcount", (PyCFunction)sys_gettotalrefcount, METH_NOARGS},
746 #endif
747 {"getrefcount", (PyCFunction)sys_getrefcount, METH_O, getrefcount_doc},
748 {"getrecursionlimit", (PyCFunction)sys_getrecursionlimit, METH_NOARGS,
749 getrecursionlimit_doc},
750 {"_getframe", sys_getframe, METH_VARARGS, getframe_doc},
751 #ifdef MS_WINDOWS
752 {"getwindowsversion", (PyCFunction)sys_getwindowsversion, METH_NOARGS,
753 getwindowsversion_doc},
754 #endif /* MS_WINDOWS */
755 #ifdef USE_MALLOPT
756 {"mdebug", sys_mdebug, METH_VARARGS},
757 #endif
758 #ifdef Py_USING_UNICODE
759 {"setdefaultencoding", sys_setdefaultencoding, METH_VARARGS,
760 setdefaultencoding_doc},
761 #endif
762 {"setcheckinterval", sys_setcheckinterval, METH_VARARGS,
763 setcheckinterval_doc},
764 {"getcheckinterval", sys_getcheckinterval, METH_NOARGS,
765 getcheckinterval_doc},
766 #ifdef HAVE_DLOPEN
767 {"setdlopenflags", sys_setdlopenflags, METH_VARARGS,
768 setdlopenflags_doc},
769 #endif
770 {"setprofile", sys_setprofile, METH_O, setprofile_doc},
771 {"setrecursionlimit", sys_setrecursionlimit, METH_VARARGS,
772 setrecursionlimit_doc},
773 #ifdef WITH_TSC
774 {"settscdump", sys_settscdump, METH_VARARGS, settscdump_doc},
775 #endif
776 {"settrace", sys_settrace, METH_O, settrace_doc},
777 {"call_tracing", sys_call_tracing, METH_VARARGS, call_tracing_doc},
778 {NULL, NULL} /* sentinel */
781 static PyObject *
782 list_builtin_module_names(void)
784 PyObject *list = PyList_New(0);
785 int i;
786 if (list == NULL)
787 return NULL;
788 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
789 PyObject *name = PyString_FromString(
790 PyImport_Inittab[i].name);
791 if (name == NULL)
792 break;
793 PyList_Append(list, name);
794 Py_DECREF(name);
796 if (PyList_Sort(list) != 0) {
797 Py_DECREF(list);
798 list = NULL;
800 if (list) {
801 PyObject *v = PyList_AsTuple(list);
802 Py_DECREF(list);
803 list = v;
805 return list;
808 static PyObject *warnoptions = NULL;
810 void
811 PySys_ResetWarnOptions(void)
813 if (warnoptions == NULL || !PyList_Check(warnoptions))
814 return;
815 PyList_SetSlice(warnoptions, 0, PyList_GET_SIZE(warnoptions), NULL);
818 void
819 PySys_AddWarnOption(char *s)
821 PyObject *str;
823 if (warnoptions == NULL || !PyList_Check(warnoptions)) {
824 Py_XDECREF(warnoptions);
825 warnoptions = PyList_New(0);
826 if (warnoptions == NULL)
827 return;
829 str = PyString_FromString(s);
830 if (str != NULL) {
831 PyList_Append(warnoptions, str);
832 Py_DECREF(str);
836 /* XXX This doc string is too long to be a single string literal in VC++ 5.0.
837 Two literals concatenated works just fine. If you have a K&R compiler
838 or other abomination that however *does* understand longer strings,
839 get rid of the !!! comment in the middle and the quotes that surround it. */
840 PyDoc_VAR(sys_doc) =
841 PyDoc_STR(
842 "This module provides access to some objects used or maintained by the\n\
843 interpreter and to functions that interact strongly with the interpreter.\n\
845 Dynamic objects:\n\
847 argv -- command line arguments; argv[0] is the script pathname if known\n\
848 path -- module search path; path[0] is the script directory, else ''\n\
849 modules -- dictionary of loaded modules\n\
851 displayhook -- called to show results in an interactive session\n\
852 excepthook -- called to handle any uncaught exception other than SystemExit\n\
853 To customize printing in an interactive session or to install a custom\n\
854 top-level exception handler, assign other functions to replace these.\n\
856 exitfunc -- if sys.exitfunc exists, this routine is called when Python exits\n\
857 Assigning to sys.exitfunc is deprecated; use the atexit module instead.\n\
859 stdin -- standard input file object; used by raw_input() and input()\n\
860 stdout -- standard output file object; used by the print statement\n\
861 stderr -- standard error object; used for error messages\n\
862 By assigning other file objects (or objects that behave like files)\n\
863 to these, it is possible to redirect all of the interpreter's I/O.\n\
865 last_type -- type of last uncaught exception\n\
866 last_value -- value of last uncaught exception\n\
867 last_traceback -- traceback of last uncaught exception\n\
868 These three are only available in an interactive session after a\n\
869 traceback has been printed.\n\
871 exc_type -- type of exception currently being handled\n\
872 exc_value -- value of exception currently being handled\n\
873 exc_traceback -- traceback of exception currently being handled\n\
874 The function exc_info() should be used instead of these three,\n\
875 because it is thread-safe.\n\
878 /* concatenating string here */
879 PyDoc_STR(
880 "\n\
881 Static objects:\n\
883 maxint -- the largest supported integer (the smallest is -maxint-1)\n\
884 maxunicode -- the largest supported character\n\
885 builtin_module_names -- tuple of module names built into this interpreter\n\
886 version -- the version of this interpreter as a string\n\
887 version_info -- version information as a tuple\n\
888 hexversion -- version information encoded as a single integer\n\
889 copyright -- copyright notice pertaining to this interpreter\n\
890 platform -- platform identifier\n\
891 executable -- pathname of this Python interpreter\n\
892 prefix -- prefix used to find the Python library\n\
893 exec_prefix -- prefix used to find the machine-specific Python library\n\
896 #ifdef MS_WINDOWS
897 /* concatenating string here */
898 PyDoc_STR(
899 "dllhandle -- [Windows only] integer handle of the Python DLL\n\
900 winver -- [Windows only] version number of the Python DLL\n\
903 #endif /* MS_WINDOWS */
904 PyDoc_STR(
905 "__stdin__ -- the original stdin; don't touch!\n\
906 __stdout__ -- the original stdout; don't touch!\n\
907 __stderr__ -- the original stderr; don't touch!\n\
908 __displayhook__ -- the original displayhook; don't touch!\n\
909 __excepthook__ -- the original excepthook; don't touch!\n\
911 Functions:\n\
913 displayhook() -- print an object to the screen, and save it in __builtin__._\n\
914 excepthook() -- print an exception and its traceback to sys.stderr\n\
915 exc_info() -- return thread-safe information about the current exception\n\
916 exc_clear() -- clear the exception state for the current thread\n\
917 exit() -- exit the interpreter by raising SystemExit\n\
918 getdlopenflags() -- returns flags to be used for dlopen() calls\n\
919 getrefcount() -- return the reference count for an object (plus one :-)\n\
920 getrecursionlimit() -- return the max recursion depth for the interpreter\n\
921 setcheckinterval() -- control how often the interpreter checks for events\n\
922 setdlopenflags() -- set the flags to be used for dlopen() calls\n\
923 setprofile() -- set the global profiling function\n\
924 setrecursionlimit() -- set the max recursion depth for the interpreter\n\
925 settrace() -- set the global debug tracing function\n\
928 /* end of sys_doc */ ;
930 PyObject *
931 _PySys_Init(void)
933 PyObject *m, *v, *sysdict;
934 PyObject *sysin, *sysout, *syserr;
935 char *s;
936 #ifdef MS_WINDOWS
937 char buf[10];
938 #endif
940 m = Py_InitModule3("sys", sys_methods, sys_doc);
941 sysdict = PyModule_GetDict(m);
943 sysin = PyFile_FromFile(stdin, "<stdin>", "r", NULL);
944 sysout = PyFile_FromFile(stdout, "<stdout>", "w", NULL);
945 syserr = PyFile_FromFile(stderr, "<stderr>", "w", NULL);
946 if (PyErr_Occurred())
947 return NULL;
948 #ifdef MS_WINDOWS
949 if(isatty(_fileno(stdin))){
950 sprintf(buf, "cp%d", GetConsoleCP());
951 if (!PyFile_SetEncoding(sysin, buf))
952 return NULL;
954 if(isatty(_fileno(stdout))) {
955 sprintf(buf, "cp%d", GetConsoleOutputCP());
956 if (!PyFile_SetEncoding(sysout, buf))
957 return NULL;
959 #endif
961 PyDict_SetItemString(sysdict, "stdin", sysin);
962 PyDict_SetItemString(sysdict, "stdout", sysout);
963 PyDict_SetItemString(sysdict, "stderr", syserr);
964 /* Make backup copies for cleanup */
965 PyDict_SetItemString(sysdict, "__stdin__", sysin);
966 PyDict_SetItemString(sysdict, "__stdout__", sysout);
967 PyDict_SetItemString(sysdict, "__stderr__", syserr);
968 PyDict_SetItemString(sysdict, "__displayhook__",
969 PyDict_GetItemString(sysdict, "displayhook"));
970 PyDict_SetItemString(sysdict, "__excepthook__",
971 PyDict_GetItemString(sysdict, "excepthook"));
972 Py_XDECREF(sysin);
973 Py_XDECREF(sysout);
974 Py_XDECREF(syserr);
975 PyDict_SetItemString(sysdict, "version",
976 v = PyString_FromString(Py_GetVersion()));
977 Py_XDECREF(v);
978 PyDict_SetItemString(sysdict, "hexversion",
979 v = PyInt_FromLong(PY_VERSION_HEX));
980 Py_XDECREF(v);
982 * These release level checks are mutually exclusive and cover
983 * the field, so don't get too fancy with the pre-processor!
985 #if PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_ALPHA
986 s = "alpha";
987 #elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_BETA
988 s = "beta";
989 #elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_GAMMA
990 s = "candidate";
991 #elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_FINAL
992 s = "final";
993 #endif
994 PyDict_SetItemString(sysdict, "version_info",
995 v = Py_BuildValue("iiisi", PY_MAJOR_VERSION,
996 PY_MINOR_VERSION,
997 PY_MICRO_VERSION, s,
998 PY_RELEASE_SERIAL));
999 Py_XDECREF(v);
1000 PyDict_SetItemString(sysdict, "api_version",
1001 v = PyInt_FromLong(PYTHON_API_VERSION));
1002 Py_XDECREF(v);
1003 PyDict_SetItemString(sysdict, "copyright",
1004 v = PyString_FromString(Py_GetCopyright()));
1005 Py_XDECREF(v);
1006 PyDict_SetItemString(sysdict, "platform",
1007 v = PyString_FromString(Py_GetPlatform()));
1008 Py_XDECREF(v);
1009 PyDict_SetItemString(sysdict, "executable",
1010 v = PyString_FromString(Py_GetProgramFullPath()));
1011 Py_XDECREF(v);
1012 PyDict_SetItemString(sysdict, "prefix",
1013 v = PyString_FromString(Py_GetPrefix()));
1014 Py_XDECREF(v);
1015 PyDict_SetItemString(sysdict, "exec_prefix",
1016 v = PyString_FromString(Py_GetExecPrefix()));
1017 Py_XDECREF(v);
1018 PyDict_SetItemString(sysdict, "maxint",
1019 v = PyInt_FromLong(PyInt_GetMax()));
1020 Py_XDECREF(v);
1021 #ifdef Py_USING_UNICODE
1022 PyDict_SetItemString(sysdict, "maxunicode",
1023 v = PyInt_FromLong(PyUnicode_GetMax()));
1024 Py_XDECREF(v);
1025 #endif
1026 PyDict_SetItemString(sysdict, "builtin_module_names",
1027 v = list_builtin_module_names());
1028 Py_XDECREF(v);
1030 /* Assumes that longs are at least 2 bytes long.
1031 Should be safe! */
1032 unsigned long number = 1;
1033 char *value;
1035 s = (char *) &number;
1036 if (s[0] == 0)
1037 value = "big";
1038 else
1039 value = "little";
1040 PyDict_SetItemString(sysdict, "byteorder",
1041 v = PyString_FromString(value));
1042 Py_XDECREF(v);
1044 #ifdef MS_COREDLL
1045 PyDict_SetItemString(sysdict, "dllhandle",
1046 v = PyLong_FromVoidPtr(PyWin_DLLhModule));
1047 Py_XDECREF(v);
1048 PyDict_SetItemString(sysdict, "winver",
1049 v = PyString_FromString(PyWin_DLLVersionString));
1050 Py_XDECREF(v);
1051 #endif
1052 if (warnoptions == NULL) {
1053 warnoptions = PyList_New(0);
1055 else {
1056 Py_INCREF(warnoptions);
1058 if (warnoptions != NULL) {
1059 PyDict_SetItemString(sysdict, "warnoptions", warnoptions);
1062 if (PyErr_Occurred())
1063 return NULL;
1064 return m;
1067 static PyObject *
1068 makepathobject(char *path, int delim)
1070 int i, n;
1071 char *p;
1072 PyObject *v, *w;
1074 n = 1;
1075 p = path;
1076 while ((p = strchr(p, delim)) != NULL) {
1077 n++;
1078 p++;
1080 v = PyList_New(n);
1081 if (v == NULL)
1082 return NULL;
1083 for (i = 0; ; i++) {
1084 p = strchr(path, delim);
1085 if (p == NULL)
1086 p = strchr(path, '\0'); /* End of string */
1087 w = PyString_FromStringAndSize(path, (int) (p - path));
1088 if (w == NULL) {
1089 Py_DECREF(v);
1090 return NULL;
1092 PyList_SetItem(v, i, w);
1093 if (*p == '\0')
1094 break;
1095 path = p+1;
1097 return v;
1100 void
1101 PySys_SetPath(char *path)
1103 PyObject *v;
1104 if ((v = makepathobject(path, DELIM)) == NULL)
1105 Py_FatalError("can't create sys.path");
1106 if (PySys_SetObject("path", v) != 0)
1107 Py_FatalError("can't assign sys.path");
1108 Py_DECREF(v);
1111 static PyObject *
1112 makeargvobject(int argc, char **argv)
1114 PyObject *av;
1115 if (argc <= 0 || argv == NULL) {
1116 /* Ensure at least one (empty) argument is seen */
1117 static char *empty_argv[1] = {""};
1118 argv = empty_argv;
1119 argc = 1;
1121 av = PyList_New(argc);
1122 if (av != NULL) {
1123 int i;
1124 for (i = 0; i < argc; i++) {
1125 #ifdef __VMS
1126 PyObject *v;
1128 /* argv[0] is the script pathname if known */
1129 if (i == 0) {
1130 char* fn = decc$translate_vms(argv[0]);
1131 if ((fn == (char *)0) || fn == (char *)-1)
1132 v = PyString_FromString(argv[0]);
1133 else
1134 v = PyString_FromString(
1135 decc$translate_vms(argv[0]));
1136 } else
1137 v = PyString_FromString(argv[i]);
1138 #else
1139 PyObject *v = PyString_FromString(argv[i]);
1140 #endif
1141 if (v == NULL) {
1142 Py_DECREF(av);
1143 av = NULL;
1144 break;
1146 PyList_SetItem(av, i, v);
1149 return av;
1152 void
1153 PySys_SetArgv(int argc, char **argv)
1155 #if defined(HAVE_REALPATH)
1156 char fullpath[MAXPATHLEN];
1157 #elif defined(MS_WINDOWS)
1158 char fullpath[MAX_PATH];
1159 #endif
1160 PyObject *av = makeargvobject(argc, argv);
1161 PyObject *path = PySys_GetObject("path");
1162 if (av == NULL)
1163 Py_FatalError("no mem for sys.argv");
1164 if (PySys_SetObject("argv", av) != 0)
1165 Py_FatalError("can't assign sys.argv");
1166 if (path != NULL) {
1167 char *argv0 = argv[0];
1168 char *p = NULL;
1169 int n = 0;
1170 PyObject *a;
1171 #ifdef HAVE_READLINK
1172 char link[MAXPATHLEN+1];
1173 char argv0copy[2*MAXPATHLEN+1];
1174 int nr = 0;
1175 if (argc > 0 && argv0 != NULL)
1176 nr = readlink(argv0, link, MAXPATHLEN);
1177 if (nr > 0) {
1178 /* It's a symlink */
1179 link[nr] = '\0';
1180 if (link[0] == SEP)
1181 argv0 = link; /* Link to absolute path */
1182 else if (strchr(link, SEP) == NULL)
1183 ; /* Link without path */
1184 else {
1185 /* Must join(dirname(argv0), link) */
1186 char *q = strrchr(argv0, SEP);
1187 if (q == NULL)
1188 argv0 = link; /* argv0 without path */
1189 else {
1190 /* Must make a copy */
1191 strcpy(argv0copy, argv0);
1192 q = strrchr(argv0copy, SEP);
1193 strcpy(q+1, link);
1194 argv0 = argv0copy;
1198 #endif /* HAVE_READLINK */
1199 #if SEP == '\\' /* Special case for MS filename syntax */
1200 if (argc > 0 && argv0 != NULL) {
1201 char *q;
1202 #ifdef MS_WINDOWS
1203 char *ptemp;
1204 if (GetFullPathName(argv0,
1205 sizeof(fullpath),
1206 fullpath,
1207 &ptemp)) {
1208 argv0 = fullpath;
1210 #endif
1211 p = strrchr(argv0, SEP);
1212 /* Test for alternate separator */
1213 q = strrchr(p ? p : argv0, '/');
1214 if (q != NULL)
1215 p = q;
1216 if (p != NULL) {
1217 n = p + 1 - argv0;
1218 if (n > 1 && p[-1] != ':')
1219 n--; /* Drop trailing separator */
1222 #else /* All other filename syntaxes */
1223 if (argc > 0 && argv0 != NULL) {
1224 #if defined(HAVE_REALPATH)
1225 if (realpath(argv0, fullpath)) {
1226 argv0 = fullpath;
1228 #endif
1229 p = strrchr(argv0, SEP);
1231 if (p != NULL) {
1232 #ifndef RISCOS
1233 n = p + 1 - argv0;
1234 #else /* don't include trailing separator */
1235 n = p - argv0;
1236 #endif /* RISCOS */
1237 #if SEP == '/' /* Special case for Unix filename syntax */
1238 if (n > 1)
1239 n--; /* Drop trailing separator */
1240 #endif /* Unix */
1242 #endif /* All others */
1243 a = PyString_FromStringAndSize(argv0, n);
1244 if (a == NULL)
1245 Py_FatalError("no mem for sys.path insertion");
1246 if (PyList_Insert(path, 0, a) < 0)
1247 Py_FatalError("sys.path.insert(0) failed");
1248 Py_DECREF(a);
1250 Py_DECREF(av);
1254 /* APIs to write to sys.stdout or sys.stderr using a printf-like interface.
1255 Adapted from code submitted by Just van Rossum.
1257 PySys_WriteStdout(format, ...)
1258 PySys_WriteStderr(format, ...)
1260 The first function writes to sys.stdout; the second to sys.stderr. When
1261 there is a problem, they write to the real (C level) stdout or stderr;
1262 no exceptions are raised.
1264 Both take a printf-style format string as their first argument followed
1265 by a variable length argument list determined by the format string.
1267 *** WARNING ***
1269 The format should limit the total size of the formatted output string to
1270 1000 bytes. In particular, this means that no unrestricted "%s" formats
1271 should occur; these should be limited using "%.<N>s where <N> is a
1272 decimal number calculated so that <N> plus the maximum size of other
1273 formatted text does not exceed 1000 bytes. Also watch out for "%f",
1274 which can print hundreds of digits for very large numbers.
1278 static void
1279 mywrite(char *name, FILE *fp, const char *format, va_list va)
1281 PyObject *file;
1282 PyObject *error_type, *error_value, *error_traceback;
1284 PyErr_Fetch(&error_type, &error_value, &error_traceback);
1285 file = PySys_GetObject(name);
1286 if (file == NULL || PyFile_AsFile(file) == fp)
1287 vfprintf(fp, format, va);
1288 else {
1289 char buffer[1001];
1290 const int written = PyOS_vsnprintf(buffer, sizeof(buffer),
1291 format, va);
1292 if (PyFile_WriteString(buffer, file) != 0) {
1293 PyErr_Clear();
1294 fputs(buffer, fp);
1296 if (written < 0 || written >= sizeof(buffer)) {
1297 const char *truncated = "... truncated";
1298 if (PyFile_WriteString(truncated, file) != 0) {
1299 PyErr_Clear();
1300 fputs(truncated, fp);
1304 PyErr_Restore(error_type, error_value, error_traceback);
1307 void
1308 PySys_WriteStdout(const char *format, ...)
1310 va_list va;
1312 va_start(va, format);
1313 mywrite("stdout", stdout, format, va);
1314 va_end(va);
1317 void
1318 PySys_WriteStderr(const char *format, ...)
1320 va_list va;
1322 va_start(va, format);
1323 mywrite("stderr", stderr, format, va);
1324 va_end(va);