blob: 6911c9aef6af00a9e98f1fc62ce5d988884eaedd [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;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +020082 _Py_IDENTIFIER(encoding);
83 _Py_IDENTIFIER(buffer);
Victor Stinner13d49ee2010-12-04 17:24:33 +000084
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +020085 stdout_encoding = _PyObject_GetAttrId(outf, &PyId_encoding);
Victor Stinner13d49ee2010-12-04 17:24:33 +000086 if (stdout_encoding == NULL)
87 goto error;
88 stdout_encoding_str = _PyUnicode_AsString(stdout_encoding);
89 if (stdout_encoding_str == NULL)
90 goto error;
91
92 repr_str = PyObject_Repr(o);
93 if (repr_str == NULL)
94 goto error;
95 encoded = PyUnicode_AsEncodedString(repr_str,
96 stdout_encoding_str,
97 "backslashreplace");
98 Py_DECREF(repr_str);
99 if (encoded == NULL)
100 goto error;
101
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200102 buffer = _PyObject_GetAttrId(outf, &PyId_buffer);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000103 if (buffer) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200104 _Py_IDENTIFIER(write);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200105 result = _PyObject_CallMethodId(buffer, &PyId_write, "(O)", encoded);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000106 Py_DECREF(buffer);
107 Py_DECREF(encoded);
108 if (result == NULL)
109 goto error;
110 Py_DECREF(result);
111 }
112 else {
113 PyErr_Clear();
114 escaped_str = PyUnicode_FromEncodedObject(encoded,
115 stdout_encoding_str,
116 "strict");
117 Py_DECREF(encoded);
118 if (PyFile_WriteObject(escaped_str, outf, Py_PRINT_RAW) != 0) {
119 Py_DECREF(escaped_str);
120 goto error;
121 }
122 Py_DECREF(escaped_str);
123 }
124 ret = 0;
125 goto finally;
126
127error:
128 ret = -1;
129finally:
130 Py_XDECREF(stdout_encoding);
131 return ret;
132}
133
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000134static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000135sys_displayhook(PyObject *self, PyObject *o)
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000136{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000137 PyObject *outf;
138 PyInterpreterState *interp = PyThreadState_GET()->interp;
139 PyObject *modules = interp->modules;
140 PyObject *builtins = PyDict_GetItemString(modules, "builtins");
Victor Stinner13d49ee2010-12-04 17:24:33 +0000141 int err;
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200142 _Py_IDENTIFIER(_);
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000143
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000144 if (builtins == NULL) {
145 PyErr_SetString(PyExc_RuntimeError, "lost builtins module");
146 return NULL;
147 }
Moshe Zadka03897ea2001-07-23 13:32:43 +0000148
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000149 /* Print value except if None */
150 /* After printing, also assign to '_' */
151 /* Before, set '_' to None to avoid recursion */
152 if (o == Py_None) {
153 Py_INCREF(Py_None);
154 return Py_None;
155 }
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200156 if (_PyObject_SetAttrId(builtins, &PyId__, Py_None) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000157 return NULL;
158 outf = PySys_GetObject("stdout");
159 if (outf == NULL || outf == Py_None) {
160 PyErr_SetString(PyExc_RuntimeError, "lost sys.stdout");
161 return NULL;
162 }
Victor Stinner13d49ee2010-12-04 17:24:33 +0000163 if (PyFile_WriteObject(o, outf, 0) != 0) {
164 if (PyErr_ExceptionMatches(PyExc_UnicodeEncodeError)) {
165 /* repr(o) is not encodable to sys.stdout.encoding with
166 * sys.stdout.errors error handler (which is probably 'strict') */
167 PyErr_Clear();
168 err = sys_displayhook_unencodable(outf, o);
169 if (err)
170 return NULL;
171 }
172 else {
173 return NULL;
174 }
175 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000176 if (PyFile_WriteString("\n", outf) != 0)
177 return NULL;
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200178 if (_PyObject_SetAttrId(builtins, &PyId__, o) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000179 return NULL;
180 Py_INCREF(Py_None);
181 return Py_None;
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000182}
183
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000184PyDoc_STRVAR(displayhook_doc,
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000185"displayhook(object) -> None\n"
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000186"\n"
Florent Xicluna5749e852010-03-03 11:54:54 +0000187"Print an object to sys.stdout and also save it in builtins._\n"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000188);
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000189
190static PyObject *
191sys_excepthook(PyObject* self, PyObject* args)
192{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000193 PyObject *exc, *value, *tb;
194 if (!PyArg_UnpackTuple(args, "excepthook", 3, 3, &exc, &value, &tb))
195 return NULL;
196 PyErr_Display(exc, value, tb);
197 Py_INCREF(Py_None);
198 return Py_None;
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000199}
200
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000201PyDoc_STRVAR(excepthook_doc,
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000202"excepthook(exctype, value, traceback) -> None\n"
203"\n"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000204"Handle an exception by displaying it with a traceback on sys.stderr.\n"
205);
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000206
207static PyObject *
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000208sys_exc_info(PyObject *self, PyObject *noargs)
Guido van Rossuma027efa1997-05-05 20:56:21 +0000209{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000210 PyThreadState *tstate;
211 tstate = PyThreadState_GET();
212 return Py_BuildValue(
213 "(OOO)",
214 tstate->exc_type != NULL ? tstate->exc_type : Py_None,
215 tstate->exc_value != NULL ? tstate->exc_value : Py_None,
216 tstate->exc_traceback != NULL ?
217 tstate->exc_traceback : Py_None);
Guido van Rossuma027efa1997-05-05 20:56:21 +0000218}
219
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000220PyDoc_STRVAR(exc_info_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000221"exc_info() -> (type, value, traceback)\n\
222\n\
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000223Return information about the most recent exception caught by an except\n\
224clause in the current stack frame or in an older stack frame."
225);
226
227static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000228sys_exit(PyObject *self, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000229{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000230 PyObject *exit_code = 0;
231 if (!PyArg_UnpackTuple(args, "exit", 0, 1, &exit_code))
232 return NULL;
233 /* Raise SystemExit so callers may catch it or clean up. */
234 PyErr_SetObject(PyExc_SystemExit, exit_code);
235 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000236}
237
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000238PyDoc_STRVAR(exit_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000239"exit([status])\n\
240\n\
241Exit the interpreter by raising SystemExit(status).\n\
242If the status is omitted or None, it defaults to zero (i.e., success).\n\
Neil Schemenauer0f2103f2002-03-23 20:46:35 +0000243If the status is numeric, it will be used as the system exit status.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000244If it is another kind of object, it will be printed and the system\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000245exit status will be one (i.e., failure)."
246);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000247
Martin v. Löwis107b7da2001-11-09 20:59:39 +0000248
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000249static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000250sys_getdefaultencoding(PyObject *self)
Fred Drake8b4d01d2000-05-09 19:57:01 +0000251{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000252 return PyUnicode_FromString(PyUnicode_GetDefaultEncoding());
Fred Drake8b4d01d2000-05-09 19:57:01 +0000253}
254
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000255PyDoc_STRVAR(getdefaultencoding_doc,
Marc-André Lemburg99964b82000-06-07 09:13:41 +0000256"getdefaultencoding() -> string\n\
Fred Drake8b4d01d2000-05-09 19:57:01 +0000257\n\
258Return the current default string encoding used by the Unicode \n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000259implementation."
260);
Fred Drake8b4d01d2000-05-09 19:57:01 +0000261
262static PyObject *
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000263sys_getfilesystemencoding(PyObject *self)
264{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000265 if (Py_FileSystemDefaultEncoding)
266 return PyUnicode_FromString(Py_FileSystemDefaultEncoding);
Victor Stinner27181ac2011-03-31 13:39:03 +0200267 PyErr_SetString(PyExc_RuntimeError,
268 "filesystem encoding is not initialized");
269 return NULL;
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000270}
271
272PyDoc_STRVAR(getfilesystemencoding_doc,
273"getfilesystemencoding() -> string\n\
274\n\
275Return the encoding used to convert Unicode filenames in\n\
276operating system filenames."
277);
278
Martin v. Löwis04dc25c2008-10-03 16:09:28 +0000279static PyObject *
Georg Brandl66a796e2006-12-19 20:50:34 +0000280sys_intern(PyObject *self, PyObject *args)
281{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000282 PyObject *s;
283 if (!PyArg_ParseTuple(args, "U:intern", &s))
284 return NULL;
285 if (PyUnicode_CheckExact(s)) {
286 Py_INCREF(s);
287 PyUnicode_InternInPlace(&s);
288 return s;
289 }
290 else {
291 PyErr_Format(PyExc_TypeError,
292 "can't intern %.400s", s->ob_type->tp_name);
293 return NULL;
294 }
Georg Brandl66a796e2006-12-19 20:50:34 +0000295}
296
297PyDoc_STRVAR(intern_doc,
298"intern(string) -> string\n\
299\n\
300``Intern'' the given string. This enters the string in the (global)\n\
301table of interned strings whose purpose is to speed up dictionary lookups.\n\
302Return the string itself or the previously interned string object with the\n\
303same value.");
304
305
Fred Drake5755ce62001-06-27 19:19:46 +0000306/*
307 * Cached interned string objects used for calling the profile and
308 * trace functions. Initialized by trace_init().
309 */
Nicholas Bastinc69ebe82004-03-24 21:57:10 +0000310static PyObject *whatstrings[7] = {NULL, NULL, NULL, NULL, NULL, NULL, NULL};
Fred Drake5755ce62001-06-27 19:19:46 +0000311
312static int
313trace_init(void)
314{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000315 static char *whatnames[7] = {"call", "exception", "line", "return",
316 "c_call", "c_exception", "c_return"};
317 PyObject *name;
318 int i;
319 for (i = 0; i < 7; ++i) {
320 if (whatstrings[i] == NULL) {
321 name = PyUnicode_InternFromString(whatnames[i]);
322 if (name == NULL)
323 return -1;
324 whatstrings[i] = name;
325 }
326 }
327 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000328}
329
330
331static PyObject *
332call_trampoline(PyThreadState *tstate, PyObject* callback,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000333 PyFrameObject *frame, int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000334{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000335 PyObject *args = PyTuple_New(3);
336 PyObject *whatstr;
337 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000338
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000339 if (args == NULL)
340 return NULL;
341 Py_INCREF(frame);
342 whatstr = whatstrings[what];
343 Py_INCREF(whatstr);
344 if (arg == NULL)
345 arg = Py_None;
346 Py_INCREF(arg);
347 PyTuple_SET_ITEM(args, 0, (PyObject *)frame);
348 PyTuple_SET_ITEM(args, 1, whatstr);
349 PyTuple_SET_ITEM(args, 2, arg);
Fred Drake5755ce62001-06-27 19:19:46 +0000350
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000351 /* call the Python-level function */
352 PyFrame_FastToLocals(frame);
353 result = PyEval_CallObject(callback, args);
354 PyFrame_LocalsToFast(frame, 1);
355 if (result == NULL)
356 PyTraceBack_Here(frame);
Fred Drake5755ce62001-06-27 19:19:46 +0000357
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000358 /* cleanup */
359 Py_DECREF(args);
360 return result;
Fred Drake5755ce62001-06-27 19:19:46 +0000361}
362
363static int
364profile_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000365 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000366{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 PyThreadState *tstate = frame->f_tstate;
368 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000369
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000370 if (arg == NULL)
371 arg = Py_None;
372 result = call_trampoline(tstate, self, frame, what, arg);
373 if (result == NULL) {
374 PyEval_SetProfile(NULL, NULL);
375 return -1;
376 }
377 Py_DECREF(result);
378 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000379}
380
381static int
382trace_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000383 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000384{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000385 PyThreadState *tstate = frame->f_tstate;
386 PyObject *callback;
387 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000388
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000389 if (what == PyTrace_CALL)
390 callback = self;
391 else
392 callback = frame->f_trace;
393 if (callback == NULL)
394 return 0;
395 result = call_trampoline(tstate, callback, frame, what, arg);
396 if (result == NULL) {
397 PyEval_SetTrace(NULL, NULL);
398 Py_XDECREF(frame->f_trace);
399 frame->f_trace = NULL;
400 return -1;
401 }
402 if (result != Py_None) {
403 PyObject *temp = frame->f_trace;
404 frame->f_trace = NULL;
405 Py_XDECREF(temp);
406 frame->f_trace = result;
407 }
408 else {
409 Py_DECREF(result);
410 }
411 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000412}
Fred Draked0838392001-06-16 21:02:31 +0000413
Fred Drake8b4d01d2000-05-09 19:57:01 +0000414static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000415sys_settrace(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000416{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000417 if (trace_init() == -1)
418 return NULL;
419 if (args == Py_None)
420 PyEval_SetTrace(NULL, NULL);
421 else
422 PyEval_SetTrace(trace_trampoline, args);
423 Py_INCREF(Py_None);
424 return Py_None;
Guido van Rossume2437a11992-03-23 18:20:18 +0000425}
426
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000427PyDoc_STRVAR(settrace_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000428"settrace(function)\n\
429\n\
430Set the global debug tracing function. It will be called on each\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000431function call. See the debugger chapter in the library manual."
432);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000433
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000434static PyObject *
Christian Heimes9bd667a2008-01-20 15:14:11 +0000435sys_gettrace(PyObject *self, PyObject *args)
436{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000437 PyThreadState *tstate = PyThreadState_GET();
438 PyObject *temp = tstate->c_traceobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000439
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000440 if (temp == NULL)
441 temp = Py_None;
442 Py_INCREF(temp);
443 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000444}
445
446PyDoc_STRVAR(gettrace_doc,
447"gettrace()\n\
448\n\
449Return the global debug tracing function set with sys.settrace.\n\
450See the debugger chapter in the library manual."
451);
452
453static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000454sys_setprofile(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000455{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 if (trace_init() == -1)
457 return NULL;
458 if (args == Py_None)
459 PyEval_SetProfile(NULL, NULL);
460 else
461 PyEval_SetProfile(profile_trampoline, args);
462 Py_INCREF(Py_None);
463 return Py_None;
Guido van Rossume2437a11992-03-23 18:20:18 +0000464}
465
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000466PyDoc_STRVAR(setprofile_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000467"setprofile(function)\n\
468\n\
469Set the profiling function. It will be called on each function call\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000470and return. See the profiler chapter in the library manual."
471);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000472
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000473static PyObject *
Christian Heimes9bd667a2008-01-20 15:14:11 +0000474sys_getprofile(PyObject *self, PyObject *args)
475{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000476 PyThreadState *tstate = PyThreadState_GET();
477 PyObject *temp = tstate->c_profileobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000478
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000479 if (temp == NULL)
480 temp = Py_None;
481 Py_INCREF(temp);
482 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000483}
484
485PyDoc_STRVAR(getprofile_doc,
486"getprofile()\n\
487\n\
488Return the profiling function set with sys.setprofile.\n\
489See the profiler chapter in the library manual."
490);
491
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000492static int _check_interval = 100;
493
Christian Heimes9bd667a2008-01-20 15:14:11 +0000494static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000495sys_setcheckinterval(PyObject *self, PyObject *args)
Guido van Rossuma0d7a231995-01-09 17:46:13 +0000496{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000497 if (PyErr_WarnEx(PyExc_DeprecationWarning,
498 "sys.getcheckinterval() and sys.setcheckinterval() "
499 "are deprecated. Use sys.setswitchinterval() "
500 "instead.", 1) < 0)
501 return NULL;
502 if (!PyArg_ParseTuple(args, "i:setcheckinterval", &_check_interval))
503 return NULL;
504 Py_INCREF(Py_None);
505 return Py_None;
Guido van Rossuma0d7a231995-01-09 17:46:13 +0000506}
507
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000508PyDoc_STRVAR(setcheckinterval_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000509"setcheckinterval(n)\n\
510\n\
511Tell the Python interpreter to check for asynchronous events every\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000512n instructions. This also affects how often thread switches occur."
513);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000514
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000515static PyObject *
Tim Peterse5e065b2003-07-06 18:36:54 +0000516sys_getcheckinterval(PyObject *self, PyObject *args)
517{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000518 if (PyErr_WarnEx(PyExc_DeprecationWarning,
519 "sys.getcheckinterval() and sys.setcheckinterval() "
520 "are deprecated. Use sys.getswitchinterval() "
521 "instead.", 1) < 0)
522 return NULL;
523 return PyLong_FromLong(_check_interval);
Tim Peterse5e065b2003-07-06 18:36:54 +0000524}
525
526PyDoc_STRVAR(getcheckinterval_doc,
527"getcheckinterval() -> current check interval; see setcheckinterval()."
528);
529
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000530#ifdef WITH_THREAD
531static PyObject *
532sys_setswitchinterval(PyObject *self, PyObject *args)
533{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000534 double d;
535 if (!PyArg_ParseTuple(args, "d:setswitchinterval", &d))
536 return NULL;
537 if (d <= 0.0) {
538 PyErr_SetString(PyExc_ValueError,
539 "switch interval must be strictly positive");
540 return NULL;
541 }
542 _PyEval_SetSwitchInterval((unsigned long) (1e6 * d));
543 Py_INCREF(Py_None);
544 return Py_None;
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000545}
546
547PyDoc_STRVAR(setswitchinterval_doc,
548"setswitchinterval(n)\n\
549\n\
550Set the ideal thread switching delay inside the Python interpreter\n\
551The actual frequency of switching threads can be lower if the\n\
552interpreter executes long sequences of uninterruptible code\n\
553(this is implementation-specific and workload-dependent).\n\
554\n\
555The parameter must represent the desired switching delay in seconds\n\
556A typical value is 0.005 (5 milliseconds)."
557);
558
559static PyObject *
560sys_getswitchinterval(PyObject *self, PyObject *args)
561{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000562 return PyFloat_FromDouble(1e-6 * _PyEval_GetSwitchInterval());
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000563}
564
565PyDoc_STRVAR(getswitchinterval_doc,
566"getswitchinterval() -> current thread switch interval; see setswitchinterval()."
567);
568
569#endif /* WITH_THREAD */
570
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000571#ifdef WITH_TSC
572static PyObject *
573sys_settscdump(PyObject *self, PyObject *args)
574{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000575 int bool;
576 PyThreadState *tstate = PyThreadState_Get();
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000577
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000578 if (!PyArg_ParseTuple(args, "i:settscdump", &bool))
579 return NULL;
580 if (bool)
581 tstate->interp->tscdump = 1;
582 else
583 tstate->interp->tscdump = 0;
584 Py_INCREF(Py_None);
585 return Py_None;
Tim Peters216b78b2006-01-06 02:40:53 +0000586
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000587}
588
Tim Peters216b78b2006-01-06 02:40:53 +0000589PyDoc_STRVAR(settscdump_doc,
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000590"settscdump(bool)\n\
591\n\
592If true, tell the Python interpreter to dump VM measurements to\n\
593stderr. If false, turn off dump. The measurements are based on the\n\
Michael W. Hudson800ba232004-08-12 18:19:17 +0000594processor's time-stamp counter."
Tim Peters216b78b2006-01-06 02:40:53 +0000595);
Neal Norwitz0f5aed42004-06-13 20:32:17 +0000596#endif /* TSC */
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000597
Tim Peterse5e065b2003-07-06 18:36:54 +0000598static PyObject *
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000599sys_setrecursionlimit(PyObject *self, PyObject *args)
600{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000601 int new_limit;
602 if (!PyArg_ParseTuple(args, "i:setrecursionlimit", &new_limit))
603 return NULL;
604 if (new_limit <= 0) {
605 PyErr_SetString(PyExc_ValueError,
606 "recursion limit must be positive");
607 return NULL;
608 }
609 Py_SetRecursionLimit(new_limit);
610 Py_INCREF(Py_None);
611 return Py_None;
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000612}
613
Mark Dickinsondc787d22010-05-23 13:33:13 +0000614static PyTypeObject Hash_InfoType;
615
616PyDoc_STRVAR(hash_info_doc,
617"hash_info\n\
618\n\
619A struct sequence providing parameters used for computing\n\
620numeric hashes. The attributes are read only.");
621
622static PyStructSequence_Field hash_info_fields[] = {
623 {"width", "width of the type used for hashing, in bits"},
624 {"modulus", "prime number giving the modulus on which the hash "
625 "function is based"},
626 {"inf", "value to be used for hash of a positive infinity"},
627 {"nan", "value to be used for hash of a nan"},
628 {"imag", "multiplier used for the imaginary part of a complex number"},
629 {NULL, NULL}
630};
631
632static PyStructSequence_Desc hash_info_desc = {
633 "sys.hash_info",
634 hash_info_doc,
635 hash_info_fields,
636 5,
637};
638
Matthias Klosed885e952010-07-06 10:53:30 +0000639static PyObject *
Mark Dickinsondc787d22010-05-23 13:33:13 +0000640get_hash_info(void)
641{
642 PyObject *hash_info;
643 int field = 0;
644 hash_info = PyStructSequence_New(&Hash_InfoType);
645 if (hash_info == NULL)
646 return NULL;
647 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000648 PyLong_FromLong(8*sizeof(Py_hash_t)));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000649 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000650 PyLong_FromSsize_t(_PyHASH_MODULUS));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000651 PyStructSequence_SET_ITEM(hash_info, field++,
652 PyLong_FromLong(_PyHASH_INF));
653 PyStructSequence_SET_ITEM(hash_info, field++,
654 PyLong_FromLong(_PyHASH_NAN));
655 PyStructSequence_SET_ITEM(hash_info, field++,
656 PyLong_FromLong(_PyHASH_IMAG));
657 if (PyErr_Occurred()) {
658 Py_CLEAR(hash_info);
659 return NULL;
660 }
661 return hash_info;
662}
663
664
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000665PyDoc_STRVAR(setrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000666"setrecursionlimit(n)\n\
667\n\
668Set the maximum depth of the Python interpreter stack to n. This\n\
669limit prevents infinite recursion from causing an overflow of the C\n\
670stack and crashing Python. The highest possible limit is platform-\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000671dependent."
672);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000673
674static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000675sys_getrecursionlimit(PyObject *self)
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000676{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000677 return PyLong_FromLong(Py_GetRecursionLimit());
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000678}
679
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000680PyDoc_STRVAR(getrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000681"getrecursionlimit()\n\
682\n\
683Return the current value of the recursion limit, the maximum depth\n\
684of the Python interpreter stack. This limit prevents infinite\n\
Jack Jansene739a0d2002-06-26 20:39:20 +0000685recursion from causing an overflow of the C stack and crashing Python."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000686);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000687
Mark Hammond8696ebc2002-10-08 02:44:31 +0000688#ifdef MS_WINDOWS
689PyDoc_STRVAR(getwindowsversion_doc,
690"getwindowsversion()\n\
691\n\
Eric Smithf7bb5782010-01-27 00:44:57 +0000692Return information about the running version of Windows as a named tuple.\n\
693The members are named: major, minor, build, platform, service_pack,\n\
694service_pack_major, service_pack_minor, suite_mask, and product_type. For\n\
Ezio Melotti4969f702011-03-15 05:59:46 +0200695backward compatibility, only the first 5 items are available by indexing.\n\
Eric Smithf7bb5782010-01-27 00:44:57 +0000696All elements are numbers, except service_pack which is a string. Platform\n\
697may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7,\n\
6983 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain\n\
699controller, 3 for a server."
Mark Hammond8696ebc2002-10-08 02:44:31 +0000700);
701
Eric Smithf7bb5782010-01-27 00:44:57 +0000702static PyTypeObject WindowsVersionType = {0, 0, 0, 0, 0, 0};
703
704static PyStructSequence_Field windows_version_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000705 {"major", "Major version number"},
706 {"minor", "Minor version number"},
707 {"build", "Build number"},
708 {"platform", "Operating system platform"},
709 {"service_pack", "Latest Service Pack installed on the system"},
710 {"service_pack_major", "Service Pack major version number"},
711 {"service_pack_minor", "Service Pack minor version number"},
712 {"suite_mask", "Bit mask identifying available product suites"},
713 {"product_type", "System product type"},
714 {0}
Eric Smithf7bb5782010-01-27 00:44:57 +0000715};
716
717static PyStructSequence_Desc windows_version_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000718 "sys.getwindowsversion", /* name */
719 getwindowsversion_doc, /* doc */
720 windows_version_fields, /* fields */
721 5 /* For backward compatibility,
722 only the first 5 items are accessible
723 via indexing, the rest are name only */
Eric Smithf7bb5782010-01-27 00:44:57 +0000724};
725
Mark Hammond8696ebc2002-10-08 02:44:31 +0000726static PyObject *
727sys_getwindowsversion(PyObject *self)
728{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000729 PyObject *version;
730 int pos = 0;
731 OSVERSIONINFOEX ver;
732 ver.dwOSVersionInfoSize = sizeof(ver);
733 if (!GetVersionEx((OSVERSIONINFO*) &ver))
734 return PyErr_SetFromWindowsErr(0);
Eric Smithf7bb5782010-01-27 00:44:57 +0000735
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 version = PyStructSequence_New(&WindowsVersionType);
737 if (version == NULL)
738 return NULL;
Eric Smithf7bb5782010-01-27 00:44:57 +0000739
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMajorVersion));
741 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMinorVersion));
742 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwBuildNumber));
743 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwPlatformId));
744 PyStructSequence_SET_ITEM(version, pos++, PyUnicode_FromString(ver.szCSDVersion));
745 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMajor));
746 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMinor));
747 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wSuiteMask));
748 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wProductType));
Eric Smithf7bb5782010-01-27 00:44:57 +0000749
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000750 return version;
Mark Hammond8696ebc2002-10-08 02:44:31 +0000751}
752
753#endif /* MS_WINDOWS */
754
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000755#ifdef HAVE_DLOPEN
756static PyObject *
757sys_setdlopenflags(PyObject *self, PyObject *args)
758{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000759 int new_val;
760 PyThreadState *tstate = PyThreadState_GET();
761 if (!PyArg_ParseTuple(args, "i:setdlopenflags", &new_val))
762 return NULL;
763 if (!tstate)
764 return NULL;
765 tstate->interp->dlopenflags = new_val;
766 Py_INCREF(Py_None);
767 return Py_None;
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000768}
769
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000770PyDoc_STRVAR(setdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000771"setdlopenflags(n) -> None\n\
772\n\
Alexandre Vassalotti260484d2009-07-17 11:43:26 +0000773Set the flags used by the interpreter for dlopen calls, such as when the\n\
774interpreter loads extension modules. Among other things, this will enable\n\
775a lazy resolving of symbols when importing a module, if called as\n\
776sys.setdlopenflags(0). To share symbols across extension modules, call as\n\
777sys.setdlopenflags(ctypes.RTLD_GLOBAL). Symbolic names for the flag modules\n\
778can be either found in the ctypes module, or in the DLFCN module. If DLFCN\n\
779is not available, it can be generated from /usr/include/dlfcn.h using the\n\
780h2py script.");
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000781
782static PyObject *
783sys_getdlopenflags(PyObject *self, PyObject *args)
784{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000785 PyThreadState *tstate = PyThreadState_GET();
786 if (!tstate)
787 return NULL;
788 return PyLong_FromLong(tstate->interp->dlopenflags);
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000789}
790
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000791PyDoc_STRVAR(getdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000792"getdlopenflags() -> int\n\
793\n\
Alexandre Vassalotti260484d2009-07-17 11:43:26 +0000794Return the current value of the flags that are used for dlopen calls.\n\
795The flag constants are defined in the ctypes and DLFCN modules.");
796
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000797#endif /* HAVE_DLOPEN */
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000798
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000799#ifdef USE_MALLOPT
800/* Link with -lmalloc (or -lmpc) on an SGI */
801#include <malloc.h>
802
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000803static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000804sys_mdebug(PyObject *self, PyObject *args)
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000805{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000806 int flag;
807 if (!PyArg_ParseTuple(args, "i:mdebug", &flag))
808 return NULL;
809 mallopt(M_DEBUG, flag);
810 Py_INCREF(Py_None);
811 return Py_None;
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000812}
813#endif /* USE_MALLOPT */
814
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000815static PyObject *
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000816sys_getsizeof(PyObject *self, PyObject *args, PyObject *kwds)
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000817{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000818 PyObject *res = NULL;
819 static PyObject *str__sizeof__ = NULL, *gc_head_size = NULL;
820 static char *kwlist[] = {"object", "default", 0};
821 PyObject *o, *dflt = NULL;
822 PyObject *method;
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000823
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|O:getsizeof",
825 kwlist, &o, &dflt))
826 return NULL;
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000827
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 /* Initialize static variable for GC head size */
829 if (gc_head_size == NULL) {
830 gc_head_size = PyLong_FromSsize_t(sizeof(PyGC_Head));
831 if (gc_head_size == NULL)
832 return NULL;
833 }
Benjamin Petersona5758c02009-05-09 18:15:04 +0000834
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000835 /* Make sure the type is initialized. float gets initialized late */
836 if (PyType_Ready(Py_TYPE(o)) < 0)
837 return NULL;
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000838
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000839 method = _PyObject_LookupSpecial(o, "__sizeof__",
840 &str__sizeof__);
841 if (method == NULL) {
842 if (!PyErr_Occurred())
843 PyErr_Format(PyExc_TypeError,
844 "Type %.100s doesn't define __sizeof__",
845 Py_TYPE(o)->tp_name);
846 }
847 else {
848 res = PyObject_CallFunctionObjArgs(method, NULL);
849 Py_DECREF(method);
850 }
851
852 /* Has a default value been given */
853 if ((res == NULL) && (dflt != NULL) &&
854 PyErr_ExceptionMatches(PyExc_TypeError))
855 {
856 PyErr_Clear();
857 Py_INCREF(dflt);
858 return dflt;
859 }
860 else if (res == NULL)
861 return res;
862
863 /* add gc_head size */
864 if (PyObject_IS_GC(o)) {
865 PyObject *tmp = res;
866 res = PyNumber_Add(tmp, gc_head_size);
867 Py_DECREF(tmp);
868 }
869 return res;
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000870}
871
872PyDoc_STRVAR(getsizeof_doc,
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000873"getsizeof(object, default) -> int\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000874\n\
875Return the size of object in bytes.");
876
877static PyObject *
Fred Drakea7688822001-10-24 20:47:48 +0000878sys_getrefcount(PyObject *self, PyObject *arg)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000879{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000880 return PyLong_FromSsize_t(arg->ob_refcnt);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000881}
882
Tim Peters4be93d02002-07-07 19:59:50 +0000883#ifdef Py_REF_DEBUG
Mark Hammond440d8982000-06-20 08:12:48 +0000884static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000885sys_gettotalrefcount(PyObject *self)
Mark Hammond440d8982000-06-20 08:12:48 +0000886{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000887 return PyLong_FromSsize_t(_Py_GetRefTotal());
Mark Hammond440d8982000-06-20 08:12:48 +0000888}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000889#endif /* Py_REF_DEBUG */
Mark Hammond440d8982000-06-20 08:12:48 +0000890
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000891PyDoc_STRVAR(getrefcount_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000892"getrefcount(object) -> integer\n\
893\n\
Fred Drakeba3ff1b2002-06-20 21:36:19 +0000894Return the reference count of object. The count returned is generally\n\
895one higher than you might expect, because it includes the (temporary)\n\
896reference as an argument to getrefcount()."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000897);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000898
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000899#ifdef COUNT_ALLOCS
900static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000901sys_getcounts(PyObject *self)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000902{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000903 extern PyObject *get_counts(void);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000904
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 return get_counts();
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000906}
907#endif
908
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000909PyDoc_STRVAR(getframe_doc,
Barry Warsawb6a54d22000-12-06 21:47:46 +0000910"_getframe([depth]) -> frameobject\n\
911\n\
912Return a frame object from the call stack. If optional integer depth is\n\
913given, return the frame object that many calls below the top of the stack.\n\
914If that is deeper than the call stack, ValueError is raised. The default\n\
915for depth is zero, returning the frame at the top of the call stack.\n\
916\n\
917This function should be used for internal and specialized\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000918purposes only."
919);
Barry Warsawb6a54d22000-12-06 21:47:46 +0000920
921static PyObject *
922sys_getframe(PyObject *self, PyObject *args)
923{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000924 PyFrameObject *f = PyThreadState_GET()->frame;
925 int depth = -1;
Barry Warsawb6a54d22000-12-06 21:47:46 +0000926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000927 if (!PyArg_ParseTuple(args, "|i:_getframe", &depth))
928 return NULL;
Barry Warsawb6a54d22000-12-06 21:47:46 +0000929
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000930 while (depth > 0 && f != NULL) {
931 f = f->f_back;
932 --depth;
933 }
934 if (f == NULL) {
935 PyErr_SetString(PyExc_ValueError,
936 "call stack is not deep enough");
937 return NULL;
938 }
939 Py_INCREF(f);
940 return (PyObject*)f;
Barry Warsawb6a54d22000-12-06 21:47:46 +0000941}
942
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000943PyDoc_STRVAR(current_frames_doc,
944"_current_frames() -> dictionary\n\
945\n\
946Return a dictionary mapping each current thread T's thread id to T's\n\
947current stack frame.\n\
948\n\
949This function should be used for specialized purposes only."
950);
951
952static PyObject *
953sys_current_frames(PyObject *self, PyObject *noargs)
954{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 return _PyThread_CurrentFrames();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000956}
957
Guido van Rossuma12fe4e2003-04-09 19:06:21 +0000958PyDoc_STRVAR(call_tracing_doc,
959"call_tracing(func, args) -> object\n\
960\n\
961Call func(*args), while tracing is enabled. The tracing state is\n\
962saved, and restored afterwards. This is intended to be called from\n\
963a debugger from a checkpoint, to recursively debug some other code."
964);
965
966static PyObject *
967sys_call_tracing(PyObject *self, PyObject *args)
968{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000969 PyObject *func, *funcargs;
970 if (!PyArg_ParseTuple(args, "OO!:call_tracing", &func, &PyTuple_Type, &funcargs))
971 return NULL;
972 return _PyEval_CallTracing(func, funcargs);
Guido van Rossuma12fe4e2003-04-09 19:06:21 +0000973}
974
Jeremy Hylton985eba52003-02-05 23:13:00 +0000975PyDoc_STRVAR(callstats_doc,
976"callstats() -> tuple of integers\n\
977\n\
978Return a tuple of function call statistics, if CALL_PROFILE was defined\n\
979when Python was built. Otherwise, return None.\n\
980\n\
981When enabled, this function returns detailed, implementation-specific\n\
982details about the number of function calls executed. The return value is\n\
983a 11-tuple where the entries in the tuple are counts of:\n\
9840. all function calls\n\
9851. calls to PyFunction_Type objects\n\
9862. PyFunction calls that do not create an argument tuple\n\
9873. PyFunction calls that do not create an argument tuple\n\
988 and bypass PyEval_EvalCodeEx()\n\
9894. PyMethod calls\n\
9905. PyMethod calls on bound methods\n\
9916. PyType calls\n\
9927. PyCFunction calls\n\
9938. generator calls\n\
9949. All other calls\n\
99510. Number of stack pops performed by call_function()"
996);
Barry Warsawb6a54d22000-12-06 21:47:46 +0000997
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000998#ifdef __cplusplus
999extern "C" {
1000#endif
1001
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001002#ifdef Py_TRACE_REFS
Guido van Rossumded690f1996-05-24 20:48:31 +00001003/* Defined in objects.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001004extern PyObject *_Py_GetObjects(PyObject *, PyObject *);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001005#endif
Guido van Rossumded690f1996-05-24 20:48:31 +00001006
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001007#ifdef DYNAMIC_EXECUTION_PROFILE
1008/* Defined in ceval.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001009extern PyObject *_Py_GetDXProfile(PyObject *, PyObject *);
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001010#endif
1011
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001012#ifdef __cplusplus
1013}
1014#endif
1015
Christian Heimes15ebc882008-02-04 18:48:49 +00001016static PyObject *
1017sys_clear_type_cache(PyObject* self, PyObject* args)
1018{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001019 PyType_ClearCache();
1020 Py_RETURN_NONE;
Christian Heimes15ebc882008-02-04 18:48:49 +00001021}
1022
1023PyDoc_STRVAR(sys_clear_type_cache__doc__,
1024"_clear_type_cache() -> None\n\
1025Clear the internal type lookup cache.");
1026
1027
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001028static PyMethodDef sys_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001029 /* Might as well keep this in alphabetic order */
1030 {"callstats", (PyCFunction)PyEval_GetCallStats, METH_NOARGS,
1031 callstats_doc},
1032 {"_clear_type_cache", sys_clear_type_cache, METH_NOARGS,
1033 sys_clear_type_cache__doc__},
1034 {"_current_frames", sys_current_frames, METH_NOARGS,
1035 current_frames_doc},
1036 {"displayhook", sys_displayhook, METH_O, displayhook_doc},
1037 {"exc_info", sys_exc_info, METH_NOARGS, exc_info_doc},
1038 {"excepthook", sys_excepthook, METH_VARARGS, excepthook_doc},
1039 {"exit", sys_exit, METH_VARARGS, exit_doc},
1040 {"getdefaultencoding", (PyCFunction)sys_getdefaultencoding,
1041 METH_NOARGS, getdefaultencoding_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001042#ifdef HAVE_DLOPEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001043 {"getdlopenflags", (PyCFunction)sys_getdlopenflags, METH_NOARGS,
1044 getdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001045#endif
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001046#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001047 {"getcounts", (PyCFunction)sys_getcounts, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001048#endif
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001049#ifdef DYNAMIC_EXECUTION_PROFILE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001050 {"getdxp", _Py_GetDXProfile, METH_VARARGS},
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001051#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001052 {"getfilesystemencoding", (PyCFunction)sys_getfilesystemencoding,
1053 METH_NOARGS, getfilesystemencoding_doc},
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001054#ifdef Py_TRACE_REFS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 {"getobjects", _Py_GetObjects, METH_VARARGS},
Tim Peters4be93d02002-07-07 19:59:50 +00001056#endif
1057#ifdef Py_REF_DEBUG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001058 {"gettotalrefcount", (PyCFunction)sys_gettotalrefcount, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001059#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001060 {"getrefcount", (PyCFunction)sys_getrefcount, METH_O, getrefcount_doc},
1061 {"getrecursionlimit", (PyCFunction)sys_getrecursionlimit, METH_NOARGS,
1062 getrecursionlimit_doc},
1063 {"getsizeof", (PyCFunction)sys_getsizeof,
1064 METH_VARARGS | METH_KEYWORDS, getsizeof_doc},
1065 {"_getframe", sys_getframe, METH_VARARGS, getframe_doc},
Mark Hammond8696ebc2002-10-08 02:44:31 +00001066#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001067 {"getwindowsversion", (PyCFunction)sys_getwindowsversion, METH_NOARGS,
1068 getwindowsversion_doc},
Mark Hammond8696ebc2002-10-08 02:44:31 +00001069#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001070 {"intern", sys_intern, METH_VARARGS, intern_doc},
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001071#ifdef USE_MALLOPT
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001072 {"mdebug", sys_mdebug, METH_VARARGS},
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001073#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001074 {"setcheckinterval", sys_setcheckinterval, METH_VARARGS,
1075 setcheckinterval_doc},
1076 {"getcheckinterval", sys_getcheckinterval, METH_NOARGS,
1077 getcheckinterval_doc},
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001078#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001079 {"setswitchinterval", sys_setswitchinterval, METH_VARARGS,
1080 setswitchinterval_doc},
1081 {"getswitchinterval", sys_getswitchinterval, METH_NOARGS,
1082 getswitchinterval_doc},
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001083#endif
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001084#ifdef HAVE_DLOPEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001085 {"setdlopenflags", sys_setdlopenflags, METH_VARARGS,
1086 setdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001087#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001088 {"setprofile", sys_setprofile, METH_O, setprofile_doc},
1089 {"getprofile", sys_getprofile, METH_NOARGS, getprofile_doc},
1090 {"setrecursionlimit", sys_setrecursionlimit, METH_VARARGS,
1091 setrecursionlimit_doc},
Martin v. Löwisf30d60e2004-06-08 08:17:44 +00001092#ifdef WITH_TSC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 {"settscdump", sys_settscdump, METH_VARARGS, settscdump_doc},
Martin v. Löwisf30d60e2004-06-08 08:17:44 +00001094#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001095 {"settrace", sys_settrace, METH_O, settrace_doc},
1096 {"gettrace", sys_gettrace, METH_NOARGS, gettrace_doc},
1097 {"call_tracing", sys_call_tracing, METH_VARARGS, call_tracing_doc},
1098 {NULL, NULL} /* sentinel */
Guido van Rossum3f5da241990-12-20 15:06:42 +00001099};
1100
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001101static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001102list_builtin_module_names(void)
Guido van Rossum34679b71993-01-26 13:33:44 +00001103{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001104 PyObject *list = PyList_New(0);
1105 int i;
1106 if (list == NULL)
1107 return NULL;
1108 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1109 PyObject *name = PyUnicode_FromString(
1110 PyImport_Inittab[i].name);
1111 if (name == NULL)
1112 break;
1113 PyList_Append(list, name);
1114 Py_DECREF(name);
1115 }
1116 if (PyList_Sort(list) != 0) {
1117 Py_DECREF(list);
1118 list = NULL;
1119 }
1120 if (list) {
1121 PyObject *v = PyList_AsTuple(list);
1122 Py_DECREF(list);
1123 list = v;
1124 }
1125 return list;
Guido van Rossum34679b71993-01-26 13:33:44 +00001126}
1127
Guido van Rossum23fff912000-12-15 22:02:05 +00001128static PyObject *warnoptions = NULL;
1129
1130void
1131PySys_ResetWarnOptions(void)
1132{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001133 if (warnoptions == NULL || !PyList_Check(warnoptions))
1134 return;
1135 PyList_SetSlice(warnoptions, 0, PyList_GET_SIZE(warnoptions), NULL);
Guido van Rossum23fff912000-12-15 22:02:05 +00001136}
1137
1138void
Victor Stinner9ca9c252010-05-19 16:53:30 +00001139PySys_AddWarnOptionUnicode(PyObject *unicode)
Guido van Rossum23fff912000-12-15 22:02:05 +00001140{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001141 if (warnoptions == NULL || !PyList_Check(warnoptions)) {
1142 Py_XDECREF(warnoptions);
1143 warnoptions = PyList_New(0);
1144 if (warnoptions == NULL)
1145 return;
1146 }
Victor Stinner9ca9c252010-05-19 16:53:30 +00001147 PyList_Append(warnoptions, unicode);
1148}
1149
1150void
1151PySys_AddWarnOption(const wchar_t *s)
1152{
1153 PyObject *unicode;
1154 unicode = PyUnicode_FromWideChar(s, -1);
1155 if (unicode == NULL)
1156 return;
1157 PySys_AddWarnOptionUnicode(unicode);
1158 Py_DECREF(unicode);
Guido van Rossum23fff912000-12-15 22:02:05 +00001159}
1160
Christian Heimes33fe8092008-04-13 13:53:33 +00001161int
1162PySys_HasWarnOptions(void)
1163{
1164 return (warnoptions != NULL && (PyList_Size(warnoptions) > 0)) ? 1 : 0;
1165}
1166
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001167static PyObject *xoptions = NULL;
1168
1169static PyObject *
1170get_xoptions(void)
1171{
1172 if (xoptions == NULL || !PyDict_Check(xoptions)) {
1173 Py_XDECREF(xoptions);
1174 xoptions = PyDict_New();
1175 }
1176 return xoptions;
1177}
1178
1179void
1180PySys_AddXOption(const wchar_t *s)
1181{
1182 PyObject *opts;
1183 PyObject *name = NULL, *value = NULL;
1184 const wchar_t *name_end;
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001185
1186 opts = get_xoptions();
1187 if (opts == NULL)
1188 goto error;
1189
1190 name_end = wcschr(s, L'=');
1191 if (!name_end) {
1192 name = PyUnicode_FromWideChar(s, -1);
1193 value = Py_True;
1194 Py_INCREF(value);
1195 }
1196 else {
1197 name = PyUnicode_FromWideChar(s, name_end - s);
1198 value = PyUnicode_FromWideChar(name_end + 1, -1);
1199 }
1200 if (name == NULL || value == NULL)
1201 goto error;
Brett Cannonb94767f2011-02-22 20:15:44 +00001202 PyDict_SetItem(opts, name, value);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001203 Py_DECREF(name);
1204 Py_DECREF(value);
1205 return;
1206
1207error:
1208 Py_XDECREF(name);
1209 Py_XDECREF(value);
1210 /* No return value, therefore clear error state if possible */
1211 if (_Py_atomic_load_relaxed(&_PyThreadState_Current))
1212 PyErr_Clear();
1213}
1214
1215PyObject *
1216PySys_GetXOptions(void)
1217{
1218 return get_xoptions();
1219}
1220
Guido van Rossum40552d01998-08-06 03:34:39 +00001221/* XXX This doc string is too long to be a single string literal in VC++ 5.0.
1222 Two literals concatenated works just fine. If you have a K&R compiler
1223 or other abomination that however *does* understand longer strings,
1224 get rid of the !!! comment in the middle and the quotes that surround it. */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001225PyDoc_VAR(sys_doc) =
1226PyDoc_STR(
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001227"This module provides access to some objects used or maintained by the\n\
1228interpreter and to functions that interact strongly with the interpreter.\n\
1229\n\
1230Dynamic objects:\n\
1231\n\
1232argv -- command line arguments; argv[0] is the script pathname if known\n\
1233path -- module search path; path[0] is the script directory, else ''\n\
1234modules -- dictionary of loaded modules\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001235\n\
1236displayhook -- called to show results in an interactive session\n\
1237excepthook -- called to handle any uncaught exception other than SystemExit\n\
1238 To customize printing in an interactive session or to install a custom\n\
1239 top-level exception handler, assign other functions to replace these.\n\
1240\n\
Benjamin Peterson06157a42008-07-15 00:28:36 +00001241stdin -- standard input file object; used by input()\n\
Georg Brandl88fc6642007-02-09 21:28:07 +00001242stdout -- standard output file object; used by print()\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001243stderr -- standard error object; used for error messages\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001244 By assigning other file objects (or objects that behave like files)\n\
1245 to these, it is possible to redirect all of the interpreter's I/O.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001246\n\
1247last_type -- type of last uncaught exception\n\
1248last_value -- value of last uncaught exception\n\
1249last_traceback -- traceback of last uncaught exception\n\
1250 These three are only available in an interactive session after a\n\
1251 traceback has been printed.\n\
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001252"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001253)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001254/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001255PyDoc_STR(
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001256"\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001257Static objects:\n\
1258\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001259builtin_module_names -- tuple of module names built into this interpreter\n\
1260copyright -- copyright notice pertaining to this interpreter\n\
1261exec_prefix -- prefix used to find the machine-specific Python library\n\
1262executable -- pathname of this Python interpreter\n\
1263float_info -- a struct sequence with information about the float implementation.\n\
1264float_repr_style -- string indicating the style of repr() output for floats\n\
1265hexversion -- version information encoded as a single integer\n\
Mark Dickinsonbd792642009-03-18 20:06:12 +00001266int_info -- a struct sequence with information about the int implementation.\n\
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001267maxsize -- the largest supported length of containers.\n\
Ezio Melotti48a2f8f2011-09-29 00:18:19 +03001268maxunicode -- the value of the largest Unicode codepoint\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001269platform -- platform identifier\n\
1270prefix -- prefix used to find the Python library\n\
1271thread_info -- a struct sequence with information about the thread implementation.\n\
Fred Drake801c08d2000-04-13 15:29:10 +00001272version -- the version of this interpreter as a string\n\
Eric Smith0e5b5622009-02-06 01:32:42 +00001273version_info -- version information as a named tuple\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001274"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001275)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001276#ifdef MS_WINDOWS
1277/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001278PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001279"dllhandle -- [Windows only] integer handle of the Python DLL\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001280winver -- [Windows only] version number of the Python DLL\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001281"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001282)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001283#endif /* MS_WINDOWS */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001284PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001285"__stdin__ -- the original stdin; don't touch!\n\
1286__stdout__ -- the original stdout; don't touch!\n\
1287__stderr__ -- the original stderr; don't touch!\n\
1288__displayhook__ -- the original displayhook; don't touch!\n\
1289__excepthook__ -- the original excepthook; don't touch!\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001290\n\
1291Functions:\n\
1292\n\
Georg Brandl1a3284e2007-12-02 09:40:06 +00001293displayhook() -- print an object to the screen, and save it in builtins._\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001294excepthook() -- print an exception and its traceback to sys.stderr\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001295exc_info() -- return thread-safe information about the current exception\n\
1296exit() -- exit the interpreter by raising SystemExit\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001297getdlopenflags() -- returns flags to be used for dlopen() calls\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001298getprofile() -- get the global profiling function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001299getrefcount() -- return the reference count for an object (plus one :-)\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001300getrecursionlimit() -- return the max recursion depth for the interpreter\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001301getsizeof() -- return the size of an object in bytes\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001302gettrace() -- get the global debug tracing function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001303setcheckinterval() -- control how often the interpreter checks for events\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001304setdlopenflags() -- set the flags to be used for dlopen() calls\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001305setprofile() -- set the global profiling function\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001306setrecursionlimit() -- set the max recursion depth for the interpreter\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001307settrace() -- set the global debug tracing function\n\
Fred Drakeccede592000-08-14 20:59:57 +00001308"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001309)
Fred Drakeccede592000-08-14 20:59:57 +00001310/* end of sys_doc */ ;
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001311
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001312
1313PyDoc_STRVAR(flags__doc__,
1314"sys.flags\n\
1315\n\
1316Flags provided through command line arguments or environment vars.");
1317
1318static PyTypeObject FlagsType;
1319
1320static PyStructSequence_Field flags_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001321 {"debug", "-d"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001322 {"inspect", "-i"},
1323 {"interactive", "-i"},
1324 {"optimize", "-O or -OO"},
1325 {"dont_write_bytecode", "-B"},
1326 {"no_user_site", "-s"},
1327 {"no_site", "-S"},
1328 {"ignore_environment", "-E"},
1329 {"verbose", "-v"},
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001330#ifdef RISCOS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001331 {"riscos_wimp", "???"},
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001332#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001333 /* {"unbuffered", "-u"}, */
1334 /* {"skip_first", "-x"}, */
Georg Brandl8aa7e992010-12-28 18:30:18 +00001335 {"bytes_warning", "-b"},
1336 {"quiet", "-q"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001337 {0}
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001338};
1339
1340static PyStructSequence_Desc flags_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001341 "sys.flags", /* name */
1342 flags__doc__, /* doc */
1343 flags_fields, /* fields */
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001344#ifdef RISCOS
Raymond Hettinger90e8f8c2011-01-05 20:08:25 +00001345 12
Éric Araujobe3bd572011-03-26 01:55:15 +01001346#else
1347 11
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001348#endif
1349};
1350
1351static PyObject*
1352make_flags(void)
1353{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001354 int pos = 0;
1355 PyObject *seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001356
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001357 seq = PyStructSequence_New(&FlagsType);
1358 if (seq == NULL)
1359 return NULL;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001360
1361#define SetFlag(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001362 PyStructSequence_SET_ITEM(seq, pos++, PyLong_FromLong(flag))
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001363
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001364 SetFlag(Py_DebugFlag);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001365 SetFlag(Py_InspectFlag);
1366 SetFlag(Py_InteractiveFlag);
1367 SetFlag(Py_OptimizeFlag);
1368 SetFlag(Py_DontWriteBytecodeFlag);
1369 SetFlag(Py_NoUserSiteDirectory);
1370 SetFlag(Py_NoSiteFlag);
1371 SetFlag(Py_IgnoreEnvironmentFlag);
1372 SetFlag(Py_VerboseFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001373#ifdef RISCOS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001374 SetFlag(Py_RISCOSWimpFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001375#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001376 /* SetFlag(saw_unbuffered_flag); */
1377 /* SetFlag(skipfirstline); */
Christian Heimes33fe8092008-04-13 13:53:33 +00001378 SetFlag(Py_BytesWarningFlag);
Georg Brandl8aa7e992010-12-28 18:30:18 +00001379 SetFlag(Py_QuietFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001380#undef SetFlag
1381
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001382 if (PyErr_Occurred()) {
1383 return NULL;
1384 }
1385 return seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001386}
1387
Eric Smith0e5b5622009-02-06 01:32:42 +00001388PyDoc_STRVAR(version_info__doc__,
1389"sys.version_info\n\
1390\n\
1391Version information as a named tuple.");
1392
1393static PyTypeObject VersionInfoType;
1394
1395static PyStructSequence_Field version_info_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001396 {"major", "Major release number"},
1397 {"minor", "Minor release number"},
1398 {"micro", "Patch release number"},
1399 {"releaselevel", "'alpha', 'beta', 'candidate', or 'release'"},
1400 {"serial", "Serial release number"},
1401 {0}
Eric Smith0e5b5622009-02-06 01:32:42 +00001402};
1403
1404static PyStructSequence_Desc version_info_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001405 "sys.version_info", /* name */
1406 version_info__doc__, /* doc */
1407 version_info_fields, /* fields */
1408 5
Eric Smith0e5b5622009-02-06 01:32:42 +00001409};
1410
1411static PyObject *
1412make_version_info(void)
1413{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 PyObject *version_info;
1415 char *s;
1416 int pos = 0;
Eric Smith0e5b5622009-02-06 01:32:42 +00001417
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001418 version_info = PyStructSequence_New(&VersionInfoType);
1419 if (version_info == NULL) {
1420 return NULL;
1421 }
Eric Smith0e5b5622009-02-06 01:32:42 +00001422
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001423 /*
1424 * These release level checks are mutually exclusive and cover
1425 * the field, so don't get too fancy with the pre-processor!
1426 */
Eric Smith0e5b5622009-02-06 01:32:42 +00001427#if PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_ALPHA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 s = "alpha";
Eric Smith0e5b5622009-02-06 01:32:42 +00001429#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_BETA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001430 s = "beta";
Eric Smith0e5b5622009-02-06 01:32:42 +00001431#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_GAMMA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 s = "candidate";
Eric Smith0e5b5622009-02-06 01:32:42 +00001433#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_FINAL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001434 s = "final";
Eric Smith0e5b5622009-02-06 01:32:42 +00001435#endif
1436
1437#define SetIntItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001438 PyStructSequence_SET_ITEM(version_info, pos++, PyLong_FromLong(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001439#define SetStrItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001440 PyStructSequence_SET_ITEM(version_info, pos++, PyUnicode_FromString(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001441
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001442 SetIntItem(PY_MAJOR_VERSION);
1443 SetIntItem(PY_MINOR_VERSION);
1444 SetIntItem(PY_MICRO_VERSION);
1445 SetStrItem(s);
1446 SetIntItem(PY_RELEASE_SERIAL);
Eric Smith0e5b5622009-02-06 01:32:42 +00001447#undef SetIntItem
1448#undef SetStrItem
1449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001450 if (PyErr_Occurred()) {
1451 Py_CLEAR(version_info);
1452 return NULL;
1453 }
1454 return version_info;
Eric Smith0e5b5622009-02-06 01:32:42 +00001455}
1456
Martin v. Löwis1a214512008-06-11 05:26:20 +00001457static struct PyModuleDef sysmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001458 PyModuleDef_HEAD_INIT,
1459 "sys",
1460 sys_doc,
1461 -1, /* multiple "initialization" just copies the module dict. */
1462 sys_methods,
1463 NULL,
1464 NULL,
1465 NULL,
1466 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00001467};
1468
Guido van Rossum25ce5661997-08-02 03:10:38 +00001469PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001470_PySys_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001471{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001472 PyObject *m, *v, *sysdict;
1473 char *s;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001474
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001475 m = PyModule_Create(&sysmodule);
1476 if (m == NULL)
1477 return NULL;
1478 sysdict = PyModule_GetDict(m);
1479#define SET_SYS_FROM_STRING(key, value) \
1480 v = value; \
1481 if (v != NULL) \
1482 PyDict_SetItemString(sysdict, key, v); \
1483 Py_XDECREF(v)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001484
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001485 /* Check that stdin is not a directory
1486 Using shell redirection, you can redirect stdin to a directory,
1487 crashing the Python interpreter. Catch this common mistake here
1488 and output a useful error message. Note that under MS Windows,
1489 the shell already prevents that. */
Martin v. Löwisec59d042009-01-12 07:59:10 +00001490#if !defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001491 {
1492 struct stat sb;
1493 if (fstat(fileno(stdin), &sb) == 0 &&
1494 S_ISDIR(sb.st_mode)) {
1495 /* There's nothing more we can do. */
1496 /* Py_FatalError() will core dump, so just exit. */
1497 PySys_WriteStderr("Python error: <stdin> is a directory, cannot continue\n");
1498 exit(EXIT_FAILURE);
1499 }
1500 }
Martin v. Löwisec59d042009-01-12 07:59:10 +00001501#endif
Neal Norwitz11bd1192005-10-03 00:54:56 +00001502
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001503 /* stdin/stdout/stderr are now set by pythonrun.c */
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 PyDict_SetItemString(sysdict, "__displayhook__",
1506 PyDict_GetItemString(sysdict, "displayhook"));
1507 PyDict_SetItemString(sysdict, "__excepthook__",
1508 PyDict_GetItemString(sysdict, "excepthook"));
1509 SET_SYS_FROM_STRING("version",
1510 PyUnicode_FromString(Py_GetVersion()));
1511 SET_SYS_FROM_STRING("hexversion",
1512 PyLong_FromLong(PY_VERSION_HEX));
Georg Brandl1ca2e792011-03-05 20:51:24 +01001513 SET_SYS_FROM_STRING("_mercurial",
1514 Py_BuildValue("(szz)", "CPython", _Py_hgidentifier(),
1515 _Py_hgversion()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001516 SET_SYS_FROM_STRING("dont_write_bytecode",
1517 PyBool_FromLong(Py_DontWriteBytecodeFlag));
1518 SET_SYS_FROM_STRING("api_version",
1519 PyLong_FromLong(PYTHON_API_VERSION));
1520 SET_SYS_FROM_STRING("copyright",
1521 PyUnicode_FromString(Py_GetCopyright()));
1522 SET_SYS_FROM_STRING("platform",
1523 PyUnicode_FromString(Py_GetPlatform()));
1524 SET_SYS_FROM_STRING("executable",
1525 PyUnicode_FromWideChar(
1526 Py_GetProgramFullPath(), -1));
1527 SET_SYS_FROM_STRING("prefix",
1528 PyUnicode_FromWideChar(Py_GetPrefix(), -1));
1529 SET_SYS_FROM_STRING("exec_prefix",
1530 PyUnicode_FromWideChar(Py_GetExecPrefix(), -1));
1531 SET_SYS_FROM_STRING("maxsize",
1532 PyLong_FromSsize_t(PY_SSIZE_T_MAX));
1533 SET_SYS_FROM_STRING("float_info",
1534 PyFloat_GetInfo());
1535 SET_SYS_FROM_STRING("int_info",
1536 PyLong_GetInfo());
Mark Dickinsondc787d22010-05-23 13:33:13 +00001537 /* initialize hash_info */
1538 if (Hash_InfoType.tp_name == 0)
1539 PyStructSequence_InitType(&Hash_InfoType, &hash_info_desc);
1540 SET_SYS_FROM_STRING("hash_info",
1541 get_hash_info());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 SET_SYS_FROM_STRING("maxunicode",
Ezio Melotti48a2f8f2011-09-29 00:18:19 +03001543 PyLong_FromLong(0x10FFFF));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001544 SET_SYS_FROM_STRING("builtin_module_names",
1545 list_builtin_module_names());
1546 {
1547 /* Assumes that longs are at least 2 bytes long.
1548 Should be safe! */
1549 unsigned long number = 1;
1550 char *value;
Fred Drake099325e2000-08-14 15:47:03 +00001551
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001552 s = (char *) &number;
1553 if (s[0] == 0)
1554 value = "big";
1555 else
1556 value = "little";
1557 SET_SYS_FROM_STRING("byteorder",
1558 PyUnicode_FromString(value));
1559 }
Guido van Rossum8b9ea871996-08-23 18:14:47 +00001560#ifdef MS_COREDLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001561 SET_SYS_FROM_STRING("dllhandle",
1562 PyLong_FromVoidPtr(PyWin_DLLhModule));
1563 SET_SYS_FROM_STRING("winver",
1564 PyUnicode_FromString(PyWin_DLLVersionString));
Guido van Rossumc606fe11996-04-09 02:37:57 +00001565#endif
Barry Warsaw8cf4eae2010-10-16 01:04:07 +00001566#ifdef ABIFLAGS
1567 SET_SYS_FROM_STRING("abiflags",
1568 PyUnicode_FromString(ABIFLAGS));
1569#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001570 if (warnoptions == NULL) {
1571 warnoptions = PyList_New(0);
1572 }
1573 else {
1574 Py_INCREF(warnoptions);
1575 }
1576 if (warnoptions != NULL) {
1577 PyDict_SetItemString(sysdict, "warnoptions", warnoptions);
1578 }
Tim Peters216b78b2006-01-06 02:40:53 +00001579
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001580 v = get_xoptions();
1581 if (v != NULL) {
1582 PyDict_SetItemString(sysdict, "_xoptions", v);
1583 }
1584
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 /* version_info */
1586 if (VersionInfoType.tp_name == 0)
1587 PyStructSequence_InitType(&VersionInfoType, &version_info_desc);
1588 SET_SYS_FROM_STRING("version_info", make_version_info());
1589 /* prevent user from creating new instances */
1590 VersionInfoType.tp_init = NULL;
1591 VersionInfoType.tp_new = NULL;
Eric Smith0e5b5622009-02-06 01:32:42 +00001592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001593 /* flags */
1594 if (FlagsType.tp_name == 0)
1595 PyStructSequence_InitType(&FlagsType, &flags_desc);
1596 SET_SYS_FROM_STRING("flags", make_flags());
1597 /* prevent user from creating new instances */
1598 FlagsType.tp_init = NULL;
1599 FlagsType.tp_new = NULL;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001600
Eric Smithf7bb5782010-01-27 00:44:57 +00001601
1602#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001603 /* getwindowsversion */
1604 if (WindowsVersionType.tp_name == 0)
1605 PyStructSequence_InitType(&WindowsVersionType, &windows_version_desc);
1606 /* prevent user from creating new instances */
1607 WindowsVersionType.tp_init = NULL;
1608 WindowsVersionType.tp_new = NULL;
Eric Smithf7bb5782010-01-27 00:44:57 +00001609#endif
1610
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001611 /* float repr style: 0.03 (short) vs 0.029999999999999999 (legacy) */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001612#ifndef PY_NO_SHORT_FLOAT_REPR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 SET_SYS_FROM_STRING("float_repr_style",
1614 PyUnicode_FromString("short"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001615#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001616 SET_SYS_FROM_STRING("float_repr_style",
1617 PyUnicode_FromString("legacy"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001618#endif
1619
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001620#ifdef WITH_THREAD
1621 SET_SYS_FROM_STRING("thread_info", PyThread_GetInfo());
1622#endif
1623
Christian Heimes7b3ce6a2008-01-31 14:31:45 +00001624#undef SET_SYS_FROM_STRING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001625 if (PyErr_Occurred())
1626 return NULL;
1627 return m;
Guido van Rossum5b3138b1990-11-18 17:41:40 +00001628}
1629
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001630static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00001631makepathobject(const wchar_t *path, wchar_t delim)
Guido van Rossum5b3138b1990-11-18 17:41:40 +00001632{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001633 int i, n;
1634 const wchar_t *p;
1635 PyObject *v, *w;
Tim Peters216b78b2006-01-06 02:40:53 +00001636
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001637 n = 1;
1638 p = path;
1639 while ((p = wcschr(p, delim)) != NULL) {
1640 n++;
1641 p++;
1642 }
1643 v = PyList_New(n);
1644 if (v == NULL)
1645 return NULL;
1646 for (i = 0; ; i++) {
1647 p = wcschr(path, delim);
1648 if (p == NULL)
1649 p = path + wcslen(path); /* End of string */
1650 w = PyUnicode_FromWideChar(path, (Py_ssize_t)(p - path));
1651 if (w == NULL) {
1652 Py_DECREF(v);
1653 return NULL;
1654 }
1655 PyList_SetItem(v, i, w);
1656 if (*p == '\0')
1657 break;
1658 path = p+1;
1659 }
1660 return v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001661}
1662
1663void
Martin v. Löwis790465f2008-04-05 20:41:37 +00001664PySys_SetPath(const wchar_t *path)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001665{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001666 PyObject *v;
1667 if ((v = makepathobject(path, DELIM)) == NULL)
1668 Py_FatalError("can't create sys.path");
1669 if (PySys_SetObject("path", v) != 0)
1670 Py_FatalError("can't assign sys.path");
1671 Py_DECREF(v);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001672}
1673
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001674static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00001675makeargvobject(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001676{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 PyObject *av;
1678 if (argc <= 0 || argv == NULL) {
1679 /* Ensure at least one (empty) argument is seen */
1680 static wchar_t *empty_argv[1] = {L""};
1681 argv = empty_argv;
1682 argc = 1;
1683 }
1684 av = PyList_New(argc);
1685 if (av != NULL) {
1686 int i;
1687 for (i = 0; i < argc; i++) {
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +00001688#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001689 PyObject *v;
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +00001690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001691 /* argv[0] is the script pathname if known */
1692 if (i == 0) {
1693 char* fn = decc$translate_vms(argv[0]);
1694 if ((fn == (char *)0) || fn == (char *)-1)
1695 v = PyUnicode_FromString(argv[0]);
1696 else
1697 v = PyUnicode_FromString(
1698 decc$translate_vms(argv[0]));
1699 } else
1700 v = PyUnicode_FromString(argv[i]);
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +00001701#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001702 PyObject *v = PyUnicode_FromWideChar(argv[i], -1);
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +00001703#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001704 if (v == NULL) {
1705 Py_DECREF(av);
1706 av = NULL;
1707 break;
1708 }
1709 PyList_SetItem(av, i, v);
1710 }
1711 }
1712 return av;
Guido van Rossum3f5da241990-12-20 15:06:42 +00001713}
1714
Nick Coghland26c18a2010-08-17 13:06:11 +00001715#define _HAVE_SCRIPT_ARGUMENT(argc, argv) \
1716 (argc > 0 && argv0 != NULL && \
1717 wcscmp(argv0, L"-c") != 0 && wcscmp(argv0, L"-m") != 0)
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001718
1719static void
1720sys_update_path(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001721{
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001722 wchar_t *argv0;
1723 wchar_t *p = NULL;
1724 Py_ssize_t n = 0;
1725 PyObject *a;
1726 PyObject *path;
1727#ifdef HAVE_READLINK
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001728 wchar_t link[MAXPATHLEN+1];
1729 wchar_t argv0copy[2*MAXPATHLEN+1];
1730 int nr = 0;
1731#endif
Guido van Rossum162e38c2003-02-19 15:25:10 +00001732#if defined(HAVE_REALPATH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001733 wchar_t fullpath[MAXPATHLEN];
Martin v. Löwisec59d042009-01-12 07:59:10 +00001734#elif defined(MS_WINDOWS) && !defined(MS_WINCE)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001735 wchar_t fullpath[MAX_PATH];
Thomas Heller27bb71e2003-01-08 14:33:48 +00001736#endif
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001737
1738 path = PySys_GetObject("path");
1739 if (path == NULL)
1740 return;
1741
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001742 argv0 = argv[0];
1743
1744#ifdef HAVE_READLINK
1745 if (_HAVE_SCRIPT_ARGUMENT(argc, argv))
1746 nr = _Py_wreadlink(argv0, link, MAXPATHLEN);
1747 if (nr > 0) {
1748 /* It's a symlink */
1749 link[nr] = '\0';
1750 if (link[0] == SEP)
1751 argv0 = link; /* Link to absolute path */
1752 else if (wcschr(link, SEP) == NULL)
1753 ; /* Link without path */
1754 else {
1755 /* Must join(dirname(argv0), link) */
1756 wchar_t *q = wcsrchr(argv0, SEP);
1757 if (q == NULL)
1758 argv0 = link; /* argv0 without path */
1759 else {
1760 /* Must make a copy */
1761 wcscpy(argv0copy, argv0);
1762 q = wcsrchr(argv0copy, SEP);
1763 wcscpy(q+1, link);
1764 argv0 = argv0copy;
1765 }
1766 }
1767 }
1768#endif /* HAVE_READLINK */
1769#if SEP == '\\' /* Special case for MS filename syntax */
1770 if (_HAVE_SCRIPT_ARGUMENT(argc, argv)) {
1771 wchar_t *q;
1772#if defined(MS_WINDOWS) && !defined(MS_WINCE)
1773 /* This code here replaces the first element in argv with the full
1774 path that it represents. Under CE, there are no relative paths so
1775 the argument must be the full path anyway. */
1776 wchar_t *ptemp;
1777 if (GetFullPathNameW(argv0,
Victor Stinner63941882011-09-29 00:42:28 +02001778 Py_ARRAY_LENGTH(fullpath),
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001779 fullpath,
1780 &ptemp)) {
1781 argv0 = fullpath;
1782 }
1783#endif
1784 p = wcsrchr(argv0, SEP);
1785 /* Test for alternate separator */
1786 q = wcsrchr(p ? p : argv0, '/');
1787 if (q != NULL)
1788 p = q;
1789 if (p != NULL) {
1790 n = p + 1 - argv0;
1791 if (n > 1 && p[-1] != ':')
1792 n--; /* Drop trailing separator */
1793 }
1794 }
1795#else /* All other filename syntaxes */
1796 if (_HAVE_SCRIPT_ARGUMENT(argc, argv)) {
1797#if defined(HAVE_REALPATH)
Victor Stinner015f4d82010-10-07 22:29:53 +00001798 if (_Py_wrealpath(argv0, fullpath, PATH_MAX)) {
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001799 argv0 = fullpath;
1800 }
1801#endif
1802 p = wcsrchr(argv0, SEP);
1803 }
1804 if (p != NULL) {
1805 n = p + 1 - argv0;
1806#if SEP == '/' /* Special case for Unix filename syntax */
1807 if (n > 1)
1808 n--; /* Drop trailing separator */
1809#endif /* Unix */
1810 }
1811#endif /* All others */
1812 a = PyUnicode_FromWideChar(argv0, n);
1813 if (a == NULL)
1814 Py_FatalError("no mem for sys.path insertion");
1815 if (PyList_Insert(path, 0, a) < 0)
1816 Py_FatalError("sys.path.insert(0) failed");
1817 Py_DECREF(a);
1818}
1819
1820void
1821PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)
1822{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001823 PyObject *av = makeargvobject(argc, argv);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001824 if (av == NULL)
1825 Py_FatalError("no mem for sys.argv");
1826 if (PySys_SetObject("argv", av) != 0)
1827 Py_FatalError("can't assign sys.argv");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001828 Py_DECREF(av);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001829 if (updatepath)
1830 sys_update_path(argc, argv);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001831}
Guido van Rossuma890e681998-05-12 14:59:24 +00001832
Antoine Pitrouf978fac2010-05-21 17:25:34 +00001833void
1834PySys_SetArgv(int argc, wchar_t **argv)
1835{
1836 PySys_SetArgvEx(argc, argv, 1);
1837}
1838
Victor Stinner14284c22010-04-23 12:02:30 +00001839/* Reimplementation of PyFile_WriteString() no calling indirectly
1840 PyErr_CheckSignals(): avoid the call to PyObject_Str(). */
1841
1842static int
Victor Stinner79766632010-08-16 17:36:42 +00001843sys_pyfile_write_unicode(PyObject *unicode, PyObject *file)
Victor Stinner14284c22010-04-23 12:02:30 +00001844{
Victor Stinner79766632010-08-16 17:36:42 +00001845 PyObject *writer = NULL, *args = NULL, *result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001846 int err;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001847 _Py_IDENTIFIER(write);
Victor Stinner14284c22010-04-23 12:02:30 +00001848
Victor Stinnerecccc4f2010-06-08 20:46:00 +00001849 if (file == NULL)
1850 return -1;
1851
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02001852 writer = _PyObject_GetAttrId(file, &PyId_write);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001853 if (writer == NULL)
1854 goto error;
Victor Stinner14284c22010-04-23 12:02:30 +00001855
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001856 args = PyTuple_Pack(1, unicode);
1857 if (args == NULL)
1858 goto error;
Victor Stinner14284c22010-04-23 12:02:30 +00001859
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001860 result = PyEval_CallObject(writer, args);
1861 if (result == NULL) {
1862 goto error;
1863 } else {
1864 err = 0;
1865 goto finally;
1866 }
Victor Stinner14284c22010-04-23 12:02:30 +00001867
1868error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001869 err = -1;
Victor Stinner14284c22010-04-23 12:02:30 +00001870finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001871 Py_XDECREF(writer);
1872 Py_XDECREF(args);
1873 Py_XDECREF(result);
1874 return err;
Victor Stinner14284c22010-04-23 12:02:30 +00001875}
1876
Victor Stinner79766632010-08-16 17:36:42 +00001877static int
1878sys_pyfile_write(const char *text, PyObject *file)
1879{
1880 PyObject *unicode = NULL;
1881 int err;
1882
1883 if (file == NULL)
1884 return -1;
1885
1886 unicode = PyUnicode_FromString(text);
1887 if (unicode == NULL)
1888 return -1;
1889
1890 err = sys_pyfile_write_unicode(unicode, file);
1891 Py_DECREF(unicode);
1892 return err;
1893}
Guido van Rossuma890e681998-05-12 14:59:24 +00001894
1895/* APIs to write to sys.stdout or sys.stderr using a printf-like interface.
1896 Adapted from code submitted by Just van Rossum.
1897
1898 PySys_WriteStdout(format, ...)
1899 PySys_WriteStderr(format, ...)
1900
1901 The first function writes to sys.stdout; the second to sys.stderr. When
1902 there is a problem, they write to the real (C level) stdout or stderr;
Guido van Rossum8442af31998-10-12 18:22:10 +00001903 no exceptions are raised.
Guido van Rossuma890e681998-05-12 14:59:24 +00001904
Victor Stinner14284c22010-04-23 12:02:30 +00001905 PyErr_CheckSignals() is not called to avoid the execution of the Python
Victor Stinner79766632010-08-16 17:36:42 +00001906 signal handlers: they may raise a new exception whereas sys_write()
1907 ignores all exceptions.
Victor Stinner14284c22010-04-23 12:02:30 +00001908
Guido van Rossuma890e681998-05-12 14:59:24 +00001909 Both take a printf-style format string as their first argument followed
1910 by a variable length argument list determined by the format string.
1911
1912 *** WARNING ***
1913
1914 The format should limit the total size of the formatted output string to
1915 1000 bytes. In particular, this means that no unrestricted "%s" formats
1916 should occur; these should be limited using "%.<N>s where <N> is a
1917 decimal number calculated so that <N> plus the maximum size of other
1918 formatted text does not exceed 1000 bytes. Also watch out for "%f",
1919 which can print hundreds of digits for very large numbers.
1920
1921 */
1922
1923static void
Victor Stinner79766632010-08-16 17:36:42 +00001924sys_write(char *name, FILE *fp, const char *format, va_list va)
Guido van Rossuma890e681998-05-12 14:59:24 +00001925{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001926 PyObject *file;
1927 PyObject *error_type, *error_value, *error_traceback;
1928 char buffer[1001];
1929 int written;
Guido van Rossuma890e681998-05-12 14:59:24 +00001930
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001931 PyErr_Fetch(&error_type, &error_value, &error_traceback);
1932 file = PySys_GetObject(name);
1933 written = PyOS_vsnprintf(buffer, sizeof(buffer), format, va);
1934 if (sys_pyfile_write(buffer, file) != 0) {
1935 PyErr_Clear();
1936 fputs(buffer, fp);
1937 }
1938 if (written < 0 || (size_t)written >= sizeof(buffer)) {
1939 const char *truncated = "... truncated";
Victor Stinner79766632010-08-16 17:36:42 +00001940 if (sys_pyfile_write(truncated, file) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001941 fputs(truncated, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001942 }
1943 PyErr_Restore(error_type, error_value, error_traceback);
Guido van Rossuma890e681998-05-12 14:59:24 +00001944}
1945
1946void
Guido van Rossuma890e681998-05-12 14:59:24 +00001947PySys_WriteStdout(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00001948{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001949 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00001950
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001951 va_start(va, format);
Victor Stinner79766632010-08-16 17:36:42 +00001952 sys_write("stdout", stdout, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001953 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00001954}
1955
1956void
Guido van Rossuma890e681998-05-12 14:59:24 +00001957PySys_WriteStderr(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00001958{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001959 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00001960
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001961 va_start(va, format);
Victor Stinner79766632010-08-16 17:36:42 +00001962 sys_write("stderr", stderr, format, va);
1963 va_end(va);
1964}
1965
1966static void
1967sys_format(char *name, FILE *fp, const char *format, va_list va)
1968{
1969 PyObject *file, *message;
1970 PyObject *error_type, *error_value, *error_traceback;
1971 char *utf8;
1972
1973 PyErr_Fetch(&error_type, &error_value, &error_traceback);
1974 file = PySys_GetObject(name);
1975 message = PyUnicode_FromFormatV(format, va);
1976 if (message != NULL) {
1977 if (sys_pyfile_write_unicode(message, file) != 0) {
1978 PyErr_Clear();
1979 utf8 = _PyUnicode_AsString(message);
1980 if (utf8 != NULL)
1981 fputs(utf8, fp);
1982 }
1983 Py_DECREF(message);
1984 }
1985 PyErr_Restore(error_type, error_value, error_traceback);
1986}
1987
1988void
1989PySys_FormatStdout(const char *format, ...)
1990{
1991 va_list va;
1992
1993 va_start(va, format);
1994 sys_format("stdout", stdout, format, va);
1995 va_end(va);
1996}
1997
1998void
1999PySys_FormatStderr(const char *format, ...)
2000{
2001 va_list va;
2002
2003 va_start(va, format);
2004 sys_format("stderr", stderr, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002005 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00002006}