blob: 44191fcb476247e9ecbe04f903b16b3fe2ada6d1 [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"
Stefan Krah1845d142016-04-25 21:38:53 +020023#include <locale.h>
Guido van Rossum3f5da241990-12-20 15:06:42 +000024
Mark Hammond8696ebc2002-10-08 02:44:31 +000025#ifdef MS_WINDOWS
26#define WIN32_LEAN_AND_MEAN
Amaury Forgeot d'Arc06cfe952007-11-10 13:55:44 +000027#include <windows.h>
Mark Hammond8696ebc2002-10-08 02:44:31 +000028#endif /* MS_WINDOWS */
29
Guido van Rossum9b38a141996-09-11 23:12:24 +000030#ifdef MS_COREDLL
Guido van Rossumc606fe11996-04-09 02:37:57 +000031extern void *PyWin_DLLhModule;
Guido van Rossum6c1e5f21997-09-29 23:34:23 +000032/* A string loaded from the DLL at startup: */
33extern const char *PyWin_DLLVersionString;
Guido van Rossumc606fe11996-04-09 02:37:57 +000034#endif
35
Martin v. Löwis5467d4c2003-05-10 07:10:12 +000036#ifdef HAVE_LANGINFO_H
Martin v. Löwis5467d4c2003-05-10 07:10:12 +000037#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 *
Steve Dowercc16be82016-09-08 10:35:16 -0700314sys_getfilesystemencodeerrors(PyObject *self)
315{
316 if (Py_FileSystemDefaultEncodeErrors)
317 return PyUnicode_FromString(Py_FileSystemDefaultEncodeErrors);
318 PyErr_SetString(PyExc_RuntimeError,
319 "filesystem encoding is not initialized");
320 return NULL;
321}
322
323PyDoc_STRVAR(getfilesystemencodeerrors_doc,
324 "getfilesystemencodeerrors() -> string\n\
325\n\
326Return the error mode used to convert Unicode filenames in\n\
327operating system filenames."
328);
329
330static PyObject *
Georg Brandl66a796e2006-12-19 20:50:34 +0000331sys_intern(PyObject *self, PyObject *args)
332{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000333 PyObject *s;
334 if (!PyArg_ParseTuple(args, "U:intern", &s))
335 return NULL;
336 if (PyUnicode_CheckExact(s)) {
337 Py_INCREF(s);
338 PyUnicode_InternInPlace(&s);
339 return s;
340 }
341 else {
342 PyErr_Format(PyExc_TypeError,
343 "can't intern %.400s", s->ob_type->tp_name);
344 return NULL;
345 }
Georg Brandl66a796e2006-12-19 20:50:34 +0000346}
347
348PyDoc_STRVAR(intern_doc,
349"intern(string) -> string\n\
350\n\
351``Intern'' the given string. This enters the string in the (global)\n\
352table of interned strings whose purpose is to speed up dictionary lookups.\n\
353Return the string itself or the previously interned string object with the\n\
354same value.");
355
356
Fred Drake5755ce62001-06-27 19:19:46 +0000357/*
358 * Cached interned string objects used for calling the profile and
359 * trace functions. Initialized by trace_init().
360 */
Nicholas Bastinc69ebe82004-03-24 21:57:10 +0000361static PyObject *whatstrings[7] = {NULL, NULL, NULL, NULL, NULL, NULL, NULL};
Fred Drake5755ce62001-06-27 19:19:46 +0000362
363static int
364trace_init(void)
365{
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200366 static const char * const whatnames[7] = {
367 "call", "exception", "line", "return",
368 "c_call", "c_exception", "c_return"
369 };
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000370 PyObject *name;
371 int i;
372 for (i = 0; i < 7; ++i) {
373 if (whatstrings[i] == NULL) {
374 name = PyUnicode_InternFromString(whatnames[i]);
375 if (name == NULL)
376 return -1;
377 whatstrings[i] = name;
378 }
379 }
380 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000381}
382
383
384static PyObject *
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100385call_trampoline(PyObject* callback,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000386 PyFrameObject *frame, int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000387{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000388 PyObject *result;
Victor Stinner78da82b2016-08-20 01:22:57 +0200389 PyObject *stack[3];
Fred Drake5755ce62001-06-27 19:19:46 +0000390
Victor Stinner78da82b2016-08-20 01:22:57 +0200391 if (PyFrame_FastToLocalsWithError(frame) < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000392 return NULL;
Victor Stinner78da82b2016-08-20 01:22:57 +0200393 }
Victor Stinner41bb43a2013-10-29 01:19:37 +0100394
Victor Stinner78da82b2016-08-20 01:22:57 +0200395 stack[0] = (PyObject *)frame;
396 stack[1] = whatstrings[what];
397 stack[2] = (arg != NULL) ? arg : Py_None;
Fred Drake5755ce62001-06-27 19:19:46 +0000398
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000399 /* call the Python-level function */
Victor Stinner559bb6a2016-08-22 22:48:54 +0200400 result = _PyObject_FastCall(callback, stack, 3);
Fred Drake5755ce62001-06-27 19:19:46 +0000401
Victor Stinner78da82b2016-08-20 01:22:57 +0200402 PyFrame_LocalsToFast(frame, 1);
403 if (result == NULL) {
404 PyTraceBack_Here(frame);
405 }
406
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000407 return result;
Fred Drake5755ce62001-06-27 19:19:46 +0000408}
409
410static int
411profile_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000412 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000413{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000414 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000415
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000416 if (arg == NULL)
417 arg = Py_None;
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100418 result = call_trampoline(self, frame, what, arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000419 if (result == NULL) {
420 PyEval_SetProfile(NULL, NULL);
421 return -1;
422 }
423 Py_DECREF(result);
424 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000425}
426
427static int
428trace_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000429 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000430{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000431 PyObject *callback;
432 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000433
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000434 if (what == PyTrace_CALL)
435 callback = self;
436 else
437 callback = frame->f_trace;
438 if (callback == NULL)
439 return 0;
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100440 result = call_trampoline(callback, frame, what, arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000441 if (result == NULL) {
442 PyEval_SetTrace(NULL, NULL);
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200443 Py_CLEAR(frame->f_trace);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000444 return -1;
445 }
446 if (result != Py_None) {
Serhiy Storchakaec397562016-04-06 09:50:03 +0300447 Py_XSETREF(frame->f_trace, result);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000448 }
449 else {
450 Py_DECREF(result);
451 }
452 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000453}
Fred Draked0838392001-06-16 21:02:31 +0000454
Fred Drake8b4d01d2000-05-09 19:57:01 +0000455static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000456sys_settrace(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000457{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000458 if (trace_init() == -1)
459 return NULL;
460 if (args == Py_None)
461 PyEval_SetTrace(NULL, NULL);
462 else
463 PyEval_SetTrace(trace_trampoline, args);
464 Py_INCREF(Py_None);
465 return Py_None;
Guido van Rossume2437a11992-03-23 18:20:18 +0000466}
467
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000468PyDoc_STRVAR(settrace_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000469"settrace(function)\n\
470\n\
471Set the global debug tracing function. It will be called on each\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000472function call. See the debugger chapter in the library manual."
473);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000474
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000475static PyObject *
Christian Heimes9bd667a2008-01-20 15:14:11 +0000476sys_gettrace(PyObject *self, PyObject *args)
477{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000478 PyThreadState *tstate = PyThreadState_GET();
479 PyObject *temp = tstate->c_traceobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000480
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000481 if (temp == NULL)
482 temp = Py_None;
483 Py_INCREF(temp);
484 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000485}
486
487PyDoc_STRVAR(gettrace_doc,
488"gettrace()\n\
489\n\
490Return the global debug tracing function set with sys.settrace.\n\
491See the debugger chapter in the library manual."
492);
493
494static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000495sys_setprofile(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000496{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000497 if (trace_init() == -1)
498 return NULL;
499 if (args == Py_None)
500 PyEval_SetProfile(NULL, NULL);
501 else
502 PyEval_SetProfile(profile_trampoline, args);
503 Py_INCREF(Py_None);
504 return Py_None;
Guido van Rossume2437a11992-03-23 18:20:18 +0000505}
506
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000507PyDoc_STRVAR(setprofile_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000508"setprofile(function)\n\
509\n\
510Set the profiling function. It will be called on each function call\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000511and return. See the profiler chapter in the library manual."
512);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000513
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000514static PyObject *
Christian Heimes9bd667a2008-01-20 15:14:11 +0000515sys_getprofile(PyObject *self, PyObject *args)
516{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000517 PyThreadState *tstate = PyThreadState_GET();
518 PyObject *temp = tstate->c_profileobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000519
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000520 if (temp == NULL)
521 temp = Py_None;
522 Py_INCREF(temp);
523 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000524}
525
526PyDoc_STRVAR(getprofile_doc,
527"getprofile()\n\
528\n\
529Return the profiling function set with sys.setprofile.\n\
530See the profiler chapter in the library manual."
531);
532
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000533static int _check_interval = 100;
534
Christian Heimes9bd667a2008-01-20 15:14:11 +0000535static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000536sys_setcheckinterval(PyObject *self, PyObject *args)
Guido van Rossuma0d7a231995-01-09 17:46:13 +0000537{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 if (PyErr_WarnEx(PyExc_DeprecationWarning,
539 "sys.getcheckinterval() and sys.setcheckinterval() "
540 "are deprecated. Use sys.setswitchinterval() "
541 "instead.", 1) < 0)
542 return NULL;
543 if (!PyArg_ParseTuple(args, "i:setcheckinterval", &_check_interval))
544 return NULL;
545 Py_INCREF(Py_None);
546 return Py_None;
Guido van Rossuma0d7a231995-01-09 17:46:13 +0000547}
548
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000549PyDoc_STRVAR(setcheckinterval_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000550"setcheckinterval(n)\n\
551\n\
552Tell the Python interpreter to check for asynchronous events every\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000553n instructions. This also affects how often thread switches occur."
554);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000555
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000556static PyObject *
Tim Peterse5e065b2003-07-06 18:36:54 +0000557sys_getcheckinterval(PyObject *self, PyObject *args)
558{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000559 if (PyErr_WarnEx(PyExc_DeprecationWarning,
560 "sys.getcheckinterval() and sys.setcheckinterval() "
561 "are deprecated. Use sys.getswitchinterval() "
562 "instead.", 1) < 0)
563 return NULL;
564 return PyLong_FromLong(_check_interval);
Tim Peterse5e065b2003-07-06 18:36:54 +0000565}
566
567PyDoc_STRVAR(getcheckinterval_doc,
568"getcheckinterval() -> current check interval; see setcheckinterval()."
569);
570
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000571#ifdef WITH_THREAD
572static PyObject *
573sys_setswitchinterval(PyObject *self, PyObject *args)
574{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000575 double d;
576 if (!PyArg_ParseTuple(args, "d:setswitchinterval", &d))
577 return NULL;
578 if (d <= 0.0) {
579 PyErr_SetString(PyExc_ValueError,
580 "switch interval must be strictly positive");
581 return NULL;
582 }
583 _PyEval_SetSwitchInterval((unsigned long) (1e6 * d));
584 Py_INCREF(Py_None);
585 return Py_None;
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000586}
587
588PyDoc_STRVAR(setswitchinterval_doc,
589"setswitchinterval(n)\n\
590\n\
591Set the ideal thread switching delay inside the Python interpreter\n\
592The actual frequency of switching threads can be lower if the\n\
593interpreter executes long sequences of uninterruptible code\n\
594(this is implementation-specific and workload-dependent).\n\
595\n\
596The parameter must represent the desired switching delay in seconds\n\
597A typical value is 0.005 (5 milliseconds)."
598);
599
600static PyObject *
601sys_getswitchinterval(PyObject *self, PyObject *args)
602{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000603 return PyFloat_FromDouble(1e-6 * _PyEval_GetSwitchInterval());
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000604}
605
606PyDoc_STRVAR(getswitchinterval_doc,
607"getswitchinterval() -> current thread switch interval; see setswitchinterval()."
608);
609
610#endif /* WITH_THREAD */
611
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000612#ifdef WITH_TSC
613static PyObject *
614sys_settscdump(PyObject *self, PyObject *args)
615{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000616 int bool;
617 PyThreadState *tstate = PyThreadState_Get();
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 if (!PyArg_ParseTuple(args, "i:settscdump", &bool))
620 return NULL;
621 if (bool)
622 tstate->interp->tscdump = 1;
623 else
624 tstate->interp->tscdump = 0;
625 Py_INCREF(Py_None);
626 return Py_None;
Tim Peters216b78b2006-01-06 02:40:53 +0000627
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000628}
629
Tim Peters216b78b2006-01-06 02:40:53 +0000630PyDoc_STRVAR(settscdump_doc,
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000631"settscdump(bool)\n\
632\n\
633If true, tell the Python interpreter to dump VM measurements to\n\
634stderr. If false, turn off dump. The measurements are based on the\n\
Michael W. Hudson800ba232004-08-12 18:19:17 +0000635processor's time-stamp counter."
Tim Peters216b78b2006-01-06 02:40:53 +0000636);
Neal Norwitz0f5aed42004-06-13 20:32:17 +0000637#endif /* TSC */
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000638
Tim Peterse5e065b2003-07-06 18:36:54 +0000639static PyObject *
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000640sys_setrecursionlimit(PyObject *self, PyObject *args)
641{
Victor Stinner50856d52015-10-13 00:11:21 +0200642 int new_limit, mark;
643 PyThreadState *tstate;
644
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000645 if (!PyArg_ParseTuple(args, "i:setrecursionlimit", &new_limit))
646 return NULL;
Victor Stinner50856d52015-10-13 00:11:21 +0200647
648 if (new_limit < 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000649 PyErr_SetString(PyExc_ValueError,
Victor Stinner50856d52015-10-13 00:11:21 +0200650 "recursion limit must be greater or equal than 1");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000651 return NULL;
652 }
Victor Stinner50856d52015-10-13 00:11:21 +0200653
654 /* Issue #25274: When the recursion depth hits the recursion limit in
655 _Py_CheckRecursiveCall(), the overflowed flag of the thread state is
656 set to 1 and a RecursionError is raised. The overflowed flag is reset
657 to 0 when the recursion depth goes below the low-water mark: see
658 Py_LeaveRecursiveCall().
659
660 Reject too low new limit if the current recursion depth is higher than
661 the new low-water mark. Otherwise it may not be possible anymore to
662 reset the overflowed flag to 0. */
663 mark = _Py_RecursionLimitLowerWaterMark(new_limit);
664 tstate = PyThreadState_GET();
665 if (tstate->recursion_depth >= mark) {
666 PyErr_Format(PyExc_RecursionError,
667 "cannot set the recursion limit to %i at "
668 "the recursion depth %i: the limit is too low",
669 new_limit, tstate->recursion_depth);
670 return NULL;
671 }
672
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000673 Py_SetRecursionLimit(new_limit);
674 Py_INCREF(Py_None);
675 return Py_None;
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000676}
677
Yury Selivanov75445082015-05-11 22:57:16 -0400678static PyObject *
679sys_set_coroutine_wrapper(PyObject *self, PyObject *wrapper)
680{
681 if (wrapper != Py_None) {
682 if (!PyCallable_Check(wrapper)) {
683 PyErr_Format(PyExc_TypeError,
684 "callable expected, got %.50s",
685 Py_TYPE(wrapper)->tp_name);
686 return NULL;
687 }
Yury Selivanovd8cf3822015-06-01 12:15:23 -0400688 _PyEval_SetCoroutineWrapper(wrapper);
Yury Selivanov75445082015-05-11 22:57:16 -0400689 }
Benjamin Petersonbaa2e562015-05-12 11:32:41 -0400690 else {
Yury Selivanovd8cf3822015-06-01 12:15:23 -0400691 _PyEval_SetCoroutineWrapper(NULL);
Benjamin Petersonbaa2e562015-05-12 11:32:41 -0400692 }
Yury Selivanov75445082015-05-11 22:57:16 -0400693 Py_RETURN_NONE;
694}
695
696PyDoc_STRVAR(set_coroutine_wrapper_doc,
697"set_coroutine_wrapper(wrapper)\n\
698\n\
699Set a wrapper for coroutine objects."
700);
701
702static PyObject *
703sys_get_coroutine_wrapper(PyObject *self, PyObject *args)
704{
Yury Selivanovd8cf3822015-06-01 12:15:23 -0400705 PyObject *wrapper = _PyEval_GetCoroutineWrapper();
Yury Selivanov75445082015-05-11 22:57:16 -0400706 if (wrapper == NULL) {
707 wrapper = Py_None;
708 }
709 Py_INCREF(wrapper);
710 return wrapper;
711}
712
713PyDoc_STRVAR(get_coroutine_wrapper_doc,
714"get_coroutine_wrapper()\n\
715\n\
716Return the wrapper for coroutine objects set by sys.set_coroutine_wrapper."
717);
718
719
Yury Selivanoveb636452016-09-08 22:01:51 -0700720static PyTypeObject AsyncGenHooksType;
721
722PyDoc_STRVAR(asyncgen_hooks_doc,
723"asyncgen_hooks\n\
724\n\
725A struct sequence providing information about asynhronous\n\
726generators hooks. The attributes are read only.");
727
728static PyStructSequence_Field asyncgen_hooks_fields[] = {
729 {"firstiter", "Hook to intercept first iteration"},
730 {"finalizer", "Hook to intercept finalization"},
731 {0}
732};
733
734static PyStructSequence_Desc asyncgen_hooks_desc = {
735 "asyncgen_hooks", /* name */
736 asyncgen_hooks_doc, /* doc */
737 asyncgen_hooks_fields , /* fields */
738 2
739};
740
741
742static PyObject *
743sys_set_asyncgen_hooks(PyObject *self, PyObject *args, PyObject *kw)
744{
745 static char *keywords[] = {"firstiter", "finalizer", NULL};
746 PyObject *firstiter = NULL;
747 PyObject *finalizer = NULL;
748
749 if (!PyArg_ParseTupleAndKeywords(
750 args, kw, "|OO", keywords,
751 &firstiter, &finalizer)) {
752 return NULL;
753 }
754
755 if (finalizer && finalizer != Py_None) {
756 if (!PyCallable_Check(finalizer)) {
757 PyErr_Format(PyExc_TypeError,
758 "callable finalizer expected, got %.50s",
759 Py_TYPE(finalizer)->tp_name);
760 return NULL;
761 }
762 _PyEval_SetAsyncGenFinalizer(finalizer);
763 }
764 else if (finalizer == Py_None) {
765 _PyEval_SetAsyncGenFinalizer(NULL);
766 }
767
768 if (firstiter && firstiter != Py_None) {
769 if (!PyCallable_Check(firstiter)) {
770 PyErr_Format(PyExc_TypeError,
771 "callable firstiter expected, got %.50s",
772 Py_TYPE(firstiter)->tp_name);
773 return NULL;
774 }
775 _PyEval_SetAsyncGenFirstiter(firstiter);
776 }
777 else if (firstiter == Py_None) {
778 _PyEval_SetAsyncGenFirstiter(NULL);
779 }
780
781 Py_RETURN_NONE;
782}
783
784PyDoc_STRVAR(set_asyncgen_hooks_doc,
785"set_asyncgen_hooks(*, firstiter=None, finalizer=None)\n\
786\n\
787Set a finalizer for async generators objects."
788);
789
790static PyObject *
791sys_get_asyncgen_hooks(PyObject *self, PyObject *args)
792{
793 PyObject *res;
794 PyObject *firstiter = _PyEval_GetAsyncGenFirstiter();
795 PyObject *finalizer = _PyEval_GetAsyncGenFinalizer();
796
797 res = PyStructSequence_New(&AsyncGenHooksType);
798 if (res == NULL) {
799 return NULL;
800 }
801
802 if (firstiter == NULL) {
803 firstiter = Py_None;
804 }
805
806 if (finalizer == NULL) {
807 finalizer = Py_None;
808 }
809
810 Py_INCREF(firstiter);
811 PyStructSequence_SET_ITEM(res, 0, firstiter);
812
813 Py_INCREF(finalizer);
814 PyStructSequence_SET_ITEM(res, 1, finalizer);
815
816 return res;
817}
818
819PyDoc_STRVAR(get_asyncgen_hooks_doc,
820"get_asyncgen_hooks()\n\
821\n\
822Return a namedtuple of installed asynchronous generators hooks \
823(firstiter, finalizer)."
824);
825
826
Mark Dickinsondc787d22010-05-23 13:33:13 +0000827static PyTypeObject Hash_InfoType;
828
829PyDoc_STRVAR(hash_info_doc,
830"hash_info\n\
831\n\
832A struct sequence providing parameters used for computing\n\
Christian Heimes985ecdc2013-11-20 11:46:18 +0100833hashes. The attributes are read only.");
Mark Dickinsondc787d22010-05-23 13:33:13 +0000834
835static PyStructSequence_Field hash_info_fields[] = {
836 {"width", "width of the type used for hashing, in bits"},
837 {"modulus", "prime number giving the modulus on which the hash "
838 "function is based"},
839 {"inf", "value to be used for hash of a positive infinity"},
840 {"nan", "value to be used for hash of a nan"},
841 {"imag", "multiplier used for the imaginary part of a complex number"},
Christian Heimes985ecdc2013-11-20 11:46:18 +0100842 {"algorithm", "name of the algorithm for hashing of str, bytes and "
843 "memoryviews"},
844 {"hash_bits", "internal output size of hash algorithm"},
845 {"seed_bits", "seed size of hash algorithm"},
846 {"cutoff", "small string optimization cutoff"},
Mark Dickinsondc787d22010-05-23 13:33:13 +0000847 {NULL, NULL}
848};
849
850static PyStructSequence_Desc hash_info_desc = {
851 "sys.hash_info",
852 hash_info_doc,
853 hash_info_fields,
Christian Heimes985ecdc2013-11-20 11:46:18 +0100854 9,
Mark Dickinsondc787d22010-05-23 13:33:13 +0000855};
856
Matthias Klosed885e952010-07-06 10:53:30 +0000857static PyObject *
Mark Dickinsondc787d22010-05-23 13:33:13 +0000858get_hash_info(void)
859{
860 PyObject *hash_info;
861 int field = 0;
Christian Heimes985ecdc2013-11-20 11:46:18 +0100862 PyHash_FuncDef *hashfunc;
Mark Dickinsondc787d22010-05-23 13:33:13 +0000863 hash_info = PyStructSequence_New(&Hash_InfoType);
864 if (hash_info == NULL)
865 return NULL;
Christian Heimes985ecdc2013-11-20 11:46:18 +0100866 hashfunc = PyHash_GetFuncDef();
Mark Dickinsondc787d22010-05-23 13:33:13 +0000867 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000868 PyLong_FromLong(8*sizeof(Py_hash_t)));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000869 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000870 PyLong_FromSsize_t(_PyHASH_MODULUS));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000871 PyStructSequence_SET_ITEM(hash_info, field++,
872 PyLong_FromLong(_PyHASH_INF));
873 PyStructSequence_SET_ITEM(hash_info, field++,
874 PyLong_FromLong(_PyHASH_NAN));
875 PyStructSequence_SET_ITEM(hash_info, field++,
876 PyLong_FromLong(_PyHASH_IMAG));
Christian Heimes985ecdc2013-11-20 11:46:18 +0100877 PyStructSequence_SET_ITEM(hash_info, field++,
878 PyUnicode_FromString(hashfunc->name));
879 PyStructSequence_SET_ITEM(hash_info, field++,
880 PyLong_FromLong(hashfunc->hash_bits));
881 PyStructSequence_SET_ITEM(hash_info, field++,
882 PyLong_FromLong(hashfunc->seed_bits));
883 PyStructSequence_SET_ITEM(hash_info, field++,
884 PyLong_FromLong(Py_HASH_CUTOFF));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000885 if (PyErr_Occurred()) {
886 Py_CLEAR(hash_info);
887 return NULL;
888 }
889 return hash_info;
890}
891
892
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000893PyDoc_STRVAR(setrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000894"setrecursionlimit(n)\n\
895\n\
896Set the maximum depth of the Python interpreter stack to n. This\n\
897limit prevents infinite recursion from causing an overflow of the C\n\
898stack and crashing Python. The highest possible limit is platform-\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000899dependent."
900);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000901
902static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000903sys_getrecursionlimit(PyObject *self)
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000904{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 return PyLong_FromLong(Py_GetRecursionLimit());
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000906}
907
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000908PyDoc_STRVAR(getrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000909"getrecursionlimit()\n\
910\n\
911Return the current value of the recursion limit, the maximum depth\n\
912of the Python interpreter stack. This limit prevents infinite\n\
Jack Jansene739a0d2002-06-26 20:39:20 +0000913recursion from causing an overflow of the C stack and crashing Python."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000914);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000915
Mark Hammond8696ebc2002-10-08 02:44:31 +0000916#ifdef MS_WINDOWS
917PyDoc_STRVAR(getwindowsversion_doc,
918"getwindowsversion()\n\
919\n\
Eric Smithf7bb5782010-01-27 00:44:57 +0000920Return information about the running version of Windows as a named tuple.\n\
921The members are named: major, minor, build, platform, service_pack,\n\
922service_pack_major, service_pack_minor, suite_mask, and product_type. For\n\
Ezio Melotti4969f702011-03-15 05:59:46 +0200923backward compatibility, only the first 5 items are available by indexing.\n\
Eric Smithf7bb5782010-01-27 00:44:57 +0000924All elements are numbers, except service_pack which is a string. Platform\n\
925may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7,\n\
9263 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain\n\
927controller, 3 for a server."
Mark Hammond8696ebc2002-10-08 02:44:31 +0000928);
929
Eric Smithf7bb5782010-01-27 00:44:57 +0000930static PyTypeObject WindowsVersionType = {0, 0, 0, 0, 0, 0};
931
932static PyStructSequence_Field windows_version_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000933 {"major", "Major version number"},
934 {"minor", "Minor version number"},
935 {"build", "Build number"},
936 {"platform", "Operating system platform"},
937 {"service_pack", "Latest Service Pack installed on the system"},
938 {"service_pack_major", "Service Pack major version number"},
939 {"service_pack_minor", "Service Pack minor version number"},
940 {"suite_mask", "Bit mask identifying available product suites"},
941 {"product_type", "System product type"},
942 {0}
Eric Smithf7bb5782010-01-27 00:44:57 +0000943};
944
945static PyStructSequence_Desc windows_version_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000946 "sys.getwindowsversion", /* name */
947 getwindowsversion_doc, /* doc */
948 windows_version_fields, /* fields */
949 5 /* For backward compatibility,
950 only the first 5 items are accessible
951 via indexing, the rest are name only */
Eric Smithf7bb5782010-01-27 00:44:57 +0000952};
953
Steve Dower3e96f322015-03-02 08:01:10 -0800954/* Disable deprecation warnings about GetVersionEx as the result is
955 being passed straight through to the caller, who is responsible for
956 using it correctly. */
957#pragma warning(push)
958#pragma warning(disable:4996)
959
Mark Hammond8696ebc2002-10-08 02:44:31 +0000960static PyObject *
961sys_getwindowsversion(PyObject *self)
962{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000963 PyObject *version;
964 int pos = 0;
965 OSVERSIONINFOEX ver;
966 ver.dwOSVersionInfoSize = sizeof(ver);
967 if (!GetVersionEx((OSVERSIONINFO*) &ver))
968 return PyErr_SetFromWindowsErr(0);
Eric Smithf7bb5782010-01-27 00:44:57 +0000969
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 version = PyStructSequence_New(&WindowsVersionType);
971 if (version == NULL)
972 return NULL;
Eric Smithf7bb5782010-01-27 00:44:57 +0000973
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000974 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMajorVersion));
975 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMinorVersion));
976 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwBuildNumber));
977 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwPlatformId));
978 PyStructSequence_SET_ITEM(version, pos++, PyUnicode_FromString(ver.szCSDVersion));
979 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMajor));
980 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMinor));
981 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wSuiteMask));
982 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wProductType));
Eric Smithf7bb5782010-01-27 00:44:57 +0000983
Serhiy Storchaka48d761e2013-12-17 15:11:24 +0200984 if (PyErr_Occurred()) {
985 Py_DECREF(version);
986 return NULL;
987 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000988 return version;
Mark Hammond8696ebc2002-10-08 02:44:31 +0000989}
990
Steve Dower3e96f322015-03-02 08:01:10 -0800991#pragma warning(pop)
992
Steve Dowercc16be82016-09-08 10:35:16 -0700993PyDoc_STRVAR(enablelegacywindowsfsencoding_doc,
994"_enablelegacywindowsfsencoding()\n\
995\n\
996Changes the default filesystem encoding to mbcs:replace for consistency\n\
997with earlier versions of Python. See PEP 529 for more information.\n\
998\n\
999This is equivalent to defining the PYTHONLEGACYWINDOWSFSENCODING \n\
1000environment variable before launching Python."
1001);
1002
1003static PyObject *
1004sys_enablelegacywindowsfsencoding(PyObject *self)
1005{
1006 Py_FileSystemDefaultEncoding = "mbcs";
1007 Py_FileSystemDefaultEncodeErrors = "replace";
1008 Py_RETURN_NONE;
1009}
1010
Mark Hammond8696ebc2002-10-08 02:44:31 +00001011#endif /* MS_WINDOWS */
1012
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001013#ifdef HAVE_DLOPEN
1014static PyObject *
1015sys_setdlopenflags(PyObject *self, PyObject *args)
1016{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001017 int new_val;
1018 PyThreadState *tstate = PyThreadState_GET();
1019 if (!PyArg_ParseTuple(args, "i:setdlopenflags", &new_val))
1020 return NULL;
1021 if (!tstate)
1022 return NULL;
1023 tstate->interp->dlopenflags = new_val;
1024 Py_INCREF(Py_None);
1025 return Py_None;
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001026}
1027
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001028PyDoc_STRVAR(setdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001029"setdlopenflags(n) -> None\n\
1030\n\
Alexandre Vassalotti260484d2009-07-17 11:43:26 +00001031Set the flags used by the interpreter for dlopen calls, such as when the\n\
1032interpreter loads extension modules. Among other things, this will enable\n\
1033a lazy resolving of symbols when importing a module, if called as\n\
1034sys.setdlopenflags(0). To share symbols across extension modules, call as\n\
Andrew Kuchlingc61b9132013-06-21 10:58:41 -04001035sys.setdlopenflags(os.RTLD_GLOBAL). Symbolic names for the flag modules\n\
Victor Stinnerf4afa432011-10-31 11:48:09 +01001036can be found in the os module (RTLD_xxx constants, e.g. os.RTLD_LAZY).");
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001037
1038static PyObject *
1039sys_getdlopenflags(PyObject *self, PyObject *args)
1040{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001041 PyThreadState *tstate = PyThreadState_GET();
1042 if (!tstate)
1043 return NULL;
1044 return PyLong_FromLong(tstate->interp->dlopenflags);
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001045}
1046
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001047PyDoc_STRVAR(getdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001048"getdlopenflags() -> int\n\
1049\n\
Alexandre Vassalotti260484d2009-07-17 11:43:26 +00001050Return the current value of the flags that are used for dlopen calls.\n\
Andrew Kuchlingc61b9132013-06-21 10:58:41 -04001051The flag constants are defined in the os module.");
Alexandre Vassalotti260484d2009-07-17 11:43:26 +00001052
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053#endif /* HAVE_DLOPEN */
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001054
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001055#ifdef USE_MALLOPT
1056/* Link with -lmalloc (or -lmpc) on an SGI */
1057#include <malloc.h>
1058
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001059static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001060sys_mdebug(PyObject *self, PyObject *args)
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001061{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001062 int flag;
1063 if (!PyArg_ParseTuple(args, "i:mdebug", &flag))
1064 return NULL;
1065 mallopt(M_DEBUG, flag);
1066 Py_INCREF(Py_None);
1067 return Py_None;
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001068}
1069#endif /* USE_MALLOPT */
1070
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001071size_t
1072_PySys_GetSizeOf(PyObject *o)
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001073{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001074 PyObject *res = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001075 PyObject *method;
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001076 Py_ssize_t size;
Benjamin Petersona5758c02009-05-09 18:15:04 +00001077
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001078 /* Make sure the type is initialized. float gets initialized late */
1079 if (PyType_Ready(Py_TYPE(o)) < 0)
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001080 return (size_t)-1;
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +00001081
Benjamin Petersonce798522012-01-22 11:24:29 -05001082 method = _PyObject_LookupSpecial(o, &PyId___sizeof__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001083 if (method == NULL) {
1084 if (!PyErr_Occurred())
1085 PyErr_Format(PyExc_TypeError,
1086 "Type %.100s doesn't define __sizeof__",
1087 Py_TYPE(o)->tp_name);
1088 }
1089 else {
1090 res = PyObject_CallFunctionObjArgs(method, NULL);
1091 Py_DECREF(method);
1092 }
1093
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001094 if (res == NULL)
1095 return (size_t)-1;
1096
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001097 size = PyLong_AsSsize_t(res);
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001098 Py_DECREF(res);
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001099 if (size == -1 && PyErr_Occurred())
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001100 return (size_t)-1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001101
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001102 if (size < 0) {
1103 PyErr_SetString(PyExc_ValueError, "__sizeof__() should return >= 0");
1104 return (size_t)-1;
1105 }
1106
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001107 /* add gc_head size */
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001108 if (PyObject_IS_GC(o))
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001109 return ((size_t)size) + sizeof(PyGC_Head);
1110 return (size_t)size;
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001111}
1112
1113static PyObject *
1114sys_getsizeof(PyObject *self, PyObject *args, PyObject *kwds)
1115{
1116 static char *kwlist[] = {"object", "default", 0};
1117 size_t size;
1118 PyObject *o, *dflt = NULL;
1119
1120 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|O:getsizeof",
1121 kwlist, &o, &dflt))
1122 return NULL;
1123
1124 size = _PySys_GetSizeOf(o);
1125
1126 if (size == (size_t)-1 && PyErr_Occurred()) {
1127 /* Has a default value been given */
1128 if (dflt != NULL && PyErr_ExceptionMatches(PyExc_TypeError)) {
1129 PyErr_Clear();
1130 Py_INCREF(dflt);
1131 return dflt;
1132 }
1133 else
1134 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001135 }
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001136
1137 return PyLong_FromSize_t(size);
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001138}
1139
1140PyDoc_STRVAR(getsizeof_doc,
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +00001141"getsizeof(object, default) -> int\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001142\n\
1143Return the size of object in bytes.");
1144
1145static PyObject *
Fred Drakea7688822001-10-24 20:47:48 +00001146sys_getrefcount(PyObject *self, PyObject *arg)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001147{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001148 return PyLong_FromSsize_t(arg->ob_refcnt);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001149}
1150
Tim Peters4be93d02002-07-07 19:59:50 +00001151#ifdef Py_REF_DEBUG
Mark Hammond440d8982000-06-20 08:12:48 +00001152static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001153sys_gettotalrefcount(PyObject *self)
Mark Hammond440d8982000-06-20 08:12:48 +00001154{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001155 return PyLong_FromSsize_t(_Py_GetRefTotal());
Mark Hammond440d8982000-06-20 08:12:48 +00001156}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001157#endif /* Py_REF_DEBUG */
Mark Hammond440d8982000-06-20 08:12:48 +00001158
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001159PyDoc_STRVAR(getrefcount_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001160"getrefcount(object) -> integer\n\
1161\n\
Fred Drakeba3ff1b2002-06-20 21:36:19 +00001162Return the reference count of object. The count returned is generally\n\
1163one higher than you might expect, because it includes the (temporary)\n\
1164reference as an argument to getrefcount()."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001165);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001166
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001167static PyObject *
1168sys_getallocatedblocks(PyObject *self)
1169{
1170 return PyLong_FromSsize_t(_Py_GetAllocatedBlocks());
1171}
1172
1173PyDoc_STRVAR(getallocatedblocks_doc,
1174"getallocatedblocks() -> integer\n\
1175\n\
1176Return the number of memory blocks currently allocated, regardless of their\n\
1177size."
1178);
1179
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001180#ifdef COUNT_ALLOCS
1181static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001182sys_getcounts(PyObject *self)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001183{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001184 extern PyObject *get_counts(void);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001185
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001186 return get_counts();
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001187}
1188#endif
1189
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001190PyDoc_STRVAR(getframe_doc,
Barry Warsawb6a54d22000-12-06 21:47:46 +00001191"_getframe([depth]) -> frameobject\n\
1192\n\
1193Return a frame object from the call stack. If optional integer depth is\n\
1194given, return the frame object that many calls below the top of the stack.\n\
1195If that is deeper than the call stack, ValueError is raised. The default\n\
1196for depth is zero, returning the frame at the top of the call stack.\n\
1197\n\
1198This function should be used for internal and specialized\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001199purposes only."
1200);
Barry Warsawb6a54d22000-12-06 21:47:46 +00001201
1202static PyObject *
1203sys_getframe(PyObject *self, PyObject *args)
1204{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001205 PyFrameObject *f = PyThreadState_GET()->frame;
1206 int depth = -1;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001207
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001208 if (!PyArg_ParseTuple(args, "|i:_getframe", &depth))
1209 return NULL;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001210
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001211 while (depth > 0 && f != NULL) {
1212 f = f->f_back;
1213 --depth;
1214 }
1215 if (f == NULL) {
1216 PyErr_SetString(PyExc_ValueError,
1217 "call stack is not deep enough");
1218 return NULL;
1219 }
1220 Py_INCREF(f);
1221 return (PyObject*)f;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001222}
1223
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001224PyDoc_STRVAR(current_frames_doc,
1225"_current_frames() -> dictionary\n\
1226\n\
1227Return a dictionary mapping each current thread T's thread id to T's\n\
1228current stack frame.\n\
1229\n\
1230This function should be used for specialized purposes only."
1231);
1232
1233static PyObject *
1234sys_current_frames(PyObject *self, PyObject *noargs)
1235{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001236 return _PyThread_CurrentFrames();
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001237}
1238
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001239PyDoc_STRVAR(call_tracing_doc,
1240"call_tracing(func, args) -> object\n\
1241\n\
1242Call func(*args), while tracing is enabled. The tracing state is\n\
1243saved, and restored afterwards. This is intended to be called from\n\
1244a debugger from a checkpoint, to recursively debug some other code."
1245);
1246
1247static PyObject *
1248sys_call_tracing(PyObject *self, PyObject *args)
1249{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001250 PyObject *func, *funcargs;
1251 if (!PyArg_ParseTuple(args, "OO!:call_tracing", &func, &PyTuple_Type, &funcargs))
1252 return NULL;
1253 return _PyEval_CallTracing(func, funcargs);
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001254}
1255
Jeremy Hylton985eba52003-02-05 23:13:00 +00001256PyDoc_STRVAR(callstats_doc,
1257"callstats() -> tuple of integers\n\
1258\n\
1259Return a tuple of function call statistics, if CALL_PROFILE was defined\n\
1260when Python was built. Otherwise, return None.\n\
1261\n\
1262When enabled, this function returns detailed, implementation-specific\n\
1263details about the number of function calls executed. The return value is\n\
1264a 11-tuple where the entries in the tuple are counts of:\n\
12650. all function calls\n\
12661. calls to PyFunction_Type objects\n\
12672. PyFunction calls that do not create an argument tuple\n\
12683. PyFunction calls that do not create an argument tuple\n\
1269 and bypass PyEval_EvalCodeEx()\n\
12704. PyMethod calls\n\
12715. PyMethod calls on bound methods\n\
12726. PyType calls\n\
12737. PyCFunction calls\n\
12748. generator calls\n\
12759. All other calls\n\
127610. Number of stack pops performed by call_function()"
1277);
Barry Warsawb6a54d22000-12-06 21:47:46 +00001278
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001279#ifdef __cplusplus
1280extern "C" {
1281#endif
1282
David Malcolm49526f42012-06-22 14:55:41 -04001283static PyObject *
1284sys_debugmallocstats(PyObject *self, PyObject *args)
1285{
1286#ifdef WITH_PYMALLOC
Victor Stinner34be8072016-03-14 12:04:26 +01001287 if (_PyMem_PymallocEnabled()) {
1288 _PyObject_DebugMallocStats(stderr);
1289 fputc('\n', stderr);
1290 }
David Malcolm49526f42012-06-22 14:55:41 -04001291#endif
1292 _PyObject_DebugTypeStats(stderr);
1293
1294 Py_RETURN_NONE;
1295}
1296PyDoc_STRVAR(debugmallocstats_doc,
1297"_debugmallocstats()\n\
1298\n\
1299Print summary info to stderr about the state of\n\
1300pymalloc's structures.\n\
1301\n\
1302In Py_DEBUG mode, also perform some expensive internal consistency\n\
1303checks.\n\
1304");
1305
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001306#ifdef Py_TRACE_REFS
Guido van Rossumded690f1996-05-24 20:48:31 +00001307/* Defined in objects.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001308extern PyObject *_Py_GetObjects(PyObject *, PyObject *);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001309#endif
Guido van Rossumded690f1996-05-24 20:48:31 +00001310
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001311#ifdef DYNAMIC_EXECUTION_PROFILE
1312/* Defined in ceval.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001313extern PyObject *_Py_GetDXProfile(PyObject *, PyObject *);
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001314#endif
1315
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001316#ifdef __cplusplus
1317}
1318#endif
1319
Christian Heimes15ebc882008-02-04 18:48:49 +00001320static PyObject *
1321sys_clear_type_cache(PyObject* self, PyObject* args)
1322{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001323 PyType_ClearCache();
1324 Py_RETURN_NONE;
Christian Heimes15ebc882008-02-04 18:48:49 +00001325}
1326
1327PyDoc_STRVAR(sys_clear_type_cache__doc__,
1328"_clear_type_cache() -> None\n\
1329Clear the internal type lookup cache.");
1330
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001331static PyObject *
1332sys_is_finalizing(PyObject* self, PyObject* args)
1333{
1334 return PyBool_FromLong(_Py_Finalizing != NULL);
1335}
1336
1337PyDoc_STRVAR(is_finalizing_doc,
1338"is_finalizing()\n\
1339Return True if Python is exiting.");
1340
Christian Heimes15ebc882008-02-04 18:48:49 +00001341
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001342static PyMethodDef sys_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001343 /* Might as well keep this in alphabetic order */
1344 {"callstats", (PyCFunction)PyEval_GetCallStats, METH_NOARGS,
1345 callstats_doc},
1346 {"_clear_type_cache", sys_clear_type_cache, METH_NOARGS,
1347 sys_clear_type_cache__doc__},
1348 {"_current_frames", sys_current_frames, METH_NOARGS,
1349 current_frames_doc},
1350 {"displayhook", sys_displayhook, METH_O, displayhook_doc},
1351 {"exc_info", sys_exc_info, METH_NOARGS, exc_info_doc},
1352 {"excepthook", sys_excepthook, METH_VARARGS, excepthook_doc},
1353 {"exit", sys_exit, METH_VARARGS, exit_doc},
1354 {"getdefaultencoding", (PyCFunction)sys_getdefaultencoding,
1355 METH_NOARGS, getdefaultencoding_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001356#ifdef HAVE_DLOPEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001357 {"getdlopenflags", (PyCFunction)sys_getdlopenflags, METH_NOARGS,
1358 getdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001359#endif
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001360 {"getallocatedblocks", (PyCFunction)sys_getallocatedblocks, METH_NOARGS,
1361 getallocatedblocks_doc},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001362#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001363 {"getcounts", (PyCFunction)sys_getcounts, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001364#endif
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001365#ifdef DYNAMIC_EXECUTION_PROFILE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001366 {"getdxp", _Py_GetDXProfile, METH_VARARGS},
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001367#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001368 {"getfilesystemencoding", (PyCFunction)sys_getfilesystemencoding,
1369 METH_NOARGS, getfilesystemencoding_doc},
Steve Dowercc16be82016-09-08 10:35:16 -07001370 { "getfilesystemencodeerrors", (PyCFunction)sys_getfilesystemencodeerrors,
1371 METH_NOARGS, getfilesystemencodeerrors_doc },
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001372#ifdef Py_TRACE_REFS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001373 {"getobjects", _Py_GetObjects, METH_VARARGS},
Tim Peters4be93d02002-07-07 19:59:50 +00001374#endif
1375#ifdef Py_REF_DEBUG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001376 {"gettotalrefcount", (PyCFunction)sys_gettotalrefcount, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001377#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001378 {"getrefcount", (PyCFunction)sys_getrefcount, METH_O, getrefcount_doc},
1379 {"getrecursionlimit", (PyCFunction)sys_getrecursionlimit, METH_NOARGS,
1380 getrecursionlimit_doc},
1381 {"getsizeof", (PyCFunction)sys_getsizeof,
1382 METH_VARARGS | METH_KEYWORDS, getsizeof_doc},
1383 {"_getframe", sys_getframe, METH_VARARGS, getframe_doc},
Mark Hammond8696ebc2002-10-08 02:44:31 +00001384#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001385 {"getwindowsversion", (PyCFunction)sys_getwindowsversion, METH_NOARGS,
1386 getwindowsversion_doc},
Steve Dowercc16be82016-09-08 10:35:16 -07001387 {"_enablelegacywindowsfsencoding", (PyCFunction)sys_enablelegacywindowsfsencoding,
1388 METH_NOARGS, enablelegacywindowsfsencoding_doc },
Mark Hammond8696ebc2002-10-08 02:44:31 +00001389#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001390 {"intern", sys_intern, METH_VARARGS, intern_doc},
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001391 {"is_finalizing", sys_is_finalizing, METH_NOARGS, is_finalizing_doc},
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001392#ifdef USE_MALLOPT
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001393 {"mdebug", sys_mdebug, METH_VARARGS},
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001394#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001395 {"setcheckinterval", sys_setcheckinterval, METH_VARARGS,
1396 setcheckinterval_doc},
1397 {"getcheckinterval", sys_getcheckinterval, METH_NOARGS,
1398 getcheckinterval_doc},
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001399#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001400 {"setswitchinterval", sys_setswitchinterval, METH_VARARGS,
1401 setswitchinterval_doc},
1402 {"getswitchinterval", sys_getswitchinterval, METH_NOARGS,
1403 getswitchinterval_doc},
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001404#endif
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001405#ifdef HAVE_DLOPEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001406 {"setdlopenflags", sys_setdlopenflags, METH_VARARGS,
1407 setdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001408#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001409 {"setprofile", sys_setprofile, METH_O, setprofile_doc},
1410 {"getprofile", sys_getprofile, METH_NOARGS, getprofile_doc},
1411 {"setrecursionlimit", sys_setrecursionlimit, METH_VARARGS,
1412 setrecursionlimit_doc},
Martin v. Löwisf30d60e2004-06-08 08:17:44 +00001413#ifdef WITH_TSC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 {"settscdump", sys_settscdump, METH_VARARGS, settscdump_doc},
Martin v. Löwisf30d60e2004-06-08 08:17:44 +00001415#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001416 {"settrace", sys_settrace, METH_O, settrace_doc},
1417 {"gettrace", sys_gettrace, METH_NOARGS, gettrace_doc},
1418 {"call_tracing", sys_call_tracing, METH_VARARGS, call_tracing_doc},
Victor Stinnered0b87d2013-12-19 17:16:42 +01001419 {"_debugmallocstats", sys_debugmallocstats, METH_NOARGS,
David Malcolm49526f42012-06-22 14:55:41 -04001420 debugmallocstats_doc},
Yury Selivanov75445082015-05-11 22:57:16 -04001421 {"set_coroutine_wrapper", sys_set_coroutine_wrapper, METH_O,
1422 set_coroutine_wrapper_doc},
1423 {"get_coroutine_wrapper", sys_get_coroutine_wrapper, METH_NOARGS,
1424 get_coroutine_wrapper_doc},
Yury Selivanov87672d72016-09-09 00:05:42 -07001425 {"set_asyncgen_hooks", (PyCFunction)sys_set_asyncgen_hooks,
Yury Selivanoveb636452016-09-08 22:01:51 -07001426 METH_VARARGS | METH_KEYWORDS, set_asyncgen_hooks_doc},
1427 {"get_asyncgen_hooks", sys_get_asyncgen_hooks, METH_NOARGS,
1428 get_asyncgen_hooks_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001429 {NULL, NULL} /* sentinel */
Guido van Rossum3f5da241990-12-20 15:06:42 +00001430};
1431
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001432static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001433list_builtin_module_names(void)
Guido van Rossum34679b71993-01-26 13:33:44 +00001434{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001435 PyObject *list = PyList_New(0);
1436 int i;
1437 if (list == NULL)
1438 return NULL;
1439 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1440 PyObject *name = PyUnicode_FromString(
1441 PyImport_Inittab[i].name);
1442 if (name == NULL)
1443 break;
1444 PyList_Append(list, name);
1445 Py_DECREF(name);
1446 }
1447 if (PyList_Sort(list) != 0) {
1448 Py_DECREF(list);
1449 list = NULL;
1450 }
1451 if (list) {
1452 PyObject *v = PyList_AsTuple(list);
1453 Py_DECREF(list);
1454 list = v;
1455 }
1456 return list;
Guido van Rossum34679b71993-01-26 13:33:44 +00001457}
1458
Guido van Rossum23fff912000-12-15 22:02:05 +00001459static PyObject *warnoptions = NULL;
1460
1461void
1462PySys_ResetWarnOptions(void)
1463{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001464 if (warnoptions == NULL || !PyList_Check(warnoptions))
1465 return;
1466 PyList_SetSlice(warnoptions, 0, PyList_GET_SIZE(warnoptions), NULL);
Guido van Rossum23fff912000-12-15 22:02:05 +00001467}
1468
1469void
Victor Stinner9ca9c252010-05-19 16:53:30 +00001470PySys_AddWarnOptionUnicode(PyObject *unicode)
Guido van Rossum23fff912000-12-15 22:02:05 +00001471{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001472 if (warnoptions == NULL || !PyList_Check(warnoptions)) {
1473 Py_XDECREF(warnoptions);
1474 warnoptions = PyList_New(0);
1475 if (warnoptions == NULL)
1476 return;
1477 }
Victor Stinner9ca9c252010-05-19 16:53:30 +00001478 PyList_Append(warnoptions, unicode);
1479}
1480
1481void
1482PySys_AddWarnOption(const wchar_t *s)
1483{
1484 PyObject *unicode;
1485 unicode = PyUnicode_FromWideChar(s, -1);
1486 if (unicode == NULL)
1487 return;
1488 PySys_AddWarnOptionUnicode(unicode);
1489 Py_DECREF(unicode);
Guido van Rossum23fff912000-12-15 22:02:05 +00001490}
1491
Christian Heimes33fe8092008-04-13 13:53:33 +00001492int
1493PySys_HasWarnOptions(void)
1494{
1495 return (warnoptions != NULL && (PyList_Size(warnoptions) > 0)) ? 1 : 0;
1496}
1497
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001498static PyObject *xoptions = NULL;
1499
1500static PyObject *
1501get_xoptions(void)
1502{
1503 if (xoptions == NULL || !PyDict_Check(xoptions)) {
1504 Py_XDECREF(xoptions);
1505 xoptions = PyDict_New();
1506 }
1507 return xoptions;
1508}
1509
1510void
1511PySys_AddXOption(const wchar_t *s)
1512{
1513 PyObject *opts;
1514 PyObject *name = NULL, *value = NULL;
1515 const wchar_t *name_end;
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001516
1517 opts = get_xoptions();
1518 if (opts == NULL)
1519 goto error;
1520
1521 name_end = wcschr(s, L'=');
1522 if (!name_end) {
1523 name = PyUnicode_FromWideChar(s, -1);
1524 value = Py_True;
1525 Py_INCREF(value);
1526 }
1527 else {
1528 name = PyUnicode_FromWideChar(s, name_end - s);
1529 value = PyUnicode_FromWideChar(name_end + 1, -1);
1530 }
1531 if (name == NULL || value == NULL)
1532 goto error;
Brett Cannonb94767f2011-02-22 20:15:44 +00001533 PyDict_SetItem(opts, name, value);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001534 Py_DECREF(name);
1535 Py_DECREF(value);
1536 return;
1537
1538error:
1539 Py_XDECREF(name);
1540 Py_XDECREF(value);
1541 /* No return value, therefore clear error state if possible */
Victor Stinnerbfd316e2016-01-20 11:12:38 +01001542 if (_PyThreadState_UncheckedGet())
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001543 PyErr_Clear();
1544}
1545
1546PyObject *
1547PySys_GetXOptions(void)
1548{
1549 return get_xoptions();
1550}
1551
Guido van Rossum40552d01998-08-06 03:34:39 +00001552/* XXX This doc string is too long to be a single string literal in VC++ 5.0.
1553 Two literals concatenated works just fine. If you have a K&R compiler
1554 or other abomination that however *does* understand longer strings,
1555 get rid of the !!! comment in the middle and the quotes that surround it. */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001556PyDoc_VAR(sys_doc) =
1557PyDoc_STR(
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001558"This module provides access to some objects used or maintained by the\n\
1559interpreter and to functions that interact strongly with the interpreter.\n\
1560\n\
1561Dynamic objects:\n\
1562\n\
1563argv -- command line arguments; argv[0] is the script pathname if known\n\
1564path -- module search path; path[0] is the script directory, else ''\n\
1565modules -- dictionary of loaded modules\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001566\n\
1567displayhook -- called to show results in an interactive session\n\
1568excepthook -- called to handle any uncaught exception other than SystemExit\n\
1569 To customize printing in an interactive session or to install a custom\n\
1570 top-level exception handler, assign other functions to replace these.\n\
1571\n\
Benjamin Peterson06157a42008-07-15 00:28:36 +00001572stdin -- standard input file object; used by input()\n\
Georg Brandl88fc6642007-02-09 21:28:07 +00001573stdout -- standard output file object; used by print()\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001574stderr -- standard error object; used for error messages\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001575 By assigning other file objects (or objects that behave like files)\n\
1576 to these, it is possible to redirect all of the interpreter's I/O.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001577\n\
1578last_type -- type of last uncaught exception\n\
1579last_value -- value of last uncaught exception\n\
1580last_traceback -- traceback of last uncaught exception\n\
1581 These three are only available in an interactive session after a\n\
1582 traceback has been printed.\n\
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001583"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001584)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001585/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001586PyDoc_STR(
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001587"\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001588Static objects:\n\
1589\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001590builtin_module_names -- tuple of module names built into this interpreter\n\
1591copyright -- copyright notice pertaining to this interpreter\n\
1592exec_prefix -- prefix used to find the machine-specific Python library\n\
Petri Lehtinen4b0eab62012-02-02 21:23:15 +02001593executable -- absolute path of the executable binary of the Python interpreter\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001594float_info -- a struct sequence with information about the float implementation.\n\
1595float_repr_style -- string indicating the style of repr() output for floats\n\
Christian Heimes985ecdc2013-11-20 11:46:18 +01001596hash_info -- a struct sequence with information about the hash algorithm.\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001597hexversion -- version information encoded as a single integer\n\
Barry Warsaw409da152012-06-03 16:18:47 -04001598implementation -- Python implementation information.\n\
Mark Dickinsonbd792642009-03-18 20:06:12 +00001599int_info -- a struct sequence with information about the int implementation.\n\
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001600maxsize -- the largest supported length of containers.\n\
Serhiy Storchakad3faf432015-01-18 11:28:37 +02001601maxunicode -- the value of the largest Unicode code point\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001602platform -- platform identifier\n\
1603prefix -- prefix used to find the Python library\n\
1604thread_info -- a struct sequence with information about the thread implementation.\n\
Fred Drake801c08d2000-04-13 15:29:10 +00001605version -- the version of this interpreter as a string\n\
Eric Smith0e5b5622009-02-06 01:32:42 +00001606version_info -- version information as a named tuple\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001607"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001608)
Steve Dowercc16be82016-09-08 10:35:16 -07001609#ifdef MS_COREDLL
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001610/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001611PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001612"dllhandle -- [Windows only] integer handle of the Python DLL\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001613winver -- [Windows only] version number of the Python DLL\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001614"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001615)
Steve Dowercc16be82016-09-08 10:35:16 -07001616#endif /* MS_COREDLL */
1617#ifdef MS_WINDOWS
1618/* concatenating string here */
1619PyDoc_STR(
1620"_enablelegacywindowsfsencoding -- [Windows only] \n\
1621"
1622)
1623#endif
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001624PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001625"__stdin__ -- the original stdin; don't touch!\n\
1626__stdout__ -- the original stdout; don't touch!\n\
1627__stderr__ -- the original stderr; don't touch!\n\
1628__displayhook__ -- the original displayhook; don't touch!\n\
1629__excepthook__ -- the original excepthook; don't touch!\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001630\n\
1631Functions:\n\
1632\n\
Georg Brandl1a3284e2007-12-02 09:40:06 +00001633displayhook() -- print an object to the screen, and save it in builtins._\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001634excepthook() -- print an exception and its traceback to sys.stderr\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001635exc_info() -- return thread-safe information about the current exception\n\
1636exit() -- exit the interpreter by raising SystemExit\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001637getdlopenflags() -- returns flags to be used for dlopen() calls\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001638getprofile() -- get the global profiling function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001639getrefcount() -- return the reference count for an object (plus one :-)\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001640getrecursionlimit() -- return the max recursion depth for the interpreter\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001641getsizeof() -- return the size of an object in bytes\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001642gettrace() -- get the global debug tracing function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001643setcheckinterval() -- control how often the interpreter checks for events\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001644setdlopenflags() -- set the flags to be used for dlopen() calls\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001645setprofile() -- set the global profiling function\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001646setrecursionlimit() -- set the max recursion depth for the interpreter\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001647settrace() -- set the global debug tracing function\n\
Fred Drakeccede592000-08-14 20:59:57 +00001648"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001649)
Fred Drakeccede592000-08-14 20:59:57 +00001650/* end of sys_doc */ ;
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001651
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001652
1653PyDoc_STRVAR(flags__doc__,
1654"sys.flags\n\
1655\n\
1656Flags provided through command line arguments or environment vars.");
1657
1658static PyTypeObject FlagsType;
1659
1660static PyStructSequence_Field flags_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001661 {"debug", "-d"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 {"inspect", "-i"},
1663 {"interactive", "-i"},
1664 {"optimize", "-O or -OO"},
1665 {"dont_write_bytecode", "-B"},
1666 {"no_user_site", "-s"},
1667 {"no_site", "-S"},
1668 {"ignore_environment", "-E"},
1669 {"verbose", "-v"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001670 /* {"unbuffered", "-u"}, */
1671 /* {"skip_first", "-x"}, */
Georg Brandl8aa7e992010-12-28 18:30:18 +00001672 {"bytes_warning", "-b"},
1673 {"quiet", "-q"},
Georg Brandl09a7c722012-02-20 21:31:46 +01001674 {"hash_randomization", "-R"},
Christian Heimesad73a9c2013-08-10 16:36:18 +02001675 {"isolated", "-I"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001676 {0}
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001677};
1678
1679static PyStructSequence_Desc flags_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 "sys.flags", /* name */
1681 flags__doc__, /* doc */
1682 flags_fields, /* fields */
Christian Heimesad73a9c2013-08-10 16:36:18 +02001683 13
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001684};
1685
1686static PyObject*
1687make_flags(void)
1688{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001689 int pos = 0;
1690 PyObject *seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001691
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001692 seq = PyStructSequence_New(&FlagsType);
1693 if (seq == NULL)
1694 return NULL;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001695
1696#define SetFlag(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001697 PyStructSequence_SET_ITEM(seq, pos++, PyLong_FromLong(flag))
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001699 SetFlag(Py_DebugFlag);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001700 SetFlag(Py_InspectFlag);
1701 SetFlag(Py_InteractiveFlag);
1702 SetFlag(Py_OptimizeFlag);
1703 SetFlag(Py_DontWriteBytecodeFlag);
1704 SetFlag(Py_NoUserSiteDirectory);
1705 SetFlag(Py_NoSiteFlag);
1706 SetFlag(Py_IgnoreEnvironmentFlag);
1707 SetFlag(Py_VerboseFlag);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001708 /* SetFlag(saw_unbuffered_flag); */
1709 /* SetFlag(skipfirstline); */
Christian Heimes33fe8092008-04-13 13:53:33 +00001710 SetFlag(Py_BytesWarningFlag);
Georg Brandl8aa7e992010-12-28 18:30:18 +00001711 SetFlag(Py_QuietFlag);
Georg Brandl2daf6ae2012-02-20 19:54:16 +01001712 SetFlag(Py_HashRandomizationFlag);
Christian Heimesad73a9c2013-08-10 16:36:18 +02001713 SetFlag(Py_IsolatedFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001714#undef SetFlag
1715
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001716 if (PyErr_Occurred()) {
Serhiy Storchaka87a854d2013-12-17 14:59:42 +02001717 Py_DECREF(seq);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001718 return NULL;
1719 }
1720 return seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001721}
1722
Eric Smith0e5b5622009-02-06 01:32:42 +00001723PyDoc_STRVAR(version_info__doc__,
1724"sys.version_info\n\
1725\n\
1726Version information as a named tuple.");
1727
1728static PyTypeObject VersionInfoType;
1729
1730static PyStructSequence_Field version_info_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001731 {"major", "Major release number"},
1732 {"minor", "Minor release number"},
1733 {"micro", "Patch release number"},
1734 {"releaselevel", "'alpha', 'beta', 'candidate', or 'release'"},
1735 {"serial", "Serial release number"},
1736 {0}
Eric Smith0e5b5622009-02-06 01:32:42 +00001737};
1738
1739static PyStructSequence_Desc version_info_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001740 "sys.version_info", /* name */
1741 version_info__doc__, /* doc */
1742 version_info_fields, /* fields */
1743 5
Eric Smith0e5b5622009-02-06 01:32:42 +00001744};
1745
1746static PyObject *
1747make_version_info(void)
1748{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001749 PyObject *version_info;
1750 char *s;
1751 int pos = 0;
Eric Smith0e5b5622009-02-06 01:32:42 +00001752
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001753 version_info = PyStructSequence_New(&VersionInfoType);
1754 if (version_info == NULL) {
1755 return NULL;
1756 }
Eric Smith0e5b5622009-02-06 01:32:42 +00001757
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001758 /*
1759 * These release level checks are mutually exclusive and cover
1760 * the field, so don't get too fancy with the pre-processor!
1761 */
Eric Smith0e5b5622009-02-06 01:32:42 +00001762#if PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_ALPHA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001763 s = "alpha";
Eric Smith0e5b5622009-02-06 01:32:42 +00001764#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_BETA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001765 s = "beta";
Eric Smith0e5b5622009-02-06 01:32:42 +00001766#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_GAMMA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001767 s = "candidate";
Eric Smith0e5b5622009-02-06 01:32:42 +00001768#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_FINAL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001769 s = "final";
Eric Smith0e5b5622009-02-06 01:32:42 +00001770#endif
1771
1772#define SetIntItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001773 PyStructSequence_SET_ITEM(version_info, pos++, PyLong_FromLong(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001774#define SetStrItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001775 PyStructSequence_SET_ITEM(version_info, pos++, PyUnicode_FromString(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001776
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001777 SetIntItem(PY_MAJOR_VERSION);
1778 SetIntItem(PY_MINOR_VERSION);
1779 SetIntItem(PY_MICRO_VERSION);
1780 SetStrItem(s);
1781 SetIntItem(PY_RELEASE_SERIAL);
Eric Smith0e5b5622009-02-06 01:32:42 +00001782#undef SetIntItem
1783#undef SetStrItem
1784
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001785 if (PyErr_Occurred()) {
1786 Py_CLEAR(version_info);
1787 return NULL;
1788 }
1789 return version_info;
Eric Smith0e5b5622009-02-06 01:32:42 +00001790}
1791
Brett Cannon3adc7b72012-07-09 14:22:12 -04001792/* sys.implementation values */
1793#define NAME "cpython"
1794const char *_PySys_ImplName = NAME;
Victor Stinnercf01b682015-11-05 11:21:38 +01001795#define MAJOR Py_STRINGIFY(PY_MAJOR_VERSION)
1796#define MINOR Py_STRINGIFY(PY_MINOR_VERSION)
Ned Deily529ea5d2014-06-30 23:31:14 -07001797#define TAG NAME "-" MAJOR MINOR
Brett Cannon3adc7b72012-07-09 14:22:12 -04001798const char *_PySys_ImplCacheTag = TAG;
1799#undef NAME
Brett Cannon3adc7b72012-07-09 14:22:12 -04001800#undef MAJOR
1801#undef MINOR
1802#undef TAG
1803
Barry Warsaw409da152012-06-03 16:18:47 -04001804static PyObject *
1805make_impl_info(PyObject *version_info)
1806{
1807 int res;
1808 PyObject *impl_info, *value, *ns;
1809
1810 impl_info = PyDict_New();
1811 if (impl_info == NULL)
1812 return NULL;
1813
1814 /* populate the dict */
1815
Brett Cannon3adc7b72012-07-09 14:22:12 -04001816 value = PyUnicode_FromString(_PySys_ImplName);
Barry Warsaw409da152012-06-03 16:18:47 -04001817 if (value == NULL)
1818 goto error;
1819 res = PyDict_SetItemString(impl_info, "name", value);
1820 Py_DECREF(value);
1821 if (res < 0)
1822 goto error;
1823
Brett Cannon3adc7b72012-07-09 14:22:12 -04001824 value = PyUnicode_FromString(_PySys_ImplCacheTag);
Barry Warsaw409da152012-06-03 16:18:47 -04001825 if (value == NULL)
1826 goto error;
1827 res = PyDict_SetItemString(impl_info, "cache_tag", value);
1828 Py_DECREF(value);
1829 if (res < 0)
1830 goto error;
Barry Warsaw409da152012-06-03 16:18:47 -04001831
1832 res = PyDict_SetItemString(impl_info, "version", version_info);
1833 if (res < 0)
1834 goto error;
1835
1836 value = PyLong_FromLong(PY_VERSION_HEX);
1837 if (value == NULL)
1838 goto error;
1839 res = PyDict_SetItemString(impl_info, "hexversion", value);
1840 Py_DECREF(value);
1841 if (res < 0)
1842 goto error;
1843
doko@ubuntu.com55532312016-06-14 08:55:19 +02001844#ifdef MULTIARCH
1845 value = PyUnicode_FromString(MULTIARCH);
1846 if (value == NULL)
1847 goto error;
1848 res = PyDict_SetItemString(impl_info, "_multiarch", value);
1849 Py_DECREF(value);
1850 if (res < 0)
1851 goto error;
1852#endif
1853
Barry Warsaw409da152012-06-03 16:18:47 -04001854 /* dict ready */
1855
1856 ns = _PyNamespace_New(impl_info);
1857 Py_DECREF(impl_info);
1858 return ns;
1859
1860error:
1861 Py_CLEAR(impl_info);
1862 return NULL;
1863}
1864
Martin v. Löwis1a214512008-06-11 05:26:20 +00001865static struct PyModuleDef sysmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001866 PyModuleDef_HEAD_INIT,
1867 "sys",
1868 sys_doc,
1869 -1, /* multiple "initialization" just copies the module dict. */
1870 sys_methods,
1871 NULL,
1872 NULL,
1873 NULL,
1874 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00001875};
1876
Guido van Rossum25ce5661997-08-02 03:10:38 +00001877PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001878_PySys_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001879{
Victor Stinner58049602013-07-22 22:40:00 +02001880 PyObject *m, *sysdict, *version_info;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02001881 int res;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001882
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001883 m = PyModule_Create(&sysmodule);
1884 if (m == NULL)
1885 return NULL;
1886 sysdict = PyModule_GetDict(m);
Victor Stinner8fea2522013-10-27 17:15:42 +01001887#define SET_SYS_FROM_STRING_BORROW(key, value) \
Victor Stinner58049602013-07-22 22:40:00 +02001888 do { \
Victor Stinner58049602013-07-22 22:40:00 +02001889 PyObject *v = (value); \
1890 if (v == NULL) \
1891 return NULL; \
1892 res = PyDict_SetItemString(sysdict, key, v); \
1893 if (res < 0) { \
Victor Stinner8fea2522013-10-27 17:15:42 +01001894 return NULL; \
1895 } \
1896 } while (0)
1897#define SET_SYS_FROM_STRING(key, value) \
1898 do { \
Victor Stinner8fea2522013-10-27 17:15:42 +01001899 PyObject *v = (value); \
1900 if (v == NULL) \
1901 return NULL; \
1902 res = PyDict_SetItemString(sysdict, key, v); \
1903 Py_DECREF(v); \
1904 if (res < 0) { \
Victor Stinner58049602013-07-22 22:40:00 +02001905 return NULL; \
1906 } \
1907 } while (0)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001909 /* Check that stdin is not a directory
1910 Using shell redirection, you can redirect stdin to a directory,
1911 crashing the Python interpreter. Catch this common mistake here
1912 and output a useful error message. Note that under MS Windows,
1913 the shell already prevents that. */
Martin v. Löwisec59d042009-01-12 07:59:10 +00001914#if !defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001915 {
Steve Dowerf2f373f2015-02-21 08:44:05 -08001916 struct _Py_stat_struct sb;
Victor Stinnere134a7f2015-03-30 10:09:31 +02001917 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001918 S_ISDIR(sb.st_mode)) {
1919 /* There's nothing more we can do. */
1920 /* Py_FatalError() will core dump, so just exit. */
1921 PySys_WriteStderr("Python error: <stdin> is a directory, cannot continue\n");
1922 exit(EXIT_FAILURE);
1923 }
1924 }
Martin v. Löwisec59d042009-01-12 07:59:10 +00001925#endif
Neal Norwitz11bd1192005-10-03 00:54:56 +00001926
Nick Coghland6009512014-11-20 21:39:37 +10001927 /* stdin/stdout/stderr are set in pylifecycle.c */
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001928
Victor Stinner8fea2522013-10-27 17:15:42 +01001929 SET_SYS_FROM_STRING_BORROW("__displayhook__",
1930 PyDict_GetItemString(sysdict, "displayhook"));
1931 SET_SYS_FROM_STRING_BORROW("__excepthook__",
1932 PyDict_GetItemString(sysdict, "excepthook"));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001933 SET_SYS_FROM_STRING("version",
1934 PyUnicode_FromString(Py_GetVersion()));
1935 SET_SYS_FROM_STRING("hexversion",
1936 PyLong_FromLong(PY_VERSION_HEX));
Georg Brandl1ca2e792011-03-05 20:51:24 +01001937 SET_SYS_FROM_STRING("_mercurial",
1938 Py_BuildValue("(szz)", "CPython", _Py_hgidentifier(),
1939 _Py_hgversion()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001940 SET_SYS_FROM_STRING("dont_write_bytecode",
1941 PyBool_FromLong(Py_DontWriteBytecodeFlag));
1942 SET_SYS_FROM_STRING("api_version",
1943 PyLong_FromLong(PYTHON_API_VERSION));
1944 SET_SYS_FROM_STRING("copyright",
1945 PyUnicode_FromString(Py_GetCopyright()));
1946 SET_SYS_FROM_STRING("platform",
1947 PyUnicode_FromString(Py_GetPlatform()));
1948 SET_SYS_FROM_STRING("executable",
1949 PyUnicode_FromWideChar(
1950 Py_GetProgramFullPath(), -1));
1951 SET_SYS_FROM_STRING("prefix",
1952 PyUnicode_FromWideChar(Py_GetPrefix(), -1));
1953 SET_SYS_FROM_STRING("exec_prefix",
1954 PyUnicode_FromWideChar(Py_GetExecPrefix(), -1));
Vinay Sajip7ded1f02012-05-26 03:45:29 +01001955 SET_SYS_FROM_STRING("base_prefix",
1956 PyUnicode_FromWideChar(Py_GetPrefix(), -1));
1957 SET_SYS_FROM_STRING("base_exec_prefix",
1958 PyUnicode_FromWideChar(Py_GetExecPrefix(), -1));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001959 SET_SYS_FROM_STRING("maxsize",
1960 PyLong_FromSsize_t(PY_SSIZE_T_MAX));
1961 SET_SYS_FROM_STRING("float_info",
1962 PyFloat_GetInfo());
1963 SET_SYS_FROM_STRING("int_info",
1964 PyLong_GetInfo());
Mark Dickinsondc787d22010-05-23 13:33:13 +00001965 /* initialize hash_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02001966 if (Hash_InfoType.tp_name == NULL) {
1967 if (PyStructSequence_InitType2(&Hash_InfoType, &hash_info_desc) < 0)
1968 return NULL;
1969 }
Mark Dickinsondc787d22010-05-23 13:33:13 +00001970 SET_SYS_FROM_STRING("hash_info",
1971 get_hash_info());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001972 SET_SYS_FROM_STRING("maxunicode",
Ezio Melotti48a2f8f2011-09-29 00:18:19 +03001973 PyLong_FromLong(0x10FFFF));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001974 SET_SYS_FROM_STRING("builtin_module_names",
1975 list_builtin_module_names());
Christian Heimes743e0cd2012-10-17 23:52:17 +02001976#if PY_BIG_ENDIAN
1977 SET_SYS_FROM_STRING("byteorder",
1978 PyUnicode_FromString("big"));
1979#else
1980 SET_SYS_FROM_STRING("byteorder",
1981 PyUnicode_FromString("little"));
1982#endif
Fred Drake099325e2000-08-14 15:47:03 +00001983
Guido van Rossum8b9ea871996-08-23 18:14:47 +00001984#ifdef MS_COREDLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001985 SET_SYS_FROM_STRING("dllhandle",
1986 PyLong_FromVoidPtr(PyWin_DLLhModule));
1987 SET_SYS_FROM_STRING("winver",
1988 PyUnicode_FromString(PyWin_DLLVersionString));
Guido van Rossumc606fe11996-04-09 02:37:57 +00001989#endif
Barry Warsaw8cf4eae2010-10-16 01:04:07 +00001990#ifdef ABIFLAGS
1991 SET_SYS_FROM_STRING("abiflags",
1992 PyUnicode_FromString(ABIFLAGS));
1993#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001994 if (warnoptions == NULL) {
1995 warnoptions = PyList_New(0);
Victor Stinner58049602013-07-22 22:40:00 +02001996 if (warnoptions == NULL)
1997 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001998 }
1999 else {
2000 Py_INCREF(warnoptions);
2001 }
Victor Stinner8fea2522013-10-27 17:15:42 +01002002 SET_SYS_FROM_STRING_BORROW("warnoptions", warnoptions);
Tim Peters216b78b2006-01-06 02:40:53 +00002003
Victor Stinner8fea2522013-10-27 17:15:42 +01002004 SET_SYS_FROM_STRING_BORROW("_xoptions", get_xoptions());
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002005
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002006 /* version_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002007 if (VersionInfoType.tp_name == NULL) {
2008 if (PyStructSequence_InitType2(&VersionInfoType,
2009 &version_info_desc) < 0)
2010 return NULL;
2011 }
Barry Warsaw409da152012-06-03 16:18:47 -04002012 version_info = make_version_info();
2013 SET_SYS_FROM_STRING("version_info", version_info);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002014 /* prevent user from creating new instances */
2015 VersionInfoType.tp_init = NULL;
2016 VersionInfoType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02002017 res = PyDict_DelItemString(VersionInfoType.tp_dict, "__new__");
2018 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
2019 PyErr_Clear();
Eric Smith0e5b5622009-02-06 01:32:42 +00002020
Barry Warsaw409da152012-06-03 16:18:47 -04002021 /* implementation */
2022 SET_SYS_FROM_STRING("implementation", make_impl_info(version_info));
2023
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002024 /* flags */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002025 if (FlagsType.tp_name == 0) {
2026 if (PyStructSequence_InitType2(&FlagsType, &flags_desc) < 0)
2027 return NULL;
2028 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002029 SET_SYS_FROM_STRING("flags", make_flags());
2030 /* prevent user from creating new instances */
2031 FlagsType.tp_init = NULL;
2032 FlagsType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02002033 res = PyDict_DelItemString(FlagsType.tp_dict, "__new__");
2034 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
2035 PyErr_Clear();
Eric Smithf7bb5782010-01-27 00:44:57 +00002036
2037#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002038 /* getwindowsversion */
2039 if (WindowsVersionType.tp_name == 0)
Victor Stinner1c8f0592013-07-22 22:24:54 +02002040 if (PyStructSequence_InitType2(&WindowsVersionType,
2041 &windows_version_desc) < 0)
2042 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002043 /* prevent user from creating new instances */
2044 WindowsVersionType.tp_init = NULL;
2045 WindowsVersionType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02002046 res = PyDict_DelItemString(WindowsVersionType.tp_dict, "__new__");
2047 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
2048 PyErr_Clear();
Eric Smithf7bb5782010-01-27 00:44:57 +00002049#endif
2050
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002051 /* float repr style: 0.03 (short) vs 0.029999999999999999 (legacy) */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002052#ifndef PY_NO_SHORT_FLOAT_REPR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002053 SET_SYS_FROM_STRING("float_repr_style",
2054 PyUnicode_FromString("short"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002055#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002056 SET_SYS_FROM_STRING("float_repr_style",
2057 PyUnicode_FromString("legacy"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002058#endif
2059
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002060#ifdef WITH_THREAD
2061 SET_SYS_FROM_STRING("thread_info", PyThread_GetInfo());
2062#endif
2063
Yury Selivanoveb636452016-09-08 22:01:51 -07002064 /* initialize asyncgen_hooks */
2065 if (AsyncGenHooksType.tp_name == NULL) {
2066 if (PyStructSequence_InitType2(
2067 &AsyncGenHooksType, &asyncgen_hooks_desc) < 0) {
2068 return NULL;
2069 }
2070 }
2071
Christian Heimes7b3ce6a2008-01-31 14:31:45 +00002072#undef SET_SYS_FROM_STRING
Benjamin Peterson93813432014-03-28 18:52:45 -04002073#undef SET_SYS_FROM_STRING_BORROW
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002074 if (PyErr_Occurred())
2075 return NULL;
2076 return m;
Guido van Rossum5b3138b1990-11-18 17:41:40 +00002077}
2078
Guido van Rossum65bf9f21997-04-29 18:33:38 +00002079static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00002080makepathobject(const wchar_t *path, wchar_t delim)
Guido van Rossum5b3138b1990-11-18 17:41:40 +00002081{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002082 int i, n;
2083 const wchar_t *p;
2084 PyObject *v, *w;
Tim Peters216b78b2006-01-06 02:40:53 +00002085
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002086 n = 1;
2087 p = path;
2088 while ((p = wcschr(p, delim)) != NULL) {
2089 n++;
2090 p++;
2091 }
2092 v = PyList_New(n);
2093 if (v == NULL)
2094 return NULL;
2095 for (i = 0; ; i++) {
2096 p = wcschr(path, delim);
2097 if (p == NULL)
2098 p = path + wcslen(path); /* End of string */
2099 w = PyUnicode_FromWideChar(path, (Py_ssize_t)(p - path));
2100 if (w == NULL) {
2101 Py_DECREF(v);
2102 return NULL;
2103 }
2104 PyList_SetItem(v, i, w);
2105 if (*p == '\0')
2106 break;
2107 path = p+1;
2108 }
2109 return v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002110}
2111
2112void
Martin v. Löwis790465f2008-04-05 20:41:37 +00002113PySys_SetPath(const wchar_t *path)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002114{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002115 PyObject *v;
2116 if ((v = makepathobject(path, DELIM)) == NULL)
2117 Py_FatalError("can't create sys.path");
Victor Stinnerbd303c12013-11-07 23:07:29 +01002118 if (_PySys_SetObjectId(&PyId_path, v) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002119 Py_FatalError("can't assign sys.path");
2120 Py_DECREF(v);
Guido van Rossum3f5da241990-12-20 15:06:42 +00002121}
2122
Guido van Rossum65bf9f21997-04-29 18:33:38 +00002123static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00002124makeargvobject(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00002125{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002126 PyObject *av;
2127 if (argc <= 0 || argv == NULL) {
2128 /* Ensure at least one (empty) argument is seen */
2129 static wchar_t *empty_argv[1] = {L""};
2130 argv = empty_argv;
2131 argc = 1;
2132 }
2133 av = PyList_New(argc);
2134 if (av != NULL) {
2135 int i;
2136 for (i = 0; i < argc; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002137 PyObject *v = PyUnicode_FromWideChar(argv[i], -1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002138 if (v == NULL) {
2139 Py_DECREF(av);
2140 av = NULL;
2141 break;
2142 }
2143 PyList_SetItem(av, i, v);
2144 }
2145 }
2146 return av;
Guido van Rossum3f5da241990-12-20 15:06:42 +00002147}
2148
Nick Coghland26c18a2010-08-17 13:06:11 +00002149#define _HAVE_SCRIPT_ARGUMENT(argc, argv) \
2150 (argc > 0 && argv0 != NULL && \
2151 wcscmp(argv0, L"-c") != 0 && wcscmp(argv0, L"-m") != 0)
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002152
2153static void
2154sys_update_path(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00002155{
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002156 wchar_t *argv0;
2157 wchar_t *p = NULL;
2158 Py_ssize_t n = 0;
2159 PyObject *a;
2160 PyObject *path;
2161#ifdef HAVE_READLINK
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002162 wchar_t link[MAXPATHLEN+1];
2163 wchar_t argv0copy[2*MAXPATHLEN+1];
2164 int nr = 0;
2165#endif
Guido van Rossum162e38c2003-02-19 15:25:10 +00002166#if defined(HAVE_REALPATH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002167 wchar_t fullpath[MAXPATHLEN];
Larry Hastings10108a72016-09-05 15:11:23 -07002168#elif defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002169 wchar_t fullpath[MAX_PATH];
Thomas Heller27bb71e2003-01-08 14:33:48 +00002170#endif
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002171
Victor Stinnerbd303c12013-11-07 23:07:29 +01002172 path = _PySys_GetObjectId(&PyId_path);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002173 if (path == NULL)
2174 return;
2175
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002176 argv0 = argv[0];
2177
2178#ifdef HAVE_READLINK
2179 if (_HAVE_SCRIPT_ARGUMENT(argc, argv))
2180 nr = _Py_wreadlink(argv0, link, MAXPATHLEN);
2181 if (nr > 0) {
2182 /* It's a symlink */
2183 link[nr] = '\0';
2184 if (link[0] == SEP)
2185 argv0 = link; /* Link to absolute path */
2186 else if (wcschr(link, SEP) == NULL)
2187 ; /* Link without path */
2188 else {
2189 /* Must join(dirname(argv0), link) */
2190 wchar_t *q = wcsrchr(argv0, SEP);
2191 if (q == NULL)
2192 argv0 = link; /* argv0 without path */
2193 else {
Christian Heimes60a60672013-07-22 12:53:32 +02002194 /* Must make a copy, argv0copy has room for 2 * MAXPATHLEN */
2195 wcsncpy(argv0copy, argv0, MAXPATHLEN);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002196 q = wcsrchr(argv0copy, SEP);
Christian Heimes60a60672013-07-22 12:53:32 +02002197 wcsncpy(q+1, link, MAXPATHLEN);
2198 q[MAXPATHLEN + 1] = L'\0';
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002199 argv0 = argv0copy;
2200 }
2201 }
2202 }
2203#endif /* HAVE_READLINK */
2204#if SEP == '\\' /* Special case for MS filename syntax */
2205 if (_HAVE_SCRIPT_ARGUMENT(argc, argv)) {
2206 wchar_t *q;
Larry Hastings10108a72016-09-05 15:11:23 -07002207#if defined(MS_WINDOWS)
2208 /* Replace the first element in argv with the full path. */
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002209 wchar_t *ptemp;
2210 if (GetFullPathNameW(argv0,
Victor Stinner63941882011-09-29 00:42:28 +02002211 Py_ARRAY_LENGTH(fullpath),
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002212 fullpath,
2213 &ptemp)) {
2214 argv0 = fullpath;
2215 }
2216#endif
2217 p = wcsrchr(argv0, SEP);
2218 /* Test for alternate separator */
2219 q = wcsrchr(p ? p : argv0, '/');
2220 if (q != NULL)
2221 p = q;
2222 if (p != NULL) {
2223 n = p + 1 - argv0;
2224 if (n > 1 && p[-1] != ':')
2225 n--; /* Drop trailing separator */
2226 }
2227 }
2228#else /* All other filename syntaxes */
2229 if (_HAVE_SCRIPT_ARGUMENT(argc, argv)) {
2230#if defined(HAVE_REALPATH)
Victor Stinner23847142013-11-15 17:33:43 +01002231 if (_Py_wrealpath(argv0, fullpath, Py_ARRAY_LENGTH(fullpath))) {
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002232 argv0 = fullpath;
2233 }
2234#endif
2235 p = wcsrchr(argv0, SEP);
2236 }
2237 if (p != NULL) {
2238 n = p + 1 - argv0;
2239#if SEP == '/' /* Special case for Unix filename syntax */
2240 if (n > 1)
2241 n--; /* Drop trailing separator */
2242#endif /* Unix */
2243 }
2244#endif /* All others */
2245 a = PyUnicode_FromWideChar(argv0, n);
2246 if (a == NULL)
2247 Py_FatalError("no mem for sys.path insertion");
2248 if (PyList_Insert(path, 0, a) < 0)
2249 Py_FatalError("sys.path.insert(0) failed");
2250 Py_DECREF(a);
2251}
2252
2253void
2254PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)
2255{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002256 PyObject *av = makeargvobject(argc, argv);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002257 if (av == NULL)
2258 Py_FatalError("no mem for sys.argv");
2259 if (PySys_SetObject("argv", av) != 0)
2260 Py_FatalError("can't assign sys.argv");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002261 Py_DECREF(av);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002262 if (updatepath)
2263 sys_update_path(argc, argv);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002264}
Guido van Rossuma890e681998-05-12 14:59:24 +00002265
Antoine Pitrouf978fac2010-05-21 17:25:34 +00002266void
2267PySys_SetArgv(int argc, wchar_t **argv)
2268{
Christian Heimesad73a9c2013-08-10 16:36:18 +02002269 PySys_SetArgvEx(argc, argv, Py_IsolatedFlag == 0);
Antoine Pitrouf978fac2010-05-21 17:25:34 +00002270}
2271
Victor Stinner14284c22010-04-23 12:02:30 +00002272/* Reimplementation of PyFile_WriteString() no calling indirectly
2273 PyErr_CheckSignals(): avoid the call to PyObject_Str(). */
2274
2275static int
Victor Stinner79766632010-08-16 17:36:42 +00002276sys_pyfile_write_unicode(PyObject *unicode, PyObject *file)
Victor Stinner14284c22010-04-23 12:02:30 +00002277{
Victor Stinnerc3ccaae2016-08-20 01:24:22 +02002278 PyObject *writer = NULL, *result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002279 int err;
Victor Stinner14284c22010-04-23 12:02:30 +00002280
Victor Stinnerecccc4f2010-06-08 20:46:00 +00002281 if (file == NULL)
2282 return -1;
2283
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02002284 writer = _PyObject_GetAttrId(file, &PyId_write);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002285 if (writer == NULL)
2286 goto error;
Victor Stinner14284c22010-04-23 12:02:30 +00002287
Victor Stinner559bb6a2016-08-22 22:48:54 +02002288 result = _PyObject_CallArg1(writer, unicode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002289 if (result == NULL) {
2290 goto error;
2291 } else {
2292 err = 0;
2293 goto finally;
2294 }
Victor Stinner14284c22010-04-23 12:02:30 +00002295
2296error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002297 err = -1;
Victor Stinner14284c22010-04-23 12:02:30 +00002298finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002299 Py_XDECREF(writer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002300 Py_XDECREF(result);
2301 return err;
Victor Stinner14284c22010-04-23 12:02:30 +00002302}
2303
Victor Stinner79766632010-08-16 17:36:42 +00002304static int
2305sys_pyfile_write(const char *text, PyObject *file)
2306{
2307 PyObject *unicode = NULL;
2308 int err;
2309
2310 if (file == NULL)
2311 return -1;
2312
2313 unicode = PyUnicode_FromString(text);
2314 if (unicode == NULL)
2315 return -1;
2316
2317 err = sys_pyfile_write_unicode(unicode, file);
2318 Py_DECREF(unicode);
2319 return err;
2320}
Guido van Rossuma890e681998-05-12 14:59:24 +00002321
2322/* APIs to write to sys.stdout or sys.stderr using a printf-like interface.
2323 Adapted from code submitted by Just van Rossum.
2324
2325 PySys_WriteStdout(format, ...)
2326 PySys_WriteStderr(format, ...)
2327
2328 The first function writes to sys.stdout; the second to sys.stderr. When
2329 there is a problem, they write to the real (C level) stdout or stderr;
Guido van Rossum8442af31998-10-12 18:22:10 +00002330 no exceptions are raised.
Guido van Rossuma890e681998-05-12 14:59:24 +00002331
Victor Stinner14284c22010-04-23 12:02:30 +00002332 PyErr_CheckSignals() is not called to avoid the execution of the Python
Victor Stinner79766632010-08-16 17:36:42 +00002333 signal handlers: they may raise a new exception whereas sys_write()
2334 ignores all exceptions.
Victor Stinner14284c22010-04-23 12:02:30 +00002335
Guido van Rossuma890e681998-05-12 14:59:24 +00002336 Both take a printf-style format string as their first argument followed
2337 by a variable length argument list determined by the format string.
2338
2339 *** WARNING ***
2340
2341 The format should limit the total size of the formatted output string to
2342 1000 bytes. In particular, this means that no unrestricted "%s" formats
2343 should occur; these should be limited using "%.<N>s where <N> is a
2344 decimal number calculated so that <N> plus the maximum size of other
2345 formatted text does not exceed 1000 bytes. Also watch out for "%f",
2346 which can print hundreds of digits for very large numbers.
2347
2348 */
2349
2350static void
Victor Stinner09054372013-11-06 22:41:44 +01002351sys_write(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Guido van Rossuma890e681998-05-12 14:59:24 +00002352{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002353 PyObject *file;
2354 PyObject *error_type, *error_value, *error_traceback;
2355 char buffer[1001];
2356 int written;
Guido van Rossuma890e681998-05-12 14:59:24 +00002357
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002358 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Victor Stinner09054372013-11-06 22:41:44 +01002359 file = _PySys_GetObjectId(key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002360 written = PyOS_vsnprintf(buffer, sizeof(buffer), format, va);
2361 if (sys_pyfile_write(buffer, file) != 0) {
2362 PyErr_Clear();
2363 fputs(buffer, fp);
2364 }
2365 if (written < 0 || (size_t)written >= sizeof(buffer)) {
2366 const char *truncated = "... truncated";
Victor Stinner79766632010-08-16 17:36:42 +00002367 if (sys_pyfile_write(truncated, file) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002368 fputs(truncated, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002369 }
2370 PyErr_Restore(error_type, error_value, error_traceback);
Guido van Rossuma890e681998-05-12 14:59:24 +00002371}
2372
2373void
Guido van Rossuma890e681998-05-12 14:59:24 +00002374PySys_WriteStdout(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00002375{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002376 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00002377
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002378 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002379 sys_write(&PyId_stdout, stdout, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002380 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00002381}
2382
2383void
Guido van Rossuma890e681998-05-12 14:59:24 +00002384PySys_WriteStderr(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00002385{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002386 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00002387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002388 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002389 sys_write(&PyId_stderr, stderr, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00002390 va_end(va);
2391}
2392
2393static void
Victor Stinner09054372013-11-06 22:41:44 +01002394sys_format(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Victor Stinner79766632010-08-16 17:36:42 +00002395{
2396 PyObject *file, *message;
2397 PyObject *error_type, *error_value, *error_traceback;
2398 char *utf8;
2399
2400 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Victor Stinner09054372013-11-06 22:41:44 +01002401 file = _PySys_GetObjectId(key);
Victor Stinner79766632010-08-16 17:36:42 +00002402 message = PyUnicode_FromFormatV(format, va);
2403 if (message != NULL) {
2404 if (sys_pyfile_write_unicode(message, file) != 0) {
2405 PyErr_Clear();
2406 utf8 = _PyUnicode_AsString(message);
2407 if (utf8 != NULL)
2408 fputs(utf8, fp);
2409 }
2410 Py_DECREF(message);
2411 }
2412 PyErr_Restore(error_type, error_value, error_traceback);
2413}
2414
2415void
2416PySys_FormatStdout(const char *format, ...)
2417{
2418 va_list va;
2419
2420 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002421 sys_format(&PyId_stdout, stdout, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00002422 va_end(va);
2423}
2424
2425void
2426PySys_FormatStderr(const char *format, ...)
2427{
2428 va_list va;
2429
2430 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002431 sys_format(&PyId_stderr, stderr, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002432 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00002433}