blob: 2f700e65071340e3537c606c7834d04fa5de6175 [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\
Ezio Melotti4af4d272013-08-26 14:00:39 +0300243If the status is an integer, 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);
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200398 Py_CLEAR(frame->f_trace);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000399 return -1;
400 }
401 if (result != Py_None) {
402 PyObject *temp = frame->f_trace;
403 frame->f_trace = NULL;
404 Py_XDECREF(temp);
405 frame->f_trace = result;
406 }
407 else {
408 Py_DECREF(result);
409 }
410 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000411}
Fred Draked0838392001-06-16 21:02:31 +0000412
Fred Drake8b4d01d2000-05-09 19:57:01 +0000413static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000414sys_settrace(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000415{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000416 if (trace_init() == -1)
417 return NULL;
418 if (args == Py_None)
419 PyEval_SetTrace(NULL, NULL);
420 else
421 PyEval_SetTrace(trace_trampoline, args);
422 Py_INCREF(Py_None);
423 return Py_None;
Guido van Rossume2437a11992-03-23 18:20:18 +0000424}
425
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000426PyDoc_STRVAR(settrace_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000427"settrace(function)\n\
428\n\
429Set the global debug tracing function. It will be called on each\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000430function call. See the debugger chapter in the library manual."
431);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000432
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000433static PyObject *
Christian Heimes9bd667a2008-01-20 15:14:11 +0000434sys_gettrace(PyObject *self, PyObject *args)
435{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000436 PyThreadState *tstate = PyThreadState_GET();
437 PyObject *temp = tstate->c_traceobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000439 if (temp == NULL)
440 temp = Py_None;
441 Py_INCREF(temp);
442 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000443}
444
445PyDoc_STRVAR(gettrace_doc,
446"gettrace()\n\
447\n\
448Return the global debug tracing function set with sys.settrace.\n\
449See the debugger chapter in the library manual."
450);
451
452static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000453sys_setprofile(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000454{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000455 if (trace_init() == -1)
456 return NULL;
457 if (args == Py_None)
458 PyEval_SetProfile(NULL, NULL);
459 else
460 PyEval_SetProfile(profile_trampoline, args);
461 Py_INCREF(Py_None);
462 return Py_None;
Guido van Rossume2437a11992-03-23 18:20:18 +0000463}
464
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000465PyDoc_STRVAR(setprofile_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000466"setprofile(function)\n\
467\n\
468Set the profiling function. It will be called on each function call\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000469and return. See the profiler chapter in the library manual."
470);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000471
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000472static PyObject *
Christian Heimes9bd667a2008-01-20 15:14:11 +0000473sys_getprofile(PyObject *self, PyObject *args)
474{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000475 PyThreadState *tstate = PyThreadState_GET();
476 PyObject *temp = tstate->c_profileobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000477
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000478 if (temp == NULL)
479 temp = Py_None;
480 Py_INCREF(temp);
481 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000482}
483
484PyDoc_STRVAR(getprofile_doc,
485"getprofile()\n\
486\n\
487Return the profiling function set with sys.setprofile.\n\
488See the profiler chapter in the library manual."
489);
490
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000491static int _check_interval = 100;
492
Christian Heimes9bd667a2008-01-20 15:14:11 +0000493static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000494sys_setcheckinterval(PyObject *self, PyObject *args)
Guido van Rossuma0d7a231995-01-09 17:46:13 +0000495{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000496 if (PyErr_WarnEx(PyExc_DeprecationWarning,
497 "sys.getcheckinterval() and sys.setcheckinterval() "
498 "are deprecated. Use sys.setswitchinterval() "
499 "instead.", 1) < 0)
500 return NULL;
501 if (!PyArg_ParseTuple(args, "i:setcheckinterval", &_check_interval))
502 return NULL;
503 Py_INCREF(Py_None);
504 return Py_None;
Guido van Rossuma0d7a231995-01-09 17:46:13 +0000505}
506
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000507PyDoc_STRVAR(setcheckinterval_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000508"setcheckinterval(n)\n\
509\n\
510Tell the Python interpreter to check for asynchronous events every\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000511n instructions. This also affects how often thread switches occur."
512);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000513
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000514static PyObject *
Tim Peterse5e065b2003-07-06 18:36:54 +0000515sys_getcheckinterval(PyObject *self, PyObject *args)
516{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000517 if (PyErr_WarnEx(PyExc_DeprecationWarning,
518 "sys.getcheckinterval() and sys.setcheckinterval() "
519 "are deprecated. Use sys.getswitchinterval() "
520 "instead.", 1) < 0)
521 return NULL;
522 return PyLong_FromLong(_check_interval);
Tim Peterse5e065b2003-07-06 18:36:54 +0000523}
524
525PyDoc_STRVAR(getcheckinterval_doc,
526"getcheckinterval() -> current check interval; see setcheckinterval()."
527);
528
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000529#ifdef WITH_THREAD
530static PyObject *
531sys_setswitchinterval(PyObject *self, PyObject *args)
532{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000533 double d;
534 if (!PyArg_ParseTuple(args, "d:setswitchinterval", &d))
535 return NULL;
536 if (d <= 0.0) {
537 PyErr_SetString(PyExc_ValueError,
538 "switch interval must be strictly positive");
539 return NULL;
540 }
541 _PyEval_SetSwitchInterval((unsigned long) (1e6 * d));
542 Py_INCREF(Py_None);
543 return Py_None;
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000544}
545
546PyDoc_STRVAR(setswitchinterval_doc,
547"setswitchinterval(n)\n\
548\n\
549Set the ideal thread switching delay inside the Python interpreter\n\
550The actual frequency of switching threads can be lower if the\n\
551interpreter executes long sequences of uninterruptible code\n\
552(this is implementation-specific and workload-dependent).\n\
553\n\
554The parameter must represent the desired switching delay in seconds\n\
555A typical value is 0.005 (5 milliseconds)."
556);
557
558static PyObject *
559sys_getswitchinterval(PyObject *self, PyObject *args)
560{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000561 return PyFloat_FromDouble(1e-6 * _PyEval_GetSwitchInterval());
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000562}
563
564PyDoc_STRVAR(getswitchinterval_doc,
565"getswitchinterval() -> current thread switch interval; see setswitchinterval()."
566);
567
568#endif /* WITH_THREAD */
569
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000570#ifdef WITH_TSC
571static PyObject *
572sys_settscdump(PyObject *self, PyObject *args)
573{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000574 int bool;
575 PyThreadState *tstate = PyThreadState_Get();
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000576
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000577 if (!PyArg_ParseTuple(args, "i:settscdump", &bool))
578 return NULL;
579 if (bool)
580 tstate->interp->tscdump = 1;
581 else
582 tstate->interp->tscdump = 0;
583 Py_INCREF(Py_None);
584 return Py_None;
Tim Peters216b78b2006-01-06 02:40:53 +0000585
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000586}
587
Tim Peters216b78b2006-01-06 02:40:53 +0000588PyDoc_STRVAR(settscdump_doc,
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000589"settscdump(bool)\n\
590\n\
591If true, tell the Python interpreter to dump VM measurements to\n\
592stderr. If false, turn off dump. The measurements are based on the\n\
Michael W. Hudson800ba232004-08-12 18:19:17 +0000593processor's time-stamp counter."
Tim Peters216b78b2006-01-06 02:40:53 +0000594);
Neal Norwitz0f5aed42004-06-13 20:32:17 +0000595#endif /* TSC */
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000596
Tim Peterse5e065b2003-07-06 18:36:54 +0000597static PyObject *
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000598sys_setrecursionlimit(PyObject *self, PyObject *args)
599{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000600 int new_limit;
601 if (!PyArg_ParseTuple(args, "i:setrecursionlimit", &new_limit))
602 return NULL;
603 if (new_limit <= 0) {
604 PyErr_SetString(PyExc_ValueError,
605 "recursion limit must be positive");
606 return NULL;
607 }
608 Py_SetRecursionLimit(new_limit);
609 Py_INCREF(Py_None);
610 return Py_None;
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000611}
612
Mark Dickinsondc787d22010-05-23 13:33:13 +0000613static PyTypeObject Hash_InfoType;
614
615PyDoc_STRVAR(hash_info_doc,
616"hash_info\n\
617\n\
618A struct sequence providing parameters used for computing\n\
619numeric hashes. The attributes are read only.");
620
621static PyStructSequence_Field hash_info_fields[] = {
622 {"width", "width of the type used for hashing, in bits"},
623 {"modulus", "prime number giving the modulus on which the hash "
624 "function is based"},
625 {"inf", "value to be used for hash of a positive infinity"},
626 {"nan", "value to be used for hash of a nan"},
627 {"imag", "multiplier used for the imaginary part of a complex number"},
628 {NULL, NULL}
629};
630
631static PyStructSequence_Desc hash_info_desc = {
632 "sys.hash_info",
633 hash_info_doc,
634 hash_info_fields,
635 5,
636};
637
Matthias Klosed885e952010-07-06 10:53:30 +0000638static PyObject *
Mark Dickinsondc787d22010-05-23 13:33:13 +0000639get_hash_info(void)
640{
641 PyObject *hash_info;
642 int field = 0;
643 hash_info = PyStructSequence_New(&Hash_InfoType);
644 if (hash_info == NULL)
645 return NULL;
646 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000647 PyLong_FromLong(8*sizeof(Py_hash_t)));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000648 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000649 PyLong_FromSsize_t(_PyHASH_MODULUS));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000650 PyStructSequence_SET_ITEM(hash_info, field++,
651 PyLong_FromLong(_PyHASH_INF));
652 PyStructSequence_SET_ITEM(hash_info, field++,
653 PyLong_FromLong(_PyHASH_NAN));
654 PyStructSequence_SET_ITEM(hash_info, field++,
655 PyLong_FromLong(_PyHASH_IMAG));
656 if (PyErr_Occurred()) {
657 Py_CLEAR(hash_info);
658 return NULL;
659 }
660 return hash_info;
661}
662
663
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000664PyDoc_STRVAR(setrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000665"setrecursionlimit(n)\n\
666\n\
667Set the maximum depth of the Python interpreter stack to n. This\n\
668limit prevents infinite recursion from causing an overflow of the C\n\
669stack and crashing Python. The highest possible limit is platform-\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000670dependent."
671);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000672
673static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000674sys_getrecursionlimit(PyObject *self)
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000675{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000676 return PyLong_FromLong(Py_GetRecursionLimit());
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000677}
678
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000679PyDoc_STRVAR(getrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000680"getrecursionlimit()\n\
681\n\
682Return the current value of the recursion limit, the maximum depth\n\
683of the Python interpreter stack. This limit prevents infinite\n\
Jack Jansene739a0d2002-06-26 20:39:20 +0000684recursion from causing an overflow of the C stack and crashing Python."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000685);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000686
Mark Hammond8696ebc2002-10-08 02:44:31 +0000687#ifdef MS_WINDOWS
688PyDoc_STRVAR(getwindowsversion_doc,
689"getwindowsversion()\n\
690\n\
Eric Smithf7bb5782010-01-27 00:44:57 +0000691Return information about the running version of Windows as a named tuple.\n\
692The members are named: major, minor, build, platform, service_pack,\n\
693service_pack_major, service_pack_minor, suite_mask, and product_type. For\n\
Ezio Melotti4969f702011-03-15 05:59:46 +0200694backward compatibility, only the first 5 items are available by indexing.\n\
Eric Smithf7bb5782010-01-27 00:44:57 +0000695All elements are numbers, except service_pack which is a string. Platform\n\
696may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7,\n\
6973 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain\n\
698controller, 3 for a server."
Mark Hammond8696ebc2002-10-08 02:44:31 +0000699);
700
Eric Smithf7bb5782010-01-27 00:44:57 +0000701static PyTypeObject WindowsVersionType = {0, 0, 0, 0, 0, 0};
702
703static PyStructSequence_Field windows_version_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000704 {"major", "Major version number"},
705 {"minor", "Minor version number"},
706 {"build", "Build number"},
707 {"platform", "Operating system platform"},
708 {"service_pack", "Latest Service Pack installed on the system"},
709 {"service_pack_major", "Service Pack major version number"},
710 {"service_pack_minor", "Service Pack minor version number"},
711 {"suite_mask", "Bit mask identifying available product suites"},
712 {"product_type", "System product type"},
713 {0}
Eric Smithf7bb5782010-01-27 00:44:57 +0000714};
715
716static PyStructSequence_Desc windows_version_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000717 "sys.getwindowsversion", /* name */
718 getwindowsversion_doc, /* doc */
719 windows_version_fields, /* fields */
720 5 /* For backward compatibility,
721 only the first 5 items are accessible
722 via indexing, the rest are name only */
Eric Smithf7bb5782010-01-27 00:44:57 +0000723};
724
Mark Hammond8696ebc2002-10-08 02:44:31 +0000725static PyObject *
726sys_getwindowsversion(PyObject *self)
727{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000728 PyObject *version;
729 int pos = 0;
730 OSVERSIONINFOEX ver;
731 ver.dwOSVersionInfoSize = sizeof(ver);
732 if (!GetVersionEx((OSVERSIONINFO*) &ver))
733 return PyErr_SetFromWindowsErr(0);
Eric Smithf7bb5782010-01-27 00:44:57 +0000734
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000735 version = PyStructSequence_New(&WindowsVersionType);
736 if (version == NULL)
737 return NULL;
Eric Smithf7bb5782010-01-27 00:44:57 +0000738
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000739 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMajorVersion));
740 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMinorVersion));
741 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwBuildNumber));
742 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwPlatformId));
743 PyStructSequence_SET_ITEM(version, pos++, PyUnicode_FromString(ver.szCSDVersion));
744 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMajor));
745 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMinor));
746 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wSuiteMask));
747 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wProductType));
Eric Smithf7bb5782010-01-27 00:44:57 +0000748
Serhiy Storchaka48d761e2013-12-17 15:11:24 +0200749 if (PyErr_Occurred()) {
750 Py_DECREF(version);
751 return NULL;
752 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000753 return version;
Mark Hammond8696ebc2002-10-08 02:44:31 +0000754}
755
756#endif /* MS_WINDOWS */
757
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000758#ifdef HAVE_DLOPEN
759static PyObject *
760sys_setdlopenflags(PyObject *self, PyObject *args)
761{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000762 int new_val;
763 PyThreadState *tstate = PyThreadState_GET();
764 if (!PyArg_ParseTuple(args, "i:setdlopenflags", &new_val))
765 return NULL;
766 if (!tstate)
767 return NULL;
768 tstate->interp->dlopenflags = new_val;
769 Py_INCREF(Py_None);
770 return Py_None;
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000771}
772
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000773PyDoc_STRVAR(setdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000774"setdlopenflags(n) -> None\n\
775\n\
Alexandre Vassalotti260484d2009-07-17 11:43:26 +0000776Set the flags used by the interpreter for dlopen calls, such as when the\n\
777interpreter loads extension modules. Among other things, this will enable\n\
778a lazy resolving of symbols when importing a module, if called as\n\
779sys.setdlopenflags(0). To share symbols across extension modules, call as\n\
780sys.setdlopenflags(ctypes.RTLD_GLOBAL). Symbolic names for the flag modules\n\
Victor Stinnerf4afa432011-10-31 11:48:09 +0100781can be found in the os module (RTLD_xxx constants, e.g. os.RTLD_LAZY).");
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000782
783static PyObject *
784sys_getdlopenflags(PyObject *self, PyObject *args)
785{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000786 PyThreadState *tstate = PyThreadState_GET();
787 if (!tstate)
788 return NULL;
789 return PyLong_FromLong(tstate->interp->dlopenflags);
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000790}
791
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000792PyDoc_STRVAR(getdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000793"getdlopenflags() -> int\n\
794\n\
Alexandre Vassalotti260484d2009-07-17 11:43:26 +0000795Return the current value of the flags that are used for dlopen calls.\n\
796The flag constants are defined in the ctypes and DLFCN modules.");
797
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000798#endif /* HAVE_DLOPEN */
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000799
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000800#ifdef USE_MALLOPT
801/* Link with -lmalloc (or -lmpc) on an SGI */
802#include <malloc.h>
803
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000804static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000805sys_mdebug(PyObject *self, PyObject *args)
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000806{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000807 int flag;
808 if (!PyArg_ParseTuple(args, "i:mdebug", &flag))
809 return NULL;
810 mallopt(M_DEBUG, flag);
811 Py_INCREF(Py_None);
812 return Py_None;
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000813}
814#endif /* USE_MALLOPT */
815
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000816static PyObject *
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000817sys_getsizeof(PyObject *self, PyObject *args, PyObject *kwds)
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000818{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000819 PyObject *res = NULL;
Benjamin Petersonce798522012-01-22 11:24:29 -0500820 static PyObject *gc_head_size = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000821 static char *kwlist[] = {"object", "default", 0};
822 PyObject *o, *dflt = NULL;
823 PyObject *method;
Benjamin Petersonce798522012-01-22 11:24:29 -0500824 _Py_IDENTIFIER(__sizeof__);
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000825
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000826 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|O:getsizeof",
827 kwlist, &o, &dflt))
828 return NULL;
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000829
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000830 /* Initialize static variable for GC head size */
831 if (gc_head_size == NULL) {
832 gc_head_size = PyLong_FromSsize_t(sizeof(PyGC_Head));
833 if (gc_head_size == NULL)
834 return NULL;
835 }
Benjamin Petersona5758c02009-05-09 18:15:04 +0000836
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000837 /* Make sure the type is initialized. float gets initialized late */
838 if (PyType_Ready(Py_TYPE(o)) < 0)
839 return NULL;
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000840
Benjamin Petersonce798522012-01-22 11:24:29 -0500841 method = _PyObject_LookupSpecial(o, &PyId___sizeof__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000842 if (method == NULL) {
843 if (!PyErr_Occurred())
844 PyErr_Format(PyExc_TypeError,
845 "Type %.100s doesn't define __sizeof__",
846 Py_TYPE(o)->tp_name);
847 }
848 else {
849 res = PyObject_CallFunctionObjArgs(method, NULL);
850 Py_DECREF(method);
851 }
852
853 /* Has a default value been given */
854 if ((res == NULL) && (dflt != NULL) &&
855 PyErr_ExceptionMatches(PyExc_TypeError))
856 {
857 PyErr_Clear();
858 Py_INCREF(dflt);
859 return dflt;
860 }
861 else if (res == NULL)
862 return res;
863
864 /* add gc_head size */
865 if (PyObject_IS_GC(o)) {
866 PyObject *tmp = res;
867 res = PyNumber_Add(tmp, gc_head_size);
868 Py_DECREF(tmp);
869 }
870 return res;
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000871}
872
873PyDoc_STRVAR(getsizeof_doc,
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000874"getsizeof(object, default) -> int\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000875\n\
876Return the size of object in bytes.");
877
878static PyObject *
Fred Drakea7688822001-10-24 20:47:48 +0000879sys_getrefcount(PyObject *self, PyObject *arg)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000880{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000881 return PyLong_FromSsize_t(arg->ob_refcnt);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000882}
883
Tim Peters4be93d02002-07-07 19:59:50 +0000884#ifdef Py_REF_DEBUG
Mark Hammond440d8982000-06-20 08:12:48 +0000885static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000886sys_gettotalrefcount(PyObject *self)
Mark Hammond440d8982000-06-20 08:12:48 +0000887{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000888 return PyLong_FromSsize_t(_Py_GetRefTotal());
Mark Hammond440d8982000-06-20 08:12:48 +0000889}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000890#endif /* Py_REF_DEBUG */
Mark Hammond440d8982000-06-20 08:12:48 +0000891
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000892PyDoc_STRVAR(getrefcount_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000893"getrefcount(object) -> integer\n\
894\n\
Fred Drakeba3ff1b2002-06-20 21:36:19 +0000895Return the reference count of object. The count returned is generally\n\
896one higher than you might expect, because it includes the (temporary)\n\
897reference as an argument to getrefcount()."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000898);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000899
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000900#ifdef COUNT_ALLOCS
901static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000902sys_getcounts(PyObject *self)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000903{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000904 extern PyObject *get_counts(void);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000905
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000906 return get_counts();
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000907}
908#endif
909
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000910PyDoc_STRVAR(getframe_doc,
Barry Warsawb6a54d22000-12-06 21:47:46 +0000911"_getframe([depth]) -> frameobject\n\
912\n\
913Return a frame object from the call stack. If optional integer depth is\n\
914given, return the frame object that many calls below the top of the stack.\n\
915If that is deeper than the call stack, ValueError is raised. The default\n\
916for depth is zero, returning the frame at the top of the call stack.\n\
917\n\
918This function should be used for internal and specialized\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000919purposes only."
920);
Barry Warsawb6a54d22000-12-06 21:47:46 +0000921
922static PyObject *
923sys_getframe(PyObject *self, PyObject *args)
924{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000925 PyFrameObject *f = PyThreadState_GET()->frame;
926 int depth = -1;
Barry Warsawb6a54d22000-12-06 21:47:46 +0000927
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000928 if (!PyArg_ParseTuple(args, "|i:_getframe", &depth))
929 return NULL;
Barry Warsawb6a54d22000-12-06 21:47:46 +0000930
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000931 while (depth > 0 && f != NULL) {
932 f = f->f_back;
933 --depth;
934 }
935 if (f == NULL) {
936 PyErr_SetString(PyExc_ValueError,
937 "call stack is not deep enough");
938 return NULL;
939 }
940 Py_INCREF(f);
941 return (PyObject*)f;
Barry Warsawb6a54d22000-12-06 21:47:46 +0000942}
943
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000944PyDoc_STRVAR(current_frames_doc,
945"_current_frames() -> dictionary\n\
946\n\
947Return a dictionary mapping each current thread T's thread id to T's\n\
948current stack frame.\n\
949\n\
950This function should be used for specialized purposes only."
951);
952
953static PyObject *
954sys_current_frames(PyObject *self, PyObject *noargs)
955{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 return _PyThread_CurrentFrames();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000957}
958
Guido van Rossuma12fe4e2003-04-09 19:06:21 +0000959PyDoc_STRVAR(call_tracing_doc,
960"call_tracing(func, args) -> object\n\
961\n\
962Call func(*args), while tracing is enabled. The tracing state is\n\
963saved, and restored afterwards. This is intended to be called from\n\
964a debugger from a checkpoint, to recursively debug some other code."
965);
966
967static PyObject *
968sys_call_tracing(PyObject *self, PyObject *args)
969{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 PyObject *func, *funcargs;
971 if (!PyArg_ParseTuple(args, "OO!:call_tracing", &func, &PyTuple_Type, &funcargs))
972 return NULL;
973 return _PyEval_CallTracing(func, funcargs);
Guido van Rossuma12fe4e2003-04-09 19:06:21 +0000974}
975
Jeremy Hylton985eba52003-02-05 23:13:00 +0000976PyDoc_STRVAR(callstats_doc,
977"callstats() -> tuple of integers\n\
978\n\
979Return a tuple of function call statistics, if CALL_PROFILE was defined\n\
980when Python was built. Otherwise, return None.\n\
981\n\
982When enabled, this function returns detailed, implementation-specific\n\
983details about the number of function calls executed. The return value is\n\
984a 11-tuple where the entries in the tuple are counts of:\n\
9850. all function calls\n\
9861. calls to PyFunction_Type objects\n\
9872. PyFunction calls that do not create an argument tuple\n\
9883. PyFunction calls that do not create an argument tuple\n\
989 and bypass PyEval_EvalCodeEx()\n\
9904. PyMethod calls\n\
9915. PyMethod calls on bound methods\n\
9926. PyType calls\n\
9937. PyCFunction calls\n\
9948. generator calls\n\
9959. All other calls\n\
99610. Number of stack pops performed by call_function()"
997);
Barry Warsawb6a54d22000-12-06 21:47:46 +0000998
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000999#ifdef __cplusplus
1000extern "C" {
1001#endif
1002
David Malcolm49526f42012-06-22 14:55:41 -04001003static PyObject *
1004sys_debugmallocstats(PyObject *self, PyObject *args)
1005{
1006#ifdef WITH_PYMALLOC
1007 _PyObject_DebugMallocStats(stderr);
1008 fputc('\n', stderr);
1009#endif
1010 _PyObject_DebugTypeStats(stderr);
1011
1012 Py_RETURN_NONE;
1013}
1014PyDoc_STRVAR(debugmallocstats_doc,
1015"_debugmallocstats()\n\
1016\n\
1017Print summary info to stderr about the state of\n\
1018pymalloc's structures.\n\
1019\n\
1020In Py_DEBUG mode, also perform some expensive internal consistency\n\
1021checks.\n\
1022");
1023
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001024#ifdef Py_TRACE_REFS
Guido van Rossumded690f1996-05-24 20:48:31 +00001025/* Defined in objects.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001026extern PyObject *_Py_GetObjects(PyObject *, PyObject *);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001027#endif
Guido van Rossumded690f1996-05-24 20:48:31 +00001028
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001029#ifdef DYNAMIC_EXECUTION_PROFILE
1030/* Defined in ceval.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001031extern PyObject *_Py_GetDXProfile(PyObject *, PyObject *);
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001032#endif
1033
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001034#ifdef __cplusplus
1035}
1036#endif
1037
Christian Heimes15ebc882008-02-04 18:48:49 +00001038static PyObject *
1039sys_clear_type_cache(PyObject* self, PyObject* args)
1040{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001041 PyType_ClearCache();
1042 Py_RETURN_NONE;
Christian Heimes15ebc882008-02-04 18:48:49 +00001043}
1044
1045PyDoc_STRVAR(sys_clear_type_cache__doc__,
1046"_clear_type_cache() -> None\n\
1047Clear the internal type lookup cache.");
1048
1049
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001050static PyMethodDef sys_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001051 /* Might as well keep this in alphabetic order */
1052 {"callstats", (PyCFunction)PyEval_GetCallStats, METH_NOARGS,
1053 callstats_doc},
1054 {"_clear_type_cache", sys_clear_type_cache, METH_NOARGS,
1055 sys_clear_type_cache__doc__},
1056 {"_current_frames", sys_current_frames, METH_NOARGS,
1057 current_frames_doc},
1058 {"displayhook", sys_displayhook, METH_O, displayhook_doc},
1059 {"exc_info", sys_exc_info, METH_NOARGS, exc_info_doc},
1060 {"excepthook", sys_excepthook, METH_VARARGS, excepthook_doc},
1061 {"exit", sys_exit, METH_VARARGS, exit_doc},
1062 {"getdefaultencoding", (PyCFunction)sys_getdefaultencoding,
1063 METH_NOARGS, getdefaultencoding_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001064#ifdef HAVE_DLOPEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001065 {"getdlopenflags", (PyCFunction)sys_getdlopenflags, METH_NOARGS,
1066 getdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001067#endif
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001068#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001069 {"getcounts", (PyCFunction)sys_getcounts, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001070#endif
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001071#ifdef DYNAMIC_EXECUTION_PROFILE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001072 {"getdxp", _Py_GetDXProfile, METH_VARARGS},
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001073#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001074 {"getfilesystemencoding", (PyCFunction)sys_getfilesystemencoding,
1075 METH_NOARGS, getfilesystemencoding_doc},
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001076#ifdef Py_TRACE_REFS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001077 {"getobjects", _Py_GetObjects, METH_VARARGS},
Tim Peters4be93d02002-07-07 19:59:50 +00001078#endif
1079#ifdef Py_REF_DEBUG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001080 {"gettotalrefcount", (PyCFunction)sys_gettotalrefcount, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001081#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001082 {"getrefcount", (PyCFunction)sys_getrefcount, METH_O, getrefcount_doc},
1083 {"getrecursionlimit", (PyCFunction)sys_getrecursionlimit, METH_NOARGS,
1084 getrecursionlimit_doc},
1085 {"getsizeof", (PyCFunction)sys_getsizeof,
1086 METH_VARARGS | METH_KEYWORDS, getsizeof_doc},
1087 {"_getframe", sys_getframe, METH_VARARGS, getframe_doc},
Mark Hammond8696ebc2002-10-08 02:44:31 +00001088#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001089 {"getwindowsversion", (PyCFunction)sys_getwindowsversion, METH_NOARGS,
1090 getwindowsversion_doc},
Mark Hammond8696ebc2002-10-08 02:44:31 +00001091#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001092 {"intern", sys_intern, METH_VARARGS, intern_doc},
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001093#ifdef USE_MALLOPT
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001094 {"mdebug", sys_mdebug, METH_VARARGS},
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001095#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001096 {"setcheckinterval", sys_setcheckinterval, METH_VARARGS,
1097 setcheckinterval_doc},
1098 {"getcheckinterval", sys_getcheckinterval, METH_NOARGS,
1099 getcheckinterval_doc},
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001100#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001101 {"setswitchinterval", sys_setswitchinterval, METH_VARARGS,
1102 setswitchinterval_doc},
1103 {"getswitchinterval", sys_getswitchinterval, METH_NOARGS,
1104 getswitchinterval_doc},
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001105#endif
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001106#ifdef HAVE_DLOPEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001107 {"setdlopenflags", sys_setdlopenflags, METH_VARARGS,
1108 setdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001109#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001110 {"setprofile", sys_setprofile, METH_O, setprofile_doc},
1111 {"getprofile", sys_getprofile, METH_NOARGS, getprofile_doc},
1112 {"setrecursionlimit", sys_setrecursionlimit, METH_VARARGS,
1113 setrecursionlimit_doc},
Martin v. Löwisf30d60e2004-06-08 08:17:44 +00001114#ifdef WITH_TSC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001115 {"settscdump", sys_settscdump, METH_VARARGS, settscdump_doc},
Martin v. Löwisf30d60e2004-06-08 08:17:44 +00001116#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001117 {"settrace", sys_settrace, METH_O, settrace_doc},
1118 {"gettrace", sys_gettrace, METH_NOARGS, gettrace_doc},
1119 {"call_tracing", sys_call_tracing, METH_VARARGS, call_tracing_doc},
David Malcolm49526f42012-06-22 14:55:41 -04001120 {"_debugmallocstats", sys_debugmallocstats, METH_VARARGS,
1121 debugmallocstats_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 {NULL, NULL} /* sentinel */
Guido van Rossum3f5da241990-12-20 15:06:42 +00001123};
1124
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001125static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001126list_builtin_module_names(void)
Guido van Rossum34679b71993-01-26 13:33:44 +00001127{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001128 PyObject *list = PyList_New(0);
1129 int i;
1130 if (list == NULL)
1131 return NULL;
1132 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1133 PyObject *name = PyUnicode_FromString(
1134 PyImport_Inittab[i].name);
1135 if (name == NULL)
1136 break;
1137 PyList_Append(list, name);
1138 Py_DECREF(name);
1139 }
1140 if (PyList_Sort(list) != 0) {
1141 Py_DECREF(list);
1142 list = NULL;
1143 }
1144 if (list) {
1145 PyObject *v = PyList_AsTuple(list);
1146 Py_DECREF(list);
1147 list = v;
1148 }
1149 return list;
Guido van Rossum34679b71993-01-26 13:33:44 +00001150}
1151
Guido van Rossum23fff912000-12-15 22:02:05 +00001152static PyObject *warnoptions = NULL;
1153
1154void
1155PySys_ResetWarnOptions(void)
1156{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001157 if (warnoptions == NULL || !PyList_Check(warnoptions))
1158 return;
1159 PyList_SetSlice(warnoptions, 0, PyList_GET_SIZE(warnoptions), NULL);
Guido van Rossum23fff912000-12-15 22:02:05 +00001160}
1161
1162void
Victor Stinner9ca9c252010-05-19 16:53:30 +00001163PySys_AddWarnOptionUnicode(PyObject *unicode)
Guido van Rossum23fff912000-12-15 22:02:05 +00001164{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001165 if (warnoptions == NULL || !PyList_Check(warnoptions)) {
1166 Py_XDECREF(warnoptions);
1167 warnoptions = PyList_New(0);
1168 if (warnoptions == NULL)
1169 return;
1170 }
Victor Stinner9ca9c252010-05-19 16:53:30 +00001171 PyList_Append(warnoptions, unicode);
1172}
1173
1174void
1175PySys_AddWarnOption(const wchar_t *s)
1176{
1177 PyObject *unicode;
1178 unicode = PyUnicode_FromWideChar(s, -1);
1179 if (unicode == NULL)
1180 return;
1181 PySys_AddWarnOptionUnicode(unicode);
1182 Py_DECREF(unicode);
Guido van Rossum23fff912000-12-15 22:02:05 +00001183}
1184
Christian Heimes33fe8092008-04-13 13:53:33 +00001185int
1186PySys_HasWarnOptions(void)
1187{
1188 return (warnoptions != NULL && (PyList_Size(warnoptions) > 0)) ? 1 : 0;
1189}
1190
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001191static PyObject *xoptions = NULL;
1192
1193static PyObject *
1194get_xoptions(void)
1195{
1196 if (xoptions == NULL || !PyDict_Check(xoptions)) {
1197 Py_XDECREF(xoptions);
1198 xoptions = PyDict_New();
1199 }
1200 return xoptions;
1201}
1202
1203void
1204PySys_AddXOption(const wchar_t *s)
1205{
1206 PyObject *opts;
1207 PyObject *name = NULL, *value = NULL;
1208 const wchar_t *name_end;
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001209
1210 opts = get_xoptions();
1211 if (opts == NULL)
1212 goto error;
1213
1214 name_end = wcschr(s, L'=');
1215 if (!name_end) {
1216 name = PyUnicode_FromWideChar(s, -1);
1217 value = Py_True;
1218 Py_INCREF(value);
1219 }
1220 else {
1221 name = PyUnicode_FromWideChar(s, name_end - s);
1222 value = PyUnicode_FromWideChar(name_end + 1, -1);
1223 }
1224 if (name == NULL || value == NULL)
1225 goto error;
Brett Cannonb94767f2011-02-22 20:15:44 +00001226 PyDict_SetItem(opts, name, value);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001227 Py_DECREF(name);
1228 Py_DECREF(value);
1229 return;
1230
1231error:
1232 Py_XDECREF(name);
1233 Py_XDECREF(value);
1234 /* No return value, therefore clear error state if possible */
1235 if (_Py_atomic_load_relaxed(&_PyThreadState_Current))
1236 PyErr_Clear();
1237}
1238
1239PyObject *
1240PySys_GetXOptions(void)
1241{
1242 return get_xoptions();
1243}
1244
Guido van Rossum40552d01998-08-06 03:34:39 +00001245/* XXX This doc string is too long to be a single string literal in VC++ 5.0.
1246 Two literals concatenated works just fine. If you have a K&R compiler
1247 or other abomination that however *does* understand longer strings,
1248 get rid of the !!! comment in the middle and the quotes that surround it. */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001249PyDoc_VAR(sys_doc) =
1250PyDoc_STR(
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001251"This module provides access to some objects used or maintained by the\n\
1252interpreter and to functions that interact strongly with the interpreter.\n\
1253\n\
1254Dynamic objects:\n\
1255\n\
1256argv -- command line arguments; argv[0] is the script pathname if known\n\
1257path -- module search path; path[0] is the script directory, else ''\n\
1258modules -- dictionary of loaded modules\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001259\n\
1260displayhook -- called to show results in an interactive session\n\
1261excepthook -- called to handle any uncaught exception other than SystemExit\n\
1262 To customize printing in an interactive session or to install a custom\n\
1263 top-level exception handler, assign other functions to replace these.\n\
1264\n\
Benjamin Peterson06157a42008-07-15 00:28:36 +00001265stdin -- standard input file object; used by input()\n\
Georg Brandl88fc6642007-02-09 21:28:07 +00001266stdout -- standard output file object; used by print()\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001267stderr -- standard error object; used for error messages\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001268 By assigning other file objects (or objects that behave like files)\n\
1269 to these, it is possible to redirect all of the interpreter's I/O.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001270\n\
1271last_type -- type of last uncaught exception\n\
1272last_value -- value of last uncaught exception\n\
1273last_traceback -- traceback of last uncaught exception\n\
1274 These three are only available in an interactive session after a\n\
1275 traceback has been printed.\n\
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001276"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001277)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001278/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001279PyDoc_STR(
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001280"\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001281Static objects:\n\
1282\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001283builtin_module_names -- tuple of module names built into this interpreter\n\
1284copyright -- copyright notice pertaining to this interpreter\n\
1285exec_prefix -- prefix used to find the machine-specific Python library\n\
Petri Lehtinen4b0eab62012-02-02 21:23:15 +02001286executable -- absolute path of the executable binary of the Python interpreter\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001287float_info -- a struct sequence with information about the float implementation.\n\
1288float_repr_style -- string indicating the style of repr() output for floats\n\
1289hexversion -- version information encoded as a single integer\n\
Barry Warsaw409da152012-06-03 16:18:47 -04001290implementation -- Python implementation information.\n\
Mark Dickinsonbd792642009-03-18 20:06:12 +00001291int_info -- a struct sequence with information about the int implementation.\n\
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001292maxsize -- the largest supported length of containers.\n\
Ezio Melotti48a2f8f2011-09-29 00:18:19 +03001293maxunicode -- the value of the largest Unicode codepoint\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001294platform -- platform identifier\n\
1295prefix -- prefix used to find the Python library\n\
1296thread_info -- a struct sequence with information about the thread implementation.\n\
Fred Drake801c08d2000-04-13 15:29:10 +00001297version -- the version of this interpreter as a string\n\
Eric Smith0e5b5622009-02-06 01:32:42 +00001298version_info -- version information as a named tuple\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001299"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001300)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001301#ifdef MS_WINDOWS
1302/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001303PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001304"dllhandle -- [Windows only] integer handle of the Python DLL\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001305winver -- [Windows only] version number of the Python DLL\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001306"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001307)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001308#endif /* MS_WINDOWS */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001309PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001310"__stdin__ -- the original stdin; don't touch!\n\
1311__stdout__ -- the original stdout; don't touch!\n\
1312__stderr__ -- the original stderr; don't touch!\n\
1313__displayhook__ -- the original displayhook; don't touch!\n\
1314__excepthook__ -- the original excepthook; don't touch!\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001315\n\
1316Functions:\n\
1317\n\
Georg Brandl1a3284e2007-12-02 09:40:06 +00001318displayhook() -- print an object to the screen, and save it in builtins._\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001319excepthook() -- print an exception and its traceback to sys.stderr\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001320exc_info() -- return thread-safe information about the current exception\n\
1321exit() -- exit the interpreter by raising SystemExit\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001322getdlopenflags() -- returns flags to be used for dlopen() calls\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001323getprofile() -- get the global profiling function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001324getrefcount() -- return the reference count for an object (plus one :-)\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001325getrecursionlimit() -- return the max recursion depth for the interpreter\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001326getsizeof() -- return the size of an object in bytes\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001327gettrace() -- get the global debug tracing function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001328setcheckinterval() -- control how often the interpreter checks for events\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001329setdlopenflags() -- set the flags to be used for dlopen() calls\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001330setprofile() -- set the global profiling function\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001331setrecursionlimit() -- set the max recursion depth for the interpreter\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001332settrace() -- set the global debug tracing function\n\
Fred Drakeccede592000-08-14 20:59:57 +00001333"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001334)
Fred Drakeccede592000-08-14 20:59:57 +00001335/* end of sys_doc */ ;
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001336
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001337
1338PyDoc_STRVAR(flags__doc__,
1339"sys.flags\n\
1340\n\
1341Flags provided through command line arguments or environment vars.");
1342
1343static PyTypeObject FlagsType;
1344
1345static PyStructSequence_Field flags_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001346 {"debug", "-d"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 {"inspect", "-i"},
1348 {"interactive", "-i"},
1349 {"optimize", "-O or -OO"},
1350 {"dont_write_bytecode", "-B"},
1351 {"no_user_site", "-s"},
1352 {"no_site", "-S"},
1353 {"ignore_environment", "-E"},
1354 {"verbose", "-v"},
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001355#ifdef RISCOS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001356 {"riscos_wimp", "???"},
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001357#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001358 /* {"unbuffered", "-u"}, */
1359 /* {"skip_first", "-x"}, */
Georg Brandl8aa7e992010-12-28 18:30:18 +00001360 {"bytes_warning", "-b"},
1361 {"quiet", "-q"},
Georg Brandl09a7c722012-02-20 21:31:46 +01001362 {"hash_randomization", "-R"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001363 {0}
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001364};
1365
1366static PyStructSequence_Desc flags_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001367 "sys.flags", /* name */
1368 flags__doc__, /* doc */
1369 flags_fields, /* fields */
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001370#ifdef RISCOS
Georg Brandl09a7c722012-02-20 21:31:46 +01001371 13
Éric Araujobe3bd572011-03-26 01:55:15 +01001372#else
Georg Brandl2fb477c2012-02-21 00:33:36 +01001373 12
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001374#endif
1375};
1376
1377static PyObject*
1378make_flags(void)
1379{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001380 int pos = 0;
1381 PyObject *seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001382
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001383 seq = PyStructSequence_New(&FlagsType);
1384 if (seq == NULL)
1385 return NULL;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001386
1387#define SetFlag(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001388 PyStructSequence_SET_ITEM(seq, pos++, PyLong_FromLong(flag))
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001390 SetFlag(Py_DebugFlag);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 SetFlag(Py_InspectFlag);
1392 SetFlag(Py_InteractiveFlag);
1393 SetFlag(Py_OptimizeFlag);
1394 SetFlag(Py_DontWriteBytecodeFlag);
1395 SetFlag(Py_NoUserSiteDirectory);
1396 SetFlag(Py_NoSiteFlag);
1397 SetFlag(Py_IgnoreEnvironmentFlag);
1398 SetFlag(Py_VerboseFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001399#ifdef RISCOS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001400 SetFlag(Py_RISCOSWimpFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001401#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 /* SetFlag(saw_unbuffered_flag); */
1403 /* SetFlag(skipfirstline); */
Christian Heimes33fe8092008-04-13 13:53:33 +00001404 SetFlag(Py_BytesWarningFlag);
Georg Brandl8aa7e992010-12-28 18:30:18 +00001405 SetFlag(Py_QuietFlag);
Georg Brandl2daf6ae2012-02-20 19:54:16 +01001406 SetFlag(Py_HashRandomizationFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001407#undef SetFlag
1408
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001409 if (PyErr_Occurred()) {
Serhiy Storchaka87a854d2013-12-17 14:59:42 +02001410 Py_DECREF(seq);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001411 return NULL;
1412 }
1413 return seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001414}
1415
Eric Smith0e5b5622009-02-06 01:32:42 +00001416PyDoc_STRVAR(version_info__doc__,
1417"sys.version_info\n\
1418\n\
1419Version information as a named tuple.");
1420
1421static PyTypeObject VersionInfoType;
1422
1423static PyStructSequence_Field version_info_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001424 {"major", "Major release number"},
1425 {"minor", "Minor release number"},
1426 {"micro", "Patch release number"},
1427 {"releaselevel", "'alpha', 'beta', 'candidate', or 'release'"},
1428 {"serial", "Serial release number"},
1429 {0}
Eric Smith0e5b5622009-02-06 01:32:42 +00001430};
1431
1432static PyStructSequence_Desc version_info_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001433 "sys.version_info", /* name */
1434 version_info__doc__, /* doc */
1435 version_info_fields, /* fields */
1436 5
Eric Smith0e5b5622009-02-06 01:32:42 +00001437};
1438
1439static PyObject *
1440make_version_info(void)
1441{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001442 PyObject *version_info;
1443 char *s;
1444 int pos = 0;
Eric Smith0e5b5622009-02-06 01:32:42 +00001445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001446 version_info = PyStructSequence_New(&VersionInfoType);
1447 if (version_info == NULL) {
1448 return NULL;
1449 }
Eric Smith0e5b5622009-02-06 01:32:42 +00001450
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001451 /*
1452 * These release level checks are mutually exclusive and cover
1453 * the field, so don't get too fancy with the pre-processor!
1454 */
Eric Smith0e5b5622009-02-06 01:32:42 +00001455#if PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_ALPHA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 s = "alpha";
Eric Smith0e5b5622009-02-06 01:32:42 +00001457#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_BETA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001458 s = "beta";
Eric Smith0e5b5622009-02-06 01:32:42 +00001459#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_GAMMA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001460 s = "candidate";
Eric Smith0e5b5622009-02-06 01:32:42 +00001461#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_FINAL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001462 s = "final";
Eric Smith0e5b5622009-02-06 01:32:42 +00001463#endif
1464
1465#define SetIntItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001466 PyStructSequence_SET_ITEM(version_info, pos++, PyLong_FromLong(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001467#define SetStrItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001468 PyStructSequence_SET_ITEM(version_info, pos++, PyUnicode_FromString(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001469
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001470 SetIntItem(PY_MAJOR_VERSION);
1471 SetIntItem(PY_MINOR_VERSION);
1472 SetIntItem(PY_MICRO_VERSION);
1473 SetStrItem(s);
1474 SetIntItem(PY_RELEASE_SERIAL);
Eric Smith0e5b5622009-02-06 01:32:42 +00001475#undef SetIntItem
1476#undef SetStrItem
1477
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001478 if (PyErr_Occurred()) {
1479 Py_CLEAR(version_info);
1480 return NULL;
1481 }
1482 return version_info;
Eric Smith0e5b5622009-02-06 01:32:42 +00001483}
1484
Brett Cannon3adc7b72012-07-09 14:22:12 -04001485/* sys.implementation values */
1486#define NAME "cpython"
1487const char *_PySys_ImplName = NAME;
1488#define QUOTE(arg) #arg
1489#define STRIFY(name) QUOTE(name)
1490#define MAJOR STRIFY(PY_MAJOR_VERSION)
1491#define MINOR STRIFY(PY_MINOR_VERSION)
1492#define TAG NAME "-" MAJOR MINOR;
1493const char *_PySys_ImplCacheTag = TAG;
1494#undef NAME
1495#undef QUOTE
1496#undef STRIFY
1497#undef MAJOR
1498#undef MINOR
1499#undef TAG
1500
Barry Warsaw409da152012-06-03 16:18:47 -04001501static PyObject *
1502make_impl_info(PyObject *version_info)
1503{
1504 int res;
1505 PyObject *impl_info, *value, *ns;
1506
1507 impl_info = PyDict_New();
1508 if (impl_info == NULL)
1509 return NULL;
1510
1511 /* populate the dict */
1512
Brett Cannon3adc7b72012-07-09 14:22:12 -04001513 value = PyUnicode_FromString(_PySys_ImplName);
Barry Warsaw409da152012-06-03 16:18:47 -04001514 if (value == NULL)
1515 goto error;
1516 res = PyDict_SetItemString(impl_info, "name", value);
1517 Py_DECREF(value);
1518 if (res < 0)
1519 goto error;
1520
Brett Cannon3adc7b72012-07-09 14:22:12 -04001521 value = PyUnicode_FromString(_PySys_ImplCacheTag);
Barry Warsaw409da152012-06-03 16:18:47 -04001522 if (value == NULL)
1523 goto error;
1524 res = PyDict_SetItemString(impl_info, "cache_tag", value);
1525 Py_DECREF(value);
1526 if (res < 0)
1527 goto error;
Barry Warsaw409da152012-06-03 16:18:47 -04001528
1529 res = PyDict_SetItemString(impl_info, "version", version_info);
1530 if (res < 0)
1531 goto error;
1532
1533 value = PyLong_FromLong(PY_VERSION_HEX);
1534 if (value == NULL)
1535 goto error;
1536 res = PyDict_SetItemString(impl_info, "hexversion", value);
1537 Py_DECREF(value);
1538 if (res < 0)
1539 goto error;
1540
1541 /* dict ready */
1542
1543 ns = _PyNamespace_New(impl_info);
1544 Py_DECREF(impl_info);
1545 return ns;
1546
1547error:
1548 Py_CLEAR(impl_info);
1549 return NULL;
1550}
1551
Martin v. Löwis1a214512008-06-11 05:26:20 +00001552static struct PyModuleDef sysmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001553 PyModuleDef_HEAD_INIT,
1554 "sys",
1555 sys_doc,
1556 -1, /* multiple "initialization" just copies the module dict. */
1557 sys_methods,
1558 NULL,
1559 NULL,
1560 NULL,
1561 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00001562};
1563
Guido van Rossum25ce5661997-08-02 03:10:38 +00001564PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001565_PySys_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001566{
Barry Warsaw409da152012-06-03 16:18:47 -04001567 PyObject *m, *v, *sysdict, *version_info;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001568 char *s;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001569
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001570 m = PyModule_Create(&sysmodule);
1571 if (m == NULL)
1572 return NULL;
1573 sysdict = PyModule_GetDict(m);
1574#define SET_SYS_FROM_STRING(key, value) \
1575 v = value; \
1576 if (v != NULL) \
1577 PyDict_SetItemString(sysdict, key, v); \
1578 Py_XDECREF(v)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001579
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001580 /* Check that stdin is not a directory
1581 Using shell redirection, you can redirect stdin to a directory,
1582 crashing the Python interpreter. Catch this common mistake here
1583 and output a useful error message. Note that under MS Windows,
1584 the shell already prevents that. */
Martin v. Löwisec59d042009-01-12 07:59:10 +00001585#if !defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001586 {
1587 struct stat sb;
1588 if (fstat(fileno(stdin), &sb) == 0 &&
1589 S_ISDIR(sb.st_mode)) {
1590 /* There's nothing more we can do. */
1591 /* Py_FatalError() will core dump, so just exit. */
1592 PySys_WriteStderr("Python error: <stdin> is a directory, cannot continue\n");
1593 exit(EXIT_FAILURE);
1594 }
1595 }
Martin v. Löwisec59d042009-01-12 07:59:10 +00001596#endif
Neal Norwitz11bd1192005-10-03 00:54:56 +00001597
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001598 /* stdin/stdout/stderr are now set by pythonrun.c */
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001599
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001600 PyDict_SetItemString(sysdict, "__displayhook__",
1601 PyDict_GetItemString(sysdict, "displayhook"));
1602 PyDict_SetItemString(sysdict, "__excepthook__",
1603 PyDict_GetItemString(sysdict, "excepthook"));
1604 SET_SYS_FROM_STRING("version",
1605 PyUnicode_FromString(Py_GetVersion()));
1606 SET_SYS_FROM_STRING("hexversion",
1607 PyLong_FromLong(PY_VERSION_HEX));
Georg Brandl1ca2e792011-03-05 20:51:24 +01001608 SET_SYS_FROM_STRING("_mercurial",
1609 Py_BuildValue("(szz)", "CPython", _Py_hgidentifier(),
1610 _Py_hgversion()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001611 SET_SYS_FROM_STRING("dont_write_bytecode",
1612 PyBool_FromLong(Py_DontWriteBytecodeFlag));
1613 SET_SYS_FROM_STRING("api_version",
1614 PyLong_FromLong(PYTHON_API_VERSION));
1615 SET_SYS_FROM_STRING("copyright",
1616 PyUnicode_FromString(Py_GetCopyright()));
1617 SET_SYS_FROM_STRING("platform",
1618 PyUnicode_FromString(Py_GetPlatform()));
1619 SET_SYS_FROM_STRING("executable",
1620 PyUnicode_FromWideChar(
1621 Py_GetProgramFullPath(), -1));
1622 SET_SYS_FROM_STRING("prefix",
1623 PyUnicode_FromWideChar(Py_GetPrefix(), -1));
1624 SET_SYS_FROM_STRING("exec_prefix",
1625 PyUnicode_FromWideChar(Py_GetExecPrefix(), -1));
Vinay Sajip7ded1f02012-05-26 03:45:29 +01001626 SET_SYS_FROM_STRING("base_prefix",
1627 PyUnicode_FromWideChar(Py_GetPrefix(), -1));
1628 SET_SYS_FROM_STRING("base_exec_prefix",
1629 PyUnicode_FromWideChar(Py_GetExecPrefix(), -1));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001630 SET_SYS_FROM_STRING("maxsize",
1631 PyLong_FromSsize_t(PY_SSIZE_T_MAX));
1632 SET_SYS_FROM_STRING("float_info",
1633 PyFloat_GetInfo());
1634 SET_SYS_FROM_STRING("int_info",
1635 PyLong_GetInfo());
Mark Dickinsondc787d22010-05-23 13:33:13 +00001636 /* initialize hash_info */
1637 if (Hash_InfoType.tp_name == 0)
1638 PyStructSequence_InitType(&Hash_InfoType, &hash_info_desc);
1639 SET_SYS_FROM_STRING("hash_info",
1640 get_hash_info());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001641 SET_SYS_FROM_STRING("maxunicode",
Ezio Melotti48a2f8f2011-09-29 00:18:19 +03001642 PyLong_FromLong(0x10FFFF));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 SET_SYS_FROM_STRING("builtin_module_names",
1644 list_builtin_module_names());
1645 {
1646 /* Assumes that longs are at least 2 bytes long.
1647 Should be safe! */
1648 unsigned long number = 1;
1649 char *value;
Fred Drake099325e2000-08-14 15:47:03 +00001650
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001651 s = (char *) &number;
1652 if (s[0] == 0)
1653 value = "big";
1654 else
1655 value = "little";
1656 SET_SYS_FROM_STRING("byteorder",
1657 PyUnicode_FromString(value));
1658 }
Guido van Rossum8b9ea871996-08-23 18:14:47 +00001659#ifdef MS_COREDLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001660 SET_SYS_FROM_STRING("dllhandle",
1661 PyLong_FromVoidPtr(PyWin_DLLhModule));
1662 SET_SYS_FROM_STRING("winver",
1663 PyUnicode_FromString(PyWin_DLLVersionString));
Guido van Rossumc606fe11996-04-09 02:37:57 +00001664#endif
Barry Warsaw8cf4eae2010-10-16 01:04:07 +00001665#ifdef ABIFLAGS
1666 SET_SYS_FROM_STRING("abiflags",
1667 PyUnicode_FromString(ABIFLAGS));
1668#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001669 if (warnoptions == NULL) {
1670 warnoptions = PyList_New(0);
1671 }
1672 else {
1673 Py_INCREF(warnoptions);
1674 }
1675 if (warnoptions != NULL) {
1676 PyDict_SetItemString(sysdict, "warnoptions", warnoptions);
1677 }
Tim Peters216b78b2006-01-06 02:40:53 +00001678
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001679 v = get_xoptions();
1680 if (v != NULL) {
1681 PyDict_SetItemString(sysdict, "_xoptions", v);
1682 }
1683
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001684 /* version_info */
1685 if (VersionInfoType.tp_name == 0)
1686 PyStructSequence_InitType(&VersionInfoType, &version_info_desc);
Barry Warsaw409da152012-06-03 16:18:47 -04001687 version_info = make_version_info();
1688 SET_SYS_FROM_STRING("version_info", version_info);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001689 /* prevent user from creating new instances */
1690 VersionInfoType.tp_init = NULL;
1691 VersionInfoType.tp_new = NULL;
Eric Smith0e5b5622009-02-06 01:32:42 +00001692
Barry Warsaw409da152012-06-03 16:18:47 -04001693 /* implementation */
1694 SET_SYS_FROM_STRING("implementation", make_impl_info(version_info));
1695
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001696 /* flags */
1697 if (FlagsType.tp_name == 0)
1698 PyStructSequence_InitType(&FlagsType, &flags_desc);
1699 SET_SYS_FROM_STRING("flags", make_flags());
1700 /* prevent user from creating new instances */
1701 FlagsType.tp_init = NULL;
1702 FlagsType.tp_new = NULL;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001703
Eric Smithf7bb5782010-01-27 00:44:57 +00001704
1705#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001706 /* getwindowsversion */
1707 if (WindowsVersionType.tp_name == 0)
1708 PyStructSequence_InitType(&WindowsVersionType, &windows_version_desc);
1709 /* prevent user from creating new instances */
1710 WindowsVersionType.tp_init = NULL;
1711 WindowsVersionType.tp_new = NULL;
Eric Smithf7bb5782010-01-27 00:44:57 +00001712#endif
1713
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001714 /* float repr style: 0.03 (short) vs 0.029999999999999999 (legacy) */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001715#ifndef PY_NO_SHORT_FLOAT_REPR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001716 SET_SYS_FROM_STRING("float_repr_style",
1717 PyUnicode_FromString("short"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001718#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001719 SET_SYS_FROM_STRING("float_repr_style",
1720 PyUnicode_FromString("legacy"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001721#endif
1722
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001723#ifdef WITH_THREAD
1724 SET_SYS_FROM_STRING("thread_info", PyThread_GetInfo());
1725#endif
1726
Christian Heimes7b3ce6a2008-01-31 14:31:45 +00001727#undef SET_SYS_FROM_STRING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001728 if (PyErr_Occurred())
1729 return NULL;
1730 return m;
Guido van Rossum5b3138b1990-11-18 17:41:40 +00001731}
1732
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001733static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00001734makepathobject(const wchar_t *path, wchar_t delim)
Guido van Rossum5b3138b1990-11-18 17:41:40 +00001735{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001736 int i, n;
1737 const wchar_t *p;
1738 PyObject *v, *w;
Tim Peters216b78b2006-01-06 02:40:53 +00001739
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001740 n = 1;
1741 p = path;
1742 while ((p = wcschr(p, delim)) != NULL) {
1743 n++;
1744 p++;
1745 }
1746 v = PyList_New(n);
1747 if (v == NULL)
1748 return NULL;
1749 for (i = 0; ; i++) {
1750 p = wcschr(path, delim);
1751 if (p == NULL)
1752 p = path + wcslen(path); /* End of string */
1753 w = PyUnicode_FromWideChar(path, (Py_ssize_t)(p - path));
1754 if (w == NULL) {
1755 Py_DECREF(v);
1756 return NULL;
1757 }
1758 PyList_SetItem(v, i, w);
1759 if (*p == '\0')
1760 break;
1761 path = p+1;
1762 }
1763 return v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001764}
1765
1766void
Martin v. Löwis790465f2008-04-05 20:41:37 +00001767PySys_SetPath(const wchar_t *path)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001768{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001769 PyObject *v;
1770 if ((v = makepathobject(path, DELIM)) == NULL)
1771 Py_FatalError("can't create sys.path");
1772 if (PySys_SetObject("path", v) != 0)
1773 Py_FatalError("can't assign sys.path");
1774 Py_DECREF(v);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001775}
1776
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001777static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00001778makeargvobject(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001779{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001780 PyObject *av;
1781 if (argc <= 0 || argv == NULL) {
1782 /* Ensure at least one (empty) argument is seen */
1783 static wchar_t *empty_argv[1] = {L""};
1784 argv = empty_argv;
1785 argc = 1;
1786 }
1787 av = PyList_New(argc);
1788 if (av != NULL) {
1789 int i;
1790 for (i = 0; i < argc; i++) {
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +00001791#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001792 PyObject *v;
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +00001793
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001794 /* argv[0] is the script pathname if known */
1795 if (i == 0) {
1796 char* fn = decc$translate_vms(argv[0]);
1797 if ((fn == (char *)0) || fn == (char *)-1)
1798 v = PyUnicode_FromString(argv[0]);
1799 else
1800 v = PyUnicode_FromString(
1801 decc$translate_vms(argv[0]));
1802 } else
1803 v = PyUnicode_FromString(argv[i]);
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +00001804#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001805 PyObject *v = PyUnicode_FromWideChar(argv[i], -1);
Martin v. Löwisc16f3bd2003-05-03 09:14:54 +00001806#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001807 if (v == NULL) {
1808 Py_DECREF(av);
1809 av = NULL;
1810 break;
1811 }
1812 PyList_SetItem(av, i, v);
1813 }
1814 }
1815 return av;
Guido van Rossum3f5da241990-12-20 15:06:42 +00001816}
1817
Nick Coghland26c18a2010-08-17 13:06:11 +00001818#define _HAVE_SCRIPT_ARGUMENT(argc, argv) \
1819 (argc > 0 && argv0 != NULL && \
1820 wcscmp(argv0, L"-c") != 0 && wcscmp(argv0, L"-m") != 0)
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001821
1822static void
1823sys_update_path(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001824{
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001825 wchar_t *argv0;
1826 wchar_t *p = NULL;
1827 Py_ssize_t n = 0;
1828 PyObject *a;
1829 PyObject *path;
1830#ifdef HAVE_READLINK
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001831 wchar_t link[MAXPATHLEN+1];
1832 wchar_t argv0copy[2*MAXPATHLEN+1];
1833 int nr = 0;
1834#endif
Guido van Rossum162e38c2003-02-19 15:25:10 +00001835#if defined(HAVE_REALPATH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001836 wchar_t fullpath[MAXPATHLEN];
Martin v. Löwisec59d042009-01-12 07:59:10 +00001837#elif defined(MS_WINDOWS) && !defined(MS_WINCE)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001838 wchar_t fullpath[MAX_PATH];
Thomas Heller27bb71e2003-01-08 14:33:48 +00001839#endif
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001840
1841 path = PySys_GetObject("path");
1842 if (path == NULL)
1843 return;
1844
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001845 argv0 = argv[0];
1846
1847#ifdef HAVE_READLINK
1848 if (_HAVE_SCRIPT_ARGUMENT(argc, argv))
1849 nr = _Py_wreadlink(argv0, link, MAXPATHLEN);
1850 if (nr > 0) {
1851 /* It's a symlink */
1852 link[nr] = '\0';
1853 if (link[0] == SEP)
1854 argv0 = link; /* Link to absolute path */
1855 else if (wcschr(link, SEP) == NULL)
1856 ; /* Link without path */
1857 else {
1858 /* Must join(dirname(argv0), link) */
1859 wchar_t *q = wcsrchr(argv0, SEP);
1860 if (q == NULL)
1861 argv0 = link; /* argv0 without path */
1862 else {
Christian Heimes60a60672013-07-22 12:53:32 +02001863 /* Must make a copy, argv0copy has room for 2 * MAXPATHLEN */
1864 wcsncpy(argv0copy, argv0, MAXPATHLEN);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001865 q = wcsrchr(argv0copy, SEP);
Christian Heimes60a60672013-07-22 12:53:32 +02001866 wcsncpy(q+1, link, MAXPATHLEN);
1867 q[MAXPATHLEN + 1] = L'\0';
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001868 argv0 = argv0copy;
1869 }
1870 }
1871 }
1872#endif /* HAVE_READLINK */
1873#if SEP == '\\' /* Special case for MS filename syntax */
1874 if (_HAVE_SCRIPT_ARGUMENT(argc, argv)) {
1875 wchar_t *q;
1876#if defined(MS_WINDOWS) && !defined(MS_WINCE)
1877 /* This code here replaces the first element in argv with the full
1878 path that it represents. Under CE, there are no relative paths so
1879 the argument must be the full path anyway. */
1880 wchar_t *ptemp;
1881 if (GetFullPathNameW(argv0,
Victor Stinner63941882011-09-29 00:42:28 +02001882 Py_ARRAY_LENGTH(fullpath),
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001883 fullpath,
1884 &ptemp)) {
1885 argv0 = fullpath;
1886 }
1887#endif
1888 p = wcsrchr(argv0, SEP);
1889 /* Test for alternate separator */
1890 q = wcsrchr(p ? p : argv0, '/');
1891 if (q != NULL)
1892 p = q;
1893 if (p != NULL) {
1894 n = p + 1 - argv0;
1895 if (n > 1 && p[-1] != ':')
1896 n--; /* Drop trailing separator */
1897 }
1898 }
1899#else /* All other filename syntaxes */
1900 if (_HAVE_SCRIPT_ARGUMENT(argc, argv)) {
1901#if defined(HAVE_REALPATH)
Victor Stinner23847142013-11-15 17:33:43 +01001902 if (_Py_wrealpath(argv0, fullpath, Py_ARRAY_LENGTH(fullpath))) {
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001903 argv0 = fullpath;
1904 }
1905#endif
1906 p = wcsrchr(argv0, SEP);
1907 }
1908 if (p != NULL) {
1909 n = p + 1 - argv0;
1910#if SEP == '/' /* Special case for Unix filename syntax */
1911 if (n > 1)
1912 n--; /* Drop trailing separator */
1913#endif /* Unix */
1914 }
1915#endif /* All others */
1916 a = PyUnicode_FromWideChar(argv0, n);
1917 if (a == NULL)
1918 Py_FatalError("no mem for sys.path insertion");
1919 if (PyList_Insert(path, 0, a) < 0)
1920 Py_FatalError("sys.path.insert(0) failed");
1921 Py_DECREF(a);
1922}
1923
1924void
1925PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)
1926{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001927 PyObject *av = makeargvobject(argc, argv);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001928 if (av == NULL)
1929 Py_FatalError("no mem for sys.argv");
1930 if (PySys_SetObject("argv", av) != 0)
1931 Py_FatalError("can't assign sys.argv");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001932 Py_DECREF(av);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001933 if (updatepath)
1934 sys_update_path(argc, argv);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001935}
Guido van Rossuma890e681998-05-12 14:59:24 +00001936
Antoine Pitrouf978fac2010-05-21 17:25:34 +00001937void
1938PySys_SetArgv(int argc, wchar_t **argv)
1939{
1940 PySys_SetArgvEx(argc, argv, 1);
1941}
1942
Victor Stinner14284c22010-04-23 12:02:30 +00001943/* Reimplementation of PyFile_WriteString() no calling indirectly
1944 PyErr_CheckSignals(): avoid the call to PyObject_Str(). */
1945
1946static int
Victor Stinner79766632010-08-16 17:36:42 +00001947sys_pyfile_write_unicode(PyObject *unicode, PyObject *file)
Victor Stinner14284c22010-04-23 12:02:30 +00001948{
Victor Stinner79766632010-08-16 17:36:42 +00001949 PyObject *writer = NULL, *args = NULL, *result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001950 int err;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001951 _Py_IDENTIFIER(write);
Victor Stinner14284c22010-04-23 12:02:30 +00001952
Victor Stinnerecccc4f2010-06-08 20:46:00 +00001953 if (file == NULL)
1954 return -1;
1955
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02001956 writer = _PyObject_GetAttrId(file, &PyId_write);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001957 if (writer == NULL)
1958 goto error;
Victor Stinner14284c22010-04-23 12:02:30 +00001959
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001960 args = PyTuple_Pack(1, unicode);
1961 if (args == NULL)
1962 goto error;
Victor Stinner14284c22010-04-23 12:02:30 +00001963
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001964 result = PyEval_CallObject(writer, args);
1965 if (result == NULL) {
1966 goto error;
1967 } else {
1968 err = 0;
1969 goto finally;
1970 }
Victor Stinner14284c22010-04-23 12:02:30 +00001971
1972error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001973 err = -1;
Victor Stinner14284c22010-04-23 12:02:30 +00001974finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001975 Py_XDECREF(writer);
1976 Py_XDECREF(args);
1977 Py_XDECREF(result);
1978 return err;
Victor Stinner14284c22010-04-23 12:02:30 +00001979}
1980
Victor Stinner79766632010-08-16 17:36:42 +00001981static int
1982sys_pyfile_write(const char *text, PyObject *file)
1983{
1984 PyObject *unicode = NULL;
1985 int err;
1986
1987 if (file == NULL)
1988 return -1;
1989
1990 unicode = PyUnicode_FromString(text);
1991 if (unicode == NULL)
1992 return -1;
1993
1994 err = sys_pyfile_write_unicode(unicode, file);
1995 Py_DECREF(unicode);
1996 return err;
1997}
Guido van Rossuma890e681998-05-12 14:59:24 +00001998
1999/* APIs to write to sys.stdout or sys.stderr using a printf-like interface.
2000 Adapted from code submitted by Just van Rossum.
2001
2002 PySys_WriteStdout(format, ...)
2003 PySys_WriteStderr(format, ...)
2004
2005 The first function writes to sys.stdout; the second to sys.stderr. When
2006 there is a problem, they write to the real (C level) stdout or stderr;
Guido van Rossum8442af31998-10-12 18:22:10 +00002007 no exceptions are raised.
Guido van Rossuma890e681998-05-12 14:59:24 +00002008
Victor Stinner14284c22010-04-23 12:02:30 +00002009 PyErr_CheckSignals() is not called to avoid the execution of the Python
Victor Stinner79766632010-08-16 17:36:42 +00002010 signal handlers: they may raise a new exception whereas sys_write()
2011 ignores all exceptions.
Victor Stinner14284c22010-04-23 12:02:30 +00002012
Guido van Rossuma890e681998-05-12 14:59:24 +00002013 Both take a printf-style format string as their first argument followed
2014 by a variable length argument list determined by the format string.
2015
2016 *** WARNING ***
2017
2018 The format should limit the total size of the formatted output string to
2019 1000 bytes. In particular, this means that no unrestricted "%s" formats
2020 should occur; these should be limited using "%.<N>s where <N> is a
2021 decimal number calculated so that <N> plus the maximum size of other
2022 formatted text does not exceed 1000 bytes. Also watch out for "%f",
2023 which can print hundreds of digits for very large numbers.
2024
2025 */
2026
2027static void
Victor Stinner79766632010-08-16 17:36:42 +00002028sys_write(char *name, FILE *fp, const char *format, va_list va)
Guido van Rossuma890e681998-05-12 14:59:24 +00002029{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002030 PyObject *file;
2031 PyObject *error_type, *error_value, *error_traceback;
2032 char buffer[1001];
2033 int written;
Guido van Rossuma890e681998-05-12 14:59:24 +00002034
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002035 PyErr_Fetch(&error_type, &error_value, &error_traceback);
2036 file = PySys_GetObject(name);
2037 written = PyOS_vsnprintf(buffer, sizeof(buffer), format, va);
2038 if (sys_pyfile_write(buffer, file) != 0) {
2039 PyErr_Clear();
2040 fputs(buffer, fp);
2041 }
2042 if (written < 0 || (size_t)written >= sizeof(buffer)) {
2043 const char *truncated = "... truncated";
Victor Stinner79766632010-08-16 17:36:42 +00002044 if (sys_pyfile_write(truncated, file) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002045 fputs(truncated, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002046 }
2047 PyErr_Restore(error_type, error_value, error_traceback);
Guido van Rossuma890e681998-05-12 14:59:24 +00002048}
2049
2050void
Guido van Rossuma890e681998-05-12 14:59:24 +00002051PySys_WriteStdout(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00002052{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002053 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00002054
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002055 va_start(va, format);
Victor Stinner79766632010-08-16 17:36:42 +00002056 sys_write("stdout", stdout, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002057 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00002058}
2059
2060void
Guido van Rossuma890e681998-05-12 14:59:24 +00002061PySys_WriteStderr(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00002062{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002063 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00002064
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002065 va_start(va, format);
Victor Stinner79766632010-08-16 17:36:42 +00002066 sys_write("stderr", stderr, format, va);
2067 va_end(va);
2068}
2069
2070static void
2071sys_format(char *name, FILE *fp, const char *format, va_list va)
2072{
2073 PyObject *file, *message;
2074 PyObject *error_type, *error_value, *error_traceback;
2075 char *utf8;
2076
2077 PyErr_Fetch(&error_type, &error_value, &error_traceback);
2078 file = PySys_GetObject(name);
2079 message = PyUnicode_FromFormatV(format, va);
2080 if (message != NULL) {
2081 if (sys_pyfile_write_unicode(message, file) != 0) {
2082 PyErr_Clear();
2083 utf8 = _PyUnicode_AsString(message);
2084 if (utf8 != NULL)
2085 fputs(utf8, fp);
2086 }
2087 Py_DECREF(message);
2088 }
2089 PyErr_Restore(error_type, error_value, error_traceback);
2090}
2091
2092void
2093PySys_FormatStdout(const char *format, ...)
2094{
2095 va_list va;
2096
2097 va_start(va, format);
2098 sys_format("stdout", stdout, format, va);
2099 va_end(va);
2100}
2101
2102void
2103PySys_FormatStderr(const char *format, ...)
2104{
2105 va_list va;
2106
2107 va_start(va, format);
2108 sys_format("stderr", stderr, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002109 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00002110}