blob: aa4046ff93b9d8b218f2d4b1ca75a275df2b1b8b [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öwis5467d4c2003-05-10 07:10:12 +000035#ifdef HAVE_LANGINFO_H
36#include <locale.h>
37#include <langinfo.h>
38#endif
39
Victor Stinnerbd303c12013-11-07 23:07:29 +010040_Py_IDENTIFIER(_);
41_Py_IDENTIFIER(__sizeof__);
42_Py_IDENTIFIER(buffer);
43_Py_IDENTIFIER(builtins);
44_Py_IDENTIFIER(encoding);
45_Py_IDENTIFIER(path);
46_Py_IDENTIFIER(stdout);
47_Py_IDENTIFIER(stderr);
48_Py_IDENTIFIER(write);
49
Guido van Rossum65bf9f21997-04-29 18:33:38 +000050PyObject *
Victor Stinnerd67bd452013-11-06 22:36:40 +010051_PySys_GetObjectId(_Py_Identifier *key)
52{
53 PyThreadState *tstate = PyThreadState_GET();
54 PyObject *sd = tstate->interp->sysdict;
55 if (sd == NULL)
56 return NULL;
57 return _PyDict_GetItemId(sd, key);
58}
59
60PyObject *
Neal Norwitzf3081322007-08-25 00:32:45 +000061PySys_GetObject(const char *name)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000062{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000063 PyThreadState *tstate = PyThreadState_GET();
64 PyObject *sd = tstate->interp->sysdict;
65 if (sd == NULL)
66 return NULL;
67 return PyDict_GetItemString(sd, name);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000068}
69
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000070int
Victor Stinnerd67bd452013-11-06 22:36:40 +010071_PySys_SetObjectId(_Py_Identifier *key, PyObject *v)
72{
73 PyThreadState *tstate = PyThreadState_GET();
74 PyObject *sd = tstate->interp->sysdict;
75 if (v == NULL) {
76 if (_PyDict_GetItemId(sd, key) == NULL)
77 return 0;
78 else
79 return _PyDict_DelItemId(sd, key);
80 }
81 else
82 return _PyDict_SetItemId(sd, key, v);
83}
84
85int
Neal Norwitzf3081322007-08-25 00:32:45 +000086PySys_SetObject(const char *name, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000087{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000088 PyThreadState *tstate = PyThreadState_GET();
89 PyObject *sd = tstate->interp->sysdict;
90 if (v == NULL) {
91 if (PyDict_GetItemString(sd, name) == NULL)
92 return 0;
93 else
94 return PyDict_DelItemString(sd, name);
95 }
96 else
97 return PyDict_SetItemString(sd, name, v);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000098}
99
Victor Stinner13d49ee2010-12-04 17:24:33 +0000100/* Write repr(o) to sys.stdout using sys.stdout.encoding and 'backslashreplace'
101 error handler. If sys.stdout has a buffer attribute, use
102 sys.stdout.buffer.write(encoded), otherwise redecode the string and use
103 sys.stdout.write(redecoded).
104
105 Helper function for sys_displayhook(). */
106static int
107sys_displayhook_unencodable(PyObject *outf, PyObject *o)
108{
109 PyObject *stdout_encoding = NULL;
110 PyObject *encoded, *escaped_str, *repr_str, *buffer, *result;
111 char *stdout_encoding_str;
112 int ret;
113
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200114 stdout_encoding = _PyObject_GetAttrId(outf, &PyId_encoding);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000115 if (stdout_encoding == NULL)
116 goto error;
117 stdout_encoding_str = _PyUnicode_AsString(stdout_encoding);
118 if (stdout_encoding_str == NULL)
119 goto error;
120
121 repr_str = PyObject_Repr(o);
122 if (repr_str == NULL)
123 goto error;
124 encoded = PyUnicode_AsEncodedString(repr_str,
125 stdout_encoding_str,
126 "backslashreplace");
127 Py_DECREF(repr_str);
128 if (encoded == NULL)
129 goto error;
130
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200131 buffer = _PyObject_GetAttrId(outf, &PyId_buffer);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000132 if (buffer) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200133 result = _PyObject_CallMethodId(buffer, &PyId_write, "(O)", encoded);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000134 Py_DECREF(buffer);
135 Py_DECREF(encoded);
136 if (result == NULL)
137 goto error;
138 Py_DECREF(result);
139 }
140 else {
141 PyErr_Clear();
142 escaped_str = PyUnicode_FromEncodedObject(encoded,
143 stdout_encoding_str,
144 "strict");
145 Py_DECREF(encoded);
146 if (PyFile_WriteObject(escaped_str, outf, Py_PRINT_RAW) != 0) {
147 Py_DECREF(escaped_str);
148 goto error;
149 }
150 Py_DECREF(escaped_str);
151 }
152 ret = 0;
153 goto finally;
154
155error:
156 ret = -1;
157finally:
158 Py_XDECREF(stdout_encoding);
159 return ret;
160}
161
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000162static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000163sys_displayhook(PyObject *self, PyObject *o)
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000164{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000165 PyObject *outf;
166 PyInterpreterState *interp = PyThreadState_GET()->interp;
167 PyObject *modules = interp->modules;
Victor Stinnerd02fbb82013-11-06 18:27:13 +0100168 PyObject *builtins;
169 static PyObject *newline = NULL;
Victor Stinner13d49ee2010-12-04 17:24:33 +0000170 int err;
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000171
Victor Stinnerd02fbb82013-11-06 18:27:13 +0100172 builtins = _PyDict_GetItemId(modules, &PyId_builtins);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000173 if (builtins == NULL) {
174 PyErr_SetString(PyExc_RuntimeError, "lost builtins module");
175 return NULL;
176 }
Moshe Zadka03897ea2001-07-23 13:32:43 +0000177
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000178 /* Print value except if None */
179 /* After printing, also assign to '_' */
180 /* Before, set '_' to None to avoid recursion */
181 if (o == Py_None) {
182 Py_INCREF(Py_None);
183 return Py_None;
184 }
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200185 if (_PyObject_SetAttrId(builtins, &PyId__, Py_None) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 return NULL;
Victor Stinnerbd303c12013-11-07 23:07:29 +0100187 outf = _PySys_GetObjectId(&PyId_stdout);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000188 if (outf == NULL || outf == Py_None) {
189 PyErr_SetString(PyExc_RuntimeError, "lost sys.stdout");
190 return NULL;
191 }
Victor Stinner13d49ee2010-12-04 17:24:33 +0000192 if (PyFile_WriteObject(o, outf, 0) != 0) {
193 if (PyErr_ExceptionMatches(PyExc_UnicodeEncodeError)) {
194 /* repr(o) is not encodable to sys.stdout.encoding with
195 * sys.stdout.errors error handler (which is probably 'strict') */
196 PyErr_Clear();
197 err = sys_displayhook_unencodable(outf, o);
198 if (err)
199 return NULL;
200 }
201 else {
202 return NULL;
203 }
204 }
Victor Stinnerd02fbb82013-11-06 18:27:13 +0100205 if (newline == NULL) {
206 newline = PyUnicode_FromString("\n");
207 if (newline == NULL)
208 return NULL;
209 }
210 if (PyFile_WriteObject(newline, outf, Py_PRINT_RAW) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000211 return NULL;
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200212 if (_PyObject_SetAttrId(builtins, &PyId__, o) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000213 return NULL;
214 Py_INCREF(Py_None);
215 return Py_None;
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000216}
217
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000218PyDoc_STRVAR(displayhook_doc,
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000219"displayhook(object) -> None\n"
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000220"\n"
Florent Xicluna5749e852010-03-03 11:54:54 +0000221"Print an object to sys.stdout and also save it in builtins._\n"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000222);
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000223
224static PyObject *
225sys_excepthook(PyObject* self, PyObject* args)
226{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000227 PyObject *exc, *value, *tb;
228 if (!PyArg_UnpackTuple(args, "excepthook", 3, 3, &exc, &value, &tb))
229 return NULL;
230 PyErr_Display(exc, value, tb);
231 Py_INCREF(Py_None);
232 return Py_None;
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000233}
234
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000235PyDoc_STRVAR(excepthook_doc,
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000236"excepthook(exctype, value, traceback) -> None\n"
237"\n"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000238"Handle an exception by displaying it with a traceback on sys.stderr.\n"
239);
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000240
241static PyObject *
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000242sys_exc_info(PyObject *self, PyObject *noargs)
Guido van Rossuma027efa1997-05-05 20:56:21 +0000243{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000244 PyThreadState *tstate;
245 tstate = PyThreadState_GET();
246 return Py_BuildValue(
247 "(OOO)",
248 tstate->exc_type != NULL ? tstate->exc_type : Py_None,
249 tstate->exc_value != NULL ? tstate->exc_value : Py_None,
250 tstate->exc_traceback != NULL ?
251 tstate->exc_traceback : Py_None);
Guido van Rossuma027efa1997-05-05 20:56:21 +0000252}
253
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000254PyDoc_STRVAR(exc_info_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000255"exc_info() -> (type, value, traceback)\n\
256\n\
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000257Return information about the most recent exception caught by an except\n\
258clause in the current stack frame or in an older stack frame."
259);
260
261static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000262sys_exit(PyObject *self, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000263{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000264 PyObject *exit_code = 0;
265 if (!PyArg_UnpackTuple(args, "exit", 0, 1, &exit_code))
266 return NULL;
267 /* Raise SystemExit so callers may catch it or clean up. */
268 PyErr_SetObject(PyExc_SystemExit, exit_code);
269 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000270}
271
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000272PyDoc_STRVAR(exit_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000273"exit([status])\n\
274\n\
275Exit the interpreter by raising SystemExit(status).\n\
276If the status is omitted or None, it defaults to zero (i.e., success).\n\
Ezio Melotti4af4d272013-08-26 14:00:39 +0300277If the status is an integer, it will be used as the system exit status.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000278If it is another kind of object, it will be printed and the system\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000279exit status will be one (i.e., failure)."
280);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000281
Martin v. Löwis107b7da2001-11-09 20:59:39 +0000282
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000283static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000284sys_getdefaultencoding(PyObject *self)
Fred Drake8b4d01d2000-05-09 19:57:01 +0000285{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000286 return PyUnicode_FromString(PyUnicode_GetDefaultEncoding());
Fred Drake8b4d01d2000-05-09 19:57:01 +0000287}
288
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000289PyDoc_STRVAR(getdefaultencoding_doc,
Marc-André Lemburg99964b82000-06-07 09:13:41 +0000290"getdefaultencoding() -> string\n\
Fred Drake8b4d01d2000-05-09 19:57:01 +0000291\n\
292Return the current default string encoding used by the Unicode \n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000293implementation."
294);
Fred Drake8b4d01d2000-05-09 19:57:01 +0000295
296static PyObject *
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000297sys_getfilesystemencoding(PyObject *self)
298{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000299 if (Py_FileSystemDefaultEncoding)
300 return PyUnicode_FromString(Py_FileSystemDefaultEncoding);
Victor Stinner27181ac2011-03-31 13:39:03 +0200301 PyErr_SetString(PyExc_RuntimeError,
302 "filesystem encoding is not initialized");
303 return NULL;
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000304}
305
306PyDoc_STRVAR(getfilesystemencoding_doc,
307"getfilesystemencoding() -> string\n\
308\n\
309Return the encoding used to convert Unicode filenames in\n\
310operating system filenames."
311);
312
Martin v. Löwis04dc25c2008-10-03 16:09:28 +0000313static PyObject *
Georg Brandl66a796e2006-12-19 20:50:34 +0000314sys_intern(PyObject *self, PyObject *args)
315{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000316 PyObject *s;
317 if (!PyArg_ParseTuple(args, "U:intern", &s))
318 return NULL;
319 if (PyUnicode_CheckExact(s)) {
320 Py_INCREF(s);
321 PyUnicode_InternInPlace(&s);
322 return s;
323 }
324 else {
325 PyErr_Format(PyExc_TypeError,
326 "can't intern %.400s", s->ob_type->tp_name);
327 return NULL;
328 }
Georg Brandl66a796e2006-12-19 20:50:34 +0000329}
330
331PyDoc_STRVAR(intern_doc,
332"intern(string) -> string\n\
333\n\
334``Intern'' the given string. This enters the string in the (global)\n\
335table of interned strings whose purpose is to speed up dictionary lookups.\n\
336Return the string itself or the previously interned string object with the\n\
337same value.");
338
339
Fred Drake5755ce62001-06-27 19:19:46 +0000340/*
341 * Cached interned string objects used for calling the profile and
342 * trace functions. Initialized by trace_init().
343 */
Nicholas Bastinc69ebe82004-03-24 21:57:10 +0000344static PyObject *whatstrings[7] = {NULL, NULL, NULL, NULL, NULL, NULL, NULL};
Fred Drake5755ce62001-06-27 19:19:46 +0000345
346static int
347trace_init(void)
348{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 static char *whatnames[7] = {"call", "exception", "line", "return",
350 "c_call", "c_exception", "c_return"};
351 PyObject *name;
352 int i;
353 for (i = 0; i < 7; ++i) {
354 if (whatstrings[i] == NULL) {
355 name = PyUnicode_InternFromString(whatnames[i]);
356 if (name == NULL)
357 return -1;
358 whatstrings[i] = name;
359 }
360 }
361 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000362}
363
364
365static PyObject *
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100366call_trampoline(PyObject* callback,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 PyFrameObject *frame, int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000368{
Victor Stinner41bb43a2013-10-29 01:19:37 +0100369 PyObject *args;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000370 PyObject *whatstr;
371 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000372
Victor Stinner41bb43a2013-10-29 01:19:37 +0100373 args = PyTuple_New(3);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000374 if (args == NULL)
375 return NULL;
Victor Stinner41bb43a2013-10-29 01:19:37 +0100376 if (PyFrame_FastToLocalsWithError(frame) < 0)
377 return NULL;
378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000379 Py_INCREF(frame);
380 whatstr = whatstrings[what];
381 Py_INCREF(whatstr);
382 if (arg == NULL)
383 arg = Py_None;
384 Py_INCREF(arg);
385 PyTuple_SET_ITEM(args, 0, (PyObject *)frame);
386 PyTuple_SET_ITEM(args, 1, whatstr);
387 PyTuple_SET_ITEM(args, 2, arg);
Fred Drake5755ce62001-06-27 19:19:46 +0000388
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000389 /* call the Python-level function */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000390 result = PyEval_CallObject(callback, args);
391 PyFrame_LocalsToFast(frame, 1);
392 if (result == NULL)
393 PyTraceBack_Here(frame);
Fred Drake5755ce62001-06-27 19:19:46 +0000394
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000395 /* cleanup */
396 Py_DECREF(args);
397 return result;
Fred Drake5755ce62001-06-27 19:19:46 +0000398}
399
400static int
401profile_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000402 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000403{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000404 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000406 if (arg == NULL)
407 arg = Py_None;
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100408 result = call_trampoline(self, frame, what, arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000409 if (result == NULL) {
410 PyEval_SetProfile(NULL, NULL);
411 return -1;
412 }
413 Py_DECREF(result);
414 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000415}
416
417static int
418trace_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000419 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000420{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000421 PyObject *callback;
422 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000423
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000424 if (what == PyTrace_CALL)
425 callback = self;
426 else
427 callback = frame->f_trace;
428 if (callback == NULL)
429 return 0;
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100430 result = call_trampoline(callback, frame, what, arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000431 if (result == NULL) {
432 PyEval_SetTrace(NULL, NULL);
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200433 Py_CLEAR(frame->f_trace);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000434 return -1;
435 }
436 if (result != Py_None) {
437 PyObject *temp = frame->f_trace;
438 frame->f_trace = NULL;
439 Py_XDECREF(temp);
440 frame->f_trace = result;
441 }
442 else {
443 Py_DECREF(result);
444 }
445 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000446}
Fred Draked0838392001-06-16 21:02:31 +0000447
Fred Drake8b4d01d2000-05-09 19:57:01 +0000448static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000449sys_settrace(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000450{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000451 if (trace_init() == -1)
452 return NULL;
453 if (args == Py_None)
454 PyEval_SetTrace(NULL, NULL);
455 else
456 PyEval_SetTrace(trace_trampoline, args);
457 Py_INCREF(Py_None);
458 return Py_None;
Guido van Rossume2437a11992-03-23 18:20:18 +0000459}
460
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000461PyDoc_STRVAR(settrace_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000462"settrace(function)\n\
463\n\
464Set the global debug tracing function. It will be called on each\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000465function call. See the debugger chapter in the library manual."
466);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000467
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000468static PyObject *
Christian Heimes9bd667a2008-01-20 15:14:11 +0000469sys_gettrace(PyObject *self, PyObject *args)
470{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000471 PyThreadState *tstate = PyThreadState_GET();
472 PyObject *temp = tstate->c_traceobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000474 if (temp == NULL)
475 temp = Py_None;
476 Py_INCREF(temp);
477 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000478}
479
480PyDoc_STRVAR(gettrace_doc,
481"gettrace()\n\
482\n\
483Return the global debug tracing function set with sys.settrace.\n\
484See the debugger chapter in the library manual."
485);
486
487static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000488sys_setprofile(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000489{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000490 if (trace_init() == -1)
491 return NULL;
492 if (args == Py_None)
493 PyEval_SetProfile(NULL, NULL);
494 else
495 PyEval_SetProfile(profile_trampoline, args);
496 Py_INCREF(Py_None);
497 return Py_None;
Guido van Rossume2437a11992-03-23 18:20:18 +0000498}
499
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000500PyDoc_STRVAR(setprofile_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000501"setprofile(function)\n\
502\n\
503Set the profiling function. It will be called on each function call\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000504and return. See the profiler chapter in the library manual."
505);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000506
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000507static PyObject *
Christian Heimes9bd667a2008-01-20 15:14:11 +0000508sys_getprofile(PyObject *self, PyObject *args)
509{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000510 PyThreadState *tstate = PyThreadState_GET();
511 PyObject *temp = tstate->c_profileobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000513 if (temp == NULL)
514 temp = Py_None;
515 Py_INCREF(temp);
516 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000517}
518
519PyDoc_STRVAR(getprofile_doc,
520"getprofile()\n\
521\n\
522Return the profiling function set with sys.setprofile.\n\
523See the profiler chapter in the library manual."
524);
525
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000526static int _check_interval = 100;
527
Christian Heimes9bd667a2008-01-20 15:14:11 +0000528static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000529sys_setcheckinterval(PyObject *self, PyObject *args)
Guido van Rossuma0d7a231995-01-09 17:46:13 +0000530{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000531 if (PyErr_WarnEx(PyExc_DeprecationWarning,
532 "sys.getcheckinterval() and sys.setcheckinterval() "
533 "are deprecated. Use sys.setswitchinterval() "
534 "instead.", 1) < 0)
535 return NULL;
536 if (!PyArg_ParseTuple(args, "i:setcheckinterval", &_check_interval))
537 return NULL;
538 Py_INCREF(Py_None);
539 return Py_None;
Guido van Rossuma0d7a231995-01-09 17:46:13 +0000540}
541
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000542PyDoc_STRVAR(setcheckinterval_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000543"setcheckinterval(n)\n\
544\n\
545Tell the Python interpreter to check for asynchronous events every\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000546n instructions. This also affects how often thread switches occur."
547);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000548
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000549static PyObject *
Tim Peterse5e065b2003-07-06 18:36:54 +0000550sys_getcheckinterval(PyObject *self, PyObject *args)
551{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000552 if (PyErr_WarnEx(PyExc_DeprecationWarning,
553 "sys.getcheckinterval() and sys.setcheckinterval() "
554 "are deprecated. Use sys.getswitchinterval() "
555 "instead.", 1) < 0)
556 return NULL;
557 return PyLong_FromLong(_check_interval);
Tim Peterse5e065b2003-07-06 18:36:54 +0000558}
559
560PyDoc_STRVAR(getcheckinterval_doc,
561"getcheckinterval() -> current check interval; see setcheckinterval()."
562);
563
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000564#ifdef WITH_THREAD
565static PyObject *
566sys_setswitchinterval(PyObject *self, PyObject *args)
567{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000568 double d;
569 if (!PyArg_ParseTuple(args, "d:setswitchinterval", &d))
570 return NULL;
571 if (d <= 0.0) {
572 PyErr_SetString(PyExc_ValueError,
573 "switch interval must be strictly positive");
574 return NULL;
575 }
576 _PyEval_SetSwitchInterval((unsigned long) (1e6 * d));
577 Py_INCREF(Py_None);
578 return Py_None;
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000579}
580
581PyDoc_STRVAR(setswitchinterval_doc,
582"setswitchinterval(n)\n\
583\n\
584Set the ideal thread switching delay inside the Python interpreter\n\
585The actual frequency of switching threads can be lower if the\n\
586interpreter executes long sequences of uninterruptible code\n\
587(this is implementation-specific and workload-dependent).\n\
588\n\
589The parameter must represent the desired switching delay in seconds\n\
590A typical value is 0.005 (5 milliseconds)."
591);
592
593static PyObject *
594sys_getswitchinterval(PyObject *self, PyObject *args)
595{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000596 return PyFloat_FromDouble(1e-6 * _PyEval_GetSwitchInterval());
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000597}
598
599PyDoc_STRVAR(getswitchinterval_doc,
600"getswitchinterval() -> current thread switch interval; see setswitchinterval()."
601);
602
603#endif /* WITH_THREAD */
604
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000605#ifdef WITH_TSC
606static PyObject *
607sys_settscdump(PyObject *self, PyObject *args)
608{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000609 int bool;
610 PyThreadState *tstate = PyThreadState_Get();
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000611
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000612 if (!PyArg_ParseTuple(args, "i:settscdump", &bool))
613 return NULL;
614 if (bool)
615 tstate->interp->tscdump = 1;
616 else
617 tstate->interp->tscdump = 0;
618 Py_INCREF(Py_None);
619 return Py_None;
Tim Peters216b78b2006-01-06 02:40:53 +0000620
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000621}
622
Tim Peters216b78b2006-01-06 02:40:53 +0000623PyDoc_STRVAR(settscdump_doc,
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000624"settscdump(bool)\n\
625\n\
626If true, tell the Python interpreter to dump VM measurements to\n\
627stderr. If false, turn off dump. The measurements are based on the\n\
Michael W. Hudson800ba232004-08-12 18:19:17 +0000628processor's time-stamp counter."
Tim Peters216b78b2006-01-06 02:40:53 +0000629);
Neal Norwitz0f5aed42004-06-13 20:32:17 +0000630#endif /* TSC */
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000631
Tim Peterse5e065b2003-07-06 18:36:54 +0000632static PyObject *
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000633sys_setrecursionlimit(PyObject *self, PyObject *args)
634{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000635 int new_limit;
636 if (!PyArg_ParseTuple(args, "i:setrecursionlimit", &new_limit))
637 return NULL;
638 if (new_limit <= 0) {
639 PyErr_SetString(PyExc_ValueError,
640 "recursion limit must be positive");
641 return NULL;
642 }
643 Py_SetRecursionLimit(new_limit);
644 Py_INCREF(Py_None);
645 return Py_None;
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000646}
647
Mark Dickinsondc787d22010-05-23 13:33:13 +0000648static PyTypeObject Hash_InfoType;
649
650PyDoc_STRVAR(hash_info_doc,
651"hash_info\n\
652\n\
653A struct sequence providing parameters used for computing\n\
Christian Heimes985ecdc2013-11-20 11:46:18 +0100654hashes. The attributes are read only.");
Mark Dickinsondc787d22010-05-23 13:33:13 +0000655
656static PyStructSequence_Field hash_info_fields[] = {
657 {"width", "width of the type used for hashing, in bits"},
658 {"modulus", "prime number giving the modulus on which the hash "
659 "function is based"},
660 {"inf", "value to be used for hash of a positive infinity"},
661 {"nan", "value to be used for hash of a nan"},
662 {"imag", "multiplier used for the imaginary part of a complex number"},
Christian Heimes985ecdc2013-11-20 11:46:18 +0100663 {"algorithm", "name of the algorithm for hashing of str, bytes and "
664 "memoryviews"},
665 {"hash_bits", "internal output size of hash algorithm"},
666 {"seed_bits", "seed size of hash algorithm"},
667 {"cutoff", "small string optimization cutoff"},
Mark Dickinsondc787d22010-05-23 13:33:13 +0000668 {NULL, NULL}
669};
670
671static PyStructSequence_Desc hash_info_desc = {
672 "sys.hash_info",
673 hash_info_doc,
674 hash_info_fields,
Christian Heimes985ecdc2013-11-20 11:46:18 +0100675 9,
Mark Dickinsondc787d22010-05-23 13:33:13 +0000676};
677
Matthias Klosed885e952010-07-06 10:53:30 +0000678static PyObject *
Mark Dickinsondc787d22010-05-23 13:33:13 +0000679get_hash_info(void)
680{
681 PyObject *hash_info;
682 int field = 0;
Christian Heimes985ecdc2013-11-20 11:46:18 +0100683 PyHash_FuncDef *hashfunc;
Mark Dickinsondc787d22010-05-23 13:33:13 +0000684 hash_info = PyStructSequence_New(&Hash_InfoType);
685 if (hash_info == NULL)
686 return NULL;
Christian Heimes985ecdc2013-11-20 11:46:18 +0100687 hashfunc = PyHash_GetFuncDef();
Mark Dickinsondc787d22010-05-23 13:33:13 +0000688 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000689 PyLong_FromLong(8*sizeof(Py_hash_t)));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000690 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000691 PyLong_FromSsize_t(_PyHASH_MODULUS));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000692 PyStructSequence_SET_ITEM(hash_info, field++,
693 PyLong_FromLong(_PyHASH_INF));
694 PyStructSequence_SET_ITEM(hash_info, field++,
695 PyLong_FromLong(_PyHASH_NAN));
696 PyStructSequence_SET_ITEM(hash_info, field++,
697 PyLong_FromLong(_PyHASH_IMAG));
Christian Heimes985ecdc2013-11-20 11:46:18 +0100698 PyStructSequence_SET_ITEM(hash_info, field++,
699 PyUnicode_FromString(hashfunc->name));
700 PyStructSequence_SET_ITEM(hash_info, field++,
701 PyLong_FromLong(hashfunc->hash_bits));
702 PyStructSequence_SET_ITEM(hash_info, field++,
703 PyLong_FromLong(hashfunc->seed_bits));
704 PyStructSequence_SET_ITEM(hash_info, field++,
705 PyLong_FromLong(Py_HASH_CUTOFF));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000706 if (PyErr_Occurred()) {
707 Py_CLEAR(hash_info);
708 return NULL;
709 }
710 return hash_info;
711}
712
713
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000714PyDoc_STRVAR(setrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000715"setrecursionlimit(n)\n\
716\n\
717Set the maximum depth of the Python interpreter stack to n. This\n\
718limit prevents infinite recursion from causing an overflow of the C\n\
719stack and crashing Python. The highest possible limit is platform-\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000720dependent."
721);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000722
723static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000724sys_getrecursionlimit(PyObject *self)
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000725{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000726 return PyLong_FromLong(Py_GetRecursionLimit());
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000727}
728
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000729PyDoc_STRVAR(getrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000730"getrecursionlimit()\n\
731\n\
732Return the current value of the recursion limit, the maximum depth\n\
733of the Python interpreter stack. This limit prevents infinite\n\
Jack Jansene739a0d2002-06-26 20:39:20 +0000734recursion from causing an overflow of the C stack and crashing Python."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000735);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000736
Mark Hammond8696ebc2002-10-08 02:44:31 +0000737#ifdef MS_WINDOWS
738PyDoc_STRVAR(getwindowsversion_doc,
739"getwindowsversion()\n\
740\n\
Eric Smithf7bb5782010-01-27 00:44:57 +0000741Return information about the running version of Windows as a named tuple.\n\
742The members are named: major, minor, build, platform, service_pack,\n\
743service_pack_major, service_pack_minor, suite_mask, and product_type. For\n\
Ezio Melotti4969f702011-03-15 05:59:46 +0200744backward compatibility, only the first 5 items are available by indexing.\n\
Eric Smithf7bb5782010-01-27 00:44:57 +0000745All elements are numbers, except service_pack which is a string. Platform\n\
746may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7,\n\
7473 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain\n\
748controller, 3 for a server."
Mark Hammond8696ebc2002-10-08 02:44:31 +0000749);
750
Eric Smithf7bb5782010-01-27 00:44:57 +0000751static PyTypeObject WindowsVersionType = {0, 0, 0, 0, 0, 0};
752
753static PyStructSequence_Field windows_version_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000754 {"major", "Major version number"},
755 {"minor", "Minor version number"},
756 {"build", "Build number"},
757 {"platform", "Operating system platform"},
758 {"service_pack", "Latest Service Pack installed on the system"},
759 {"service_pack_major", "Service Pack major version number"},
760 {"service_pack_minor", "Service Pack minor version number"},
761 {"suite_mask", "Bit mask identifying available product suites"},
762 {"product_type", "System product type"},
763 {0}
Eric Smithf7bb5782010-01-27 00:44:57 +0000764};
765
766static PyStructSequence_Desc windows_version_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000767 "sys.getwindowsversion", /* name */
768 getwindowsversion_doc, /* doc */
769 windows_version_fields, /* fields */
770 5 /* For backward compatibility,
771 only the first 5 items are accessible
772 via indexing, the rest are name only */
Eric Smithf7bb5782010-01-27 00:44:57 +0000773};
774
Mark Hammond8696ebc2002-10-08 02:44:31 +0000775static PyObject *
776sys_getwindowsversion(PyObject *self)
777{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 PyObject *version;
779 int pos = 0;
780 OSVERSIONINFOEX ver;
781 ver.dwOSVersionInfoSize = sizeof(ver);
782 if (!GetVersionEx((OSVERSIONINFO*) &ver))
783 return PyErr_SetFromWindowsErr(0);
Eric Smithf7bb5782010-01-27 00:44:57 +0000784
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000785 version = PyStructSequence_New(&WindowsVersionType);
786 if (version == NULL)
787 return NULL;
Eric Smithf7bb5782010-01-27 00:44:57 +0000788
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000789 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMajorVersion));
790 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMinorVersion));
791 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwBuildNumber));
792 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwPlatformId));
793 PyStructSequence_SET_ITEM(version, pos++, PyUnicode_FromString(ver.szCSDVersion));
794 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMajor));
795 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMinor));
796 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wSuiteMask));
797 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wProductType));
Eric Smithf7bb5782010-01-27 00:44:57 +0000798
Serhiy Storchaka48d761e2013-12-17 15:11:24 +0200799 if (PyErr_Occurred()) {
800 Py_DECREF(version);
801 return NULL;
802 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000803 return version;
Mark Hammond8696ebc2002-10-08 02:44:31 +0000804}
805
806#endif /* MS_WINDOWS */
807
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000808#ifdef HAVE_DLOPEN
809static PyObject *
810sys_setdlopenflags(PyObject *self, PyObject *args)
811{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000812 int new_val;
813 PyThreadState *tstate = PyThreadState_GET();
814 if (!PyArg_ParseTuple(args, "i:setdlopenflags", &new_val))
815 return NULL;
816 if (!tstate)
817 return NULL;
818 tstate->interp->dlopenflags = new_val;
819 Py_INCREF(Py_None);
820 return Py_None;
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000821}
822
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000823PyDoc_STRVAR(setdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000824"setdlopenflags(n) -> None\n\
825\n\
Alexandre Vassalotti260484d2009-07-17 11:43:26 +0000826Set the flags used by the interpreter for dlopen calls, such as when the\n\
827interpreter loads extension modules. Among other things, this will enable\n\
828a lazy resolving of symbols when importing a module, if called as\n\
829sys.setdlopenflags(0). To share symbols across extension modules, call as\n\
Andrew Kuchlingc61b9132013-06-21 10:58:41 -0400830sys.setdlopenflags(os.RTLD_GLOBAL). Symbolic names for the flag modules\n\
Victor Stinnerf4afa432011-10-31 11:48:09 +0100831can be found in the os module (RTLD_xxx constants, e.g. os.RTLD_LAZY).");
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000832
833static PyObject *
834sys_getdlopenflags(PyObject *self, PyObject *args)
835{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000836 PyThreadState *tstate = PyThreadState_GET();
837 if (!tstate)
838 return NULL;
839 return PyLong_FromLong(tstate->interp->dlopenflags);
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000840}
841
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000842PyDoc_STRVAR(getdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000843"getdlopenflags() -> int\n\
844\n\
Alexandre Vassalotti260484d2009-07-17 11:43:26 +0000845Return the current value of the flags that are used for dlopen calls.\n\
Andrew Kuchlingc61b9132013-06-21 10:58:41 -0400846The flag constants are defined in the os module.");
Alexandre Vassalotti260484d2009-07-17 11:43:26 +0000847
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000848#endif /* HAVE_DLOPEN */
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000849
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000850#ifdef USE_MALLOPT
851/* Link with -lmalloc (or -lmpc) on an SGI */
852#include <malloc.h>
853
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000854static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000855sys_mdebug(PyObject *self, PyObject *args)
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000856{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000857 int flag;
858 if (!PyArg_ParseTuple(args, "i:mdebug", &flag))
859 return NULL;
860 mallopt(M_DEBUG, flag);
861 Py_INCREF(Py_None);
862 return Py_None;
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000863}
864#endif /* USE_MALLOPT */
865
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +0300866size_t
867_PySys_GetSizeOf(PyObject *o)
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000868{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000869 PyObject *res = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000870 PyObject *method;
Serhiy Storchaka030e92d2014-11-15 13:21:37 +0200871 Py_ssize_t size;
Benjamin Petersona5758c02009-05-09 18:15:04 +0000872
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000873 /* Make sure the type is initialized. float gets initialized late */
874 if (PyType_Ready(Py_TYPE(o)) < 0)
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +0300875 return (size_t)-1;
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000876
Benjamin Petersonce798522012-01-22 11:24:29 -0500877 method = _PyObject_LookupSpecial(o, &PyId___sizeof__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000878 if (method == NULL) {
879 if (!PyErr_Occurred())
880 PyErr_Format(PyExc_TypeError,
881 "Type %.100s doesn't define __sizeof__",
882 Py_TYPE(o)->tp_name);
883 }
884 else {
885 res = PyObject_CallFunctionObjArgs(method, NULL);
886 Py_DECREF(method);
887 }
888
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +0300889 if (res == NULL)
890 return (size_t)-1;
891
Serhiy Storchaka030e92d2014-11-15 13:21:37 +0200892 size = PyLong_AsSsize_t(res);
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +0300893 Py_DECREF(res);
Serhiy Storchaka030e92d2014-11-15 13:21:37 +0200894 if (size == -1 && PyErr_Occurred())
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +0300895 return (size_t)-1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000896
Serhiy Storchaka030e92d2014-11-15 13:21:37 +0200897 if (size < 0) {
898 PyErr_SetString(PyExc_ValueError, "__sizeof__() should return >= 0");
899 return (size_t)-1;
900 }
901
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000902 /* add gc_head size */
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +0300903 if (PyObject_IS_GC(o))
Serhiy Storchaka030e92d2014-11-15 13:21:37 +0200904 return ((size_t)size) + sizeof(PyGC_Head);
905 return (size_t)size;
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +0300906}
907
908static PyObject *
909sys_getsizeof(PyObject *self, PyObject *args, PyObject *kwds)
910{
911 static char *kwlist[] = {"object", "default", 0};
912 size_t size;
913 PyObject *o, *dflt = NULL;
914
915 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|O:getsizeof",
916 kwlist, &o, &dflt))
917 return NULL;
918
919 size = _PySys_GetSizeOf(o);
920
921 if (size == (size_t)-1 && PyErr_Occurred()) {
922 /* Has a default value been given */
923 if (dflt != NULL && PyErr_ExceptionMatches(PyExc_TypeError)) {
924 PyErr_Clear();
925 Py_INCREF(dflt);
926 return dflt;
927 }
928 else
929 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000930 }
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +0300931
932 return PyLong_FromSize_t(size);
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000933}
934
935PyDoc_STRVAR(getsizeof_doc,
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000936"getsizeof(object, default) -> int\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000937\n\
938Return the size of object in bytes.");
939
940static PyObject *
Fred Drakea7688822001-10-24 20:47:48 +0000941sys_getrefcount(PyObject *self, PyObject *arg)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000942{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000943 return PyLong_FromSsize_t(arg->ob_refcnt);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000944}
945
Tim Peters4be93d02002-07-07 19:59:50 +0000946#ifdef Py_REF_DEBUG
Mark Hammond440d8982000-06-20 08:12:48 +0000947static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000948sys_gettotalrefcount(PyObject *self)
Mark Hammond440d8982000-06-20 08:12:48 +0000949{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000950 return PyLong_FromSsize_t(_Py_GetRefTotal());
Mark Hammond440d8982000-06-20 08:12:48 +0000951}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000952#endif /* Py_REF_DEBUG */
Mark Hammond440d8982000-06-20 08:12:48 +0000953
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000954PyDoc_STRVAR(getrefcount_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000955"getrefcount(object) -> integer\n\
956\n\
Fred Drakeba3ff1b2002-06-20 21:36:19 +0000957Return the reference count of object. The count returned is generally\n\
958one higher than you might expect, because it includes the (temporary)\n\
959reference as an argument to getrefcount()."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000960);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000961
Antoine Pitrouf9d0b122012-12-09 14:28:26 +0100962static PyObject *
963sys_getallocatedblocks(PyObject *self)
964{
965 return PyLong_FromSsize_t(_Py_GetAllocatedBlocks());
966}
967
968PyDoc_STRVAR(getallocatedblocks_doc,
969"getallocatedblocks() -> integer\n\
970\n\
971Return the number of memory blocks currently allocated, regardless of their\n\
972size."
973);
974
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000975#ifdef COUNT_ALLOCS
976static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000977sys_getcounts(PyObject *self)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000978{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000979 extern PyObject *get_counts(void);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000980
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000981 return get_counts();
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000982}
983#endif
984
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000985PyDoc_STRVAR(getframe_doc,
Barry Warsawb6a54d22000-12-06 21:47:46 +0000986"_getframe([depth]) -> frameobject\n\
987\n\
988Return a frame object from the call stack. If optional integer depth is\n\
989given, return the frame object that many calls below the top of the stack.\n\
990If that is deeper than the call stack, ValueError is raised. The default\n\
991for depth is zero, returning the frame at the top of the call stack.\n\
992\n\
993This function should be used for internal and specialized\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000994purposes only."
995);
Barry Warsawb6a54d22000-12-06 21:47:46 +0000996
997static PyObject *
998sys_getframe(PyObject *self, PyObject *args)
999{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001000 PyFrameObject *f = PyThreadState_GET()->frame;
1001 int depth = -1;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001002
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001003 if (!PyArg_ParseTuple(args, "|i:_getframe", &depth))
1004 return NULL;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001005
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001006 while (depth > 0 && f != NULL) {
1007 f = f->f_back;
1008 --depth;
1009 }
1010 if (f == NULL) {
1011 PyErr_SetString(PyExc_ValueError,
1012 "call stack is not deep enough");
1013 return NULL;
1014 }
1015 Py_INCREF(f);
1016 return (PyObject*)f;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001017}
1018
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001019PyDoc_STRVAR(current_frames_doc,
1020"_current_frames() -> dictionary\n\
1021\n\
1022Return a dictionary mapping each current thread T's thread id to T's\n\
1023current stack frame.\n\
1024\n\
1025This function should be used for specialized purposes only."
1026);
1027
1028static PyObject *
1029sys_current_frames(PyObject *self, PyObject *noargs)
1030{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001031 return _PyThread_CurrentFrames();
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001032}
1033
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001034PyDoc_STRVAR(call_tracing_doc,
1035"call_tracing(func, args) -> object\n\
1036\n\
1037Call func(*args), while tracing is enabled. The tracing state is\n\
1038saved, and restored afterwards. This is intended to be called from\n\
1039a debugger from a checkpoint, to recursively debug some other code."
1040);
1041
1042static PyObject *
1043sys_call_tracing(PyObject *self, PyObject *args)
1044{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001045 PyObject *func, *funcargs;
1046 if (!PyArg_ParseTuple(args, "OO!:call_tracing", &func, &PyTuple_Type, &funcargs))
1047 return NULL;
1048 return _PyEval_CallTracing(func, funcargs);
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001049}
1050
Jeremy Hylton985eba52003-02-05 23:13:00 +00001051PyDoc_STRVAR(callstats_doc,
1052"callstats() -> tuple of integers\n\
1053\n\
1054Return a tuple of function call statistics, if CALL_PROFILE was defined\n\
1055when Python was built. Otherwise, return None.\n\
1056\n\
1057When enabled, this function returns detailed, implementation-specific\n\
1058details about the number of function calls executed. The return value is\n\
1059a 11-tuple where the entries in the tuple are counts of:\n\
10600. all function calls\n\
10611. calls to PyFunction_Type objects\n\
10622. PyFunction calls that do not create an argument tuple\n\
10633. PyFunction calls that do not create an argument tuple\n\
1064 and bypass PyEval_EvalCodeEx()\n\
10654. PyMethod calls\n\
10665. PyMethod calls on bound methods\n\
10676. PyType calls\n\
10687. PyCFunction calls\n\
10698. generator calls\n\
10709. All other calls\n\
107110. Number of stack pops performed by call_function()"
1072);
Barry Warsawb6a54d22000-12-06 21:47:46 +00001073
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001074#ifdef __cplusplus
1075extern "C" {
1076#endif
1077
David Malcolm49526f42012-06-22 14:55:41 -04001078static PyObject *
1079sys_debugmallocstats(PyObject *self, PyObject *args)
1080{
1081#ifdef WITH_PYMALLOC
1082 _PyObject_DebugMallocStats(stderr);
1083 fputc('\n', stderr);
1084#endif
1085 _PyObject_DebugTypeStats(stderr);
1086
1087 Py_RETURN_NONE;
1088}
1089PyDoc_STRVAR(debugmallocstats_doc,
1090"_debugmallocstats()\n\
1091\n\
1092Print summary info to stderr about the state of\n\
1093pymalloc's structures.\n\
1094\n\
1095In Py_DEBUG mode, also perform some expensive internal consistency\n\
1096checks.\n\
1097");
1098
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001099#ifdef Py_TRACE_REFS
Guido van Rossumded690f1996-05-24 20:48:31 +00001100/* Defined in objects.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001101extern PyObject *_Py_GetObjects(PyObject *, PyObject *);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001102#endif
Guido van Rossumded690f1996-05-24 20:48:31 +00001103
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001104#ifdef DYNAMIC_EXECUTION_PROFILE
1105/* Defined in ceval.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001106extern PyObject *_Py_GetDXProfile(PyObject *, PyObject *);
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001107#endif
1108
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001109#ifdef __cplusplus
1110}
1111#endif
1112
Christian Heimes15ebc882008-02-04 18:48:49 +00001113static PyObject *
1114sys_clear_type_cache(PyObject* self, PyObject* args)
1115{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001116 PyType_ClearCache();
1117 Py_RETURN_NONE;
Christian Heimes15ebc882008-02-04 18:48:49 +00001118}
1119
1120PyDoc_STRVAR(sys_clear_type_cache__doc__,
1121"_clear_type_cache() -> None\n\
1122Clear the internal type lookup cache.");
1123
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001124static PyObject *
1125sys_is_finalizing(PyObject* self, PyObject* args)
1126{
1127 return PyBool_FromLong(_Py_Finalizing != NULL);
1128}
1129
1130PyDoc_STRVAR(is_finalizing_doc,
1131"is_finalizing()\n\
1132Return True if Python is exiting.");
1133
Christian Heimes15ebc882008-02-04 18:48:49 +00001134
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001135static PyMethodDef sys_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001136 /* Might as well keep this in alphabetic order */
1137 {"callstats", (PyCFunction)PyEval_GetCallStats, METH_NOARGS,
1138 callstats_doc},
1139 {"_clear_type_cache", sys_clear_type_cache, METH_NOARGS,
1140 sys_clear_type_cache__doc__},
1141 {"_current_frames", sys_current_frames, METH_NOARGS,
1142 current_frames_doc},
1143 {"displayhook", sys_displayhook, METH_O, displayhook_doc},
1144 {"exc_info", sys_exc_info, METH_NOARGS, exc_info_doc},
1145 {"excepthook", sys_excepthook, METH_VARARGS, excepthook_doc},
1146 {"exit", sys_exit, METH_VARARGS, exit_doc},
1147 {"getdefaultencoding", (PyCFunction)sys_getdefaultencoding,
1148 METH_NOARGS, getdefaultencoding_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001149#ifdef HAVE_DLOPEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001150 {"getdlopenflags", (PyCFunction)sys_getdlopenflags, METH_NOARGS,
1151 getdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001152#endif
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001153 {"getallocatedblocks", (PyCFunction)sys_getallocatedblocks, METH_NOARGS,
1154 getallocatedblocks_doc},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001155#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001156 {"getcounts", (PyCFunction)sys_getcounts, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001157#endif
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001158#ifdef DYNAMIC_EXECUTION_PROFILE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001159 {"getdxp", _Py_GetDXProfile, METH_VARARGS},
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001160#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001161 {"getfilesystemencoding", (PyCFunction)sys_getfilesystemencoding,
1162 METH_NOARGS, getfilesystemencoding_doc},
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001163#ifdef Py_TRACE_REFS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001164 {"getobjects", _Py_GetObjects, METH_VARARGS},
Tim Peters4be93d02002-07-07 19:59:50 +00001165#endif
1166#ifdef Py_REF_DEBUG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001167 {"gettotalrefcount", (PyCFunction)sys_gettotalrefcount, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001168#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001169 {"getrefcount", (PyCFunction)sys_getrefcount, METH_O, getrefcount_doc},
1170 {"getrecursionlimit", (PyCFunction)sys_getrecursionlimit, METH_NOARGS,
1171 getrecursionlimit_doc},
1172 {"getsizeof", (PyCFunction)sys_getsizeof,
1173 METH_VARARGS | METH_KEYWORDS, getsizeof_doc},
1174 {"_getframe", sys_getframe, METH_VARARGS, getframe_doc},
Mark Hammond8696ebc2002-10-08 02:44:31 +00001175#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001176 {"getwindowsversion", (PyCFunction)sys_getwindowsversion, METH_NOARGS,
1177 getwindowsversion_doc},
Mark Hammond8696ebc2002-10-08 02:44:31 +00001178#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001179 {"intern", sys_intern, METH_VARARGS, intern_doc},
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001180 {"is_finalizing", sys_is_finalizing, METH_NOARGS, is_finalizing_doc},
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001181#ifdef USE_MALLOPT
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001182 {"mdebug", sys_mdebug, METH_VARARGS},
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001183#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001184 {"setcheckinterval", sys_setcheckinterval, METH_VARARGS,
1185 setcheckinterval_doc},
1186 {"getcheckinterval", sys_getcheckinterval, METH_NOARGS,
1187 getcheckinterval_doc},
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001188#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 {"setswitchinterval", sys_setswitchinterval, METH_VARARGS,
1190 setswitchinterval_doc},
1191 {"getswitchinterval", sys_getswitchinterval, METH_NOARGS,
1192 getswitchinterval_doc},
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001193#endif
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001194#ifdef HAVE_DLOPEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001195 {"setdlopenflags", sys_setdlopenflags, METH_VARARGS,
1196 setdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001197#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001198 {"setprofile", sys_setprofile, METH_O, setprofile_doc},
1199 {"getprofile", sys_getprofile, METH_NOARGS, getprofile_doc},
1200 {"setrecursionlimit", sys_setrecursionlimit, METH_VARARGS,
1201 setrecursionlimit_doc},
Martin v. Löwisf30d60e2004-06-08 08:17:44 +00001202#ifdef WITH_TSC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001203 {"settscdump", sys_settscdump, METH_VARARGS, settscdump_doc},
Martin v. Löwisf30d60e2004-06-08 08:17:44 +00001204#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001205 {"settrace", sys_settrace, METH_O, settrace_doc},
1206 {"gettrace", sys_gettrace, METH_NOARGS, gettrace_doc},
1207 {"call_tracing", sys_call_tracing, METH_VARARGS, call_tracing_doc},
Victor Stinnered0b87d2013-12-19 17:16:42 +01001208 {"_debugmallocstats", sys_debugmallocstats, METH_NOARGS,
David Malcolm49526f42012-06-22 14:55:41 -04001209 debugmallocstats_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001210 {NULL, NULL} /* sentinel */
Guido van Rossum3f5da241990-12-20 15:06:42 +00001211};
1212
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001213static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001214list_builtin_module_names(void)
Guido van Rossum34679b71993-01-26 13:33:44 +00001215{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001216 PyObject *list = PyList_New(0);
1217 int i;
1218 if (list == NULL)
1219 return NULL;
1220 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1221 PyObject *name = PyUnicode_FromString(
1222 PyImport_Inittab[i].name);
1223 if (name == NULL)
1224 break;
1225 PyList_Append(list, name);
1226 Py_DECREF(name);
1227 }
1228 if (PyList_Sort(list) != 0) {
1229 Py_DECREF(list);
1230 list = NULL;
1231 }
1232 if (list) {
1233 PyObject *v = PyList_AsTuple(list);
1234 Py_DECREF(list);
1235 list = v;
1236 }
1237 return list;
Guido van Rossum34679b71993-01-26 13:33:44 +00001238}
1239
Guido van Rossum23fff912000-12-15 22:02:05 +00001240static PyObject *warnoptions = NULL;
1241
1242void
1243PySys_ResetWarnOptions(void)
1244{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 if (warnoptions == NULL || !PyList_Check(warnoptions))
1246 return;
1247 PyList_SetSlice(warnoptions, 0, PyList_GET_SIZE(warnoptions), NULL);
Guido van Rossum23fff912000-12-15 22:02:05 +00001248}
1249
1250void
Victor Stinner9ca9c252010-05-19 16:53:30 +00001251PySys_AddWarnOptionUnicode(PyObject *unicode)
Guido van Rossum23fff912000-12-15 22:02:05 +00001252{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001253 if (warnoptions == NULL || !PyList_Check(warnoptions)) {
1254 Py_XDECREF(warnoptions);
1255 warnoptions = PyList_New(0);
1256 if (warnoptions == NULL)
1257 return;
1258 }
Victor Stinner9ca9c252010-05-19 16:53:30 +00001259 PyList_Append(warnoptions, unicode);
1260}
1261
1262void
1263PySys_AddWarnOption(const wchar_t *s)
1264{
1265 PyObject *unicode;
1266 unicode = PyUnicode_FromWideChar(s, -1);
1267 if (unicode == NULL)
1268 return;
1269 PySys_AddWarnOptionUnicode(unicode);
1270 Py_DECREF(unicode);
Guido van Rossum23fff912000-12-15 22:02:05 +00001271}
1272
Christian Heimes33fe8092008-04-13 13:53:33 +00001273int
1274PySys_HasWarnOptions(void)
1275{
1276 return (warnoptions != NULL && (PyList_Size(warnoptions) > 0)) ? 1 : 0;
1277}
1278
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001279static PyObject *xoptions = NULL;
1280
1281static PyObject *
1282get_xoptions(void)
1283{
1284 if (xoptions == NULL || !PyDict_Check(xoptions)) {
1285 Py_XDECREF(xoptions);
1286 xoptions = PyDict_New();
1287 }
1288 return xoptions;
1289}
1290
1291void
1292PySys_AddXOption(const wchar_t *s)
1293{
1294 PyObject *opts;
1295 PyObject *name = NULL, *value = NULL;
1296 const wchar_t *name_end;
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001297
1298 opts = get_xoptions();
1299 if (opts == NULL)
1300 goto error;
1301
1302 name_end = wcschr(s, L'=');
1303 if (!name_end) {
1304 name = PyUnicode_FromWideChar(s, -1);
1305 value = Py_True;
1306 Py_INCREF(value);
1307 }
1308 else {
1309 name = PyUnicode_FromWideChar(s, name_end - s);
1310 value = PyUnicode_FromWideChar(name_end + 1, -1);
1311 }
1312 if (name == NULL || value == NULL)
1313 goto error;
Brett Cannonb94767f2011-02-22 20:15:44 +00001314 PyDict_SetItem(opts, name, value);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001315 Py_DECREF(name);
1316 Py_DECREF(value);
1317 return;
1318
1319error:
1320 Py_XDECREF(name);
1321 Py_XDECREF(value);
1322 /* No return value, therefore clear error state if possible */
1323 if (_Py_atomic_load_relaxed(&_PyThreadState_Current))
1324 PyErr_Clear();
1325}
1326
1327PyObject *
1328PySys_GetXOptions(void)
1329{
1330 return get_xoptions();
1331}
1332
Guido van Rossum40552d01998-08-06 03:34:39 +00001333/* XXX This doc string is too long to be a single string literal in VC++ 5.0.
1334 Two literals concatenated works just fine. If you have a K&R compiler
1335 or other abomination that however *does* understand longer strings,
1336 get rid of the !!! comment in the middle and the quotes that surround it. */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001337PyDoc_VAR(sys_doc) =
1338PyDoc_STR(
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001339"This module provides access to some objects used or maintained by the\n\
1340interpreter and to functions that interact strongly with the interpreter.\n\
1341\n\
1342Dynamic objects:\n\
1343\n\
1344argv -- command line arguments; argv[0] is the script pathname if known\n\
1345path -- module search path; path[0] is the script directory, else ''\n\
1346modules -- dictionary of loaded modules\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001347\n\
1348displayhook -- called to show results in an interactive session\n\
1349excepthook -- called to handle any uncaught exception other than SystemExit\n\
1350 To customize printing in an interactive session or to install a custom\n\
1351 top-level exception handler, assign other functions to replace these.\n\
1352\n\
Benjamin Peterson06157a42008-07-15 00:28:36 +00001353stdin -- standard input file object; used by input()\n\
Georg Brandl88fc6642007-02-09 21:28:07 +00001354stdout -- standard output file object; used by print()\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001355stderr -- standard error object; used for error messages\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001356 By assigning other file objects (or objects that behave like files)\n\
1357 to these, it is possible to redirect all of the interpreter's I/O.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001358\n\
1359last_type -- type of last uncaught exception\n\
1360last_value -- value of last uncaught exception\n\
1361last_traceback -- traceback of last uncaught exception\n\
1362 These three are only available in an interactive session after a\n\
1363 traceback has been printed.\n\
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001364"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001365)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001366/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001367PyDoc_STR(
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001368"\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001369Static objects:\n\
1370\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001371builtin_module_names -- tuple of module names built into this interpreter\n\
1372copyright -- copyright notice pertaining to this interpreter\n\
1373exec_prefix -- prefix used to find the machine-specific Python library\n\
Petri Lehtinen4b0eab62012-02-02 21:23:15 +02001374executable -- absolute path of the executable binary of the Python interpreter\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001375float_info -- a struct sequence with information about the float implementation.\n\
1376float_repr_style -- string indicating the style of repr() output for floats\n\
Christian Heimes985ecdc2013-11-20 11:46:18 +01001377hash_info -- a struct sequence with information about the hash algorithm.\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001378hexversion -- version information encoded as a single integer\n\
Barry Warsaw409da152012-06-03 16:18:47 -04001379implementation -- Python implementation information.\n\
Mark Dickinsonbd792642009-03-18 20:06:12 +00001380int_info -- a struct sequence with information about the int implementation.\n\
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001381maxsize -- the largest supported length of containers.\n\
Ezio Melotti48a2f8f2011-09-29 00:18:19 +03001382maxunicode -- the value of the largest Unicode codepoint\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001383platform -- platform identifier\n\
1384prefix -- prefix used to find the Python library\n\
1385thread_info -- a struct sequence with information about the thread implementation.\n\
Fred Drake801c08d2000-04-13 15:29:10 +00001386version -- the version of this interpreter as a string\n\
Eric Smith0e5b5622009-02-06 01:32:42 +00001387version_info -- version information as a named tuple\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001388"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001389)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001390#ifdef MS_WINDOWS
1391/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001392PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001393"dllhandle -- [Windows only] integer handle of the Python DLL\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001394winver -- [Windows only] version number of the Python DLL\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001395"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001396)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001397#endif /* MS_WINDOWS */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001398PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001399"__stdin__ -- the original stdin; don't touch!\n\
1400__stdout__ -- the original stdout; don't touch!\n\
1401__stderr__ -- the original stderr; don't touch!\n\
1402__displayhook__ -- the original displayhook; don't touch!\n\
1403__excepthook__ -- the original excepthook; don't touch!\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001404\n\
1405Functions:\n\
1406\n\
Georg Brandl1a3284e2007-12-02 09:40:06 +00001407displayhook() -- print an object to the screen, and save it in builtins._\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001408excepthook() -- print an exception and its traceback to sys.stderr\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001409exc_info() -- return thread-safe information about the current exception\n\
1410exit() -- exit the interpreter by raising SystemExit\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001411getdlopenflags() -- returns flags to be used for dlopen() calls\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001412getprofile() -- get the global profiling function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001413getrefcount() -- return the reference count for an object (plus one :-)\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001414getrecursionlimit() -- return the max recursion depth for the interpreter\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001415getsizeof() -- return the size of an object in bytes\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001416gettrace() -- get the global debug tracing function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001417setcheckinterval() -- control how often the interpreter checks for events\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001418setdlopenflags() -- set the flags to be used for dlopen() calls\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001419setprofile() -- set the global profiling function\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001420setrecursionlimit() -- set the max recursion depth for the interpreter\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001421settrace() -- set the global debug tracing function\n\
Fred Drakeccede592000-08-14 20:59:57 +00001422"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001423)
Fred Drakeccede592000-08-14 20:59:57 +00001424/* end of sys_doc */ ;
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001425
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001426
1427PyDoc_STRVAR(flags__doc__,
1428"sys.flags\n\
1429\n\
1430Flags provided through command line arguments or environment vars.");
1431
1432static PyTypeObject FlagsType;
1433
1434static PyStructSequence_Field flags_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001435 {"debug", "-d"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 {"inspect", "-i"},
1437 {"interactive", "-i"},
1438 {"optimize", "-O or -OO"},
1439 {"dont_write_bytecode", "-B"},
1440 {"no_user_site", "-s"},
1441 {"no_site", "-S"},
1442 {"ignore_environment", "-E"},
1443 {"verbose", "-v"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001444 /* {"unbuffered", "-u"}, */
1445 /* {"skip_first", "-x"}, */
Georg Brandl8aa7e992010-12-28 18:30:18 +00001446 {"bytes_warning", "-b"},
1447 {"quiet", "-q"},
Georg Brandl09a7c722012-02-20 21:31:46 +01001448 {"hash_randomization", "-R"},
Christian Heimesad73a9c2013-08-10 16:36:18 +02001449 {"isolated", "-I"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001450 {0}
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001451};
1452
1453static PyStructSequence_Desc flags_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 "sys.flags", /* name */
1455 flags__doc__, /* doc */
1456 flags_fields, /* fields */
Christian Heimesad73a9c2013-08-10 16:36:18 +02001457 13
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001458};
1459
1460static PyObject*
1461make_flags(void)
1462{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001463 int pos = 0;
1464 PyObject *seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001466 seq = PyStructSequence_New(&FlagsType);
1467 if (seq == NULL)
1468 return NULL;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001469
1470#define SetFlag(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001471 PyStructSequence_SET_ITEM(seq, pos++, PyLong_FromLong(flag))
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001472
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001473 SetFlag(Py_DebugFlag);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 SetFlag(Py_InspectFlag);
1475 SetFlag(Py_InteractiveFlag);
1476 SetFlag(Py_OptimizeFlag);
1477 SetFlag(Py_DontWriteBytecodeFlag);
1478 SetFlag(Py_NoUserSiteDirectory);
1479 SetFlag(Py_NoSiteFlag);
1480 SetFlag(Py_IgnoreEnvironmentFlag);
1481 SetFlag(Py_VerboseFlag);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001482 /* SetFlag(saw_unbuffered_flag); */
1483 /* SetFlag(skipfirstline); */
Christian Heimes33fe8092008-04-13 13:53:33 +00001484 SetFlag(Py_BytesWarningFlag);
Georg Brandl8aa7e992010-12-28 18:30:18 +00001485 SetFlag(Py_QuietFlag);
Georg Brandl2daf6ae2012-02-20 19:54:16 +01001486 SetFlag(Py_HashRandomizationFlag);
Christian Heimesad73a9c2013-08-10 16:36:18 +02001487 SetFlag(Py_IsolatedFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001488#undef SetFlag
1489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001490 if (PyErr_Occurred()) {
Serhiy Storchaka87a854d2013-12-17 14:59:42 +02001491 Py_DECREF(seq);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001492 return NULL;
1493 }
1494 return seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001495}
1496
Eric Smith0e5b5622009-02-06 01:32:42 +00001497PyDoc_STRVAR(version_info__doc__,
1498"sys.version_info\n\
1499\n\
1500Version information as a named tuple.");
1501
1502static PyTypeObject VersionInfoType;
1503
1504static PyStructSequence_Field version_info_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 {"major", "Major release number"},
1506 {"minor", "Minor release number"},
1507 {"micro", "Patch release number"},
1508 {"releaselevel", "'alpha', 'beta', 'candidate', or 'release'"},
1509 {"serial", "Serial release number"},
1510 {0}
Eric Smith0e5b5622009-02-06 01:32:42 +00001511};
1512
1513static PyStructSequence_Desc version_info_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001514 "sys.version_info", /* name */
1515 version_info__doc__, /* doc */
1516 version_info_fields, /* fields */
1517 5
Eric Smith0e5b5622009-02-06 01:32:42 +00001518};
1519
1520static PyObject *
1521make_version_info(void)
1522{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001523 PyObject *version_info;
1524 char *s;
1525 int pos = 0;
Eric Smith0e5b5622009-02-06 01:32:42 +00001526
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001527 version_info = PyStructSequence_New(&VersionInfoType);
1528 if (version_info == NULL) {
1529 return NULL;
1530 }
Eric Smith0e5b5622009-02-06 01:32:42 +00001531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001532 /*
1533 * These release level checks are mutually exclusive and cover
1534 * the field, so don't get too fancy with the pre-processor!
1535 */
Eric Smith0e5b5622009-02-06 01:32:42 +00001536#if PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_ALPHA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001537 s = "alpha";
Eric Smith0e5b5622009-02-06 01:32:42 +00001538#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_BETA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001539 s = "beta";
Eric Smith0e5b5622009-02-06 01:32:42 +00001540#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_GAMMA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001541 s = "candidate";
Eric Smith0e5b5622009-02-06 01:32:42 +00001542#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_FINAL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001543 s = "final";
Eric Smith0e5b5622009-02-06 01:32:42 +00001544#endif
1545
1546#define SetIntItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001547 PyStructSequence_SET_ITEM(version_info, pos++, PyLong_FromLong(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001548#define SetStrItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 PyStructSequence_SET_ITEM(version_info, pos++, PyUnicode_FromString(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001550
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001551 SetIntItem(PY_MAJOR_VERSION);
1552 SetIntItem(PY_MINOR_VERSION);
1553 SetIntItem(PY_MICRO_VERSION);
1554 SetStrItem(s);
1555 SetIntItem(PY_RELEASE_SERIAL);
Eric Smith0e5b5622009-02-06 01:32:42 +00001556#undef SetIntItem
1557#undef SetStrItem
1558
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001559 if (PyErr_Occurred()) {
1560 Py_CLEAR(version_info);
1561 return NULL;
1562 }
1563 return version_info;
Eric Smith0e5b5622009-02-06 01:32:42 +00001564}
1565
Brett Cannon3adc7b72012-07-09 14:22:12 -04001566/* sys.implementation values */
1567#define NAME "cpython"
1568const char *_PySys_ImplName = NAME;
1569#define QUOTE(arg) #arg
1570#define STRIFY(name) QUOTE(name)
1571#define MAJOR STRIFY(PY_MAJOR_VERSION)
1572#define MINOR STRIFY(PY_MINOR_VERSION)
Ned Deily529ea5d2014-06-30 23:31:14 -07001573#define TAG NAME "-" MAJOR MINOR
Brett Cannon3adc7b72012-07-09 14:22:12 -04001574const char *_PySys_ImplCacheTag = TAG;
1575#undef NAME
1576#undef QUOTE
1577#undef STRIFY
1578#undef MAJOR
1579#undef MINOR
1580#undef TAG
1581
Barry Warsaw409da152012-06-03 16:18:47 -04001582static PyObject *
1583make_impl_info(PyObject *version_info)
1584{
1585 int res;
1586 PyObject *impl_info, *value, *ns;
1587
1588 impl_info = PyDict_New();
1589 if (impl_info == NULL)
1590 return NULL;
1591
1592 /* populate the dict */
1593
Brett Cannon3adc7b72012-07-09 14:22:12 -04001594 value = PyUnicode_FromString(_PySys_ImplName);
Barry Warsaw409da152012-06-03 16:18:47 -04001595 if (value == NULL)
1596 goto error;
1597 res = PyDict_SetItemString(impl_info, "name", value);
1598 Py_DECREF(value);
1599 if (res < 0)
1600 goto error;
1601
Brett Cannon3adc7b72012-07-09 14:22:12 -04001602 value = PyUnicode_FromString(_PySys_ImplCacheTag);
Barry Warsaw409da152012-06-03 16:18:47 -04001603 if (value == NULL)
1604 goto error;
1605 res = PyDict_SetItemString(impl_info, "cache_tag", value);
1606 Py_DECREF(value);
1607 if (res < 0)
1608 goto error;
Barry Warsaw409da152012-06-03 16:18:47 -04001609
1610 res = PyDict_SetItemString(impl_info, "version", version_info);
1611 if (res < 0)
1612 goto error;
1613
1614 value = PyLong_FromLong(PY_VERSION_HEX);
1615 if (value == NULL)
1616 goto error;
1617 res = PyDict_SetItemString(impl_info, "hexversion", value);
1618 Py_DECREF(value);
1619 if (res < 0)
1620 goto error;
1621
1622 /* dict ready */
1623
1624 ns = _PyNamespace_New(impl_info);
1625 Py_DECREF(impl_info);
1626 return ns;
1627
1628error:
1629 Py_CLEAR(impl_info);
1630 return NULL;
1631}
1632
Martin v. Löwis1a214512008-06-11 05:26:20 +00001633static struct PyModuleDef sysmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001634 PyModuleDef_HEAD_INIT,
1635 "sys",
1636 sys_doc,
1637 -1, /* multiple "initialization" just copies the module dict. */
1638 sys_methods,
1639 NULL,
1640 NULL,
1641 NULL,
1642 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00001643};
1644
Guido van Rossum25ce5661997-08-02 03:10:38 +00001645PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001646_PySys_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001647{
Victor Stinner58049602013-07-22 22:40:00 +02001648 PyObject *m, *sysdict, *version_info;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02001649 int res;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001650
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001651 m = PyModule_Create(&sysmodule);
1652 if (m == NULL)
1653 return NULL;
1654 sysdict = PyModule_GetDict(m);
Victor Stinner8fea2522013-10-27 17:15:42 +01001655#define SET_SYS_FROM_STRING_BORROW(key, value) \
Victor Stinner58049602013-07-22 22:40:00 +02001656 do { \
Victor Stinner58049602013-07-22 22:40:00 +02001657 PyObject *v = (value); \
1658 if (v == NULL) \
1659 return NULL; \
1660 res = PyDict_SetItemString(sysdict, key, v); \
1661 if (res < 0) { \
Victor Stinner8fea2522013-10-27 17:15:42 +01001662 return NULL; \
1663 } \
1664 } while (0)
1665#define SET_SYS_FROM_STRING(key, value) \
1666 do { \
Victor Stinner8fea2522013-10-27 17:15:42 +01001667 PyObject *v = (value); \
1668 if (v == NULL) \
1669 return NULL; \
1670 res = PyDict_SetItemString(sysdict, key, v); \
1671 Py_DECREF(v); \
1672 if (res < 0) { \
Victor Stinner58049602013-07-22 22:40:00 +02001673 return NULL; \
1674 } \
1675 } while (0)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001676
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 /* Check that stdin is not a directory
1678 Using shell redirection, you can redirect stdin to a directory,
1679 crashing the Python interpreter. Catch this common mistake here
1680 and output a useful error message. Note that under MS Windows,
1681 the shell already prevents that. */
Martin v. Löwisec59d042009-01-12 07:59:10 +00001682#if !defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001683 {
1684 struct stat sb;
1685 if (fstat(fileno(stdin), &sb) == 0 &&
1686 S_ISDIR(sb.st_mode)) {
1687 /* There's nothing more we can do. */
1688 /* Py_FatalError() will core dump, so just exit. */
1689 PySys_WriteStderr("Python error: <stdin> is a directory, cannot continue\n");
1690 exit(EXIT_FAILURE);
1691 }
1692 }
Martin v. Löwisec59d042009-01-12 07:59:10 +00001693#endif
Neal Norwitz11bd1192005-10-03 00:54:56 +00001694
Nick Coghland6009512014-11-20 21:39:37 +10001695 /* stdin/stdout/stderr are set in pylifecycle.c */
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001696
Victor Stinner8fea2522013-10-27 17:15:42 +01001697 SET_SYS_FROM_STRING_BORROW("__displayhook__",
1698 PyDict_GetItemString(sysdict, "displayhook"));
1699 SET_SYS_FROM_STRING_BORROW("__excepthook__",
1700 PyDict_GetItemString(sysdict, "excepthook"));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001701 SET_SYS_FROM_STRING("version",
1702 PyUnicode_FromString(Py_GetVersion()));
1703 SET_SYS_FROM_STRING("hexversion",
1704 PyLong_FromLong(PY_VERSION_HEX));
Georg Brandl1ca2e792011-03-05 20:51:24 +01001705 SET_SYS_FROM_STRING("_mercurial",
1706 Py_BuildValue("(szz)", "CPython", _Py_hgidentifier(),
1707 _Py_hgversion()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001708 SET_SYS_FROM_STRING("dont_write_bytecode",
1709 PyBool_FromLong(Py_DontWriteBytecodeFlag));
1710 SET_SYS_FROM_STRING("api_version",
1711 PyLong_FromLong(PYTHON_API_VERSION));
1712 SET_SYS_FROM_STRING("copyright",
1713 PyUnicode_FromString(Py_GetCopyright()));
1714 SET_SYS_FROM_STRING("platform",
1715 PyUnicode_FromString(Py_GetPlatform()));
1716 SET_SYS_FROM_STRING("executable",
1717 PyUnicode_FromWideChar(
1718 Py_GetProgramFullPath(), -1));
1719 SET_SYS_FROM_STRING("prefix",
1720 PyUnicode_FromWideChar(Py_GetPrefix(), -1));
1721 SET_SYS_FROM_STRING("exec_prefix",
1722 PyUnicode_FromWideChar(Py_GetExecPrefix(), -1));
Vinay Sajip7ded1f02012-05-26 03:45:29 +01001723 SET_SYS_FROM_STRING("base_prefix",
1724 PyUnicode_FromWideChar(Py_GetPrefix(), -1));
1725 SET_SYS_FROM_STRING("base_exec_prefix",
1726 PyUnicode_FromWideChar(Py_GetExecPrefix(), -1));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001727 SET_SYS_FROM_STRING("maxsize",
1728 PyLong_FromSsize_t(PY_SSIZE_T_MAX));
1729 SET_SYS_FROM_STRING("float_info",
1730 PyFloat_GetInfo());
1731 SET_SYS_FROM_STRING("int_info",
1732 PyLong_GetInfo());
Mark Dickinsondc787d22010-05-23 13:33:13 +00001733 /* initialize hash_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02001734 if (Hash_InfoType.tp_name == NULL) {
1735 if (PyStructSequence_InitType2(&Hash_InfoType, &hash_info_desc) < 0)
1736 return NULL;
1737 }
Mark Dickinsondc787d22010-05-23 13:33:13 +00001738 SET_SYS_FROM_STRING("hash_info",
1739 get_hash_info());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001740 SET_SYS_FROM_STRING("maxunicode",
Ezio Melotti48a2f8f2011-09-29 00:18:19 +03001741 PyLong_FromLong(0x10FFFF));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001742 SET_SYS_FROM_STRING("builtin_module_names",
1743 list_builtin_module_names());
Christian Heimes743e0cd2012-10-17 23:52:17 +02001744#if PY_BIG_ENDIAN
1745 SET_SYS_FROM_STRING("byteorder",
1746 PyUnicode_FromString("big"));
1747#else
1748 SET_SYS_FROM_STRING("byteorder",
1749 PyUnicode_FromString("little"));
1750#endif
Fred Drake099325e2000-08-14 15:47:03 +00001751
Guido van Rossum8b9ea871996-08-23 18:14:47 +00001752#ifdef MS_COREDLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001753 SET_SYS_FROM_STRING("dllhandle",
1754 PyLong_FromVoidPtr(PyWin_DLLhModule));
1755 SET_SYS_FROM_STRING("winver",
1756 PyUnicode_FromString(PyWin_DLLVersionString));
Guido van Rossumc606fe11996-04-09 02:37:57 +00001757#endif
Barry Warsaw8cf4eae2010-10-16 01:04:07 +00001758#ifdef ABIFLAGS
1759 SET_SYS_FROM_STRING("abiflags",
1760 PyUnicode_FromString(ABIFLAGS));
1761#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001762 if (warnoptions == NULL) {
1763 warnoptions = PyList_New(0);
Victor Stinner58049602013-07-22 22:40:00 +02001764 if (warnoptions == NULL)
1765 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001766 }
1767 else {
1768 Py_INCREF(warnoptions);
1769 }
Victor Stinner8fea2522013-10-27 17:15:42 +01001770 SET_SYS_FROM_STRING_BORROW("warnoptions", warnoptions);
Tim Peters216b78b2006-01-06 02:40:53 +00001771
Victor Stinner8fea2522013-10-27 17:15:42 +01001772 SET_SYS_FROM_STRING_BORROW("_xoptions", get_xoptions());
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001773
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001774 /* version_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02001775 if (VersionInfoType.tp_name == NULL) {
1776 if (PyStructSequence_InitType2(&VersionInfoType,
1777 &version_info_desc) < 0)
1778 return NULL;
1779 }
Barry Warsaw409da152012-06-03 16:18:47 -04001780 version_info = make_version_info();
1781 SET_SYS_FROM_STRING("version_info", version_info);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001782 /* prevent user from creating new instances */
1783 VersionInfoType.tp_init = NULL;
1784 VersionInfoType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02001785 res = PyDict_DelItemString(VersionInfoType.tp_dict, "__new__");
1786 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1787 PyErr_Clear();
Eric Smith0e5b5622009-02-06 01:32:42 +00001788
Barry Warsaw409da152012-06-03 16:18:47 -04001789 /* implementation */
1790 SET_SYS_FROM_STRING("implementation", make_impl_info(version_info));
1791
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001792 /* flags */
Victor Stinner1c8f0592013-07-22 22:24:54 +02001793 if (FlagsType.tp_name == 0) {
1794 if (PyStructSequence_InitType2(&FlagsType, &flags_desc) < 0)
1795 return NULL;
1796 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001797 SET_SYS_FROM_STRING("flags", make_flags());
1798 /* prevent user from creating new instances */
1799 FlagsType.tp_init = NULL;
1800 FlagsType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02001801 res = PyDict_DelItemString(FlagsType.tp_dict, "__new__");
1802 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1803 PyErr_Clear();
Eric Smithf7bb5782010-01-27 00:44:57 +00001804
1805#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001806 /* getwindowsversion */
1807 if (WindowsVersionType.tp_name == 0)
Victor Stinner1c8f0592013-07-22 22:24:54 +02001808 if (PyStructSequence_InitType2(&WindowsVersionType,
1809 &windows_version_desc) < 0)
1810 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001811 /* prevent user from creating new instances */
1812 WindowsVersionType.tp_init = NULL;
1813 WindowsVersionType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02001814 res = PyDict_DelItemString(WindowsVersionType.tp_dict, "__new__");
1815 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1816 PyErr_Clear();
Eric Smithf7bb5782010-01-27 00:44:57 +00001817#endif
1818
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001819 /* float repr style: 0.03 (short) vs 0.029999999999999999 (legacy) */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001820#ifndef PY_NO_SHORT_FLOAT_REPR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001821 SET_SYS_FROM_STRING("float_repr_style",
1822 PyUnicode_FromString("short"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001823#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001824 SET_SYS_FROM_STRING("float_repr_style",
1825 PyUnicode_FromString("legacy"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001826#endif
1827
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001828#ifdef WITH_THREAD
1829 SET_SYS_FROM_STRING("thread_info", PyThread_GetInfo());
1830#endif
1831
Christian Heimes7b3ce6a2008-01-31 14:31:45 +00001832#undef SET_SYS_FROM_STRING
Benjamin Peterson93813432014-03-28 18:52:45 -04001833#undef SET_SYS_FROM_STRING_BORROW
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001834 if (PyErr_Occurred())
1835 return NULL;
1836 return m;
Guido van Rossum5b3138b1990-11-18 17:41:40 +00001837}
1838
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001839static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00001840makepathobject(const wchar_t *path, wchar_t delim)
Guido van Rossum5b3138b1990-11-18 17:41:40 +00001841{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001842 int i, n;
1843 const wchar_t *p;
1844 PyObject *v, *w;
Tim Peters216b78b2006-01-06 02:40:53 +00001845
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001846 n = 1;
1847 p = path;
1848 while ((p = wcschr(p, delim)) != NULL) {
1849 n++;
1850 p++;
1851 }
1852 v = PyList_New(n);
1853 if (v == NULL)
1854 return NULL;
1855 for (i = 0; ; i++) {
1856 p = wcschr(path, delim);
1857 if (p == NULL)
1858 p = path + wcslen(path); /* End of string */
1859 w = PyUnicode_FromWideChar(path, (Py_ssize_t)(p - path));
1860 if (w == NULL) {
1861 Py_DECREF(v);
1862 return NULL;
1863 }
1864 PyList_SetItem(v, i, w);
1865 if (*p == '\0')
1866 break;
1867 path = p+1;
1868 }
1869 return v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001870}
1871
1872void
Martin v. Löwis790465f2008-04-05 20:41:37 +00001873PySys_SetPath(const wchar_t *path)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001874{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001875 PyObject *v;
1876 if ((v = makepathobject(path, DELIM)) == NULL)
1877 Py_FatalError("can't create sys.path");
Victor Stinnerbd303c12013-11-07 23:07:29 +01001878 if (_PySys_SetObjectId(&PyId_path, v) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001879 Py_FatalError("can't assign sys.path");
1880 Py_DECREF(v);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001881}
1882
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001883static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00001884makeargvobject(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001885{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001886 PyObject *av;
1887 if (argc <= 0 || argv == NULL) {
1888 /* Ensure at least one (empty) argument is seen */
1889 static wchar_t *empty_argv[1] = {L""};
1890 argv = empty_argv;
1891 argc = 1;
1892 }
1893 av = PyList_New(argc);
1894 if (av != NULL) {
1895 int i;
1896 for (i = 0; i < argc; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001897 PyObject *v = PyUnicode_FromWideChar(argv[i], -1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001898 if (v == NULL) {
1899 Py_DECREF(av);
1900 av = NULL;
1901 break;
1902 }
1903 PyList_SetItem(av, i, v);
1904 }
1905 }
1906 return av;
Guido van Rossum3f5da241990-12-20 15:06:42 +00001907}
1908
Nick Coghland26c18a2010-08-17 13:06:11 +00001909#define _HAVE_SCRIPT_ARGUMENT(argc, argv) \
1910 (argc > 0 && argv0 != NULL && \
1911 wcscmp(argv0, L"-c") != 0 && wcscmp(argv0, L"-m") != 0)
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001912
1913static void
1914sys_update_path(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001915{
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001916 wchar_t *argv0;
1917 wchar_t *p = NULL;
1918 Py_ssize_t n = 0;
1919 PyObject *a;
1920 PyObject *path;
1921#ifdef HAVE_READLINK
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001922 wchar_t link[MAXPATHLEN+1];
1923 wchar_t argv0copy[2*MAXPATHLEN+1];
1924 int nr = 0;
1925#endif
Guido van Rossum162e38c2003-02-19 15:25:10 +00001926#if defined(HAVE_REALPATH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001927 wchar_t fullpath[MAXPATHLEN];
Martin v. Löwisec59d042009-01-12 07:59:10 +00001928#elif defined(MS_WINDOWS) && !defined(MS_WINCE)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001929 wchar_t fullpath[MAX_PATH];
Thomas Heller27bb71e2003-01-08 14:33:48 +00001930#endif
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001931
Victor Stinnerbd303c12013-11-07 23:07:29 +01001932 path = _PySys_GetObjectId(&PyId_path);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001933 if (path == NULL)
1934 return;
1935
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001936 argv0 = argv[0];
1937
1938#ifdef HAVE_READLINK
1939 if (_HAVE_SCRIPT_ARGUMENT(argc, argv))
1940 nr = _Py_wreadlink(argv0, link, MAXPATHLEN);
1941 if (nr > 0) {
1942 /* It's a symlink */
1943 link[nr] = '\0';
1944 if (link[0] == SEP)
1945 argv0 = link; /* Link to absolute path */
1946 else if (wcschr(link, SEP) == NULL)
1947 ; /* Link without path */
1948 else {
1949 /* Must join(dirname(argv0), link) */
1950 wchar_t *q = wcsrchr(argv0, SEP);
1951 if (q == NULL)
1952 argv0 = link; /* argv0 without path */
1953 else {
Christian Heimes60a60672013-07-22 12:53:32 +02001954 /* Must make a copy, argv0copy has room for 2 * MAXPATHLEN */
1955 wcsncpy(argv0copy, argv0, MAXPATHLEN);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001956 q = wcsrchr(argv0copy, SEP);
Christian Heimes60a60672013-07-22 12:53:32 +02001957 wcsncpy(q+1, link, MAXPATHLEN);
1958 q[MAXPATHLEN + 1] = L'\0';
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001959 argv0 = argv0copy;
1960 }
1961 }
1962 }
1963#endif /* HAVE_READLINK */
1964#if SEP == '\\' /* Special case for MS filename syntax */
1965 if (_HAVE_SCRIPT_ARGUMENT(argc, argv)) {
1966 wchar_t *q;
1967#if defined(MS_WINDOWS) && !defined(MS_WINCE)
1968 /* This code here replaces the first element in argv with the full
1969 path that it represents. Under CE, there are no relative paths so
1970 the argument must be the full path anyway. */
1971 wchar_t *ptemp;
1972 if (GetFullPathNameW(argv0,
Victor Stinner63941882011-09-29 00:42:28 +02001973 Py_ARRAY_LENGTH(fullpath),
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001974 fullpath,
1975 &ptemp)) {
1976 argv0 = fullpath;
1977 }
1978#endif
1979 p = wcsrchr(argv0, SEP);
1980 /* Test for alternate separator */
1981 q = wcsrchr(p ? p : argv0, '/');
1982 if (q != NULL)
1983 p = q;
1984 if (p != NULL) {
1985 n = p + 1 - argv0;
1986 if (n > 1 && p[-1] != ':')
1987 n--; /* Drop trailing separator */
1988 }
1989 }
1990#else /* All other filename syntaxes */
1991 if (_HAVE_SCRIPT_ARGUMENT(argc, argv)) {
1992#if defined(HAVE_REALPATH)
Victor Stinner23847142013-11-15 17:33:43 +01001993 if (_Py_wrealpath(argv0, fullpath, Py_ARRAY_LENGTH(fullpath))) {
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001994 argv0 = fullpath;
1995 }
1996#endif
1997 p = wcsrchr(argv0, SEP);
1998 }
1999 if (p != NULL) {
2000 n = p + 1 - argv0;
2001#if SEP == '/' /* Special case for Unix filename syntax */
2002 if (n > 1)
2003 n--; /* Drop trailing separator */
2004#endif /* Unix */
2005 }
2006#endif /* All others */
2007 a = PyUnicode_FromWideChar(argv0, n);
2008 if (a == NULL)
2009 Py_FatalError("no mem for sys.path insertion");
2010 if (PyList_Insert(path, 0, a) < 0)
2011 Py_FatalError("sys.path.insert(0) failed");
2012 Py_DECREF(a);
2013}
2014
2015void
2016PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)
2017{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002018 PyObject *av = makeargvobject(argc, argv);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002019 if (av == NULL)
2020 Py_FatalError("no mem for sys.argv");
2021 if (PySys_SetObject("argv", av) != 0)
2022 Py_FatalError("can't assign sys.argv");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002023 Py_DECREF(av);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002024 if (updatepath)
2025 sys_update_path(argc, argv);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002026}
Guido van Rossuma890e681998-05-12 14:59:24 +00002027
Antoine Pitrouf978fac2010-05-21 17:25:34 +00002028void
2029PySys_SetArgv(int argc, wchar_t **argv)
2030{
Christian Heimesad73a9c2013-08-10 16:36:18 +02002031 PySys_SetArgvEx(argc, argv, Py_IsolatedFlag == 0);
Antoine Pitrouf978fac2010-05-21 17:25:34 +00002032}
2033
Victor Stinner14284c22010-04-23 12:02:30 +00002034/* Reimplementation of PyFile_WriteString() no calling indirectly
2035 PyErr_CheckSignals(): avoid the call to PyObject_Str(). */
2036
2037static int
Victor Stinner79766632010-08-16 17:36:42 +00002038sys_pyfile_write_unicode(PyObject *unicode, PyObject *file)
Victor Stinner14284c22010-04-23 12:02:30 +00002039{
Victor Stinner79766632010-08-16 17:36:42 +00002040 PyObject *writer = NULL, *args = NULL, *result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002041 int err;
Victor Stinner14284c22010-04-23 12:02:30 +00002042
Victor Stinnerecccc4f2010-06-08 20:46:00 +00002043 if (file == NULL)
2044 return -1;
2045
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02002046 writer = _PyObject_GetAttrId(file, &PyId_write);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002047 if (writer == NULL)
2048 goto error;
Victor Stinner14284c22010-04-23 12:02:30 +00002049
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002050 args = PyTuple_Pack(1, unicode);
2051 if (args == NULL)
2052 goto error;
Victor Stinner14284c22010-04-23 12:02:30 +00002053
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002054 result = PyEval_CallObject(writer, args);
2055 if (result == NULL) {
2056 goto error;
2057 } else {
2058 err = 0;
2059 goto finally;
2060 }
Victor Stinner14284c22010-04-23 12:02:30 +00002061
2062error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002063 err = -1;
Victor Stinner14284c22010-04-23 12:02:30 +00002064finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002065 Py_XDECREF(writer);
2066 Py_XDECREF(args);
2067 Py_XDECREF(result);
2068 return err;
Victor Stinner14284c22010-04-23 12:02:30 +00002069}
2070
Victor Stinner79766632010-08-16 17:36:42 +00002071static int
2072sys_pyfile_write(const char *text, PyObject *file)
2073{
2074 PyObject *unicode = NULL;
2075 int err;
2076
2077 if (file == NULL)
2078 return -1;
2079
2080 unicode = PyUnicode_FromString(text);
2081 if (unicode == NULL)
2082 return -1;
2083
2084 err = sys_pyfile_write_unicode(unicode, file);
2085 Py_DECREF(unicode);
2086 return err;
2087}
Guido van Rossuma890e681998-05-12 14:59:24 +00002088
2089/* APIs to write to sys.stdout or sys.stderr using a printf-like interface.
2090 Adapted from code submitted by Just van Rossum.
2091
2092 PySys_WriteStdout(format, ...)
2093 PySys_WriteStderr(format, ...)
2094
2095 The first function writes to sys.stdout; the second to sys.stderr. When
2096 there is a problem, they write to the real (C level) stdout or stderr;
Guido van Rossum8442af31998-10-12 18:22:10 +00002097 no exceptions are raised.
Guido van Rossuma890e681998-05-12 14:59:24 +00002098
Victor Stinner14284c22010-04-23 12:02:30 +00002099 PyErr_CheckSignals() is not called to avoid the execution of the Python
Victor Stinner79766632010-08-16 17:36:42 +00002100 signal handlers: they may raise a new exception whereas sys_write()
2101 ignores all exceptions.
Victor Stinner14284c22010-04-23 12:02:30 +00002102
Guido van Rossuma890e681998-05-12 14:59:24 +00002103 Both take a printf-style format string as their first argument followed
2104 by a variable length argument list determined by the format string.
2105
2106 *** WARNING ***
2107
2108 The format should limit the total size of the formatted output string to
2109 1000 bytes. In particular, this means that no unrestricted "%s" formats
2110 should occur; these should be limited using "%.<N>s where <N> is a
2111 decimal number calculated so that <N> plus the maximum size of other
2112 formatted text does not exceed 1000 bytes. Also watch out for "%f",
2113 which can print hundreds of digits for very large numbers.
2114
2115 */
2116
2117static void
Victor Stinner09054372013-11-06 22:41:44 +01002118sys_write(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Guido van Rossuma890e681998-05-12 14:59:24 +00002119{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002120 PyObject *file;
2121 PyObject *error_type, *error_value, *error_traceback;
2122 char buffer[1001];
2123 int written;
Guido van Rossuma890e681998-05-12 14:59:24 +00002124
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002125 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Victor Stinner09054372013-11-06 22:41:44 +01002126 file = _PySys_GetObjectId(key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002127 written = PyOS_vsnprintf(buffer, sizeof(buffer), format, va);
2128 if (sys_pyfile_write(buffer, file) != 0) {
2129 PyErr_Clear();
2130 fputs(buffer, fp);
2131 }
2132 if (written < 0 || (size_t)written >= sizeof(buffer)) {
2133 const char *truncated = "... truncated";
Victor Stinner79766632010-08-16 17:36:42 +00002134 if (sys_pyfile_write(truncated, file) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002135 fputs(truncated, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002136 }
2137 PyErr_Restore(error_type, error_value, error_traceback);
Guido van Rossuma890e681998-05-12 14:59:24 +00002138}
2139
2140void
Guido van Rossuma890e681998-05-12 14:59:24 +00002141PySys_WriteStdout(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00002142{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002143 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00002144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002145 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002146 sys_write(&PyId_stdout, stdout, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002147 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00002148}
2149
2150void
Guido van Rossuma890e681998-05-12 14:59:24 +00002151PySys_WriteStderr(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00002152{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002153 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00002154
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002155 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002156 sys_write(&PyId_stderr, stderr, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00002157 va_end(va);
2158}
2159
2160static void
Victor Stinner09054372013-11-06 22:41:44 +01002161sys_format(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Victor Stinner79766632010-08-16 17:36:42 +00002162{
2163 PyObject *file, *message;
2164 PyObject *error_type, *error_value, *error_traceback;
2165 char *utf8;
2166
2167 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Victor Stinner09054372013-11-06 22:41:44 +01002168 file = _PySys_GetObjectId(key);
Victor Stinner79766632010-08-16 17:36:42 +00002169 message = PyUnicode_FromFormatV(format, va);
2170 if (message != NULL) {
2171 if (sys_pyfile_write_unicode(message, file) != 0) {
2172 PyErr_Clear();
2173 utf8 = _PyUnicode_AsString(message);
2174 if (utf8 != NULL)
2175 fputs(utf8, fp);
2176 }
2177 Py_DECREF(message);
2178 }
2179 PyErr_Restore(error_type, error_value, error_traceback);
2180}
2181
2182void
2183PySys_FormatStdout(const char *format, ...)
2184{
2185 va_list va;
2186
2187 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002188 sys_format(&PyId_stdout, stdout, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00002189 va_end(va);
2190}
2191
2192void
2193PySys_FormatStderr(const char *format, ...)
2194{
2195 va_list va;
2196
2197 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002198 sys_format(&PyId_stderr, stderr, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002199 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00002200}