blob: b5492035365a3b32d9cbe2c680f583b029669dc4 [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"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000018#include "code.h"
Barry Warsawb6a54d22000-12-06 21:47:46 +000019#include "frameobject.h"
Victor Stinnerd5c355c2011-04-30 14:53:09 +020020#include "pythread.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000021
Guido van Rossume2437a11992-03-23 18:20:18 +000022#include "osdefs.h"
Guido van Rossum3f5da241990-12-20 15:06:42 +000023
Mark Hammond8696ebc2002-10-08 02:44:31 +000024#ifdef MS_WINDOWS
25#define WIN32_LEAN_AND_MEAN
Amaury Forgeot d'Arc06cfe952007-11-10 13:55:44 +000026#include <windows.h>
Mark Hammond8696ebc2002-10-08 02:44:31 +000027#endif /* MS_WINDOWS */
28
Guido van Rossum9b38a141996-09-11 23:12:24 +000029#ifdef MS_COREDLL
Guido van Rossumc606fe11996-04-09 02:37:57 +000030extern void *PyWin_DLLhModule;
Guido van Rossum6c1e5f21997-09-29 23:34:23 +000031/* A string loaded from the DLL at startup: */
32extern const char *PyWin_DLLVersionString;
Guido van Rossumc606fe11996-04-09 02:37:57 +000033#endif
34
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +000035#ifdef __VMS
36#include <unixlib.h>
37#endif
38
Martin v. Löwis5467d4c2003-05-10 07:10:12 +000039#ifdef HAVE_LANGINFO_H
40#include <locale.h>
41#include <langinfo.h>
42#endif
43
Guido van Rossum65bf9f21997-04-29 18:33:38 +000044PyObject *
Neal Norwitzf3081322007-08-25 00:32:45 +000045PySys_GetObject(const char *name)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000046{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000047 PyThreadState *tstate = PyThreadState_GET();
48 PyObject *sd = tstate->interp->sysdict;
49 if (sd == NULL)
50 return NULL;
51 return PyDict_GetItemString(sd, name);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000052}
53
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000054int
Neal Norwitzf3081322007-08-25 00:32:45 +000055PySys_SetObject(const char *name, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000056{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000057 PyThreadState *tstate = PyThreadState_GET();
58 PyObject *sd = tstate->interp->sysdict;
59 if (v == NULL) {
60 if (PyDict_GetItemString(sd, name) == NULL)
61 return 0;
62 else
63 return PyDict_DelItemString(sd, name);
64 }
65 else
66 return PyDict_SetItemString(sd, name, v);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000067}
68
Victor Stinner13d49ee2010-12-04 17:24:33 +000069/* Write repr(o) to sys.stdout using sys.stdout.encoding and 'backslashreplace'
70 error handler. If sys.stdout has a buffer attribute, use
71 sys.stdout.buffer.write(encoded), otherwise redecode the string and use
72 sys.stdout.write(redecoded).
73
74 Helper function for sys_displayhook(). */
75static int
76sys_displayhook_unencodable(PyObject *outf, PyObject *o)
77{
78 PyObject *stdout_encoding = NULL;
79 PyObject *encoded, *escaped_str, *repr_str, *buffer, *result;
80 char *stdout_encoding_str;
81 int ret;
82
83 stdout_encoding = PyObject_GetAttrString(outf, "encoding");
84 if (stdout_encoding == NULL)
85 goto error;
86 stdout_encoding_str = _PyUnicode_AsString(stdout_encoding);
87 if (stdout_encoding_str == NULL)
88 goto error;
89
90 repr_str = PyObject_Repr(o);
91 if (repr_str == NULL)
92 goto error;
93 encoded = PyUnicode_AsEncodedString(repr_str,
94 stdout_encoding_str,
95 "backslashreplace");
96 Py_DECREF(repr_str);
97 if (encoded == NULL)
98 goto error;
99
100 buffer = PyObject_GetAttrString(outf, "buffer");
101 if (buffer) {
102 result = PyObject_CallMethod(buffer, "write", "(O)", encoded);
103 Py_DECREF(buffer);
104 Py_DECREF(encoded);
105 if (result == NULL)
106 goto error;
107 Py_DECREF(result);
108 }
109 else {
110 PyErr_Clear();
111 escaped_str = PyUnicode_FromEncodedObject(encoded,
112 stdout_encoding_str,
113 "strict");
114 Py_DECREF(encoded);
115 if (PyFile_WriteObject(escaped_str, outf, Py_PRINT_RAW) != 0) {
116 Py_DECREF(escaped_str);
117 goto error;
118 }
119 Py_DECREF(escaped_str);
120 }
121 ret = 0;
122 goto finally;
123
124error:
125 ret = -1;
126finally:
127 Py_XDECREF(stdout_encoding);
128 return ret;
129}
130
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000131static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000132sys_displayhook(PyObject *self, PyObject *o)
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000133{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000134 PyObject *outf;
135 PyInterpreterState *interp = PyThreadState_GET()->interp;
136 PyObject *modules = interp->modules;
137 PyObject *builtins = PyDict_GetItemString(modules, "builtins");
Victor Stinner13d49ee2010-12-04 17:24:33 +0000138 int err;
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000140 if (builtins == NULL) {
141 PyErr_SetString(PyExc_RuntimeError, "lost builtins module");
142 return NULL;
143 }
Moshe Zadka03897ea2001-07-23 13:32:43 +0000144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000145 /* Print value except if None */
146 /* After printing, also assign to '_' */
147 /* Before, set '_' to None to avoid recursion */
148 if (o == Py_None) {
149 Py_INCREF(Py_None);
150 return Py_None;
151 }
152 if (PyObject_SetAttrString(builtins, "_", Py_None) != 0)
153 return NULL;
154 outf = PySys_GetObject("stdout");
155 if (outf == NULL || outf == Py_None) {
156 PyErr_SetString(PyExc_RuntimeError, "lost sys.stdout");
157 return NULL;
158 }
Victor Stinner13d49ee2010-12-04 17:24:33 +0000159 if (PyFile_WriteObject(o, outf, 0) != 0) {
160 if (PyErr_ExceptionMatches(PyExc_UnicodeEncodeError)) {
161 /* repr(o) is not encodable to sys.stdout.encoding with
162 * sys.stdout.errors error handler (which is probably 'strict') */
163 PyErr_Clear();
164 err = sys_displayhook_unencodable(outf, o);
165 if (err)
166 return NULL;
167 }
168 else {
169 return NULL;
170 }
171 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000172 if (PyFile_WriteString("\n", outf) != 0)
173 return NULL;
174 if (PyObject_SetAttrString(builtins, "_", o) != 0)
175 return NULL;
176 Py_INCREF(Py_None);
177 return Py_None;
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000178}
179
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000180PyDoc_STRVAR(displayhook_doc,
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000181"displayhook(object) -> None\n"
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000182"\n"
Florent Xicluna5749e852010-03-03 11:54:54 +0000183"Print an object to sys.stdout and also save it in builtins._\n"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000184);
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000185
186static PyObject *
187sys_excepthook(PyObject* self, PyObject* args)
188{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000189 PyObject *exc, *value, *tb;
190 if (!PyArg_UnpackTuple(args, "excepthook", 3, 3, &exc, &value, &tb))
191 return NULL;
192 PyErr_Display(exc, value, tb);
193 Py_INCREF(Py_None);
194 return Py_None;
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000195}
196
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000197PyDoc_STRVAR(excepthook_doc,
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000198"excepthook(exctype, value, traceback) -> None\n"
199"\n"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000200"Handle an exception by displaying it with a traceback on sys.stderr.\n"
201);
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000202
203static PyObject *
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000204sys_exc_info(PyObject *self, PyObject *noargs)
Guido van Rossuma027efa1997-05-05 20:56:21 +0000205{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000206 PyThreadState *tstate;
207 tstate = PyThreadState_GET();
208 return Py_BuildValue(
209 "(OOO)",
210 tstate->exc_type != NULL ? tstate->exc_type : Py_None,
211 tstate->exc_value != NULL ? tstate->exc_value : Py_None,
212 tstate->exc_traceback != NULL ?
213 tstate->exc_traceback : Py_None);
Guido van Rossuma027efa1997-05-05 20:56:21 +0000214}
215
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000216PyDoc_STRVAR(exc_info_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000217"exc_info() -> (type, value, traceback)\n\
218\n\
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000219Return information about the most recent exception caught by an except\n\
220clause in the current stack frame or in an older stack frame."
221);
222
223static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000224sys_exit(PyObject *self, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000225{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000226 PyObject *exit_code = 0;
227 if (!PyArg_UnpackTuple(args, "exit", 0, 1, &exit_code))
228 return NULL;
229 /* Raise SystemExit so callers may catch it or clean up. */
230 PyErr_SetObject(PyExc_SystemExit, exit_code);
231 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000232}
233
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000234PyDoc_STRVAR(exit_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000235"exit([status])\n\
236\n\
237Exit the interpreter by raising SystemExit(status).\n\
238If the status is omitted or None, it defaults to zero (i.e., success).\n\
Neil Schemenauer0f2103f2002-03-23 20:46:35 +0000239If the status is numeric, it will be used as the system exit status.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000240If it is another kind of object, it will be printed and the system\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000241exit status will be one (i.e., failure)."
242);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000243
Martin v. Löwis107b7da2001-11-09 20:59:39 +0000244
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000245static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000246sys_getdefaultencoding(PyObject *self)
Fred Drake8b4d01d2000-05-09 19:57:01 +0000247{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000248 return PyUnicode_FromString(PyUnicode_GetDefaultEncoding());
Fred Drake8b4d01d2000-05-09 19:57:01 +0000249}
250
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000251PyDoc_STRVAR(getdefaultencoding_doc,
Marc-André Lemburg99964b82000-06-07 09:13:41 +0000252"getdefaultencoding() -> string\n\
Fred Drake8b4d01d2000-05-09 19:57:01 +0000253\n\
254Return the current default string encoding used by the Unicode \n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000255implementation."
256);
Fred Drake8b4d01d2000-05-09 19:57:01 +0000257
258static PyObject *
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000259sys_getfilesystemencoding(PyObject *self)
260{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000261 if (Py_FileSystemDefaultEncoding)
262 return PyUnicode_FromString(Py_FileSystemDefaultEncoding);
Victor Stinner27181ac2011-03-31 13:39:03 +0200263 PyErr_SetString(PyExc_RuntimeError,
264 "filesystem encoding is not initialized");
265 return NULL;
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000266}
267
268PyDoc_STRVAR(getfilesystemencoding_doc,
269"getfilesystemencoding() -> string\n\
270\n\
271Return the encoding used to convert Unicode filenames in\n\
272operating system filenames."
273);
274
Martin v. Löwis04dc25c2008-10-03 16:09:28 +0000275static PyObject *
Georg Brandl66a796e2006-12-19 20:50:34 +0000276sys_intern(PyObject *self, PyObject *args)
277{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000278 PyObject *s;
279 if (!PyArg_ParseTuple(args, "U:intern", &s))
280 return NULL;
281 if (PyUnicode_CheckExact(s)) {
282 Py_INCREF(s);
283 PyUnicode_InternInPlace(&s);
284 return s;
285 }
286 else {
287 PyErr_Format(PyExc_TypeError,
288 "can't intern %.400s", s->ob_type->tp_name);
289 return NULL;
290 }
Georg Brandl66a796e2006-12-19 20:50:34 +0000291}
292
293PyDoc_STRVAR(intern_doc,
294"intern(string) -> string\n\
295\n\
296``Intern'' the given string. This enters the string in the (global)\n\
297table of interned strings whose purpose is to speed up dictionary lookups.\n\
298Return the string itself or the previously interned string object with the\n\
299same value.");
300
301
Fred Drake5755ce62001-06-27 19:19:46 +0000302/*
303 * Cached interned string objects used for calling the profile and
304 * trace functions. Initialized by trace_init().
305 */
Nicholas Bastinc69ebe82004-03-24 21:57:10 +0000306static PyObject *whatstrings[7] = {NULL, NULL, NULL, NULL, NULL, NULL, NULL};
Fred Drake5755ce62001-06-27 19:19:46 +0000307
308static int
309trace_init(void)
310{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000311 static char *whatnames[7] = {"call", "exception", "line", "return",
312 "c_call", "c_exception", "c_return"};
313 PyObject *name;
314 int i;
315 for (i = 0; i < 7; ++i) {
316 if (whatstrings[i] == NULL) {
317 name = PyUnicode_InternFromString(whatnames[i]);
318 if (name == NULL)
319 return -1;
320 whatstrings[i] = name;
321 }
322 }
323 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000324}
325
326
327static PyObject *
328call_trampoline(PyThreadState *tstate, PyObject* callback,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000329 PyFrameObject *frame, int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000330{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000331 PyObject *args = PyTuple_New(3);
332 PyObject *whatstr;
333 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000334
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000335 if (args == NULL)
336 return NULL;
337 Py_INCREF(frame);
338 whatstr = whatstrings[what];
339 Py_INCREF(whatstr);
340 if (arg == NULL)
341 arg = Py_None;
342 Py_INCREF(arg);
343 PyTuple_SET_ITEM(args, 0, (PyObject *)frame);
344 PyTuple_SET_ITEM(args, 1, whatstr);
345 PyTuple_SET_ITEM(args, 2, arg);
Fred Drake5755ce62001-06-27 19:19:46 +0000346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 /* call the Python-level function */
348 PyFrame_FastToLocals(frame);
349 result = PyEval_CallObject(callback, args);
350 PyFrame_LocalsToFast(frame, 1);
351 if (result == NULL)
352 PyTraceBack_Here(frame);
Fred Drake5755ce62001-06-27 19:19:46 +0000353
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000354 /* cleanup */
355 Py_DECREF(args);
356 return result;
Fred Drake5755ce62001-06-27 19:19:46 +0000357}
358
359static int
360profile_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000361 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000362{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000363 PyThreadState *tstate = frame->f_tstate;
364 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000365
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000366 if (arg == NULL)
367 arg = Py_None;
368 result = call_trampoline(tstate, self, frame, what, arg);
369 if (result == NULL) {
370 PyEval_SetProfile(NULL, NULL);
371 return -1;
372 }
373 Py_DECREF(result);
374 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000375}
376
377static int
378trace_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000379 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000380{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000381 PyThreadState *tstate = frame->f_tstate;
382 PyObject *callback;
383 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000384
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000385 if (what == PyTrace_CALL)
386 callback = self;
387 else
388 callback = frame->f_trace;
389 if (callback == NULL)
390 return 0;
391 result = call_trampoline(tstate, callback, frame, what, arg);
392 if (result == NULL) {
393 PyEval_SetTrace(NULL, NULL);
394 Py_XDECREF(frame->f_trace);
395 frame->f_trace = NULL;
396 return -1;
397 }
398 if (result != Py_None) {
399 PyObject *temp = frame->f_trace;
400 frame->f_trace = NULL;
401 Py_XDECREF(temp);
402 frame->f_trace = result;
403 }
404 else {
405 Py_DECREF(result);
406 }
407 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000408}
Fred Draked0838392001-06-16 21:02:31 +0000409
Fred Drake8b4d01d2000-05-09 19:57:01 +0000410static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000411sys_settrace(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000412{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000413 if (trace_init() == -1)
414 return NULL;
415 if (args == Py_None)
416 PyEval_SetTrace(NULL, NULL);
417 else
418 PyEval_SetTrace(trace_trampoline, args);
419 Py_INCREF(Py_None);
420 return Py_None;
Guido van Rossume2437a11992-03-23 18:20:18 +0000421}
422
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000423PyDoc_STRVAR(settrace_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000424"settrace(function)\n\
425\n\
426Set the global debug tracing function. It will be called on each\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000427function call. See the debugger chapter in the library manual."
428);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000429
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000430static PyObject *
Christian Heimes9bd667a2008-01-20 15:14:11 +0000431sys_gettrace(PyObject *self, PyObject *args)
432{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000433 PyThreadState *tstate = PyThreadState_GET();
434 PyObject *temp = tstate->c_traceobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000436 if (temp == NULL)
437 temp = Py_None;
438 Py_INCREF(temp);
439 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000440}
441
442PyDoc_STRVAR(gettrace_doc,
443"gettrace()\n\
444\n\
445Return the global debug tracing function set with sys.settrace.\n\
446See the debugger chapter in the library manual."
447);
448
449static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000450sys_setprofile(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000451{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000452 if (trace_init() == -1)
453 return NULL;
454 if (args == Py_None)
455 PyEval_SetProfile(NULL, NULL);
456 else
457 PyEval_SetProfile(profile_trampoline, args);
458 Py_INCREF(Py_None);
459 return Py_None;
Guido van Rossume2437a11992-03-23 18:20:18 +0000460}
461
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000462PyDoc_STRVAR(setprofile_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000463"setprofile(function)\n\
464\n\
465Set the profiling function. It will be called on each function call\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000466and return. See the profiler chapter in the library manual."
467);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000468
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000469static PyObject *
Christian Heimes9bd667a2008-01-20 15:14:11 +0000470sys_getprofile(PyObject *self, PyObject *args)
471{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000472 PyThreadState *tstate = PyThreadState_GET();
473 PyObject *temp = tstate->c_profileobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000474
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000475 if (temp == NULL)
476 temp = Py_None;
477 Py_INCREF(temp);
478 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000479}
480
481PyDoc_STRVAR(getprofile_doc,
482"getprofile()\n\
483\n\
484Return the profiling function set with sys.setprofile.\n\
485See the profiler chapter in the library manual."
486);
487
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000488static int _check_interval = 100;
489
Christian Heimes9bd667a2008-01-20 15:14:11 +0000490static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000491sys_setcheckinterval(PyObject *self, PyObject *args)
Guido van Rossuma0d7a231995-01-09 17:46:13 +0000492{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000493 if (PyErr_WarnEx(PyExc_DeprecationWarning,
494 "sys.getcheckinterval() and sys.setcheckinterval() "
495 "are deprecated. Use sys.setswitchinterval() "
496 "instead.", 1) < 0)
497 return NULL;
498 if (!PyArg_ParseTuple(args, "i:setcheckinterval", &_check_interval))
499 return NULL;
500 Py_INCREF(Py_None);
501 return Py_None;
Guido van Rossuma0d7a231995-01-09 17:46:13 +0000502}
503
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000504PyDoc_STRVAR(setcheckinterval_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000505"setcheckinterval(n)\n\
506\n\
507Tell the Python interpreter to check for asynchronous events every\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000508n instructions. This also affects how often thread switches occur."
509);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000510
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000511static PyObject *
Tim Peterse5e065b2003-07-06 18:36:54 +0000512sys_getcheckinterval(PyObject *self, PyObject *args)
513{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514 if (PyErr_WarnEx(PyExc_DeprecationWarning,
515 "sys.getcheckinterval() and sys.setcheckinterval() "
516 "are deprecated. Use sys.getswitchinterval() "
517 "instead.", 1) < 0)
518 return NULL;
519 return PyLong_FromLong(_check_interval);
Tim Peterse5e065b2003-07-06 18:36:54 +0000520}
521
522PyDoc_STRVAR(getcheckinterval_doc,
523"getcheckinterval() -> current check interval; see setcheckinterval()."
524);
525
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000526#ifdef WITH_THREAD
527static PyObject *
528sys_setswitchinterval(PyObject *self, PyObject *args)
529{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000530 double d;
531 if (!PyArg_ParseTuple(args, "d:setswitchinterval", &d))
532 return NULL;
533 if (d <= 0.0) {
534 PyErr_SetString(PyExc_ValueError,
535 "switch interval must be strictly positive");
536 return NULL;
537 }
538 _PyEval_SetSwitchInterval((unsigned long) (1e6 * d));
539 Py_INCREF(Py_None);
540 return Py_None;
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000541}
542
543PyDoc_STRVAR(setswitchinterval_doc,
544"setswitchinterval(n)\n\
545\n\
546Set the ideal thread switching delay inside the Python interpreter\n\
547The actual frequency of switching threads can be lower if the\n\
548interpreter executes long sequences of uninterruptible code\n\
549(this is implementation-specific and workload-dependent).\n\
550\n\
551The parameter must represent the desired switching delay in seconds\n\
552A typical value is 0.005 (5 milliseconds)."
553);
554
555static PyObject *
556sys_getswitchinterval(PyObject *self, PyObject *args)
557{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000558 return PyFloat_FromDouble(1e-6 * _PyEval_GetSwitchInterval());
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000559}
560
561PyDoc_STRVAR(getswitchinterval_doc,
562"getswitchinterval() -> current thread switch interval; see setswitchinterval()."
563);
564
565#endif /* WITH_THREAD */
566
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000567#ifdef WITH_TSC
568static PyObject *
569sys_settscdump(PyObject *self, PyObject *args)
570{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000571 int bool;
572 PyThreadState *tstate = PyThreadState_Get();
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000573
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000574 if (!PyArg_ParseTuple(args, "i:settscdump", &bool))
575 return NULL;
576 if (bool)
577 tstate->interp->tscdump = 1;
578 else
579 tstate->interp->tscdump = 0;
580 Py_INCREF(Py_None);
581 return Py_None;
Tim Peters216b78b2006-01-06 02:40:53 +0000582
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000583}
584
Tim Peters216b78b2006-01-06 02:40:53 +0000585PyDoc_STRVAR(settscdump_doc,
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000586"settscdump(bool)\n\
587\n\
588If true, tell the Python interpreter to dump VM measurements to\n\
589stderr. If false, turn off dump. The measurements are based on the\n\
Michael W. Hudson800ba232004-08-12 18:19:17 +0000590processor's time-stamp counter."
Tim Peters216b78b2006-01-06 02:40:53 +0000591);
Neal Norwitz0f5aed42004-06-13 20:32:17 +0000592#endif /* TSC */
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000593
Tim Peterse5e065b2003-07-06 18:36:54 +0000594static PyObject *
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000595sys_setrecursionlimit(PyObject *self, PyObject *args)
596{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000597 int new_limit;
598 if (!PyArg_ParseTuple(args, "i:setrecursionlimit", &new_limit))
599 return NULL;
600 if (new_limit <= 0) {
601 PyErr_SetString(PyExc_ValueError,
602 "recursion limit must be positive");
603 return NULL;
604 }
605 Py_SetRecursionLimit(new_limit);
606 Py_INCREF(Py_None);
607 return Py_None;
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000608}
609
Mark Dickinsondc787d22010-05-23 13:33:13 +0000610static PyTypeObject Hash_InfoType;
611
612PyDoc_STRVAR(hash_info_doc,
613"hash_info\n\
614\n\
615A struct sequence providing parameters used for computing\n\
616numeric hashes. The attributes are read only.");
617
618static PyStructSequence_Field hash_info_fields[] = {
619 {"width", "width of the type used for hashing, in bits"},
620 {"modulus", "prime number giving the modulus on which the hash "
621 "function is based"},
622 {"inf", "value to be used for hash of a positive infinity"},
623 {"nan", "value to be used for hash of a nan"},
624 {"imag", "multiplier used for the imaginary part of a complex number"},
625 {NULL, NULL}
626};
627
628static PyStructSequence_Desc hash_info_desc = {
629 "sys.hash_info",
630 hash_info_doc,
631 hash_info_fields,
632 5,
633};
634
Matthias Klosed885e952010-07-06 10:53:30 +0000635static PyObject *
Mark Dickinsondc787d22010-05-23 13:33:13 +0000636get_hash_info(void)
637{
638 PyObject *hash_info;
639 int field = 0;
640 hash_info = PyStructSequence_New(&Hash_InfoType);
641 if (hash_info == NULL)
642 return NULL;
643 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000644 PyLong_FromLong(8*sizeof(Py_hash_t)));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000645 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000646 PyLong_FromSsize_t(_PyHASH_MODULUS));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000647 PyStructSequence_SET_ITEM(hash_info, field++,
648 PyLong_FromLong(_PyHASH_INF));
649 PyStructSequence_SET_ITEM(hash_info, field++,
650 PyLong_FromLong(_PyHASH_NAN));
651 PyStructSequence_SET_ITEM(hash_info, field++,
652 PyLong_FromLong(_PyHASH_IMAG));
653 if (PyErr_Occurred()) {
654 Py_CLEAR(hash_info);
655 return NULL;
656 }
657 return hash_info;
658}
659
660
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000661PyDoc_STRVAR(setrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000662"setrecursionlimit(n)\n\
663\n\
664Set the maximum depth of the Python interpreter stack to n. This\n\
665limit prevents infinite recursion from causing an overflow of the C\n\
666stack and crashing Python. The highest possible limit is platform-\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000667dependent."
668);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000669
670static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000671sys_getrecursionlimit(PyObject *self)
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000672{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000673 return PyLong_FromLong(Py_GetRecursionLimit());
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000674}
675
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000676PyDoc_STRVAR(getrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000677"getrecursionlimit()\n\
678\n\
679Return the current value of the recursion limit, the maximum depth\n\
680of the Python interpreter stack. This limit prevents infinite\n\
Jack Jansene739a0d2002-06-26 20:39:20 +0000681recursion from causing an overflow of the C stack and crashing Python."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000682);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000683
Mark Hammond8696ebc2002-10-08 02:44:31 +0000684#ifdef MS_WINDOWS
685PyDoc_STRVAR(getwindowsversion_doc,
686"getwindowsversion()\n\
687\n\
Eric Smithf7bb5782010-01-27 00:44:57 +0000688Return information about the running version of Windows as a named tuple.\n\
689The members are named: major, minor, build, platform, service_pack,\n\
690service_pack_major, service_pack_minor, suite_mask, and product_type. For\n\
Ezio Melotti4969f702011-03-15 05:59:46 +0200691backward compatibility, only the first 5 items are available by indexing.\n\
Eric Smithf7bb5782010-01-27 00:44:57 +0000692All elements are numbers, except service_pack which is a string. Platform\n\
693may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7,\n\
6943 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain\n\
695controller, 3 for a server."
Mark Hammond8696ebc2002-10-08 02:44:31 +0000696);
697
Eric Smithf7bb5782010-01-27 00:44:57 +0000698static PyTypeObject WindowsVersionType = {0, 0, 0, 0, 0, 0};
699
700static PyStructSequence_Field windows_version_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000701 {"major", "Major version number"},
702 {"minor", "Minor version number"},
703 {"build", "Build number"},
704 {"platform", "Operating system platform"},
705 {"service_pack", "Latest Service Pack installed on the system"},
706 {"service_pack_major", "Service Pack major version number"},
707 {"service_pack_minor", "Service Pack minor version number"},
708 {"suite_mask", "Bit mask identifying available product suites"},
709 {"product_type", "System product type"},
710 {0}
Eric Smithf7bb5782010-01-27 00:44:57 +0000711};
712
713static PyStructSequence_Desc windows_version_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000714 "sys.getwindowsversion", /* name */
715 getwindowsversion_doc, /* doc */
716 windows_version_fields, /* fields */
717 5 /* For backward compatibility,
718 only the first 5 items are accessible
719 via indexing, the rest are name only */
Eric Smithf7bb5782010-01-27 00:44:57 +0000720};
721
Mark Hammond8696ebc2002-10-08 02:44:31 +0000722static PyObject *
723sys_getwindowsversion(PyObject *self)
724{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000725 PyObject *version;
726 int pos = 0;
727 OSVERSIONINFOEX ver;
728 ver.dwOSVersionInfoSize = sizeof(ver);
729 if (!GetVersionEx((OSVERSIONINFO*) &ver))
730 return PyErr_SetFromWindowsErr(0);
Eric Smithf7bb5782010-01-27 00:44:57 +0000731
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000732 version = PyStructSequence_New(&WindowsVersionType);
733 if (version == NULL)
734 return NULL;
Eric Smithf7bb5782010-01-27 00:44:57 +0000735
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMajorVersion));
737 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMinorVersion));
738 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwBuildNumber));
739 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwPlatformId));
740 PyStructSequence_SET_ITEM(version, pos++, PyUnicode_FromString(ver.szCSDVersion));
741 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMajor));
742 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMinor));
743 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wSuiteMask));
744 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wProductType));
Eric Smithf7bb5782010-01-27 00:44:57 +0000745
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000746 return version;
Mark Hammond8696ebc2002-10-08 02:44:31 +0000747}
748
749#endif /* MS_WINDOWS */
750
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000751#ifdef HAVE_DLOPEN
752static PyObject *
753sys_setdlopenflags(PyObject *self, PyObject *args)
754{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000755 int new_val;
756 PyThreadState *tstate = PyThreadState_GET();
757 if (!PyArg_ParseTuple(args, "i:setdlopenflags", &new_val))
758 return NULL;
759 if (!tstate)
760 return NULL;
761 tstate->interp->dlopenflags = new_val;
762 Py_INCREF(Py_None);
763 return Py_None;
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000764}
765
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000766PyDoc_STRVAR(setdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000767"setdlopenflags(n) -> None\n\
768\n\
Alexandre Vassalotti260484d2009-07-17 11:43:26 +0000769Set the flags used by the interpreter for dlopen calls, such as when the\n\
770interpreter loads extension modules. Among other things, this will enable\n\
771a lazy resolving of symbols when importing a module, if called as\n\
772sys.setdlopenflags(0). To share symbols across extension modules, call as\n\
773sys.setdlopenflags(ctypes.RTLD_GLOBAL). Symbolic names for the flag modules\n\
774can be either found in the ctypes module, or in the DLFCN module. If DLFCN\n\
775is not available, it can be generated from /usr/include/dlfcn.h using the\n\
776h2py script.");
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000777
778static PyObject *
779sys_getdlopenflags(PyObject *self, PyObject *args)
780{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 PyThreadState *tstate = PyThreadState_GET();
782 if (!tstate)
783 return NULL;
784 return PyLong_FromLong(tstate->interp->dlopenflags);
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000785}
786
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000787PyDoc_STRVAR(getdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000788"getdlopenflags() -> int\n\
789\n\
Alexandre Vassalotti260484d2009-07-17 11:43:26 +0000790Return the current value of the flags that are used for dlopen calls.\n\
791The flag constants are defined in the ctypes and DLFCN modules.");
792
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000793#endif /* HAVE_DLOPEN */
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000794
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000795#ifdef USE_MALLOPT
796/* Link with -lmalloc (or -lmpc) on an SGI */
797#include <malloc.h>
798
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000799static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000800sys_mdebug(PyObject *self, PyObject *args)
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000801{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000802 int flag;
803 if (!PyArg_ParseTuple(args, "i:mdebug", &flag))
804 return NULL;
805 mallopt(M_DEBUG, flag);
806 Py_INCREF(Py_None);
807 return Py_None;
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000808}
809#endif /* USE_MALLOPT */
810
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000811static PyObject *
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000812sys_getsizeof(PyObject *self, PyObject *args, PyObject *kwds)
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000813{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000814 PyObject *res = NULL;
815 static PyObject *str__sizeof__ = NULL, *gc_head_size = NULL;
816 static char *kwlist[] = {"object", "default", 0};
817 PyObject *o, *dflt = NULL;
818 PyObject *method;
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000819
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000820 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|O:getsizeof",
821 kwlist, &o, &dflt))
822 return NULL;
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000823
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 /* Initialize static variable for GC head size */
825 if (gc_head_size == NULL) {
826 gc_head_size = PyLong_FromSsize_t(sizeof(PyGC_Head));
827 if (gc_head_size == NULL)
828 return NULL;
829 }
Benjamin Petersona5758c02009-05-09 18:15:04 +0000830
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000831 /* Make sure the type is initialized. float gets initialized late */
832 if (PyType_Ready(Py_TYPE(o)) < 0)
833 return NULL;
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000834
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000835 method = _PyObject_LookupSpecial(o, "__sizeof__",
836 &str__sizeof__);
837 if (method == NULL) {
838 if (!PyErr_Occurred())
839 PyErr_Format(PyExc_TypeError,
840 "Type %.100s doesn't define __sizeof__",
841 Py_TYPE(o)->tp_name);
842 }
843 else {
844 res = PyObject_CallFunctionObjArgs(method, NULL);
845 Py_DECREF(method);
846 }
847
848 /* Has a default value been given */
849 if ((res == NULL) && (dflt != NULL) &&
850 PyErr_ExceptionMatches(PyExc_TypeError))
851 {
852 PyErr_Clear();
853 Py_INCREF(dflt);
854 return dflt;
855 }
856 else if (res == NULL)
857 return res;
858
859 /* add gc_head size */
860 if (PyObject_IS_GC(o)) {
861 PyObject *tmp = res;
862 res = PyNumber_Add(tmp, gc_head_size);
863 Py_DECREF(tmp);
864 }
865 return res;
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000866}
867
868PyDoc_STRVAR(getsizeof_doc,
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000869"getsizeof(object, default) -> int\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000870\n\
871Return the size of object in bytes.");
872
873static PyObject *
Fred Drakea7688822001-10-24 20:47:48 +0000874sys_getrefcount(PyObject *self, PyObject *arg)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000875{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000876 return PyLong_FromSsize_t(arg->ob_refcnt);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000877}
878
Tim Peters4be93d02002-07-07 19:59:50 +0000879#ifdef Py_REF_DEBUG
Mark Hammond440d8982000-06-20 08:12:48 +0000880static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000881sys_gettotalrefcount(PyObject *self)
Mark Hammond440d8982000-06-20 08:12:48 +0000882{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000883 return PyLong_FromSsize_t(_Py_GetRefTotal());
Mark Hammond440d8982000-06-20 08:12:48 +0000884}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000885#endif /* Py_REF_DEBUG */
Mark Hammond440d8982000-06-20 08:12:48 +0000886
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000887PyDoc_STRVAR(getrefcount_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000888"getrefcount(object) -> integer\n\
889\n\
Fred Drakeba3ff1b2002-06-20 21:36:19 +0000890Return the reference count of object. The count returned is generally\n\
891one higher than you might expect, because it includes the (temporary)\n\
892reference as an argument to getrefcount()."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000893);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000894
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000895#ifdef COUNT_ALLOCS
896static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000897sys_getcounts(PyObject *self)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000898{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000899 extern PyObject *get_counts(void);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000900
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000901 return get_counts();
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000902}
903#endif
904
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000905PyDoc_STRVAR(getframe_doc,
Barry Warsawb6a54d22000-12-06 21:47:46 +0000906"_getframe([depth]) -> frameobject\n\
907\n\
908Return a frame object from the call stack. If optional integer depth is\n\
909given, return the frame object that many calls below the top of the stack.\n\
910If that is deeper than the call stack, ValueError is raised. The default\n\
911for depth is zero, returning the frame at the top of the call stack.\n\
912\n\
913This function should be used for internal and specialized\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000914purposes only."
915);
Barry Warsawb6a54d22000-12-06 21:47:46 +0000916
917static PyObject *
918sys_getframe(PyObject *self, PyObject *args)
919{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000920 PyFrameObject *f = PyThreadState_GET()->frame;
921 int depth = -1;
Barry Warsawb6a54d22000-12-06 21:47:46 +0000922
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000923 if (!PyArg_ParseTuple(args, "|i:_getframe", &depth))
924 return NULL;
Barry Warsawb6a54d22000-12-06 21:47:46 +0000925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000926 while (depth > 0 && f != NULL) {
927 f = f->f_back;
928 --depth;
929 }
930 if (f == NULL) {
931 PyErr_SetString(PyExc_ValueError,
932 "call stack is not deep enough");
933 return NULL;
934 }
935 Py_INCREF(f);
936 return (PyObject*)f;
Barry Warsawb6a54d22000-12-06 21:47:46 +0000937}
938
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000939PyDoc_STRVAR(current_frames_doc,
940"_current_frames() -> dictionary\n\
941\n\
942Return a dictionary mapping each current thread T's thread id to T's\n\
943current stack frame.\n\
944\n\
945This function should be used for specialized purposes only."
946);
947
948static PyObject *
949sys_current_frames(PyObject *self, PyObject *noargs)
950{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000951 return _PyThread_CurrentFrames();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000952}
953
Guido van Rossuma12fe4e2003-04-09 19:06:21 +0000954PyDoc_STRVAR(call_tracing_doc,
955"call_tracing(func, args) -> object\n\
956\n\
957Call func(*args), while tracing is enabled. The tracing state is\n\
958saved, and restored afterwards. This is intended to be called from\n\
959a debugger from a checkpoint, to recursively debug some other code."
960);
961
962static PyObject *
963sys_call_tracing(PyObject *self, PyObject *args)
964{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000965 PyObject *func, *funcargs;
966 if (!PyArg_ParseTuple(args, "OO!:call_tracing", &func, &PyTuple_Type, &funcargs))
967 return NULL;
968 return _PyEval_CallTracing(func, funcargs);
Guido van Rossuma12fe4e2003-04-09 19:06:21 +0000969}
970
Jeremy Hylton985eba52003-02-05 23:13:00 +0000971PyDoc_STRVAR(callstats_doc,
972"callstats() -> tuple of integers\n\
973\n\
974Return a tuple of function call statistics, if CALL_PROFILE was defined\n\
975when Python was built. Otherwise, return None.\n\
976\n\
977When enabled, this function returns detailed, implementation-specific\n\
978details about the number of function calls executed. The return value is\n\
979a 11-tuple where the entries in the tuple are counts of:\n\
9800. all function calls\n\
9811. calls to PyFunction_Type objects\n\
9822. PyFunction calls that do not create an argument tuple\n\
9833. PyFunction calls that do not create an argument tuple\n\
984 and bypass PyEval_EvalCodeEx()\n\
9854. PyMethod calls\n\
9865. PyMethod calls on bound methods\n\
9876. PyType calls\n\
9887. PyCFunction calls\n\
9898. generator calls\n\
9909. All other calls\n\
99110. Number of stack pops performed by call_function()"
992);
Barry Warsawb6a54d22000-12-06 21:47:46 +0000993
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000994#ifdef __cplusplus
995extern "C" {
996#endif
997
Guido van Rossum7f3f2c11996-05-23 22:45:41 +0000998#ifdef Py_TRACE_REFS
Guido van Rossumded690f1996-05-24 20:48:31 +0000999/* Defined in objects.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001000extern PyObject *_Py_GetObjects(PyObject *, PyObject *);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001001#endif
Guido van Rossumded690f1996-05-24 20:48:31 +00001002
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001003#ifdef DYNAMIC_EXECUTION_PROFILE
1004/* Defined in ceval.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001005extern PyObject *_Py_GetDXProfile(PyObject *, PyObject *);
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001006#endif
1007
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001008#ifdef __cplusplus
1009}
1010#endif
1011
Christian Heimes15ebc882008-02-04 18:48:49 +00001012static PyObject *
1013sys_clear_type_cache(PyObject* self, PyObject* args)
1014{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001015 PyType_ClearCache();
1016 Py_RETURN_NONE;
Christian Heimes15ebc882008-02-04 18:48:49 +00001017}
1018
1019PyDoc_STRVAR(sys_clear_type_cache__doc__,
1020"_clear_type_cache() -> None\n\
1021Clear the internal type lookup cache.");
1022
1023
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001024static PyMethodDef sys_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001025 /* Might as well keep this in alphabetic order */
1026 {"callstats", (PyCFunction)PyEval_GetCallStats, METH_NOARGS,
1027 callstats_doc},
1028 {"_clear_type_cache", sys_clear_type_cache, METH_NOARGS,
1029 sys_clear_type_cache__doc__},
1030 {"_current_frames", sys_current_frames, METH_NOARGS,
1031 current_frames_doc},
1032 {"displayhook", sys_displayhook, METH_O, displayhook_doc},
1033 {"exc_info", sys_exc_info, METH_NOARGS, exc_info_doc},
1034 {"excepthook", sys_excepthook, METH_VARARGS, excepthook_doc},
1035 {"exit", sys_exit, METH_VARARGS, exit_doc},
1036 {"getdefaultencoding", (PyCFunction)sys_getdefaultencoding,
1037 METH_NOARGS, getdefaultencoding_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001038#ifdef HAVE_DLOPEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001039 {"getdlopenflags", (PyCFunction)sys_getdlopenflags, METH_NOARGS,
1040 getdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001041#endif
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001042#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001043 {"getcounts", (PyCFunction)sys_getcounts, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001044#endif
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001045#ifdef DYNAMIC_EXECUTION_PROFILE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 {"getdxp", _Py_GetDXProfile, METH_VARARGS},
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001047#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001048 {"getfilesystemencoding", (PyCFunction)sys_getfilesystemencoding,
1049 METH_NOARGS, getfilesystemencoding_doc},
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001050#ifdef Py_TRACE_REFS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001051 {"getobjects", _Py_GetObjects, METH_VARARGS},
Tim Peters4be93d02002-07-07 19:59:50 +00001052#endif
1053#ifdef Py_REF_DEBUG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001054 {"gettotalrefcount", (PyCFunction)sys_gettotalrefcount, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001055#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001056 {"getrefcount", (PyCFunction)sys_getrefcount, METH_O, getrefcount_doc},
1057 {"getrecursionlimit", (PyCFunction)sys_getrecursionlimit, METH_NOARGS,
1058 getrecursionlimit_doc},
1059 {"getsizeof", (PyCFunction)sys_getsizeof,
1060 METH_VARARGS | METH_KEYWORDS, getsizeof_doc},
1061 {"_getframe", sys_getframe, METH_VARARGS, getframe_doc},
Mark Hammond8696ebc2002-10-08 02:44:31 +00001062#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001063 {"getwindowsversion", (PyCFunction)sys_getwindowsversion, METH_NOARGS,
1064 getwindowsversion_doc},
Mark Hammond8696ebc2002-10-08 02:44:31 +00001065#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001066 {"intern", sys_intern, METH_VARARGS, intern_doc},
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001067#ifdef USE_MALLOPT
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001068 {"mdebug", sys_mdebug, METH_VARARGS},
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001069#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001070 {"setcheckinterval", sys_setcheckinterval, METH_VARARGS,
1071 setcheckinterval_doc},
1072 {"getcheckinterval", sys_getcheckinterval, METH_NOARGS,
1073 getcheckinterval_doc},
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001074#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001075 {"setswitchinterval", sys_setswitchinterval, METH_VARARGS,
1076 setswitchinterval_doc},
1077 {"getswitchinterval", sys_getswitchinterval, METH_NOARGS,
1078 getswitchinterval_doc},
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001079#endif
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001080#ifdef HAVE_DLOPEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001081 {"setdlopenflags", sys_setdlopenflags, METH_VARARGS,
1082 setdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001083#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001084 {"setprofile", sys_setprofile, METH_O, setprofile_doc},
1085 {"getprofile", sys_getprofile, METH_NOARGS, getprofile_doc},
1086 {"setrecursionlimit", sys_setrecursionlimit, METH_VARARGS,
1087 setrecursionlimit_doc},
Martin v. Löwisf30d60e2004-06-08 08:17:44 +00001088#ifdef WITH_TSC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001089 {"settscdump", sys_settscdump, METH_VARARGS, settscdump_doc},
Martin v. Löwisf30d60e2004-06-08 08:17:44 +00001090#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001091 {"settrace", sys_settrace, METH_O, settrace_doc},
1092 {"gettrace", sys_gettrace, METH_NOARGS, gettrace_doc},
1093 {"call_tracing", sys_call_tracing, METH_VARARGS, call_tracing_doc},
1094 {NULL, NULL} /* sentinel */
Guido van Rossum3f5da241990-12-20 15:06:42 +00001095};
1096
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001097static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001098list_builtin_module_names(void)
Guido van Rossum34679b71993-01-26 13:33:44 +00001099{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001100 PyObject *list = PyList_New(0);
1101 int i;
1102 if (list == NULL)
1103 return NULL;
1104 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1105 PyObject *name = PyUnicode_FromString(
1106 PyImport_Inittab[i].name);
1107 if (name == NULL)
1108 break;
1109 PyList_Append(list, name);
1110 Py_DECREF(name);
1111 }
1112 if (PyList_Sort(list) != 0) {
1113 Py_DECREF(list);
1114 list = NULL;
1115 }
1116 if (list) {
1117 PyObject *v = PyList_AsTuple(list);
1118 Py_DECREF(list);
1119 list = v;
1120 }
1121 return list;
Guido van Rossum34679b71993-01-26 13:33:44 +00001122}
1123
Guido van Rossum23fff912000-12-15 22:02:05 +00001124static PyObject *warnoptions = NULL;
1125
1126void
1127PySys_ResetWarnOptions(void)
1128{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001129 if (warnoptions == NULL || !PyList_Check(warnoptions))
1130 return;
1131 PyList_SetSlice(warnoptions, 0, PyList_GET_SIZE(warnoptions), NULL);
Guido van Rossum23fff912000-12-15 22:02:05 +00001132}
1133
1134void
Victor Stinner9ca9c252010-05-19 16:53:30 +00001135PySys_AddWarnOptionUnicode(PyObject *unicode)
Guido van Rossum23fff912000-12-15 22:02:05 +00001136{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001137 if (warnoptions == NULL || !PyList_Check(warnoptions)) {
1138 Py_XDECREF(warnoptions);
1139 warnoptions = PyList_New(0);
1140 if (warnoptions == NULL)
1141 return;
1142 }
Victor Stinner9ca9c252010-05-19 16:53:30 +00001143 PyList_Append(warnoptions, unicode);
1144}
1145
1146void
1147PySys_AddWarnOption(const wchar_t *s)
1148{
1149 PyObject *unicode;
1150 unicode = PyUnicode_FromWideChar(s, -1);
1151 if (unicode == NULL)
1152 return;
1153 PySys_AddWarnOptionUnicode(unicode);
1154 Py_DECREF(unicode);
Guido van Rossum23fff912000-12-15 22:02:05 +00001155}
1156
Christian Heimes33fe8092008-04-13 13:53:33 +00001157int
1158PySys_HasWarnOptions(void)
1159{
1160 return (warnoptions != NULL && (PyList_Size(warnoptions) > 0)) ? 1 : 0;
1161}
1162
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001163static PyObject *xoptions = NULL;
1164
1165static PyObject *
1166get_xoptions(void)
1167{
1168 if (xoptions == NULL || !PyDict_Check(xoptions)) {
1169 Py_XDECREF(xoptions);
1170 xoptions = PyDict_New();
1171 }
1172 return xoptions;
1173}
1174
1175void
1176PySys_AddXOption(const wchar_t *s)
1177{
1178 PyObject *opts;
1179 PyObject *name = NULL, *value = NULL;
1180 const wchar_t *name_end;
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001181
1182 opts = get_xoptions();
1183 if (opts == NULL)
1184 goto error;
1185
1186 name_end = wcschr(s, L'=');
1187 if (!name_end) {
1188 name = PyUnicode_FromWideChar(s, -1);
1189 value = Py_True;
1190 Py_INCREF(value);
1191 }
1192 else {
1193 name = PyUnicode_FromWideChar(s, name_end - s);
1194 value = PyUnicode_FromWideChar(name_end + 1, -1);
1195 }
1196 if (name == NULL || value == NULL)
1197 goto error;
Brett Cannonb94767f2011-02-22 20:15:44 +00001198 PyDict_SetItem(opts, name, value);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001199 Py_DECREF(name);
1200 Py_DECREF(value);
1201 return;
1202
1203error:
1204 Py_XDECREF(name);
1205 Py_XDECREF(value);
1206 /* No return value, therefore clear error state if possible */
1207 if (_Py_atomic_load_relaxed(&_PyThreadState_Current))
1208 PyErr_Clear();
1209}
1210
1211PyObject *
1212PySys_GetXOptions(void)
1213{
1214 return get_xoptions();
1215}
1216
Guido van Rossum40552d01998-08-06 03:34:39 +00001217/* XXX This doc string is too long to be a single string literal in VC++ 5.0.
1218 Two literals concatenated works just fine. If you have a K&R compiler
1219 or other abomination that however *does* understand longer strings,
1220 get rid of the !!! comment in the middle and the quotes that surround it. */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001221PyDoc_VAR(sys_doc) =
1222PyDoc_STR(
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001223"This module provides access to some objects used or maintained by the\n\
1224interpreter and to functions that interact strongly with the interpreter.\n\
1225\n\
1226Dynamic objects:\n\
1227\n\
1228argv -- command line arguments; argv[0] is the script pathname if known\n\
1229path -- module search path; path[0] is the script directory, else ''\n\
1230modules -- dictionary of loaded modules\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001231\n\
1232displayhook -- called to show results in an interactive session\n\
1233excepthook -- called to handle any uncaught exception other than SystemExit\n\
1234 To customize printing in an interactive session or to install a custom\n\
1235 top-level exception handler, assign other functions to replace these.\n\
1236\n\
Benjamin Peterson06157a42008-07-15 00:28:36 +00001237stdin -- standard input file object; used by input()\n\
Georg Brandl88fc6642007-02-09 21:28:07 +00001238stdout -- standard output file object; used by print()\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001239stderr -- standard error object; used for error messages\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001240 By assigning other file objects (or objects that behave like files)\n\
1241 to these, it is possible to redirect all of the interpreter's I/O.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001242\n\
1243last_type -- type of last uncaught exception\n\
1244last_value -- value of last uncaught exception\n\
1245last_traceback -- traceback of last uncaught exception\n\
1246 These three are only available in an interactive session after a\n\
1247 traceback has been printed.\n\
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001248"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001249)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001250/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001251PyDoc_STR(
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001252"\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001253Static objects:\n\
1254\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001255builtin_module_names -- tuple of module names built into this interpreter\n\
1256copyright -- copyright notice pertaining to this interpreter\n\
1257exec_prefix -- prefix used to find the machine-specific Python library\n\
1258executable -- pathname of this Python interpreter\n\
1259float_info -- a struct sequence with information about the float implementation.\n\
1260float_repr_style -- string indicating the style of repr() output for floats\n\
1261hexversion -- version information encoded as a single integer\n\
Mark Dickinsonbd792642009-03-18 20:06:12 +00001262int_info -- a struct sequence with information about the int implementation.\n\
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001263maxsize -- the largest supported length of containers.\n\
Martin v. Löwisce9b5a52001-06-27 06:28:56 +00001264maxunicode -- the largest supported character\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001265platform -- platform identifier\n\
1266prefix -- prefix used to find the Python library\n\
1267thread_info -- a struct sequence with information about the thread implementation.\n\
Fred Drake801c08d2000-04-13 15:29:10 +00001268version -- the version of this interpreter as a string\n\
Eric Smith0e5b5622009-02-06 01:32:42 +00001269version_info -- version information as a named tuple\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001270"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001271)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001272#ifdef MS_WINDOWS
1273/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001274PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001275"dllhandle -- [Windows only] integer handle of the Python DLL\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001276winver -- [Windows only] version number of the Python DLL\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001277"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001278)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001279#endif /* MS_WINDOWS */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001280PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001281"__stdin__ -- the original stdin; don't touch!\n\
1282__stdout__ -- the original stdout; don't touch!\n\
1283__stderr__ -- the original stderr; don't touch!\n\
1284__displayhook__ -- the original displayhook; don't touch!\n\
1285__excepthook__ -- the original excepthook; don't touch!\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001286\n\
1287Functions:\n\
1288\n\
Georg Brandl1a3284e2007-12-02 09:40:06 +00001289displayhook() -- print an object to the screen, and save it in builtins._\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001290excepthook() -- print an exception and its traceback to sys.stderr\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001291exc_info() -- return thread-safe information about the current exception\n\
1292exit() -- exit the interpreter by raising SystemExit\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001293getdlopenflags() -- returns flags to be used for dlopen() calls\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001294getprofile() -- get the global profiling function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001295getrefcount() -- return the reference count for an object (plus one :-)\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001296getrecursionlimit() -- return the max recursion depth for the interpreter\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001297getsizeof() -- return the size of an object in bytes\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001298gettrace() -- get the global debug tracing function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001299setcheckinterval() -- control how often the interpreter checks for events\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001300setdlopenflags() -- set the flags to be used for dlopen() calls\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001301setprofile() -- set the global profiling function\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001302setrecursionlimit() -- set the max recursion depth for the interpreter\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001303settrace() -- set the global debug tracing function\n\
Fred Drakeccede592000-08-14 20:59:57 +00001304"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001305)
Fred Drakeccede592000-08-14 20:59:57 +00001306/* end of sys_doc */ ;
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001307
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001308
1309PyDoc_STRVAR(flags__doc__,
1310"sys.flags\n\
1311\n\
1312Flags provided through command line arguments or environment vars.");
1313
1314static PyTypeObject FlagsType;
1315
1316static PyStructSequence_Field flags_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001317 {"debug", "-d"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001318 {"inspect", "-i"},
1319 {"interactive", "-i"},
1320 {"optimize", "-O or -OO"},
1321 {"dont_write_bytecode", "-B"},
1322 {"no_user_site", "-s"},
1323 {"no_site", "-S"},
1324 {"ignore_environment", "-E"},
1325 {"verbose", "-v"},
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001326#ifdef RISCOS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001327 {"riscos_wimp", "???"},
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001328#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001329 /* {"unbuffered", "-u"}, */
1330 /* {"skip_first", "-x"}, */
Georg Brandl8aa7e992010-12-28 18:30:18 +00001331 {"bytes_warning", "-b"},
1332 {"quiet", "-q"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001333 {0}
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001334};
1335
1336static PyStructSequence_Desc flags_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001337 "sys.flags", /* name */
1338 flags__doc__, /* doc */
1339 flags_fields, /* fields */
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001340#ifdef RISCOS
Raymond Hettinger90e8f8c2011-01-05 20:08:25 +00001341 12
Éric Araujobe3bd572011-03-26 01:55:15 +01001342#else
1343 11
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001344#endif
1345};
1346
1347static PyObject*
1348make_flags(void)
1349{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001350 int pos = 0;
1351 PyObject *seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001352
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353 seq = PyStructSequence_New(&FlagsType);
1354 if (seq == NULL)
1355 return NULL;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001356
1357#define SetFlag(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001358 PyStructSequence_SET_ITEM(seq, pos++, PyLong_FromLong(flag))
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001359
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001360 SetFlag(Py_DebugFlag);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001361 SetFlag(Py_InspectFlag);
1362 SetFlag(Py_InteractiveFlag);
1363 SetFlag(Py_OptimizeFlag);
1364 SetFlag(Py_DontWriteBytecodeFlag);
1365 SetFlag(Py_NoUserSiteDirectory);
1366 SetFlag(Py_NoSiteFlag);
1367 SetFlag(Py_IgnoreEnvironmentFlag);
1368 SetFlag(Py_VerboseFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001369#ifdef RISCOS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001370 SetFlag(Py_RISCOSWimpFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001371#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 /* SetFlag(saw_unbuffered_flag); */
1373 /* SetFlag(skipfirstline); */
Christian Heimes33fe8092008-04-13 13:53:33 +00001374 SetFlag(Py_BytesWarningFlag);
Georg Brandl8aa7e992010-12-28 18:30:18 +00001375 SetFlag(Py_QuietFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001376#undef SetFlag
1377
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001378 if (PyErr_Occurred()) {
1379 return NULL;
1380 }
1381 return seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001382}
1383
Eric Smith0e5b5622009-02-06 01:32:42 +00001384PyDoc_STRVAR(version_info__doc__,
1385"sys.version_info\n\
1386\n\
1387Version information as a named tuple.");
1388
1389static PyTypeObject VersionInfoType;
1390
1391static PyStructSequence_Field version_info_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001392 {"major", "Major release number"},
1393 {"minor", "Minor release number"},
1394 {"micro", "Patch release number"},
1395 {"releaselevel", "'alpha', 'beta', 'candidate', or 'release'"},
1396 {"serial", "Serial release number"},
1397 {0}
Eric Smith0e5b5622009-02-06 01:32:42 +00001398};
1399
1400static PyStructSequence_Desc version_info_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001401 "sys.version_info", /* name */
1402 version_info__doc__, /* doc */
1403 version_info_fields, /* fields */
1404 5
Eric Smith0e5b5622009-02-06 01:32:42 +00001405};
1406
1407static PyObject *
1408make_version_info(void)
1409{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001410 PyObject *version_info;
1411 char *s;
1412 int pos = 0;
Eric Smith0e5b5622009-02-06 01:32:42 +00001413
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 version_info = PyStructSequence_New(&VersionInfoType);
1415 if (version_info == NULL) {
1416 return NULL;
1417 }
Eric Smith0e5b5622009-02-06 01:32:42 +00001418
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 /*
1420 * These release level checks are mutually exclusive and cover
1421 * the field, so don't get too fancy with the pre-processor!
1422 */
Eric Smith0e5b5622009-02-06 01:32:42 +00001423#if PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_ALPHA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001424 s = "alpha";
Eric Smith0e5b5622009-02-06 01:32:42 +00001425#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_BETA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001426 s = "beta";
Eric Smith0e5b5622009-02-06 01:32:42 +00001427#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_GAMMA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 s = "candidate";
Eric Smith0e5b5622009-02-06 01:32:42 +00001429#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_FINAL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001430 s = "final";
Eric Smith0e5b5622009-02-06 01:32:42 +00001431#endif
1432
1433#define SetIntItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001434 PyStructSequence_SET_ITEM(version_info, pos++, PyLong_FromLong(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001435#define SetStrItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 PyStructSequence_SET_ITEM(version_info, pos++, PyUnicode_FromString(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001438 SetIntItem(PY_MAJOR_VERSION);
1439 SetIntItem(PY_MINOR_VERSION);
1440 SetIntItem(PY_MICRO_VERSION);
1441 SetStrItem(s);
1442 SetIntItem(PY_RELEASE_SERIAL);
Eric Smith0e5b5622009-02-06 01:32:42 +00001443#undef SetIntItem
1444#undef SetStrItem
1445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001446 if (PyErr_Occurred()) {
1447 Py_CLEAR(version_info);
1448 return NULL;
1449 }
1450 return version_info;
Eric Smith0e5b5622009-02-06 01:32:42 +00001451}
1452
Martin v. Löwis1a214512008-06-11 05:26:20 +00001453static struct PyModuleDef sysmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 PyModuleDef_HEAD_INIT,
1455 "sys",
1456 sys_doc,
1457 -1, /* multiple "initialization" just copies the module dict. */
1458 sys_methods,
1459 NULL,
1460 NULL,
1461 NULL,
1462 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00001463};
1464
Guido van Rossum25ce5661997-08-02 03:10:38 +00001465PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001466_PySys_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001467{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001468 PyObject *m, *v, *sysdict;
1469 char *s;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001471 m = PyModule_Create(&sysmodule);
1472 if (m == NULL)
1473 return NULL;
1474 sysdict = PyModule_GetDict(m);
1475#define SET_SYS_FROM_STRING(key, value) \
1476 v = value; \
1477 if (v != NULL) \
1478 PyDict_SetItemString(sysdict, key, v); \
1479 Py_XDECREF(v)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001480
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001481 /* Check that stdin is not a directory
1482 Using shell redirection, you can redirect stdin to a directory,
1483 crashing the Python interpreter. Catch this common mistake here
1484 and output a useful error message. Note that under MS Windows,
1485 the shell already prevents that. */
Martin v. Löwisec59d042009-01-12 07:59:10 +00001486#if !defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001487 {
1488 struct stat sb;
1489 if (fstat(fileno(stdin), &sb) == 0 &&
1490 S_ISDIR(sb.st_mode)) {
1491 /* There's nothing more we can do. */
1492 /* Py_FatalError() will core dump, so just exit. */
1493 PySys_WriteStderr("Python error: <stdin> is a directory, cannot continue\n");
1494 exit(EXIT_FAILURE);
1495 }
1496 }
Martin v. Löwisec59d042009-01-12 07:59:10 +00001497#endif
Neal Norwitz11bd1192005-10-03 00:54:56 +00001498
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001499 /* stdin/stdout/stderr are now set by pythonrun.c */
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001500
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001501 PyDict_SetItemString(sysdict, "__displayhook__",
1502 PyDict_GetItemString(sysdict, "displayhook"));
1503 PyDict_SetItemString(sysdict, "__excepthook__",
1504 PyDict_GetItemString(sysdict, "excepthook"));
1505 SET_SYS_FROM_STRING("version",
1506 PyUnicode_FromString(Py_GetVersion()));
1507 SET_SYS_FROM_STRING("hexversion",
1508 PyLong_FromLong(PY_VERSION_HEX));
Georg Brandl1ca2e792011-03-05 20:51:24 +01001509 SET_SYS_FROM_STRING("_mercurial",
1510 Py_BuildValue("(szz)", "CPython", _Py_hgidentifier(),
1511 _Py_hgversion()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001512 SET_SYS_FROM_STRING("dont_write_bytecode",
1513 PyBool_FromLong(Py_DontWriteBytecodeFlag));
1514 SET_SYS_FROM_STRING("api_version",
1515 PyLong_FromLong(PYTHON_API_VERSION));
1516 SET_SYS_FROM_STRING("copyright",
1517 PyUnicode_FromString(Py_GetCopyright()));
1518 SET_SYS_FROM_STRING("platform",
1519 PyUnicode_FromString(Py_GetPlatform()));
1520 SET_SYS_FROM_STRING("executable",
1521 PyUnicode_FromWideChar(
1522 Py_GetProgramFullPath(), -1));
1523 SET_SYS_FROM_STRING("prefix",
1524 PyUnicode_FromWideChar(Py_GetPrefix(), -1));
1525 SET_SYS_FROM_STRING("exec_prefix",
1526 PyUnicode_FromWideChar(Py_GetExecPrefix(), -1));
1527 SET_SYS_FROM_STRING("maxsize",
1528 PyLong_FromSsize_t(PY_SSIZE_T_MAX));
1529 SET_SYS_FROM_STRING("float_info",
1530 PyFloat_GetInfo());
1531 SET_SYS_FROM_STRING("int_info",
1532 PyLong_GetInfo());
Mark Dickinsondc787d22010-05-23 13:33:13 +00001533 /* initialize hash_info */
1534 if (Hash_InfoType.tp_name == 0)
1535 PyStructSequence_InitType(&Hash_InfoType, &hash_info_desc);
1536 SET_SYS_FROM_STRING("hash_info",
1537 get_hash_info());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001538 SET_SYS_FROM_STRING("maxunicode",
1539 PyLong_FromLong(PyUnicode_GetMax()));
1540 SET_SYS_FROM_STRING("builtin_module_names",
1541 list_builtin_module_names());
1542 {
1543 /* Assumes that longs are at least 2 bytes long.
1544 Should be safe! */
1545 unsigned long number = 1;
1546 char *value;
Fred Drake099325e2000-08-14 15:47:03 +00001547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001548 s = (char *) &number;
1549 if (s[0] == 0)
1550 value = "big";
1551 else
1552 value = "little";
1553 SET_SYS_FROM_STRING("byteorder",
1554 PyUnicode_FromString(value));
1555 }
Guido van Rossum8b9ea871996-08-23 18:14:47 +00001556#ifdef MS_COREDLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001557 SET_SYS_FROM_STRING("dllhandle",
1558 PyLong_FromVoidPtr(PyWin_DLLhModule));
1559 SET_SYS_FROM_STRING("winver",
1560 PyUnicode_FromString(PyWin_DLLVersionString));
Guido van Rossumc606fe11996-04-09 02:37:57 +00001561#endif
Barry Warsaw8cf4eae2010-10-16 01:04:07 +00001562#ifdef ABIFLAGS
1563 SET_SYS_FROM_STRING("abiflags",
1564 PyUnicode_FromString(ABIFLAGS));
1565#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001566 if (warnoptions == NULL) {
1567 warnoptions = PyList_New(0);
1568 }
1569 else {
1570 Py_INCREF(warnoptions);
1571 }
1572 if (warnoptions != NULL) {
1573 PyDict_SetItemString(sysdict, "warnoptions", warnoptions);
1574 }
Tim Peters216b78b2006-01-06 02:40:53 +00001575
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001576 v = get_xoptions();
1577 if (v != NULL) {
1578 PyDict_SetItemString(sysdict, "_xoptions", v);
1579 }
1580
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001581 /* version_info */
1582 if (VersionInfoType.tp_name == 0)
1583 PyStructSequence_InitType(&VersionInfoType, &version_info_desc);
1584 SET_SYS_FROM_STRING("version_info", make_version_info());
1585 /* prevent user from creating new instances */
1586 VersionInfoType.tp_init = NULL;
1587 VersionInfoType.tp_new = NULL;
Eric Smith0e5b5622009-02-06 01:32:42 +00001588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001589 /* flags */
1590 if (FlagsType.tp_name == 0)
1591 PyStructSequence_InitType(&FlagsType, &flags_desc);
1592 SET_SYS_FROM_STRING("flags", make_flags());
1593 /* prevent user from creating new instances */
1594 FlagsType.tp_init = NULL;
1595 FlagsType.tp_new = NULL;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001596
Eric Smithf7bb5782010-01-27 00:44:57 +00001597
1598#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001599 /* getwindowsversion */
1600 if (WindowsVersionType.tp_name == 0)
1601 PyStructSequence_InitType(&WindowsVersionType, &windows_version_desc);
1602 /* prevent user from creating new instances */
1603 WindowsVersionType.tp_init = NULL;
1604 WindowsVersionType.tp_new = NULL;
Eric Smithf7bb5782010-01-27 00:44:57 +00001605#endif
1606
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001607 /* float repr style: 0.03 (short) vs 0.029999999999999999 (legacy) */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001608#ifndef PY_NO_SHORT_FLOAT_REPR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001609 SET_SYS_FROM_STRING("float_repr_style",
1610 PyUnicode_FromString("short"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001611#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 SET_SYS_FROM_STRING("float_repr_style",
1613 PyUnicode_FromString("legacy"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001614#endif
1615
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001616#ifdef WITH_THREAD
1617 SET_SYS_FROM_STRING("thread_info", PyThread_GetInfo());
1618#endif
1619
Christian Heimes7b3ce6a2008-01-31 14:31:45 +00001620#undef SET_SYS_FROM_STRING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001621 if (PyErr_Occurred())
1622 return NULL;
1623 return m;
Guido van Rossum5b3138b1990-11-18 17:41:40 +00001624}
1625
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001626static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00001627makepathobject(const wchar_t *path, wchar_t delim)
Guido van Rossum5b3138b1990-11-18 17:41:40 +00001628{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 int i, n;
1630 const wchar_t *p;
1631 PyObject *v, *w;
Tim Peters216b78b2006-01-06 02:40:53 +00001632
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001633 n = 1;
1634 p = path;
1635 while ((p = wcschr(p, delim)) != NULL) {
1636 n++;
1637 p++;
1638 }
1639 v = PyList_New(n);
1640 if (v == NULL)
1641 return NULL;
1642 for (i = 0; ; i++) {
1643 p = wcschr(path, delim);
1644 if (p == NULL)
1645 p = path + wcslen(path); /* End of string */
1646 w = PyUnicode_FromWideChar(path, (Py_ssize_t)(p - path));
1647 if (w == NULL) {
1648 Py_DECREF(v);
1649 return NULL;
1650 }
1651 PyList_SetItem(v, i, w);
1652 if (*p == '\0')
1653 break;
1654 path = p+1;
1655 }
1656 return v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001657}
1658
1659void
Martin v. Löwis790465f2008-04-05 20:41:37 +00001660PySys_SetPath(const wchar_t *path)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001661{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 PyObject *v;
1663 if ((v = makepathobject(path, DELIM)) == NULL)
1664 Py_FatalError("can't create sys.path");
1665 if (PySys_SetObject("path", v) != 0)
1666 Py_FatalError("can't assign sys.path");
1667 Py_DECREF(v);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001668}
1669
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001670static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00001671makeargvobject(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001672{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001673 PyObject *av;
1674 if (argc <= 0 || argv == NULL) {
1675 /* Ensure at least one (empty) argument is seen */
1676 static wchar_t *empty_argv[1] = {L""};
1677 argv = empty_argv;
1678 argc = 1;
1679 }
1680 av = PyList_New(argc);
1681 if (av != NULL) {
1682 int i;
1683 for (i = 0; i < argc; i++) {
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +00001684#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 PyObject *v;
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +00001686
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001687 /* argv[0] is the script pathname if known */
1688 if (i == 0) {
1689 char* fn = decc$translate_vms(argv[0]);
1690 if ((fn == (char *)0) || fn == (char *)-1)
1691 v = PyUnicode_FromString(argv[0]);
1692 else
1693 v = PyUnicode_FromString(
1694 decc$translate_vms(argv[0]));
1695 } else
1696 v = PyUnicode_FromString(argv[i]);
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +00001697#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001698 PyObject *v = PyUnicode_FromWideChar(argv[i], -1);
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +00001699#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001700 if (v == NULL) {
1701 Py_DECREF(av);
1702 av = NULL;
1703 break;
1704 }
1705 PyList_SetItem(av, i, v);
1706 }
1707 }
1708 return av;
Guido van Rossum3f5da241990-12-20 15:06:42 +00001709}
1710
Nick Coghland26c18a2010-08-17 13:06:11 +00001711#define _HAVE_SCRIPT_ARGUMENT(argc, argv) \
1712 (argc > 0 && argv0 != NULL && \
1713 wcscmp(argv0, L"-c") != 0 && wcscmp(argv0, L"-m") != 0)
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001714
1715static void
1716sys_update_path(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001717{
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001718 wchar_t *argv0;
1719 wchar_t *p = NULL;
1720 Py_ssize_t n = 0;
1721 PyObject *a;
1722 PyObject *path;
1723#ifdef HAVE_READLINK
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001724 wchar_t link[MAXPATHLEN+1];
1725 wchar_t argv0copy[2*MAXPATHLEN+1];
1726 int nr = 0;
1727#endif
Guido van Rossum162e38c2003-02-19 15:25:10 +00001728#if defined(HAVE_REALPATH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001729 wchar_t fullpath[MAXPATHLEN];
Martin v. Löwisec59d042009-01-12 07:59:10 +00001730#elif defined(MS_WINDOWS) && !defined(MS_WINCE)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001731 wchar_t fullpath[MAX_PATH];
Thomas Heller27bb71e2003-01-08 14:33:48 +00001732#endif
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001733
1734 path = PySys_GetObject("path");
1735 if (path == NULL)
1736 return;
1737
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001738 argv0 = argv[0];
1739
1740#ifdef HAVE_READLINK
1741 if (_HAVE_SCRIPT_ARGUMENT(argc, argv))
1742 nr = _Py_wreadlink(argv0, link, MAXPATHLEN);
1743 if (nr > 0) {
1744 /* It's a symlink */
1745 link[nr] = '\0';
1746 if (link[0] == SEP)
1747 argv0 = link; /* Link to absolute path */
1748 else if (wcschr(link, SEP) == NULL)
1749 ; /* Link without path */
1750 else {
1751 /* Must join(dirname(argv0), link) */
1752 wchar_t *q = wcsrchr(argv0, SEP);
1753 if (q == NULL)
1754 argv0 = link; /* argv0 without path */
1755 else {
1756 /* Must make a copy */
1757 wcscpy(argv0copy, argv0);
1758 q = wcsrchr(argv0copy, SEP);
1759 wcscpy(q+1, link);
1760 argv0 = argv0copy;
1761 }
1762 }
1763 }
1764#endif /* HAVE_READLINK */
1765#if SEP == '\\' /* Special case for MS filename syntax */
1766 if (_HAVE_SCRIPT_ARGUMENT(argc, argv)) {
1767 wchar_t *q;
1768#if defined(MS_WINDOWS) && !defined(MS_WINCE)
1769 /* This code here replaces the first element in argv with the full
1770 path that it represents. Under CE, there are no relative paths so
1771 the argument must be the full path anyway. */
1772 wchar_t *ptemp;
1773 if (GetFullPathNameW(argv0,
1774 sizeof(fullpath)/sizeof(fullpath[0]),
1775 fullpath,
1776 &ptemp)) {
1777 argv0 = fullpath;
1778 }
1779#endif
1780 p = wcsrchr(argv0, SEP);
1781 /* Test for alternate separator */
1782 q = wcsrchr(p ? p : argv0, '/');
1783 if (q != NULL)
1784 p = q;
1785 if (p != NULL) {
1786 n = p + 1 - argv0;
1787 if (n > 1 && p[-1] != ':')
1788 n--; /* Drop trailing separator */
1789 }
1790 }
1791#else /* All other filename syntaxes */
1792 if (_HAVE_SCRIPT_ARGUMENT(argc, argv)) {
1793#if defined(HAVE_REALPATH)
Victor Stinner015f4d82010-10-07 22:29:53 +00001794 if (_Py_wrealpath(argv0, fullpath, PATH_MAX)) {
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001795 argv0 = fullpath;
1796 }
1797#endif
1798 p = wcsrchr(argv0, SEP);
1799 }
1800 if (p != NULL) {
1801 n = p + 1 - argv0;
1802#if SEP == '/' /* Special case for Unix filename syntax */
1803 if (n > 1)
1804 n--; /* Drop trailing separator */
1805#endif /* Unix */
1806 }
1807#endif /* All others */
1808 a = PyUnicode_FromWideChar(argv0, n);
1809 if (a == NULL)
1810 Py_FatalError("no mem for sys.path insertion");
1811 if (PyList_Insert(path, 0, a) < 0)
1812 Py_FatalError("sys.path.insert(0) failed");
1813 Py_DECREF(a);
1814}
1815
1816void
1817PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)
1818{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001819 PyObject *av = makeargvobject(argc, argv);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001820 if (av == NULL)
1821 Py_FatalError("no mem for sys.argv");
1822 if (PySys_SetObject("argv", av) != 0)
1823 Py_FatalError("can't assign sys.argv");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001824 Py_DECREF(av);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001825 if (updatepath)
1826 sys_update_path(argc, argv);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001827}
Guido van Rossuma890e681998-05-12 14:59:24 +00001828
Antoine Pitrouf978fac2010-05-21 17:25:34 +00001829void
1830PySys_SetArgv(int argc, wchar_t **argv)
1831{
1832 PySys_SetArgvEx(argc, argv, 1);
1833}
1834
Victor Stinner14284c22010-04-23 12:02:30 +00001835/* Reimplementation of PyFile_WriteString() no calling indirectly
1836 PyErr_CheckSignals(): avoid the call to PyObject_Str(). */
1837
1838static int
Victor Stinner79766632010-08-16 17:36:42 +00001839sys_pyfile_write_unicode(PyObject *unicode, PyObject *file)
Victor Stinner14284c22010-04-23 12:02:30 +00001840{
Victor Stinner79766632010-08-16 17:36:42 +00001841 PyObject *writer = NULL, *args = NULL, *result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001842 int err;
Victor Stinner14284c22010-04-23 12:02:30 +00001843
Victor Stinnerecccc4f2010-06-08 20:46:00 +00001844 if (file == NULL)
1845 return -1;
1846
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001847 writer = PyObject_GetAttrString(file, "write");
1848 if (writer == NULL)
1849 goto error;
Victor Stinner14284c22010-04-23 12:02:30 +00001850
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001851 args = PyTuple_Pack(1, unicode);
1852 if (args == NULL)
1853 goto error;
Victor Stinner14284c22010-04-23 12:02:30 +00001854
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001855 result = PyEval_CallObject(writer, args);
1856 if (result == NULL) {
1857 goto error;
1858 } else {
1859 err = 0;
1860 goto finally;
1861 }
Victor Stinner14284c22010-04-23 12:02:30 +00001862
1863error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001864 err = -1;
Victor Stinner14284c22010-04-23 12:02:30 +00001865finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001866 Py_XDECREF(writer);
1867 Py_XDECREF(args);
1868 Py_XDECREF(result);
1869 return err;
Victor Stinner14284c22010-04-23 12:02:30 +00001870}
1871
Victor Stinner79766632010-08-16 17:36:42 +00001872static int
1873sys_pyfile_write(const char *text, PyObject *file)
1874{
1875 PyObject *unicode = NULL;
1876 int err;
1877
1878 if (file == NULL)
1879 return -1;
1880
1881 unicode = PyUnicode_FromString(text);
1882 if (unicode == NULL)
1883 return -1;
1884
1885 err = sys_pyfile_write_unicode(unicode, file);
1886 Py_DECREF(unicode);
1887 return err;
1888}
Guido van Rossuma890e681998-05-12 14:59:24 +00001889
1890/* APIs to write to sys.stdout or sys.stderr using a printf-like interface.
1891 Adapted from code submitted by Just van Rossum.
1892
1893 PySys_WriteStdout(format, ...)
1894 PySys_WriteStderr(format, ...)
1895
1896 The first function writes to sys.stdout; the second to sys.stderr. When
1897 there is a problem, they write to the real (C level) stdout or stderr;
Guido van Rossum8442af31998-10-12 18:22:10 +00001898 no exceptions are raised.
Guido van Rossuma890e681998-05-12 14:59:24 +00001899
Victor Stinner14284c22010-04-23 12:02:30 +00001900 PyErr_CheckSignals() is not called to avoid the execution of the Python
Victor Stinner79766632010-08-16 17:36:42 +00001901 signal handlers: they may raise a new exception whereas sys_write()
1902 ignores all exceptions.
Victor Stinner14284c22010-04-23 12:02:30 +00001903
Guido van Rossuma890e681998-05-12 14:59:24 +00001904 Both take a printf-style format string as their first argument followed
1905 by a variable length argument list determined by the format string.
1906
1907 *** WARNING ***
1908
1909 The format should limit the total size of the formatted output string to
1910 1000 bytes. In particular, this means that no unrestricted "%s" formats
1911 should occur; these should be limited using "%.<N>s where <N> is a
1912 decimal number calculated so that <N> plus the maximum size of other
1913 formatted text does not exceed 1000 bytes. Also watch out for "%f",
1914 which can print hundreds of digits for very large numbers.
1915
1916 */
1917
1918static void
Victor Stinner79766632010-08-16 17:36:42 +00001919sys_write(char *name, FILE *fp, const char *format, va_list va)
Guido van Rossuma890e681998-05-12 14:59:24 +00001920{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001921 PyObject *file;
1922 PyObject *error_type, *error_value, *error_traceback;
1923 char buffer[1001];
1924 int written;
Guido van Rossuma890e681998-05-12 14:59:24 +00001925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001926 PyErr_Fetch(&error_type, &error_value, &error_traceback);
1927 file = PySys_GetObject(name);
1928 written = PyOS_vsnprintf(buffer, sizeof(buffer), format, va);
1929 if (sys_pyfile_write(buffer, file) != 0) {
1930 PyErr_Clear();
1931 fputs(buffer, fp);
1932 }
1933 if (written < 0 || (size_t)written >= sizeof(buffer)) {
1934 const char *truncated = "... truncated";
Victor Stinner79766632010-08-16 17:36:42 +00001935 if (sys_pyfile_write(truncated, file) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001936 fputs(truncated, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001937 }
1938 PyErr_Restore(error_type, error_value, error_traceback);
Guido van Rossuma890e681998-05-12 14:59:24 +00001939}
1940
1941void
Guido van Rossuma890e681998-05-12 14:59:24 +00001942PySys_WriteStdout(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00001943{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001944 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00001945
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001946 va_start(va, format);
Victor Stinner79766632010-08-16 17:36:42 +00001947 sys_write("stdout", stdout, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001948 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00001949}
1950
1951void
Guido van Rossuma890e681998-05-12 14:59:24 +00001952PySys_WriteStderr(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00001953{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001954 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00001955
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001956 va_start(va, format);
Victor Stinner79766632010-08-16 17:36:42 +00001957 sys_write("stderr", stderr, format, va);
1958 va_end(va);
1959}
1960
1961static void
1962sys_format(char *name, FILE *fp, const char *format, va_list va)
1963{
1964 PyObject *file, *message;
1965 PyObject *error_type, *error_value, *error_traceback;
1966 char *utf8;
1967
1968 PyErr_Fetch(&error_type, &error_value, &error_traceback);
1969 file = PySys_GetObject(name);
1970 message = PyUnicode_FromFormatV(format, va);
1971 if (message != NULL) {
1972 if (sys_pyfile_write_unicode(message, file) != 0) {
1973 PyErr_Clear();
1974 utf8 = _PyUnicode_AsString(message);
1975 if (utf8 != NULL)
1976 fputs(utf8, fp);
1977 }
1978 Py_DECREF(message);
1979 }
1980 PyErr_Restore(error_type, error_value, error_traceback);
1981}
1982
1983void
1984PySys_FormatStdout(const char *format, ...)
1985{
1986 va_list va;
1987
1988 va_start(va, format);
1989 sys_format("stdout", stdout, format, va);
1990 va_end(va);
1991}
1992
1993void
1994PySys_FormatStderr(const char *format, ...)
1995{
1996 va_list va;
1997
1998 va_start(va, format);
1999 sys_format("stderr", stderr, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002000 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00002001}