blob: 6a7e91432c0b5178f380201ef806f72d66b712df [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* System module */
3
4/*
5Various bits of information used by the interpreter are collected in
6module 'sys'.
Guido van Rossum3f5da241990-12-20 15:06:42 +00007Function member:
Guido van Rossumcc8914f1995-03-20 15:09:40 +00008- exit(sts): raise SystemExit
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00009Data members:
10- stdin, stdout, stderr: standard file objects
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000011- modules: the table of modules (dictionary)
Guido van Rossum3f5da241990-12-20 15:06:42 +000012- path: module search path (list of strings)
13- argv: script arguments (list of strings)
14- ps1, ps2: optional primary and secondary prompts (strings)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000015*/
16
Guido van Rossum65bf9f21997-04-29 18:33:38 +000017#include "Python.h"
Christian Heimesd32ed6f2008-01-14 18:49:24 +000018#include "structseq.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000019#include "code.h"
Barry Warsawb6a54d22000-12-06 21:47:46 +000020#include "frameobject.h"
Guido van Rossuma12fe4e2003-04-09 19:06:21 +000021#include "eval.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000022
Guido van Rossume2437a11992-03-23 18:20:18 +000023#include "osdefs.h"
Guido van Rossum3f5da241990-12-20 15:06:42 +000024
Mark Hammond8696ebc2002-10-08 02:44:31 +000025#ifdef MS_WINDOWS
26#define WIN32_LEAN_AND_MEAN
Amaury Forgeot d'Arc06cfe952007-11-10 13:55:44 +000027#include <windows.h>
Mark Hammond8696ebc2002-10-08 02:44:31 +000028#endif /* MS_WINDOWS */
29
Guido van Rossum9b38a141996-09-11 23:12:24 +000030#ifdef MS_COREDLL
Guido van Rossumc606fe11996-04-09 02:37:57 +000031extern void *PyWin_DLLhModule;
Guido van Rossum6c1e5f21997-09-29 23:34:23 +000032/* A string loaded from the DLL at startup: */
33extern const char *PyWin_DLLVersionString;
Guido van Rossumc606fe11996-04-09 02:37:57 +000034#endif
35
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +000036#ifdef __VMS
37#include <unixlib.h>
38#endif
39
Martin v. Löwis5467d4c2003-05-10 07:10:12 +000040#ifdef HAVE_LANGINFO_H
41#include <locale.h>
42#include <langinfo.h>
43#endif
44
Guido van Rossum65bf9f21997-04-29 18:33:38 +000045PyObject *
Neal Norwitzf3081322007-08-25 00:32:45 +000046PySys_GetObject(const char *name)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000047{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000048 PyThreadState *tstate = PyThreadState_GET();
49 PyObject *sd = tstate->interp->sysdict;
50 if (sd == NULL)
51 return NULL;
52 return PyDict_GetItemString(sd, name);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000053}
54
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000055int
Neal Norwitzf3081322007-08-25 00:32:45 +000056PySys_SetObject(const char *name, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000057{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000058 PyThreadState *tstate = PyThreadState_GET();
59 PyObject *sd = tstate->interp->sysdict;
60 if (v == NULL) {
61 if (PyDict_GetItemString(sd, name) == NULL)
62 return 0;
63 else
64 return PyDict_DelItemString(sd, name);
65 }
66 else
67 return PyDict_SetItemString(sd, name, v);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000068}
69
Guido van Rossum65bf9f21997-04-29 18:33:38 +000070static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +000071sys_displayhook(PyObject *self, PyObject *o)
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +000072{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000073 PyObject *outf;
74 PyInterpreterState *interp = PyThreadState_GET()->interp;
75 PyObject *modules = interp->modules;
76 PyObject *builtins = PyDict_GetItemString(modules, "builtins");
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +000077
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000078 if (builtins == NULL) {
79 PyErr_SetString(PyExc_RuntimeError, "lost builtins module");
80 return NULL;
81 }
Moshe Zadka03897ea2001-07-23 13:32:43 +000082
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +000083 /* Print value except if None */
84 /* After printing, also assign to '_' */
85 /* Before, set '_' to None to avoid recursion */
86 if (o == Py_None) {
87 Py_INCREF(Py_None);
88 return Py_None;
89 }
90 if (PyObject_SetAttrString(builtins, "_", Py_None) != 0)
91 return NULL;
92 outf = PySys_GetObject("stdout");
93 if (outf == NULL || outf == Py_None) {
94 PyErr_SetString(PyExc_RuntimeError, "lost sys.stdout");
95 return NULL;
96 }
97 if (PyFile_WriteObject(o, outf, 0) != 0)
98 return NULL;
99 if (PyFile_WriteString("\n", outf) != 0)
100 return NULL;
101 if (PyObject_SetAttrString(builtins, "_", o) != 0)
102 return NULL;
103 Py_INCREF(Py_None);
104 return Py_None;
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000105}
106
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000107PyDoc_STRVAR(displayhook_doc,
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000108"displayhook(object) -> None\n"
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000109"\n"
Florent Xiclunad7494de2010-03-03 11:55:53 +0000110"Print an object to sys.stdout and also save it in builtins._\n"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000111);
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000112
113static PyObject *
114sys_excepthook(PyObject* self, PyObject* args)
115{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000116 PyObject *exc, *value, *tb;
117 if (!PyArg_UnpackTuple(args, "excepthook", 3, 3, &exc, &value, &tb))
118 return NULL;
119 PyErr_Display(exc, value, tb);
120 Py_INCREF(Py_None);
121 return Py_None;
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000122}
123
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000124PyDoc_STRVAR(excepthook_doc,
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000125"excepthook(exctype, value, traceback) -> None\n"
126"\n"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000127"Handle an exception by displaying it with a traceback on sys.stderr.\n"
128);
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000129
130static PyObject *
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000131sys_exc_info(PyObject *self, PyObject *noargs)
Guido van Rossuma027efa1997-05-05 20:56:21 +0000132{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000133 PyThreadState *tstate;
134 tstate = PyThreadState_GET();
135 return Py_BuildValue(
136 "(OOO)",
137 tstate->exc_type != NULL ? tstate->exc_type : Py_None,
138 tstate->exc_value != NULL ? tstate->exc_value : Py_None,
139 tstate->exc_traceback != NULL ?
140 tstate->exc_traceback : Py_None);
Guido van Rossuma027efa1997-05-05 20:56:21 +0000141}
142
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000143PyDoc_STRVAR(exc_info_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000144"exc_info() -> (type, value, traceback)\n\
145\n\
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000146Return information about the most recent exception caught by an except\n\
147clause in the current stack frame or in an older stack frame."
148);
149
150static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000151sys_exit(PyObject *self, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000152{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000153 PyObject *exit_code = 0;
154 if (!PyArg_UnpackTuple(args, "exit", 0, 1, &exit_code))
155 return NULL;
156 /* Raise SystemExit so callers may catch it or clean up. */
157 PyErr_SetObject(PyExc_SystemExit, exit_code);
158 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000159}
160
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000161PyDoc_STRVAR(exit_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000162"exit([status])\n\
163\n\
164Exit the interpreter by raising SystemExit(status).\n\
165If the status is omitted or None, it defaults to zero (i.e., success).\n\
Neil Schemenauer0f2103f2002-03-23 20:46:35 +0000166If the status is numeric, it will be used as the system exit status.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000167If it is another kind of object, it will be printed and the system\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000168exit status will be one (i.e., failure)."
169);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000170
Martin v. Löwis107b7da2001-11-09 20:59:39 +0000171
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000172static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000173sys_getdefaultencoding(PyObject *self)
Fred Drake8b4d01d2000-05-09 19:57:01 +0000174{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000175 return PyUnicode_FromString(PyUnicode_GetDefaultEncoding());
Fred Drake8b4d01d2000-05-09 19:57:01 +0000176}
177
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000178PyDoc_STRVAR(getdefaultencoding_doc,
Marc-André Lemburg99964b82000-06-07 09:13:41 +0000179"getdefaultencoding() -> string\n\
Fred Drake8b4d01d2000-05-09 19:57:01 +0000180\n\
181Return the current default string encoding used by the Unicode \n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000182implementation."
183);
Fred Drake8b4d01d2000-05-09 19:57:01 +0000184
185static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000186sys_setdefaultencoding(PyObject *self, PyObject *args)
Fred Drake8b4d01d2000-05-09 19:57:01 +0000187{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000188 char *encoding;
189 if (!PyArg_ParseTuple(args, "s:setdefaultencoding", &encoding))
190 return NULL;
191 if (PyUnicode_SetDefaultEncoding(encoding))
192 return NULL;
193 Py_INCREF(Py_None);
194 return Py_None;
Fred Drake8b4d01d2000-05-09 19:57:01 +0000195}
196
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000197PyDoc_STRVAR(setdefaultencoding_doc,
Marc-André Lemburg99964b82000-06-07 09:13:41 +0000198"setdefaultencoding(encoding)\n\
Fred Drake8b4d01d2000-05-09 19:57:01 +0000199\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000200Set the current default string encoding used by the Unicode implementation."
201);
Fred Drake8b4d01d2000-05-09 19:57:01 +0000202
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000203static PyObject *
204sys_getfilesystemencoding(PyObject *self)
205{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000206 if (Py_FileSystemDefaultEncoding)
207 return PyUnicode_FromString(Py_FileSystemDefaultEncoding);
208 Py_INCREF(Py_None);
209 return Py_None;
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000210}
211
212PyDoc_STRVAR(getfilesystemencoding_doc,
213"getfilesystemencoding() -> string\n\
214\n\
215Return the encoding used to convert Unicode filenames in\n\
216operating system filenames."
217);
218
Martin v. Löwis04dc25c2008-10-03 16:09:28 +0000219static PyObject *
220sys_setfilesystemencoding(PyObject *self, PyObject *args)
221{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000222 PyObject *new_encoding;
223 if (!PyArg_ParseTuple(args, "U:setfilesystemencoding", &new_encoding))
224 return NULL;
225 if (_Py_SetFileSystemEncoding(new_encoding))
226 return NULL;
227 Py_INCREF(Py_None);
228 return Py_None;
Martin v. Löwis04dc25c2008-10-03 16:09:28 +0000229}
Martin v. Löwis339d0f72001-08-17 18:39:25 +0000230
Martin v. Löwis04dc25c2008-10-03 16:09:28 +0000231PyDoc_STRVAR(setfilesystemencoding_doc,
232"setfilesystemencoding(string) -> None\n\
233\n\
234Set the encoding used to convert Unicode filenames in\n\
235operating system filenames."
236);
Georg Brandl66a796e2006-12-19 20:50:34 +0000237
238static PyObject *
239sys_intern(PyObject *self, PyObject *args)
240{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000241 PyObject *s;
242 if (!PyArg_ParseTuple(args, "U:intern", &s))
243 return NULL;
244 if (PyUnicode_CheckExact(s)) {
245 Py_INCREF(s);
246 PyUnicode_InternInPlace(&s);
247 return s;
248 }
249 else {
250 PyErr_Format(PyExc_TypeError,
251 "can't intern %.400s", s->ob_type->tp_name);
252 return NULL;
253 }
Georg Brandl66a796e2006-12-19 20:50:34 +0000254}
255
256PyDoc_STRVAR(intern_doc,
257"intern(string) -> string\n\
258\n\
259``Intern'' the given string. This enters the string in the (global)\n\
260table of interned strings whose purpose is to speed up dictionary lookups.\n\
261Return the string itself or the previously interned string object with the\n\
262same value.");
263
264
Fred Drake5755ce62001-06-27 19:19:46 +0000265/*
266 * Cached interned string objects used for calling the profile and
267 * trace functions. Initialized by trace_init().
268 */
Nicholas Bastinc69ebe82004-03-24 21:57:10 +0000269static PyObject *whatstrings[7] = {NULL, NULL, NULL, NULL, NULL, NULL, NULL};
Fred Drake5755ce62001-06-27 19:19:46 +0000270
271static int
272trace_init(void)
273{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000274 static char *whatnames[7] = {"call", "exception", "line", "return",
275 "c_call", "c_exception", "c_return"};
276 PyObject *name;
277 int i;
278 for (i = 0; i < 7; ++i) {
279 if (whatstrings[i] == NULL) {
280 name = PyUnicode_InternFromString(whatnames[i]);
281 if (name == NULL)
282 return -1;
283 whatstrings[i] = name;
284 }
285 }
286 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000287}
288
289
290static PyObject *
291call_trampoline(PyThreadState *tstate, PyObject* callback,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000292 PyFrameObject *frame, int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000293{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000294 PyObject *args = PyTuple_New(3);
295 PyObject *whatstr;
296 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000297
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000298 if (args == NULL)
299 return NULL;
300 Py_INCREF(frame);
301 whatstr = whatstrings[what];
302 Py_INCREF(whatstr);
303 if (arg == NULL)
304 arg = Py_None;
305 Py_INCREF(arg);
306 PyTuple_SET_ITEM(args, 0, (PyObject *)frame);
307 PyTuple_SET_ITEM(args, 1, whatstr);
308 PyTuple_SET_ITEM(args, 2, arg);
Fred Drake5755ce62001-06-27 19:19:46 +0000309
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000310 /* call the Python-level function */
311 PyFrame_FastToLocals(frame);
312 result = PyEval_CallObject(callback, args);
313 PyFrame_LocalsToFast(frame, 1);
314 if (result == NULL)
315 PyTraceBack_Here(frame);
Fred Drake5755ce62001-06-27 19:19:46 +0000316
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000317 /* cleanup */
318 Py_DECREF(args);
319 return result;
Fred Drake5755ce62001-06-27 19:19:46 +0000320}
321
322static int
323profile_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000324 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000325{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000326 PyThreadState *tstate = frame->f_tstate;
327 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000328
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000329 if (arg == NULL)
330 arg = Py_None;
331 result = call_trampoline(tstate, self, frame, what, arg);
332 if (result == NULL) {
333 PyEval_SetProfile(NULL, NULL);
334 return -1;
335 }
336 Py_DECREF(result);
337 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000338}
339
340static int
341trace_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000342 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000343{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000344 PyThreadState *tstate = frame->f_tstate;
345 PyObject *callback;
346 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000347
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000348 if (what == PyTrace_CALL)
349 callback = self;
350 else
351 callback = frame->f_trace;
352 if (callback == NULL)
353 return 0;
354 result = call_trampoline(tstate, callback, frame, what, arg);
355 if (result == NULL) {
356 PyEval_SetTrace(NULL, NULL);
357 Py_XDECREF(frame->f_trace);
358 frame->f_trace = NULL;
359 return -1;
360 }
361 if (result != Py_None) {
362 PyObject *temp = frame->f_trace;
363 frame->f_trace = NULL;
364 Py_XDECREF(temp);
365 frame->f_trace = result;
366 }
367 else {
368 Py_DECREF(result);
369 }
370 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000371}
Fred Draked0838392001-06-16 21:02:31 +0000372
Fred Drake8b4d01d2000-05-09 19:57:01 +0000373static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000374sys_settrace(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000375{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000376 if (trace_init() == -1)
377 return NULL;
378 if (args == Py_None)
379 PyEval_SetTrace(NULL, NULL);
380 else
381 PyEval_SetTrace(trace_trampoline, args);
382 Py_INCREF(Py_None);
383 return Py_None;
Guido van Rossume2437a11992-03-23 18:20:18 +0000384}
385
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000386PyDoc_STRVAR(settrace_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000387"settrace(function)\n\
388\n\
389Set the global debug tracing function. It will be called on each\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000390function call. See the debugger chapter in the library manual."
391);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000392
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000393static PyObject *
Christian Heimes9bd667a2008-01-20 15:14:11 +0000394sys_gettrace(PyObject *self, PyObject *args)
395{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000396 PyThreadState *tstate = PyThreadState_GET();
397 PyObject *temp = tstate->c_traceobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000398
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000399 if (temp == NULL)
400 temp = Py_None;
401 Py_INCREF(temp);
402 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000403}
404
405PyDoc_STRVAR(gettrace_doc,
406"gettrace()\n\
407\n\
408Return the global debug tracing function set with sys.settrace.\n\
409See the debugger chapter in the library manual."
410);
411
412static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000413sys_setprofile(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000414{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000415 if (trace_init() == -1)
416 return NULL;
417 if (args == Py_None)
418 PyEval_SetProfile(NULL, NULL);
419 else
420 PyEval_SetProfile(profile_trampoline, args);
421 Py_INCREF(Py_None);
422 return Py_None;
Guido van Rossume2437a11992-03-23 18:20:18 +0000423}
424
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000425PyDoc_STRVAR(setprofile_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000426"setprofile(function)\n\
427\n\
428Set the profiling function. It will be called on each function call\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000429and return. See the profiler chapter in the library manual."
430);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000431
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000432static PyObject *
Christian Heimes9bd667a2008-01-20 15:14:11 +0000433sys_getprofile(PyObject *self, PyObject *args)
434{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000435 PyThreadState *tstate = PyThreadState_GET();
436 PyObject *temp = tstate->c_profileobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000437
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000438 if (temp == NULL)
439 temp = Py_None;
440 Py_INCREF(temp);
441 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000442}
443
444PyDoc_STRVAR(getprofile_doc,
445"getprofile()\n\
446\n\
447Return the profiling function set with sys.setprofile.\n\
448See the profiler chapter in the library manual."
449);
450
451static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000452sys_setcheckinterval(PyObject *self, PyObject *args)
Guido van Rossuma0d7a231995-01-09 17:46:13 +0000453{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000454 if (!PyArg_ParseTuple(args, "i:setcheckinterval", &_Py_CheckInterval))
455 return NULL;
456 Py_INCREF(Py_None);
457 return Py_None;
Guido van Rossuma0d7a231995-01-09 17:46:13 +0000458}
459
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000460PyDoc_STRVAR(setcheckinterval_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000461"setcheckinterval(n)\n\
462\n\
463Tell the Python interpreter to check for asynchronous events every\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000464n instructions. This also affects how often thread switches occur."
465);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000466
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000467static PyObject *
Tim Peterse5e065b2003-07-06 18:36:54 +0000468sys_getcheckinterval(PyObject *self, PyObject *args)
469{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000470 return PyLong_FromLong(_Py_CheckInterval);
Tim Peterse5e065b2003-07-06 18:36:54 +0000471}
472
473PyDoc_STRVAR(getcheckinterval_doc,
474"getcheckinterval() -> current check interval; see setcheckinterval()."
475);
476
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000477#ifdef WITH_TSC
478static PyObject *
479sys_settscdump(PyObject *self, PyObject *args)
480{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000481 int bool;
482 PyThreadState *tstate = PyThreadState_Get();
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000483
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000484 if (!PyArg_ParseTuple(args, "i:settscdump", &bool))
485 return NULL;
486 if (bool)
487 tstate->interp->tscdump = 1;
488 else
489 tstate->interp->tscdump = 0;
490 Py_INCREF(Py_None);
491 return Py_None;
Tim Peters216b78b2006-01-06 02:40:53 +0000492
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000493}
494
Tim Peters216b78b2006-01-06 02:40:53 +0000495PyDoc_STRVAR(settscdump_doc,
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000496"settscdump(bool)\n\
497\n\
498If true, tell the Python interpreter to dump VM measurements to\n\
499stderr. If false, turn off dump. The measurements are based on the\n\
Michael W. Hudson800ba232004-08-12 18:19:17 +0000500processor's time-stamp counter."
Tim Peters216b78b2006-01-06 02:40:53 +0000501);
Neal Norwitz0f5aed42004-06-13 20:32:17 +0000502#endif /* TSC */
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000503
Tim Peterse5e065b2003-07-06 18:36:54 +0000504static PyObject *
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000505sys_setrecursionlimit(PyObject *self, PyObject *args)
506{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000507 int new_limit;
508 if (!PyArg_ParseTuple(args, "i:setrecursionlimit", &new_limit))
509 return NULL;
510 if (new_limit <= 0) {
511 PyErr_SetString(PyExc_ValueError,
512 "recursion limit must be positive");
513 return NULL;
514 }
515 Py_SetRecursionLimit(new_limit);
516 Py_INCREF(Py_None);
517 return Py_None;
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000518}
519
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000520PyDoc_STRVAR(setrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000521"setrecursionlimit(n)\n\
522\n\
523Set the maximum depth of the Python interpreter stack to n. This\n\
524limit prevents infinite recursion from causing an overflow of the C\n\
525stack and crashing Python. The highest possible limit is platform-\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000526dependent."
527);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000528
529static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000530sys_getrecursionlimit(PyObject *self)
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000531{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000532 return PyLong_FromLong(Py_GetRecursionLimit());
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000533}
534
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000535PyDoc_STRVAR(getrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000536"getrecursionlimit()\n\
537\n\
538Return the current value of the recursion limit, the maximum depth\n\
539of the Python interpreter stack. This limit prevents infinite\n\
Jack Jansene739a0d2002-06-26 20:39:20 +0000540recursion from causing an overflow of the C stack and crashing Python."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000541);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000542
Mark Hammond8696ebc2002-10-08 02:44:31 +0000543#ifdef MS_WINDOWS
544PyDoc_STRVAR(getwindowsversion_doc,
545"getwindowsversion()\n\
546\n\
547Return information about the running version of Windows.\n\
548The result is a tuple of (major, minor, build, platform, text)\n\
549All elements are numbers, except text which is a string.\n\
550Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP\n\
551"
552);
553
554static PyObject *
555sys_getwindowsversion(PyObject *self)
556{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000557 OSVERSIONINFO ver;
558 ver.dwOSVersionInfoSize = sizeof(ver);
559 if (!GetVersionEx(&ver))
560 return PyErr_SetFromWindowsErr(0);
561 return Py_BuildValue("HHHHs",
562 ver.dwMajorVersion,
563 ver.dwMinorVersion,
564 ver.dwBuildNumber,
565 ver.dwPlatformId,
566 ver.szCSDVersion);
Mark Hammond8696ebc2002-10-08 02:44:31 +0000567}
568
569#endif /* MS_WINDOWS */
570
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000571#ifdef HAVE_DLOPEN
572static PyObject *
573sys_setdlopenflags(PyObject *self, PyObject *args)
574{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000575 int new_val;
576 PyThreadState *tstate = PyThreadState_GET();
577 if (!PyArg_ParseTuple(args, "i:setdlopenflags", &new_val))
578 return NULL;
579 if (!tstate)
580 return NULL;
581 tstate->interp->dlopenflags = new_val;
582 Py_INCREF(Py_None);
583 return Py_None;
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000584}
585
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000586PyDoc_STRVAR(setdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000587"setdlopenflags(n) -> None\n\
588\n\
Georg Brandlbcc484e2009-08-13 11:51:54 +0000589Set the flags used by the interpreter for dlopen calls, such as when the\n\
590interpreter loads extension modules. Among other things, this will enable\n\
591a lazy resolving of symbols when importing a module, if called as\n\
592sys.setdlopenflags(0). To share symbols across extension modules, call as\n\
593sys.setdlopenflags(ctypes.RTLD_GLOBAL). Symbolic names for the flag modules\n\
594can be either found in the ctypes module, or in the DLFCN module. If DLFCN\n\
595is not available, it can be generated from /usr/include/dlfcn.h using the\n\
596h2py script.");
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000597
598static PyObject *
599sys_getdlopenflags(PyObject *self, PyObject *args)
600{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000601 PyThreadState *tstate = PyThreadState_GET();
602 if (!tstate)
603 return NULL;
604 return PyLong_FromLong(tstate->interp->dlopenflags);
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000605}
606
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000607PyDoc_STRVAR(getdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000608"getdlopenflags() -> int\n\
609\n\
Georg Brandlbcc484e2009-08-13 11:51:54 +0000610Return the current value of the flags that are used for dlopen calls.\n\
611The flag constants are defined in the ctypes and DLFCN modules.");
612
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000613#endif /* HAVE_DLOPEN */
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000614
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000615#ifdef USE_MALLOPT
616/* Link with -lmalloc (or -lmpc) on an SGI */
617#include <malloc.h>
618
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000619static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000620sys_mdebug(PyObject *self, PyObject *args)
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000621{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000622 int flag;
623 if (!PyArg_ParseTuple(args, "i:mdebug", &flag))
624 return NULL;
625 mallopt(M_DEBUG, flag);
626 Py_INCREF(Py_None);
627 return Py_None;
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000628}
629#endif /* USE_MALLOPT */
630
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000631static PyObject *
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000632sys_getsizeof(PyObject *self, PyObject *args, PyObject *kwds)
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000633{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000634 PyObject *res = NULL;
635 static PyObject *str__sizeof__ = NULL, *gc_head_size = NULL;
636 static char *kwlist[] = {"object", "default", 0};
637 PyObject *o, *dflt = NULL;
638 PyObject *method;
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000639
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000640 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|O:getsizeof",
641 kwlist, &o, &dflt))
642 return NULL;
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000643
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000644 /* Initialize static variable for GC head size */
645 if (gc_head_size == NULL) {
646 gc_head_size = PyLong_FromSsize_t(sizeof(PyGC_Head));
647 if (gc_head_size == NULL)
648 return NULL;
649 }
Benjamin Petersona5758c02009-05-09 18:15:04 +0000650
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000651 /* Make sure the type is initialized. float gets initialized late */
652 if (PyType_Ready(Py_TYPE(o)) < 0)
653 return NULL;
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000654
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000655 method = _PyObject_LookupSpecial(o, "__sizeof__",
656 &str__sizeof__);
657 if (method == NULL) {
658 if (!PyErr_Occurred())
659 PyErr_Format(PyExc_TypeError,
660 "Type %.100s doesn't define __sizeof__",
661 Py_TYPE(o)->tp_name);
662 }
663 else {
664 res = PyObject_CallFunctionObjArgs(method, NULL);
665 Py_DECREF(method);
666 }
667
668 /* Has a default value been given */
669 if ((res == NULL) && (dflt != NULL) &&
670 PyErr_ExceptionMatches(PyExc_TypeError))
671 {
672 PyErr_Clear();
673 Py_INCREF(dflt);
674 return dflt;
675 }
676 else if (res == NULL)
677 return res;
678
679 /* add gc_head size */
680 if (PyObject_IS_GC(o)) {
681 PyObject *tmp = res;
682 res = PyNumber_Add(tmp, gc_head_size);
683 Py_DECREF(tmp);
684 }
685 return res;
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000686}
687
688PyDoc_STRVAR(getsizeof_doc,
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000689"getsizeof(object, default) -> int\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000690\n\
691Return the size of object in bytes.");
692
693static PyObject *
Fred Drakea7688822001-10-24 20:47:48 +0000694sys_getrefcount(PyObject *self, PyObject *arg)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000695{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000696 return PyLong_FromSsize_t(arg->ob_refcnt);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000697}
698
Tim Peters4be93d02002-07-07 19:59:50 +0000699#ifdef Py_REF_DEBUG
Mark Hammond440d8982000-06-20 08:12:48 +0000700static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000701sys_gettotalrefcount(PyObject *self)
Mark Hammond440d8982000-06-20 08:12:48 +0000702{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000703 return PyLong_FromSsize_t(_Py_GetRefTotal());
Mark Hammond440d8982000-06-20 08:12:48 +0000704}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000705#endif /* Py_REF_DEBUG */
Mark Hammond440d8982000-06-20 08:12:48 +0000706
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000707PyDoc_STRVAR(getrefcount_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000708"getrefcount(object) -> integer\n\
709\n\
Fred Drakeba3ff1b2002-06-20 21:36:19 +0000710Return the reference count of object. The count returned is generally\n\
711one higher than you might expect, because it includes the (temporary)\n\
712reference as an argument to getrefcount()."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000713);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000714
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000715#ifdef COUNT_ALLOCS
716static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000717sys_getcounts(PyObject *self)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000718{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000719 extern PyObject *get_counts(void);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000720
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000721 return get_counts();
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000722}
723#endif
724
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000725PyDoc_STRVAR(getframe_doc,
Barry Warsawb6a54d22000-12-06 21:47:46 +0000726"_getframe([depth]) -> frameobject\n\
727\n\
728Return a frame object from the call stack. If optional integer depth is\n\
729given, return the frame object that many calls below the top of the stack.\n\
730If that is deeper than the call stack, ValueError is raised. The default\n\
731for depth is zero, returning the frame at the top of the call stack.\n\
732\n\
733This function should be used for internal and specialized\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000734purposes only."
735);
Barry Warsawb6a54d22000-12-06 21:47:46 +0000736
737static PyObject *
738sys_getframe(PyObject *self, PyObject *args)
739{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000740 PyFrameObject *f = PyThreadState_GET()->frame;
741 int depth = -1;
Barry Warsawb6a54d22000-12-06 21:47:46 +0000742
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000743 if (!PyArg_ParseTuple(args, "|i:_getframe", &depth))
744 return NULL;
Barry Warsawb6a54d22000-12-06 21:47:46 +0000745
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000746 while (depth > 0 && f != NULL) {
747 f = f->f_back;
748 --depth;
749 }
750 if (f == NULL) {
751 PyErr_SetString(PyExc_ValueError,
752 "call stack is not deep enough");
753 return NULL;
754 }
755 Py_INCREF(f);
756 return (PyObject*)f;
Barry Warsawb6a54d22000-12-06 21:47:46 +0000757}
758
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000759PyDoc_STRVAR(current_frames_doc,
760"_current_frames() -> dictionary\n\
761\n\
762Return a dictionary mapping each current thread T's thread id to T's\n\
763current stack frame.\n\
764\n\
765This function should be used for specialized purposes only."
766);
767
768static PyObject *
769sys_current_frames(PyObject *self, PyObject *noargs)
770{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000771 return _PyThread_CurrentFrames();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000772}
773
Guido van Rossuma12fe4e2003-04-09 19:06:21 +0000774PyDoc_STRVAR(call_tracing_doc,
775"call_tracing(func, args) -> object\n\
776\n\
777Call func(*args), while tracing is enabled. The tracing state is\n\
778saved, and restored afterwards. This is intended to be called from\n\
779a debugger from a checkpoint, to recursively debug some other code."
780);
781
782static PyObject *
783sys_call_tracing(PyObject *self, PyObject *args)
784{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000785 PyObject *func, *funcargs;
786 if (!PyArg_ParseTuple(args, "OO!:call_tracing", &func, &PyTuple_Type, &funcargs))
787 return NULL;
788 return _PyEval_CallTracing(func, funcargs);
Guido van Rossuma12fe4e2003-04-09 19:06:21 +0000789}
790
Jeremy Hylton985eba52003-02-05 23:13:00 +0000791PyDoc_STRVAR(callstats_doc,
792"callstats() -> tuple of integers\n\
793\n\
794Return a tuple of function call statistics, if CALL_PROFILE was defined\n\
795when Python was built. Otherwise, return None.\n\
796\n\
797When enabled, this function returns detailed, implementation-specific\n\
798details about the number of function calls executed. The return value is\n\
799a 11-tuple where the entries in the tuple are counts of:\n\
8000. all function calls\n\
8011. calls to PyFunction_Type objects\n\
8022. PyFunction calls that do not create an argument tuple\n\
8033. PyFunction calls that do not create an argument tuple\n\
804 and bypass PyEval_EvalCodeEx()\n\
8054. PyMethod calls\n\
8065. PyMethod calls on bound methods\n\
8076. PyType calls\n\
8087. PyCFunction calls\n\
8098. generator calls\n\
8109. All other calls\n\
81110. Number of stack pops performed by call_function()"
812);
Barry Warsawb6a54d22000-12-06 21:47:46 +0000813
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000814#ifdef __cplusplus
815extern "C" {
816#endif
817
Guido van Rossum7f3f2c11996-05-23 22:45:41 +0000818#ifdef Py_TRACE_REFS
Guido van Rossumded690f1996-05-24 20:48:31 +0000819/* Defined in objects.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +0000820extern PyObject *_Py_GetObjects(PyObject *, PyObject *);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000821#endif
Guido van Rossumded690f1996-05-24 20:48:31 +0000822
Guido van Rossum43f1b8d1997-01-24 04:07:45 +0000823#ifdef DYNAMIC_EXECUTION_PROFILE
824/* Defined in ceval.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +0000825extern PyObject *_Py_GetDXProfile(PyObject *, PyObject *);
Guido van Rossum43f1b8d1997-01-24 04:07:45 +0000826#endif
827
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000828#ifdef __cplusplus
829}
830#endif
831
Christian Heimes15ebc882008-02-04 18:48:49 +0000832static PyObject *
833sys_clear_type_cache(PyObject* self, PyObject* args)
834{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000835 PyType_ClearCache();
836 Py_RETURN_NONE;
Christian Heimes15ebc882008-02-04 18:48:49 +0000837}
838
839PyDoc_STRVAR(sys_clear_type_cache__doc__,
840"_clear_type_cache() -> None\n\
841Clear the internal type lookup cache.");
842
843
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000844static PyMethodDef sys_methods[] = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000845 /* Might as well keep this in alphabetic order */
846 {"callstats", (PyCFunction)PyEval_GetCallStats, METH_NOARGS,
847 callstats_doc},
848 {"_clear_type_cache", sys_clear_type_cache, METH_NOARGS,
849 sys_clear_type_cache__doc__},
850 {"_current_frames", sys_current_frames, METH_NOARGS,
851 current_frames_doc},
852 {"displayhook", sys_displayhook, METH_O, displayhook_doc},
853 {"exc_info", sys_exc_info, METH_NOARGS, exc_info_doc},
854 {"excepthook", sys_excepthook, METH_VARARGS, excepthook_doc},
855 {"exit", sys_exit, METH_VARARGS, exit_doc},
856 {"getdefaultencoding", (PyCFunction)sys_getdefaultencoding,
857 METH_NOARGS, getdefaultencoding_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000858#ifdef HAVE_DLOPEN
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000859 {"getdlopenflags", (PyCFunction)sys_getdlopenflags, METH_NOARGS,
860 getdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000861#endif
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000862#ifdef COUNT_ALLOCS
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000863 {"getcounts", (PyCFunction)sys_getcounts, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000864#endif
Guido van Rossum43f1b8d1997-01-24 04:07:45 +0000865#ifdef DYNAMIC_EXECUTION_PROFILE
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000866 {"getdxp", _Py_GetDXProfile, METH_VARARGS},
Guido van Rossum43f1b8d1997-01-24 04:07:45 +0000867#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000868 {"getfilesystemencoding", (PyCFunction)sys_getfilesystemencoding,
869 METH_NOARGS, getfilesystemencoding_doc},
Guido van Rossum7f3f2c11996-05-23 22:45:41 +0000870#ifdef Py_TRACE_REFS
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000871 {"getobjects", _Py_GetObjects, METH_VARARGS},
Tim Peters4be93d02002-07-07 19:59:50 +0000872#endif
873#ifdef Py_REF_DEBUG
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000874 {"gettotalrefcount", (PyCFunction)sys_gettotalrefcount, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000875#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000876 {"getrefcount", (PyCFunction)sys_getrefcount, METH_O, getrefcount_doc},
877 {"getrecursionlimit", (PyCFunction)sys_getrecursionlimit, METH_NOARGS,
878 getrecursionlimit_doc},
879 {"getsizeof", (PyCFunction)sys_getsizeof,
880 METH_VARARGS | METH_KEYWORDS, getsizeof_doc},
881 {"_getframe", sys_getframe, METH_VARARGS, getframe_doc},
Mark Hammond8696ebc2002-10-08 02:44:31 +0000882#ifdef MS_WINDOWS
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000883 {"getwindowsversion", (PyCFunction)sys_getwindowsversion, METH_NOARGS,
884 getwindowsversion_doc},
Mark Hammond8696ebc2002-10-08 02:44:31 +0000885#endif /* MS_WINDOWS */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000886 {"intern", sys_intern, METH_VARARGS, intern_doc},
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000887#ifdef USE_MALLOPT
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000888 {"mdebug", sys_mdebug, METH_VARARGS},
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000889#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000890 {"setdefaultencoding", sys_setdefaultencoding, METH_VARARGS,
891 setdefaultencoding_doc},
892 {"setfilesystemencoding", sys_setfilesystemencoding, METH_VARARGS,
893 setfilesystemencoding_doc},
894 {"setcheckinterval", sys_setcheckinterval, METH_VARARGS,
895 setcheckinterval_doc},
896 {"getcheckinterval", sys_getcheckinterval, METH_NOARGS,
897 getcheckinterval_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000898#ifdef HAVE_DLOPEN
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000899 {"setdlopenflags", sys_setdlopenflags, METH_VARARGS,
900 setdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000901#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000902 {"setprofile", sys_setprofile, METH_O, setprofile_doc},
903 {"getprofile", sys_getprofile, METH_NOARGS, getprofile_doc},
904 {"setrecursionlimit", sys_setrecursionlimit, METH_VARARGS,
905 setrecursionlimit_doc},
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000906#ifdef WITH_TSC
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000907 {"settscdump", sys_settscdump, METH_VARARGS, settscdump_doc},
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000908#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000909 {"settrace", sys_settrace, METH_O, settrace_doc},
910 {"gettrace", sys_gettrace, METH_NOARGS, gettrace_doc},
911 {"call_tracing", sys_call_tracing, METH_VARARGS, call_tracing_doc},
912 {NULL, NULL} /* sentinel */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000913};
914
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000915static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000916list_builtin_module_names(void)
Guido van Rossum34679b71993-01-26 13:33:44 +0000917{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000918 PyObject *list = PyList_New(0);
919 int i;
920 if (list == NULL)
921 return NULL;
922 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
923 PyObject *name = PyUnicode_FromString(
924 PyImport_Inittab[i].name);
925 if (name == NULL)
926 break;
927 PyList_Append(list, name);
928 Py_DECREF(name);
929 }
930 if (PyList_Sort(list) != 0) {
931 Py_DECREF(list);
932 list = NULL;
933 }
934 if (list) {
935 PyObject *v = PyList_AsTuple(list);
936 Py_DECREF(list);
937 list = v;
938 }
939 return list;
Guido van Rossum34679b71993-01-26 13:33:44 +0000940}
941
Guido van Rossum23fff912000-12-15 22:02:05 +0000942static PyObject *warnoptions = NULL;
943
944void
945PySys_ResetWarnOptions(void)
946{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000947 if (warnoptions == NULL || !PyList_Check(warnoptions))
948 return;
949 PyList_SetSlice(warnoptions, 0, PyList_GET_SIZE(warnoptions), NULL);
Guido van Rossum23fff912000-12-15 22:02:05 +0000950}
951
952void
Martin v. Löwis790465f2008-04-05 20:41:37 +0000953PySys_AddWarnOption(const wchar_t *s)
Guido van Rossum23fff912000-12-15 22:02:05 +0000954{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000955 PyObject *str;
Guido van Rossum23fff912000-12-15 22:02:05 +0000956
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +0000957 if (warnoptions == NULL || !PyList_Check(warnoptions)) {
958 Py_XDECREF(warnoptions);
959 warnoptions = PyList_New(0);
960 if (warnoptions == NULL)
961 return;
962 }
963 str = PyUnicode_FromWideChar(s, -1);
964 if (str != NULL) {
965 PyList_Append(warnoptions, str);
966 Py_DECREF(str);
967 }
Guido van Rossum23fff912000-12-15 22:02:05 +0000968}
969
Christian Heimes33fe8092008-04-13 13:53:33 +0000970int
971PySys_HasWarnOptions(void)
972{
973 return (warnoptions != NULL && (PyList_Size(warnoptions) > 0)) ? 1 : 0;
974}
975
Guido van Rossum40552d01998-08-06 03:34:39 +0000976/* XXX This doc string is too long to be a single string literal in VC++ 5.0.
977 Two literals concatenated works just fine. If you have a K&R compiler
978 or other abomination that however *does* understand longer strings,
979 get rid of the !!! comment in the middle and the quotes that surround it. */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000980PyDoc_VAR(sys_doc) =
981PyDoc_STR(
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000982"This module provides access to some objects used or maintained by the\n\
983interpreter and to functions that interact strongly with the interpreter.\n\
984\n\
985Dynamic objects:\n\
986\n\
987argv -- command line arguments; argv[0] is the script pathname if known\n\
988path -- module search path; path[0] is the script directory, else ''\n\
989modules -- dictionary of loaded modules\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000990\n\
991displayhook -- called to show results in an interactive session\n\
992excepthook -- called to handle any uncaught exception other than SystemExit\n\
993 To customize printing in an interactive session or to install a custom\n\
994 top-level exception handler, assign other functions to replace these.\n\
995\n\
Benjamin Peterson06157a42008-07-15 00:28:36 +0000996stdin -- standard input file object; used by input()\n\
Georg Brandl88fc6642007-02-09 21:28:07 +0000997stdout -- standard output file object; used by print()\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000998stderr -- standard error object; used for error messages\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000999 By assigning other file objects (or objects that behave like files)\n\
1000 to these, it is possible to redirect all of the interpreter's I/O.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001001\n\
1002last_type -- type of last uncaught exception\n\
1003last_value -- value of last uncaught exception\n\
1004last_traceback -- traceback of last uncaught exception\n\
1005 These three are only available in an interactive session after a\n\
1006 traceback has been printed.\n\
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001007"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001008)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001009/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001010PyDoc_STR(
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001011"\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001012Static objects:\n\
1013\n\
Christian Heimes2d378ab2007-12-15 01:28:04 +00001014float_info -- a dict with information about the float implementation.\n\
Mark Dickinsonbd792642009-03-18 20:06:12 +00001015int_info -- a struct sequence with information about the int implementation.\n\
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001016maxsize -- the largest supported length of containers.\n\
Martin v. Löwisce9b5a52001-06-27 06:28:56 +00001017maxunicode -- the largest supported character\n\
Neal Norwitz2a47c0f2002-01-29 00:53:41 +00001018builtin_module_names -- tuple of module names built into this interpreter\n\
Christian Heimes2d378ab2007-12-15 01:28:04 +00001019subversion -- subversion information of the build as tuple\n\
Fred Drake801c08d2000-04-13 15:29:10 +00001020version -- the version of this interpreter as a string\n\
Eric Smith0e5b5622009-02-06 01:32:42 +00001021version_info -- version information as a named tuple\n\
Fred Drake801c08d2000-04-13 15:29:10 +00001022hexversion -- version information encoded as a single integer\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001023copyright -- copyright notice pertaining to this interpreter\n\
1024platform -- platform identifier\n\
1025executable -- pathname of this Python interpreter\n\
1026prefix -- prefix used to find the Python library\n\
1027exec_prefix -- prefix used to find the machine-specific Python library\n\
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001028float_repr_style -- string indicating the style of repr() output for floats\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001029"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001030)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001031#ifdef MS_WINDOWS
1032/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001033PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001034"dllhandle -- [Windows only] integer handle of the Python DLL\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001035winver -- [Windows only] version number of the Python DLL\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001036"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001037)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001038#endif /* MS_WINDOWS */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001039PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001040"__stdin__ -- the original stdin; don't touch!\n\
1041__stdout__ -- the original stdout; don't touch!\n\
1042__stderr__ -- the original stderr; don't touch!\n\
1043__displayhook__ -- the original displayhook; don't touch!\n\
1044__excepthook__ -- the original excepthook; don't touch!\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001045\n\
1046Functions:\n\
1047\n\
Georg Brandl1a3284e2007-12-02 09:40:06 +00001048displayhook() -- print an object to the screen, and save it in builtins._\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001049excepthook() -- print an exception and its traceback to sys.stderr\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001050exc_info() -- return thread-safe information about the current exception\n\
1051exit() -- exit the interpreter by raising SystemExit\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001052getdlopenflags() -- returns flags to be used for dlopen() calls\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001053getprofile() -- get the global profiling function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001054getrefcount() -- return the reference count for an object (plus one :-)\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001055getrecursionlimit() -- return the max recursion depth for the interpreter\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001056getsizeof() -- return the size of an object in bytes\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001057gettrace() -- get the global debug tracing function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001058setcheckinterval() -- control how often the interpreter checks for events\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001059setdlopenflags() -- set the flags to be used for dlopen() calls\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001060setprofile() -- set the global profiling function\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001061setrecursionlimit() -- set the max recursion depth for the interpreter\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001062settrace() -- set the global debug tracing function\n\
Fred Drakeccede592000-08-14 20:59:57 +00001063"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001064)
Fred Drakeccede592000-08-14 20:59:57 +00001065/* end of sys_doc */ ;
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001066
Martin v. Löwis43b57802006-01-05 23:38:54 +00001067/* Subversion branch and revision management */
Martin v. Löwis43b57802006-01-05 23:38:54 +00001068static int svn_initialized;
1069static char patchlevel_revision[50]; /* Just the number */
1070static char branch[50];
1071static char shortbranch[50];
1072static const char *svn_revision;
1073
Tim Peterse86e7a52006-01-06 02:42:46 +00001074static void
1075svnversion_init(void)
Martin v. Löwis43b57802006-01-05 23:38:54 +00001076{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001077 if (svn_initialized)
1078 return;
Martin v. Löwis43b57802006-01-05 23:38:54 +00001079
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001080 svn_initialized = 1;
Jesus Cea1d4ae842011-04-20 20:24:57 +02001081 *patchlevel_revision = '\0';
1082 strcpy(branch, "");
1083 strcpy(shortbranch, "unknown");
1084 svn_revision = "";
Martin v. Löwis43b57802006-01-05 23:38:54 +00001085}
1086
1087/* Return svnversion output if available.
1088 Else return Revision of patchlevel.h if on branch.
1089 Else return empty string */
1090const char*
1091Py_SubversionRevision()
1092{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001093 svnversion_init();
1094 return svn_revision;
Martin v. Löwis43b57802006-01-05 23:38:54 +00001095}
1096
1097const char*
1098Py_SubversionShortBranch()
1099{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001100 svnversion_init();
1101 return shortbranch;
Martin v. Löwis43b57802006-01-05 23:38:54 +00001102}
1103
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001104
1105PyDoc_STRVAR(flags__doc__,
1106"sys.flags\n\
1107\n\
1108Flags provided through command line arguments or environment vars.");
1109
1110static PyTypeObject FlagsType;
1111
1112static PyStructSequence_Field flags_fields[] = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001113 {"debug", "-d"},
1114 {"division_warning", "-Q"},
1115 {"inspect", "-i"},
1116 {"interactive", "-i"},
1117 {"optimize", "-O or -OO"},
1118 {"dont_write_bytecode", "-B"},
1119 {"no_user_site", "-s"},
1120 {"no_site", "-S"},
1121 {"ignore_environment", "-E"},
1122 {"verbose", "-v"},
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001123#ifdef RISCOS
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001124 {"riscos_wimp", "???"},
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001125#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001126 /* {"unbuffered", "-u"}, */
1127 /* {"skip_first", "-x"}, */
1128 {"bytes_warning", "-b"},
Georg Brandl2daf6ae2012-02-20 19:54:16 +01001129 {"hash_randomization", "-R"},
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001130 {0}
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001131};
1132
1133static PyStructSequence_Desc flags_desc = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001134 "sys.flags", /* name */
1135 flags__doc__, /* doc */
1136 flags_fields, /* fields */
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001137#ifdef RISCOS
Georg Brandl2daf6ae2012-02-20 19:54:16 +01001138 13
Georg Brandle1b5ac62008-06-04 13:06:58 +00001139#else
Georg Brandl2daf6ae2012-02-20 19:54:16 +01001140 12
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001141#endif
1142};
1143
1144static PyObject*
1145make_flags(void)
1146{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001147 int pos = 0;
1148 PyObject *seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001149
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001150 seq = PyStructSequence_New(&FlagsType);
1151 if (seq == NULL)
1152 return NULL;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001153
1154#define SetFlag(flag) \
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001155 PyStructSequence_SET_ITEM(seq, pos++, PyLong_FromLong(flag))
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001156
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001157 SetFlag(Py_DebugFlag);
1158 SetFlag(Py_DivisionWarningFlag);
1159 SetFlag(Py_InspectFlag);
1160 SetFlag(Py_InteractiveFlag);
1161 SetFlag(Py_OptimizeFlag);
1162 SetFlag(Py_DontWriteBytecodeFlag);
1163 SetFlag(Py_NoUserSiteDirectory);
1164 SetFlag(Py_NoSiteFlag);
1165 SetFlag(Py_IgnoreEnvironmentFlag);
1166 SetFlag(Py_VerboseFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001167#ifdef RISCOS
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001168 SetFlag(Py_RISCOSWimpFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001169#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001170 /* SetFlag(saw_unbuffered_flag); */
1171 /* SetFlag(skipfirstline); */
Christian Heimes33fe8092008-04-13 13:53:33 +00001172 SetFlag(Py_BytesWarningFlag);
Georg Brandl2daf6ae2012-02-20 19:54:16 +01001173 SetFlag(Py_HashRandomizationFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001174#undef SetFlag
1175
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001176 if (PyErr_Occurred()) {
1177 return NULL;
1178 }
1179 return seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001180}
1181
Eric Smith0e5b5622009-02-06 01:32:42 +00001182PyDoc_STRVAR(version_info__doc__,
1183"sys.version_info\n\
1184\n\
1185Version information as a named tuple.");
1186
1187static PyTypeObject VersionInfoType;
1188
1189static PyStructSequence_Field version_info_fields[] = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001190 {"major", "Major release number"},
1191 {"minor", "Minor release number"},
1192 {"micro", "Patch release number"},
1193 {"releaselevel", "'alpha', 'beta', 'candidate', or 'release'"},
1194 {"serial", "Serial release number"},
1195 {0}
Eric Smith0e5b5622009-02-06 01:32:42 +00001196};
1197
1198static PyStructSequence_Desc version_info_desc = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001199 "sys.version_info", /* name */
1200 version_info__doc__, /* doc */
1201 version_info_fields, /* fields */
1202 5
Eric Smith0e5b5622009-02-06 01:32:42 +00001203};
1204
1205static PyObject *
1206make_version_info(void)
1207{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001208 PyObject *version_info;
1209 char *s;
1210 int pos = 0;
Eric Smith0e5b5622009-02-06 01:32:42 +00001211
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001212 version_info = PyStructSequence_New(&VersionInfoType);
1213 if (version_info == NULL) {
1214 return NULL;
1215 }
Eric Smith0e5b5622009-02-06 01:32:42 +00001216
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001217 /*
1218 * These release level checks are mutually exclusive and cover
1219 * the field, so don't get too fancy with the pre-processor!
1220 */
Eric Smith0e5b5622009-02-06 01:32:42 +00001221#if PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_ALPHA
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001222 s = "alpha";
Eric Smith0e5b5622009-02-06 01:32:42 +00001223#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_BETA
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001224 s = "beta";
Eric Smith0e5b5622009-02-06 01:32:42 +00001225#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_GAMMA
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001226 s = "candidate";
Eric Smith0e5b5622009-02-06 01:32:42 +00001227#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_FINAL
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001228 s = "final";
Eric Smith0e5b5622009-02-06 01:32:42 +00001229#endif
1230
1231#define SetIntItem(flag) \
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001232 PyStructSequence_SET_ITEM(version_info, pos++, PyLong_FromLong(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001233#define SetStrItem(flag) \
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001234 PyStructSequence_SET_ITEM(version_info, pos++, PyUnicode_FromString(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001235
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001236 SetIntItem(PY_MAJOR_VERSION);
1237 SetIntItem(PY_MINOR_VERSION);
1238 SetIntItem(PY_MICRO_VERSION);
1239 SetStrItem(s);
1240 SetIntItem(PY_RELEASE_SERIAL);
Eric Smith0e5b5622009-02-06 01:32:42 +00001241#undef SetIntItem
1242#undef SetStrItem
1243
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001244 if (PyErr_Occurred()) {
1245 Py_CLEAR(version_info);
1246 return NULL;
1247 }
1248 return version_info;
Eric Smith0e5b5622009-02-06 01:32:42 +00001249}
1250
Martin v. Löwis1a214512008-06-11 05:26:20 +00001251static struct PyModuleDef sysmodule = {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001252 PyModuleDef_HEAD_INIT,
1253 "sys",
1254 sys_doc,
1255 -1, /* multiple "initialization" just copies the module dict. */
1256 sys_methods,
1257 NULL,
1258 NULL,
1259 NULL,
1260 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00001261};
1262
Guido van Rossum25ce5661997-08-02 03:10:38 +00001263PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001264_PySys_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001265{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001266 PyObject *m, *v, *sysdict;
1267 char *s;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001268
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001269 m = PyModule_Create(&sysmodule);
1270 if (m == NULL)
1271 return NULL;
1272 sysdict = PyModule_GetDict(m);
1273#define SET_SYS_FROM_STRING(key, value) \
1274 v = value; \
1275 if (v != NULL) \
1276 PyDict_SetItemString(sysdict, key, v); \
1277 Py_XDECREF(v)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001278
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001279 /* Check that stdin is not a directory
1280 Using shell redirection, you can redirect stdin to a directory,
1281 crashing the Python interpreter. Catch this common mistake here
1282 and output a useful error message. Note that under MS Windows,
1283 the shell already prevents that. */
Martin v. Löwisec59d042009-01-12 07:59:10 +00001284#if !defined(MS_WINDOWS)
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001285 {
1286 struct stat sb;
1287 if (fstat(fileno(stdin), &sb) == 0 &&
1288 S_ISDIR(sb.st_mode)) {
1289 /* There's nothing more we can do. */
1290 /* Py_FatalError() will core dump, so just exit. */
1291 PySys_WriteStderr("Python error: <stdin> is a directory, cannot continue\n");
1292 exit(EXIT_FAILURE);
1293 }
1294 }
Martin v. Löwisec59d042009-01-12 07:59:10 +00001295#endif
Neal Norwitz11bd1192005-10-03 00:54:56 +00001296
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001297 /* stdin/stdout/stderr are now set by pythonrun.c */
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001298
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001299 PyDict_SetItemString(sysdict, "__displayhook__",
1300 PyDict_GetItemString(sysdict, "displayhook"));
1301 PyDict_SetItemString(sysdict, "__excepthook__",
1302 PyDict_GetItemString(sysdict, "excepthook"));
1303 SET_SYS_FROM_STRING("version",
1304 PyUnicode_FromString(Py_GetVersion()));
1305 SET_SYS_FROM_STRING("hexversion",
1306 PyLong_FromLong(PY_VERSION_HEX));
1307 svnversion_init();
1308 SET_SYS_FROM_STRING("subversion",
1309 Py_BuildValue("(UUU)", "CPython", branch,
1310 svn_revision));
Georg Brandl1ca2e792011-03-05 20:51:24 +01001311 SET_SYS_FROM_STRING("_mercurial",
1312 Py_BuildValue("(szz)", "CPython", _Py_hgidentifier(),
1313 _Py_hgversion()));
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001314 SET_SYS_FROM_STRING("dont_write_bytecode",
1315 PyBool_FromLong(Py_DontWriteBytecodeFlag));
1316 SET_SYS_FROM_STRING("api_version",
1317 PyLong_FromLong(PYTHON_API_VERSION));
1318 SET_SYS_FROM_STRING("copyright",
1319 PyUnicode_FromString(Py_GetCopyright()));
1320 SET_SYS_FROM_STRING("platform",
1321 PyUnicode_FromString(Py_GetPlatform()));
1322 SET_SYS_FROM_STRING("executable",
1323 PyUnicode_FromWideChar(
1324 Py_GetProgramFullPath(), -1));
1325 SET_SYS_FROM_STRING("prefix",
1326 PyUnicode_FromWideChar(Py_GetPrefix(), -1));
1327 SET_SYS_FROM_STRING("exec_prefix",
1328 PyUnicode_FromWideChar(Py_GetExecPrefix(), -1));
1329 SET_SYS_FROM_STRING("maxsize",
1330 PyLong_FromSsize_t(PY_SSIZE_T_MAX));
1331 SET_SYS_FROM_STRING("float_info",
1332 PyFloat_GetInfo());
1333 SET_SYS_FROM_STRING("int_info",
1334 PyLong_GetInfo());
1335 SET_SYS_FROM_STRING("maxunicode",
1336 PyLong_FromLong(PyUnicode_GetMax()));
1337 SET_SYS_FROM_STRING("builtin_module_names",
1338 list_builtin_module_names());
1339 {
1340 /* Assumes that longs are at least 2 bytes long.
1341 Should be safe! */
1342 unsigned long number = 1;
1343 char *value;
Fred Drake099325e2000-08-14 15:47:03 +00001344
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001345 s = (char *) &number;
1346 if (s[0] == 0)
1347 value = "big";
1348 else
1349 value = "little";
1350 SET_SYS_FROM_STRING("byteorder",
1351 PyUnicode_FromString(value));
1352 }
Guido van Rossum8b9ea871996-08-23 18:14:47 +00001353#ifdef MS_COREDLL
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001354 SET_SYS_FROM_STRING("dllhandle",
1355 PyLong_FromVoidPtr(PyWin_DLLhModule));
1356 SET_SYS_FROM_STRING("winver",
1357 PyUnicode_FromString(PyWin_DLLVersionString));
Guido van Rossumc606fe11996-04-09 02:37:57 +00001358#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001359 if (warnoptions == NULL) {
1360 warnoptions = PyList_New(0);
1361 }
1362 else {
1363 Py_INCREF(warnoptions);
1364 }
1365 if (warnoptions != NULL) {
1366 PyDict_SetItemString(sysdict, "warnoptions", warnoptions);
1367 }
Tim Peters216b78b2006-01-06 02:40:53 +00001368
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001369 /* version_info */
1370 if (VersionInfoType.tp_name == 0)
1371 PyStructSequence_InitType(&VersionInfoType, &version_info_desc);
1372 SET_SYS_FROM_STRING("version_info", make_version_info());
1373 /* prevent user from creating new instances */
1374 VersionInfoType.tp_init = NULL;
1375 VersionInfoType.tp_new = NULL;
Eric Smith0e5b5622009-02-06 01:32:42 +00001376
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001377 /* flags */
1378 if (FlagsType.tp_name == 0)
1379 PyStructSequence_InitType(&FlagsType, &flags_desc);
1380 SET_SYS_FROM_STRING("flags", make_flags());
1381 /* prevent user from creating new instances */
1382 FlagsType.tp_init = NULL;
1383 FlagsType.tp_new = NULL;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001384
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001385 /* float repr style: 0.03 (short) vs 0.029999999999999999 (legacy) */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001386#ifndef PY_NO_SHORT_FLOAT_REPR
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001387 SET_SYS_FROM_STRING("float_repr_style",
1388 PyUnicode_FromString("short"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001389#else
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001390 SET_SYS_FROM_STRING("float_repr_style",
1391 PyUnicode_FromString("legacy"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001392#endif
1393
Christian Heimes7b3ce6a2008-01-31 14:31:45 +00001394#undef SET_SYS_FROM_STRING
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001395 if (PyErr_Occurred())
1396 return NULL;
1397 return m;
Guido van Rossum5b3138b1990-11-18 17:41:40 +00001398}
1399
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001400static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00001401makepathobject(const wchar_t *path, wchar_t delim)
Guido van Rossum5b3138b1990-11-18 17:41:40 +00001402{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001403 int i, n;
1404 const wchar_t *p;
1405 PyObject *v, *w;
Tim Peters216b78b2006-01-06 02:40:53 +00001406
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001407 n = 1;
1408 p = path;
1409 while ((p = wcschr(p, delim)) != NULL) {
1410 n++;
1411 p++;
1412 }
1413 v = PyList_New(n);
1414 if (v == NULL)
1415 return NULL;
1416 for (i = 0; ; i++) {
1417 p = wcschr(path, delim);
1418 if (p == NULL)
1419 p = path + wcslen(path); /* End of string */
1420 w = PyUnicode_FromWideChar(path, (Py_ssize_t)(p - path));
1421 if (w == NULL) {
1422 Py_DECREF(v);
1423 return NULL;
1424 }
1425 PyList_SetItem(v, i, w);
1426 if (*p == '\0')
1427 break;
1428 path = p+1;
1429 }
1430 return v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001431}
1432
1433void
Martin v. Löwis790465f2008-04-05 20:41:37 +00001434PySys_SetPath(const wchar_t *path)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001435{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001436 PyObject *v;
1437 if ((v = makepathobject(path, DELIM)) == NULL)
1438 Py_FatalError("can't create sys.path");
1439 if (PySys_SetObject("path", v) != 0)
1440 Py_FatalError("can't assign sys.path");
1441 Py_DECREF(v);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001442}
1443
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001444static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00001445makeargvobject(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001446{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001447 PyObject *av;
1448 if (argc <= 0 || argv == NULL) {
1449 /* Ensure at least one (empty) argument is seen */
1450 static wchar_t *empty_argv[1] = {L""};
1451 argv = empty_argv;
1452 argc = 1;
1453 }
1454 av = PyList_New(argc);
1455 if (av != NULL) {
1456 int i;
1457 for (i = 0; i < argc; i++) {
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +00001458#ifdef __VMS
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001459 PyObject *v;
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +00001460
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001461 /* argv[0] is the script pathname if known */
1462 if (i == 0) {
1463 char* fn = decc$translate_vms(argv[0]);
1464 if ((fn == (char *)0) || fn == (char *)-1)
1465 v = PyUnicode_FromString(argv[0]);
1466 else
1467 v = PyUnicode_FromString(
1468 decc$translate_vms(argv[0]));
1469 } else
1470 v = PyUnicode_FromString(argv[i]);
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +00001471#else
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001472 PyObject *v = PyUnicode_FromWideChar(argv[i], -1);
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +00001473#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001474 if (v == NULL) {
1475 Py_DECREF(av);
1476 av = NULL;
1477 break;
1478 }
1479 PyList_SetItem(av, i, v);
1480 }
1481 }
1482 return av;
Guido van Rossum3f5da241990-12-20 15:06:42 +00001483}
1484
Martin v. Löwis790465f2008-04-05 20:41:37 +00001485#ifdef HAVE_REALPATH
1486static wchar_t*
1487_wrealpath(const wchar_t *path, wchar_t *resolved_path)
1488{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001489 char cpath[PATH_MAX];
1490 char cresolved_path[PATH_MAX];
1491 char *res;
1492 size_t r;
1493 r = wcstombs(cpath, path, PATH_MAX);
1494 if (r == (size_t)-1 || r >= PATH_MAX) {
1495 errno = EINVAL;
1496 return NULL;
1497 }
1498 res = realpath(cpath, cresolved_path);
1499 if (res == NULL)
1500 return NULL;
1501 r = mbstowcs(resolved_path, cresolved_path, PATH_MAX);
1502 if (r == (size_t)-1 || r >= PATH_MAX) {
1503 errno = EINVAL;
1504 return NULL;
1505 }
1506 return resolved_path;
Martin v. Löwis790465f2008-04-05 20:41:37 +00001507}
1508#endif
1509
Guido van Rossum3f5da241990-12-20 15:06:42 +00001510void
Antoine Pitrou71d305c2010-05-21 17:33:14 +00001511PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001512{
Guido van Rossum162e38c2003-02-19 15:25:10 +00001513#if defined(HAVE_REALPATH)
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001514 wchar_t fullpath[MAXPATHLEN];
Martin v. Löwisec59d042009-01-12 07:59:10 +00001515#elif defined(MS_WINDOWS) && !defined(MS_WINCE)
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001516 wchar_t fullpath[MAX_PATH];
Thomas Heller27bb71e2003-01-08 14:33:48 +00001517#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001518 PyObject *av = makeargvobject(argc, argv);
1519 PyObject *path = PySys_GetObject("path");
1520 if (av == NULL)
1521 Py_FatalError("no mem for sys.argv");
1522 if (PySys_SetObject("argv", av) != 0)
1523 Py_FatalError("can't assign sys.argv");
Antoine Pitrou71d305c2010-05-21 17:33:14 +00001524 if (updatepath && path != NULL) {
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001525 wchar_t *argv0 = argv[0];
1526 wchar_t *p = NULL;
1527 Py_ssize_t n = 0;
1528 PyObject *a;
1529 extern int _Py_wreadlink(const wchar_t *, wchar_t *, size_t);
Guido van Rossumc474dea1997-04-25 15:38:31 +00001530#ifdef HAVE_READLINK
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001531 wchar_t link[MAXPATHLEN+1];
1532 wchar_t argv0copy[2*MAXPATHLEN+1];
1533 int nr = 0;
1534 if (argc > 0 && argv0 != NULL && wcscmp(argv0, L"-c") != 0)
1535 nr = _Py_wreadlink(argv0, link, MAXPATHLEN);
1536 if (nr > 0) {
1537 /* It's a symlink */
1538 link[nr] = '\0';
1539 if (link[0] == SEP)
1540 argv0 = link; /* Link to absolute path */
1541 else if (wcschr(link, SEP) == NULL)
1542 ; /* Link without path */
1543 else {
1544 /* Must join(dirname(argv0), link) */
1545 wchar_t *q = wcsrchr(argv0, SEP);
1546 if (q == NULL)
1547 argv0 = link; /* argv0 without path */
1548 else {
1549 /* Must make a copy */
1550 wcscpy(argv0copy, argv0);
1551 q = wcsrchr(argv0copy, SEP);
1552 wcscpy(q+1, link);
1553 argv0 = argv0copy;
1554 }
1555 }
1556 }
Guido van Rossumc474dea1997-04-25 15:38:31 +00001557#endif /* HAVE_READLINK */
Guido van Rossumcc883411996-09-10 14:44:21 +00001558#if SEP == '\\' /* Special case for MS filename syntax */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001559 if (argc > 0 && argv0 != NULL && wcscmp(argv0, L"-c") != 0) {
1560 wchar_t *q;
Martin v. Löwisec59d042009-01-12 07:59:10 +00001561#if defined(MS_WINDOWS) && !defined(MS_WINCE)
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001562 /* This code here replaces the first element in argv with the full
1563 path that it represents. Under CE, there are no relative paths so
1564 the argument must be the full path anyway. */
1565 wchar_t *ptemp;
1566 if (GetFullPathNameW(argv0,
1567 sizeof(fullpath)/sizeof(fullpath[0]),
1568 fullpath,
1569 &ptemp)) {
1570 argv0 = fullpath;
1571 }
Thomas Heller27bb71e2003-01-08 14:33:48 +00001572#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001573 p = wcsrchr(argv0, SEP);
1574 /* Test for alternate separator */
1575 q = wcsrchr(p ? p : argv0, '/');
1576 if (q != NULL)
1577 p = q;
1578 if (p != NULL) {
1579 n = p + 1 - argv0;
1580 if (n > 1 && p[-1] != ':')
1581 n--; /* Drop trailing separator */
1582 }
1583 }
Guido van Rossumcc883411996-09-10 14:44:21 +00001584#else /* All other filename syntaxes */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001585 if (argc > 0 && argv0 != NULL && wcscmp(argv0, L"-c") != 0) {
Guido van Rossum162e38c2003-02-19 15:25:10 +00001586#if defined(HAVE_REALPATH)
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001587 if (_wrealpath(argv0, fullpath)) {
1588 argv0 = fullpath;
1589 }
Guido van Rossum162e38c2003-02-19 15:25:10 +00001590#endif
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001591 p = wcsrchr(argv0, SEP);
1592 }
1593 if (p != NULL) {
1594 n = p + 1 - argv0;
Guido van Rossumcc883411996-09-10 14:44:21 +00001595#if SEP == '/' /* Special case for Unix filename syntax */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001596 if (n > 1)
1597 n--; /* Drop trailing separator */
Guido van Rossumcc883411996-09-10 14:44:21 +00001598#endif /* Unix */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001599 }
Guido van Rossumcc883411996-09-10 14:44:21 +00001600#endif /* All others */
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001601 a = PyUnicode_FromWideChar(argv0, n);
1602 if (a == NULL)
1603 Py_FatalError("no mem for sys.path insertion");
1604 if (PyList_Insert(path, 0, a) < 0)
1605 Py_FatalError("sys.path.insert(0) failed");
1606 Py_DECREF(a);
1607 }
1608 Py_DECREF(av);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001609}
Guido van Rossuma890e681998-05-12 14:59:24 +00001610
Antoine Pitrou71d305c2010-05-21 17:33:14 +00001611void
1612PySys_SetArgv(int argc, wchar_t **argv)
1613{
1614 PySys_SetArgvEx(argc, argv, 1);
1615}
1616
Victor Stinner32366b42010-04-23 12:04:53 +00001617/* Reimplementation of PyFile_WriteString() no calling indirectly
1618 PyErr_CheckSignals(): avoid the call to PyObject_Str(). */
1619
1620static int
1621sys_pyfile_write(const char *text, PyObject *file)
1622{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001623 PyObject *unicode = NULL, *writer = NULL, *args = NULL, *result = NULL;
1624 int err;
Victor Stinner32366b42010-04-23 12:04:53 +00001625
Victor Stinnera01c6b32010-06-08 20:50:09 +00001626 if (file == NULL)
1627 return -1;
1628
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001629 unicode = PyUnicode_FromString(text);
1630 if (unicode == NULL)
1631 goto error;
Victor Stinner32366b42010-04-23 12:04:53 +00001632
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001633 writer = PyObject_GetAttrString(file, "write");
1634 if (writer == NULL)
1635 goto error;
Victor Stinner32366b42010-04-23 12:04:53 +00001636
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001637 args = PyTuple_Pack(1, unicode);
1638 if (args == NULL)
1639 goto error;
Victor Stinner32366b42010-04-23 12:04:53 +00001640
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001641 result = PyEval_CallObject(writer, args);
1642 if (result == NULL) {
1643 goto error;
1644 } else {
1645 err = 0;
1646 goto finally;
1647 }
Victor Stinner32366b42010-04-23 12:04:53 +00001648
1649error:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001650 err = -1;
Victor Stinner32366b42010-04-23 12:04:53 +00001651finally:
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001652 Py_XDECREF(unicode);
1653 Py_XDECREF(writer);
1654 Py_XDECREF(args);
1655 Py_XDECREF(result);
1656 return err;
Victor Stinner32366b42010-04-23 12:04:53 +00001657}
1658
Guido van Rossuma890e681998-05-12 14:59:24 +00001659
1660/* APIs to write to sys.stdout or sys.stderr using a printf-like interface.
1661 Adapted from code submitted by Just van Rossum.
1662
1663 PySys_WriteStdout(format, ...)
1664 PySys_WriteStderr(format, ...)
1665
1666 The first function writes to sys.stdout; the second to sys.stderr. When
1667 there is a problem, they write to the real (C level) stdout or stderr;
Guido van Rossum8442af31998-10-12 18:22:10 +00001668 no exceptions are raised.
Guido van Rossuma890e681998-05-12 14:59:24 +00001669
Victor Stinner32366b42010-04-23 12:04:53 +00001670 PyErr_CheckSignals() is not called to avoid the execution of the Python
1671 signal handlers: they may raise a new exception whereas mywrite() ignores
1672 all exceptions.
1673
Guido van Rossuma890e681998-05-12 14:59:24 +00001674 Both take a printf-style format string as their first argument followed
1675 by a variable length argument list determined by the format string.
1676
1677 *** WARNING ***
1678
1679 The format should limit the total size of the formatted output string to
1680 1000 bytes. In particular, this means that no unrestricted "%s" formats
1681 should occur; these should be limited using "%.<N>s where <N> is a
1682 decimal number calculated so that <N> plus the maximum size of other
1683 formatted text does not exceed 1000 bytes. Also watch out for "%f",
1684 which can print hundreds of digits for very large numbers.
1685
1686 */
1687
1688static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001689mywrite(char *name, FILE *fp, const char *format, va_list va)
Guido van Rossuma890e681998-05-12 14:59:24 +00001690{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001691 PyObject *file;
1692 PyObject *error_type, *error_value, *error_traceback;
1693 char buffer[1001];
1694 int written;
Guido van Rossuma890e681998-05-12 14:59:24 +00001695
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001696 PyErr_Fetch(&error_type, &error_value, &error_traceback);
1697 file = PySys_GetObject(name);
1698 written = PyOS_vsnprintf(buffer, sizeof(buffer), format, va);
1699 if (sys_pyfile_write(buffer, file) != 0) {
1700 PyErr_Clear();
1701 fputs(buffer, fp);
1702 }
1703 if (written < 0 || (size_t)written >= sizeof(buffer)) {
1704 const char *truncated = "... truncated";
1705 if (sys_pyfile_write(truncated, file) != 0) {
1706 PyErr_Clear();
1707 fputs(truncated, fp);
1708 }
1709 }
1710 PyErr_Restore(error_type, error_value, error_traceback);
Guido van Rossuma890e681998-05-12 14:59:24 +00001711}
1712
1713void
Guido van Rossuma890e681998-05-12 14:59:24 +00001714PySys_WriteStdout(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00001715{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001716 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00001717
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001718 va_start(va, format);
1719 mywrite("stdout", stdout, format, va);
1720 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00001721}
1722
1723void
Guido van Rossuma890e681998-05-12 14:59:24 +00001724PySys_WriteStderr(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00001725{
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001726 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00001727
Antoine Pitrou7f14f0d2010-05-09 16:14:21 +00001728 va_start(va, format);
1729 mywrite("stderr", stderr, format, va);
1730 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00001731}