blob: b7afe93ca5f58e3b73305484d5622910dfb14bf0 [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
Tim Peterse5e065b2003-07-06 18:36:54 +0000612static PyObject *
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000613sys_setrecursionlimit(PyObject *self, PyObject *args)
614{
Victor Stinner50856d52015-10-13 00:11:21 +0200615 int new_limit, mark;
616 PyThreadState *tstate;
617
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000618 if (!PyArg_ParseTuple(args, "i:setrecursionlimit", &new_limit))
619 return NULL;
Victor Stinner50856d52015-10-13 00:11:21 +0200620
621 if (new_limit < 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000622 PyErr_SetString(PyExc_ValueError,
Victor Stinner50856d52015-10-13 00:11:21 +0200623 "recursion limit must be greater or equal than 1");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000624 return NULL;
625 }
Victor Stinner50856d52015-10-13 00:11:21 +0200626
627 /* Issue #25274: When the recursion depth hits the recursion limit in
628 _Py_CheckRecursiveCall(), the overflowed flag of the thread state is
629 set to 1 and a RecursionError is raised. The overflowed flag is reset
630 to 0 when the recursion depth goes below the low-water mark: see
631 Py_LeaveRecursiveCall().
632
633 Reject too low new limit if the current recursion depth is higher than
634 the new low-water mark. Otherwise it may not be possible anymore to
635 reset the overflowed flag to 0. */
636 mark = _Py_RecursionLimitLowerWaterMark(new_limit);
637 tstate = PyThreadState_GET();
638 if (tstate->recursion_depth >= mark) {
639 PyErr_Format(PyExc_RecursionError,
640 "cannot set the recursion limit to %i at "
641 "the recursion depth %i: the limit is too low",
642 new_limit, tstate->recursion_depth);
643 return NULL;
644 }
645
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000646 Py_SetRecursionLimit(new_limit);
647 Py_INCREF(Py_None);
648 return Py_None;
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000649}
650
Yury Selivanov75445082015-05-11 22:57:16 -0400651static PyObject *
652sys_set_coroutine_wrapper(PyObject *self, PyObject *wrapper)
653{
654 if (wrapper != Py_None) {
655 if (!PyCallable_Check(wrapper)) {
656 PyErr_Format(PyExc_TypeError,
657 "callable expected, got %.50s",
658 Py_TYPE(wrapper)->tp_name);
659 return NULL;
660 }
Yury Selivanovd8cf3822015-06-01 12:15:23 -0400661 _PyEval_SetCoroutineWrapper(wrapper);
Yury Selivanov75445082015-05-11 22:57:16 -0400662 }
Benjamin Petersonbaa2e562015-05-12 11:32:41 -0400663 else {
Yury Selivanovd8cf3822015-06-01 12:15:23 -0400664 _PyEval_SetCoroutineWrapper(NULL);
Benjamin Petersonbaa2e562015-05-12 11:32:41 -0400665 }
Yury Selivanov75445082015-05-11 22:57:16 -0400666 Py_RETURN_NONE;
667}
668
669PyDoc_STRVAR(set_coroutine_wrapper_doc,
670"set_coroutine_wrapper(wrapper)\n\
671\n\
672Set a wrapper for coroutine objects."
673);
674
675static PyObject *
676sys_get_coroutine_wrapper(PyObject *self, PyObject *args)
677{
Yury Selivanovd8cf3822015-06-01 12:15:23 -0400678 PyObject *wrapper = _PyEval_GetCoroutineWrapper();
Yury Selivanov75445082015-05-11 22:57:16 -0400679 if (wrapper == NULL) {
680 wrapper = Py_None;
681 }
682 Py_INCREF(wrapper);
683 return wrapper;
684}
685
686PyDoc_STRVAR(get_coroutine_wrapper_doc,
687"get_coroutine_wrapper()\n\
688\n\
689Return the wrapper for coroutine objects set by sys.set_coroutine_wrapper."
690);
691
692
Yury Selivanoveb636452016-09-08 22:01:51 -0700693static PyTypeObject AsyncGenHooksType;
694
695PyDoc_STRVAR(asyncgen_hooks_doc,
696"asyncgen_hooks\n\
697\n\
698A struct sequence providing information about asynhronous\n\
699generators hooks. The attributes are read only.");
700
701static PyStructSequence_Field asyncgen_hooks_fields[] = {
702 {"firstiter", "Hook to intercept first iteration"},
703 {"finalizer", "Hook to intercept finalization"},
704 {0}
705};
706
707static PyStructSequence_Desc asyncgen_hooks_desc = {
708 "asyncgen_hooks", /* name */
709 asyncgen_hooks_doc, /* doc */
710 asyncgen_hooks_fields , /* fields */
711 2
712};
713
714
715static PyObject *
716sys_set_asyncgen_hooks(PyObject *self, PyObject *args, PyObject *kw)
717{
718 static char *keywords[] = {"firstiter", "finalizer", NULL};
719 PyObject *firstiter = NULL;
720 PyObject *finalizer = NULL;
721
722 if (!PyArg_ParseTupleAndKeywords(
723 args, kw, "|OO", keywords,
724 &firstiter, &finalizer)) {
725 return NULL;
726 }
727
728 if (finalizer && finalizer != Py_None) {
729 if (!PyCallable_Check(finalizer)) {
730 PyErr_Format(PyExc_TypeError,
731 "callable finalizer expected, got %.50s",
732 Py_TYPE(finalizer)->tp_name);
733 return NULL;
734 }
735 _PyEval_SetAsyncGenFinalizer(finalizer);
736 }
737 else if (finalizer == Py_None) {
738 _PyEval_SetAsyncGenFinalizer(NULL);
739 }
740
741 if (firstiter && firstiter != Py_None) {
742 if (!PyCallable_Check(firstiter)) {
743 PyErr_Format(PyExc_TypeError,
744 "callable firstiter expected, got %.50s",
745 Py_TYPE(firstiter)->tp_name);
746 return NULL;
747 }
748 _PyEval_SetAsyncGenFirstiter(firstiter);
749 }
750 else if (firstiter == Py_None) {
751 _PyEval_SetAsyncGenFirstiter(NULL);
752 }
753
754 Py_RETURN_NONE;
755}
756
757PyDoc_STRVAR(set_asyncgen_hooks_doc,
758"set_asyncgen_hooks(*, firstiter=None, finalizer=None)\n\
759\n\
760Set a finalizer for async generators objects."
761);
762
763static PyObject *
764sys_get_asyncgen_hooks(PyObject *self, PyObject *args)
765{
766 PyObject *res;
767 PyObject *firstiter = _PyEval_GetAsyncGenFirstiter();
768 PyObject *finalizer = _PyEval_GetAsyncGenFinalizer();
769
770 res = PyStructSequence_New(&AsyncGenHooksType);
771 if (res == NULL) {
772 return NULL;
773 }
774
775 if (firstiter == NULL) {
776 firstiter = Py_None;
777 }
778
779 if (finalizer == NULL) {
780 finalizer = Py_None;
781 }
782
783 Py_INCREF(firstiter);
784 PyStructSequence_SET_ITEM(res, 0, firstiter);
785
786 Py_INCREF(finalizer);
787 PyStructSequence_SET_ITEM(res, 1, finalizer);
788
789 return res;
790}
791
792PyDoc_STRVAR(get_asyncgen_hooks_doc,
793"get_asyncgen_hooks()\n\
794\n\
795Return a namedtuple of installed asynchronous generators hooks \
796(firstiter, finalizer)."
797);
798
799
Mark Dickinsondc787d22010-05-23 13:33:13 +0000800static PyTypeObject Hash_InfoType;
801
802PyDoc_STRVAR(hash_info_doc,
803"hash_info\n\
804\n\
805A struct sequence providing parameters used for computing\n\
Christian Heimes985ecdc2013-11-20 11:46:18 +0100806hashes. The attributes are read only.");
Mark Dickinsondc787d22010-05-23 13:33:13 +0000807
808static PyStructSequence_Field hash_info_fields[] = {
809 {"width", "width of the type used for hashing, in bits"},
810 {"modulus", "prime number giving the modulus on which the hash "
811 "function is based"},
812 {"inf", "value to be used for hash of a positive infinity"},
813 {"nan", "value to be used for hash of a nan"},
814 {"imag", "multiplier used for the imaginary part of a complex number"},
Christian Heimes985ecdc2013-11-20 11:46:18 +0100815 {"algorithm", "name of the algorithm for hashing of str, bytes and "
816 "memoryviews"},
817 {"hash_bits", "internal output size of hash algorithm"},
818 {"seed_bits", "seed size of hash algorithm"},
819 {"cutoff", "small string optimization cutoff"},
Mark Dickinsondc787d22010-05-23 13:33:13 +0000820 {NULL, NULL}
821};
822
823static PyStructSequence_Desc hash_info_desc = {
824 "sys.hash_info",
825 hash_info_doc,
826 hash_info_fields,
Christian Heimes985ecdc2013-11-20 11:46:18 +0100827 9,
Mark Dickinsondc787d22010-05-23 13:33:13 +0000828};
829
Matthias Klosed885e952010-07-06 10:53:30 +0000830static PyObject *
Mark Dickinsondc787d22010-05-23 13:33:13 +0000831get_hash_info(void)
832{
833 PyObject *hash_info;
834 int field = 0;
Christian Heimes985ecdc2013-11-20 11:46:18 +0100835 PyHash_FuncDef *hashfunc;
Mark Dickinsondc787d22010-05-23 13:33:13 +0000836 hash_info = PyStructSequence_New(&Hash_InfoType);
837 if (hash_info == NULL)
838 return NULL;
Christian Heimes985ecdc2013-11-20 11:46:18 +0100839 hashfunc = PyHash_GetFuncDef();
Mark Dickinsondc787d22010-05-23 13:33:13 +0000840 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000841 PyLong_FromLong(8*sizeof(Py_hash_t)));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000842 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000843 PyLong_FromSsize_t(_PyHASH_MODULUS));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000844 PyStructSequence_SET_ITEM(hash_info, field++,
845 PyLong_FromLong(_PyHASH_INF));
846 PyStructSequence_SET_ITEM(hash_info, field++,
847 PyLong_FromLong(_PyHASH_NAN));
848 PyStructSequence_SET_ITEM(hash_info, field++,
849 PyLong_FromLong(_PyHASH_IMAG));
Christian Heimes985ecdc2013-11-20 11:46:18 +0100850 PyStructSequence_SET_ITEM(hash_info, field++,
851 PyUnicode_FromString(hashfunc->name));
852 PyStructSequence_SET_ITEM(hash_info, field++,
853 PyLong_FromLong(hashfunc->hash_bits));
854 PyStructSequence_SET_ITEM(hash_info, field++,
855 PyLong_FromLong(hashfunc->seed_bits));
856 PyStructSequence_SET_ITEM(hash_info, field++,
857 PyLong_FromLong(Py_HASH_CUTOFF));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000858 if (PyErr_Occurred()) {
859 Py_CLEAR(hash_info);
860 return NULL;
861 }
862 return hash_info;
863}
864
865
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000866PyDoc_STRVAR(setrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000867"setrecursionlimit(n)\n\
868\n\
869Set the maximum depth of the Python interpreter stack to n. This\n\
870limit prevents infinite recursion from causing an overflow of the C\n\
871stack and crashing Python. The highest possible limit is platform-\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000872dependent."
873);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000874
875static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000876sys_getrecursionlimit(PyObject *self)
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000877{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000878 return PyLong_FromLong(Py_GetRecursionLimit());
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000879}
880
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000881PyDoc_STRVAR(getrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000882"getrecursionlimit()\n\
883\n\
884Return the current value of the recursion limit, the maximum depth\n\
885of the Python interpreter stack. This limit prevents infinite\n\
Jack Jansene739a0d2002-06-26 20:39:20 +0000886recursion from causing an overflow of the C stack and crashing Python."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000887);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000888
Mark Hammond8696ebc2002-10-08 02:44:31 +0000889#ifdef MS_WINDOWS
890PyDoc_STRVAR(getwindowsversion_doc,
891"getwindowsversion()\n\
892\n\
Eric Smithf7bb5782010-01-27 00:44:57 +0000893Return information about the running version of Windows as a named tuple.\n\
894The members are named: major, minor, build, platform, service_pack,\n\
895service_pack_major, service_pack_minor, suite_mask, and product_type. For\n\
Ezio Melotti4969f702011-03-15 05:59:46 +0200896backward compatibility, only the first 5 items are available by indexing.\n\
Eric Smithf7bb5782010-01-27 00:44:57 +0000897All elements are numbers, except service_pack which is a string. Platform\n\
898may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7,\n\
8993 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain\n\
900controller, 3 for a server."
Mark Hammond8696ebc2002-10-08 02:44:31 +0000901);
902
Eric Smithf7bb5782010-01-27 00:44:57 +0000903static PyTypeObject WindowsVersionType = {0, 0, 0, 0, 0, 0};
904
905static PyStructSequence_Field windows_version_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000906 {"major", "Major version number"},
907 {"minor", "Minor version number"},
908 {"build", "Build number"},
909 {"platform", "Operating system platform"},
910 {"service_pack", "Latest Service Pack installed on the system"},
911 {"service_pack_major", "Service Pack major version number"},
912 {"service_pack_minor", "Service Pack minor version number"},
913 {"suite_mask", "Bit mask identifying available product suites"},
914 {"product_type", "System product type"},
915 {0}
Eric Smithf7bb5782010-01-27 00:44:57 +0000916};
917
918static PyStructSequence_Desc windows_version_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000919 "sys.getwindowsversion", /* name */
920 getwindowsversion_doc, /* doc */
921 windows_version_fields, /* fields */
922 5 /* For backward compatibility,
923 only the first 5 items are accessible
924 via indexing, the rest are name only */
Eric Smithf7bb5782010-01-27 00:44:57 +0000925};
926
Steve Dower3e96f322015-03-02 08:01:10 -0800927/* Disable deprecation warnings about GetVersionEx as the result is
928 being passed straight through to the caller, who is responsible for
929 using it correctly. */
930#pragma warning(push)
931#pragma warning(disable:4996)
932
Mark Hammond8696ebc2002-10-08 02:44:31 +0000933static PyObject *
934sys_getwindowsversion(PyObject *self)
935{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000936 PyObject *version;
937 int pos = 0;
938 OSVERSIONINFOEX ver;
939 ver.dwOSVersionInfoSize = sizeof(ver);
940 if (!GetVersionEx((OSVERSIONINFO*) &ver))
941 return PyErr_SetFromWindowsErr(0);
Eric Smithf7bb5782010-01-27 00:44:57 +0000942
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000943 version = PyStructSequence_New(&WindowsVersionType);
944 if (version == NULL)
945 return NULL;
Eric Smithf7bb5782010-01-27 00:44:57 +0000946
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000947 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMajorVersion));
948 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMinorVersion));
949 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwBuildNumber));
950 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwPlatformId));
951 PyStructSequence_SET_ITEM(version, pos++, PyUnicode_FromString(ver.szCSDVersion));
952 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMajor));
953 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMinor));
954 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wSuiteMask));
955 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wProductType));
Eric Smithf7bb5782010-01-27 00:44:57 +0000956
Serhiy Storchaka48d761e2013-12-17 15:11:24 +0200957 if (PyErr_Occurred()) {
958 Py_DECREF(version);
959 return NULL;
960 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000961 return version;
Mark Hammond8696ebc2002-10-08 02:44:31 +0000962}
963
Steve Dower3e96f322015-03-02 08:01:10 -0800964#pragma warning(pop)
965
Steve Dowercc16be82016-09-08 10:35:16 -0700966PyDoc_STRVAR(enablelegacywindowsfsencoding_doc,
967"_enablelegacywindowsfsencoding()\n\
968\n\
969Changes the default filesystem encoding to mbcs:replace for consistency\n\
970with earlier versions of Python. See PEP 529 for more information.\n\
971\n\
972This is equivalent to defining the PYTHONLEGACYWINDOWSFSENCODING \n\
973environment variable before launching Python."
974);
975
976static PyObject *
977sys_enablelegacywindowsfsencoding(PyObject *self)
978{
979 Py_FileSystemDefaultEncoding = "mbcs";
980 Py_FileSystemDefaultEncodeErrors = "replace";
981 Py_RETURN_NONE;
982}
983
Mark Hammond8696ebc2002-10-08 02:44:31 +0000984#endif /* MS_WINDOWS */
985
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000986#ifdef HAVE_DLOPEN
987static PyObject *
988sys_setdlopenflags(PyObject *self, PyObject *args)
989{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000990 int new_val;
991 PyThreadState *tstate = PyThreadState_GET();
992 if (!PyArg_ParseTuple(args, "i:setdlopenflags", &new_val))
993 return NULL;
994 if (!tstate)
995 return NULL;
996 tstate->interp->dlopenflags = new_val;
997 Py_INCREF(Py_None);
998 return Py_None;
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000999}
1000
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001001PyDoc_STRVAR(setdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001002"setdlopenflags(n) -> None\n\
1003\n\
Alexandre Vassalotti260484d2009-07-17 11:43:26 +00001004Set the flags used by the interpreter for dlopen calls, such as when the\n\
1005interpreter loads extension modules. Among other things, this will enable\n\
1006a lazy resolving of symbols when importing a module, if called as\n\
1007sys.setdlopenflags(0). To share symbols across extension modules, call as\n\
Andrew Kuchlingc61b9132013-06-21 10:58:41 -04001008sys.setdlopenflags(os.RTLD_GLOBAL). Symbolic names for the flag modules\n\
Victor Stinnerf4afa432011-10-31 11:48:09 +01001009can be found in the os module (RTLD_xxx constants, e.g. os.RTLD_LAZY).");
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001010
1011static PyObject *
1012sys_getdlopenflags(PyObject *self, PyObject *args)
1013{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001014 PyThreadState *tstate = PyThreadState_GET();
1015 if (!tstate)
1016 return NULL;
1017 return PyLong_FromLong(tstate->interp->dlopenflags);
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001018}
1019
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001020PyDoc_STRVAR(getdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001021"getdlopenflags() -> int\n\
1022\n\
Alexandre Vassalotti260484d2009-07-17 11:43:26 +00001023Return the current value of the flags that are used for dlopen calls.\n\
Andrew Kuchlingc61b9132013-06-21 10:58:41 -04001024The flag constants are defined in the os module.");
Alexandre Vassalotti260484d2009-07-17 11:43:26 +00001025
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001026#endif /* HAVE_DLOPEN */
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001027
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001028#ifdef USE_MALLOPT
1029/* Link with -lmalloc (or -lmpc) on an SGI */
1030#include <malloc.h>
1031
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001032static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001033sys_mdebug(PyObject *self, PyObject *args)
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001034{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001035 int flag;
1036 if (!PyArg_ParseTuple(args, "i:mdebug", &flag))
1037 return NULL;
1038 mallopt(M_DEBUG, flag);
1039 Py_INCREF(Py_None);
1040 return Py_None;
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001041}
1042#endif /* USE_MALLOPT */
1043
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001044size_t
1045_PySys_GetSizeOf(PyObject *o)
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001046{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001047 PyObject *res = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001048 PyObject *method;
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001049 Py_ssize_t size;
Benjamin Petersona5758c02009-05-09 18:15:04 +00001050
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001051 /* Make sure the type is initialized. float gets initialized late */
1052 if (PyType_Ready(Py_TYPE(o)) < 0)
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001053 return (size_t)-1;
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +00001054
Benjamin Petersonce798522012-01-22 11:24:29 -05001055 method = _PyObject_LookupSpecial(o, &PyId___sizeof__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001056 if (method == NULL) {
1057 if (!PyErr_Occurred())
1058 PyErr_Format(PyExc_TypeError,
1059 "Type %.100s doesn't define __sizeof__",
1060 Py_TYPE(o)->tp_name);
1061 }
1062 else {
1063 res = PyObject_CallFunctionObjArgs(method, NULL);
1064 Py_DECREF(method);
1065 }
1066
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001067 if (res == NULL)
1068 return (size_t)-1;
1069
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001070 size = PyLong_AsSsize_t(res);
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001071 Py_DECREF(res);
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001072 if (size == -1 && PyErr_Occurred())
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001073 return (size_t)-1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001074
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001075 if (size < 0) {
1076 PyErr_SetString(PyExc_ValueError, "__sizeof__() should return >= 0");
1077 return (size_t)-1;
1078 }
1079
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001080 /* add gc_head size */
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001081 if (PyObject_IS_GC(o))
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001082 return ((size_t)size) + sizeof(PyGC_Head);
1083 return (size_t)size;
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001084}
1085
1086static PyObject *
1087sys_getsizeof(PyObject *self, PyObject *args, PyObject *kwds)
1088{
1089 static char *kwlist[] = {"object", "default", 0};
1090 size_t size;
1091 PyObject *o, *dflt = NULL;
1092
1093 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|O:getsizeof",
1094 kwlist, &o, &dflt))
1095 return NULL;
1096
1097 size = _PySys_GetSizeOf(o);
1098
1099 if (size == (size_t)-1 && PyErr_Occurred()) {
1100 /* Has a default value been given */
1101 if (dflt != NULL && PyErr_ExceptionMatches(PyExc_TypeError)) {
1102 PyErr_Clear();
1103 Py_INCREF(dflt);
1104 return dflt;
1105 }
1106 else
1107 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001108 }
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001109
1110 return PyLong_FromSize_t(size);
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001111}
1112
1113PyDoc_STRVAR(getsizeof_doc,
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +00001114"getsizeof(object, default) -> int\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001115\n\
1116Return the size of object in bytes.");
1117
1118static PyObject *
Fred Drakea7688822001-10-24 20:47:48 +00001119sys_getrefcount(PyObject *self, PyObject *arg)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001120{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001121 return PyLong_FromSsize_t(arg->ob_refcnt);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001122}
1123
Tim Peters4be93d02002-07-07 19:59:50 +00001124#ifdef Py_REF_DEBUG
Mark Hammond440d8982000-06-20 08:12:48 +00001125static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001126sys_gettotalrefcount(PyObject *self)
Mark Hammond440d8982000-06-20 08:12:48 +00001127{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001128 return PyLong_FromSsize_t(_Py_GetRefTotal());
Mark Hammond440d8982000-06-20 08:12:48 +00001129}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001130#endif /* Py_REF_DEBUG */
Mark Hammond440d8982000-06-20 08:12:48 +00001131
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001132PyDoc_STRVAR(getrefcount_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001133"getrefcount(object) -> integer\n\
1134\n\
Fred Drakeba3ff1b2002-06-20 21:36:19 +00001135Return the reference count of object. The count returned is generally\n\
1136one higher than you might expect, because it includes the (temporary)\n\
1137reference as an argument to getrefcount()."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001138);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001139
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001140static PyObject *
1141sys_getallocatedblocks(PyObject *self)
1142{
1143 return PyLong_FromSsize_t(_Py_GetAllocatedBlocks());
1144}
1145
1146PyDoc_STRVAR(getallocatedblocks_doc,
1147"getallocatedblocks() -> integer\n\
1148\n\
1149Return the number of memory blocks currently allocated, regardless of their\n\
1150size."
1151);
1152
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001153#ifdef COUNT_ALLOCS
1154static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001155sys_getcounts(PyObject *self)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001156{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001157 extern PyObject *get_counts(void);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001158
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001159 return get_counts();
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001160}
1161#endif
1162
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001163PyDoc_STRVAR(getframe_doc,
Barry Warsawb6a54d22000-12-06 21:47:46 +00001164"_getframe([depth]) -> frameobject\n\
1165\n\
1166Return a frame object from the call stack. If optional integer depth is\n\
1167given, return the frame object that many calls below the top of the stack.\n\
1168If that is deeper than the call stack, ValueError is raised. The default\n\
1169for depth is zero, returning the frame at the top of the call stack.\n\
1170\n\
1171This function should be used for internal and specialized\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001172purposes only."
1173);
Barry Warsawb6a54d22000-12-06 21:47:46 +00001174
1175static PyObject *
1176sys_getframe(PyObject *self, PyObject *args)
1177{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001178 PyFrameObject *f = PyThreadState_GET()->frame;
1179 int depth = -1;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001180
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001181 if (!PyArg_ParseTuple(args, "|i:_getframe", &depth))
1182 return NULL;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001184 while (depth > 0 && f != NULL) {
1185 f = f->f_back;
1186 --depth;
1187 }
1188 if (f == NULL) {
1189 PyErr_SetString(PyExc_ValueError,
1190 "call stack is not deep enough");
1191 return NULL;
1192 }
1193 Py_INCREF(f);
1194 return (PyObject*)f;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001195}
1196
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001197PyDoc_STRVAR(current_frames_doc,
1198"_current_frames() -> dictionary\n\
1199\n\
1200Return a dictionary mapping each current thread T's thread id to T's\n\
1201current stack frame.\n\
1202\n\
1203This function should be used for specialized purposes only."
1204);
1205
1206static PyObject *
1207sys_current_frames(PyObject *self, PyObject *noargs)
1208{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001209 return _PyThread_CurrentFrames();
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001210}
1211
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001212PyDoc_STRVAR(call_tracing_doc,
1213"call_tracing(func, args) -> object\n\
1214\n\
1215Call func(*args), while tracing is enabled. The tracing state is\n\
1216saved, and restored afterwards. This is intended to be called from\n\
1217a debugger from a checkpoint, to recursively debug some other code."
1218);
1219
1220static PyObject *
1221sys_call_tracing(PyObject *self, PyObject *args)
1222{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 PyObject *func, *funcargs;
1224 if (!PyArg_ParseTuple(args, "OO!:call_tracing", &func, &PyTuple_Type, &funcargs))
1225 return NULL;
1226 return _PyEval_CallTracing(func, funcargs);
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001227}
1228
Jeremy Hylton985eba52003-02-05 23:13:00 +00001229PyDoc_STRVAR(callstats_doc,
1230"callstats() -> tuple of integers\n\
1231\n\
1232Return a tuple of function call statistics, if CALL_PROFILE was defined\n\
1233when Python was built. Otherwise, return None.\n\
1234\n\
1235When enabled, this function returns detailed, implementation-specific\n\
1236details about the number of function calls executed. The return value is\n\
1237a 11-tuple where the entries in the tuple are counts of:\n\
12380. all function calls\n\
12391. calls to PyFunction_Type objects\n\
12402. PyFunction calls that do not create an argument tuple\n\
12413. PyFunction calls that do not create an argument tuple\n\
1242 and bypass PyEval_EvalCodeEx()\n\
12434. PyMethod calls\n\
12445. PyMethod calls on bound methods\n\
12456. PyType calls\n\
12467. PyCFunction calls\n\
12478. generator calls\n\
12489. All other calls\n\
124910. Number of stack pops performed by call_function()"
1250);
Barry Warsawb6a54d22000-12-06 21:47:46 +00001251
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001252#ifdef __cplusplus
1253extern "C" {
1254#endif
1255
David Malcolm49526f42012-06-22 14:55:41 -04001256static PyObject *
1257sys_debugmallocstats(PyObject *self, PyObject *args)
1258{
1259#ifdef WITH_PYMALLOC
Victor Stinner34be807c2016-03-14 12:04:26 +01001260 if (_PyMem_PymallocEnabled()) {
1261 _PyObject_DebugMallocStats(stderr);
1262 fputc('\n', stderr);
1263 }
David Malcolm49526f42012-06-22 14:55:41 -04001264#endif
1265 _PyObject_DebugTypeStats(stderr);
1266
1267 Py_RETURN_NONE;
1268}
1269PyDoc_STRVAR(debugmallocstats_doc,
1270"_debugmallocstats()\n\
1271\n\
1272Print summary info to stderr about the state of\n\
1273pymalloc's structures.\n\
1274\n\
1275In Py_DEBUG mode, also perform some expensive internal consistency\n\
1276checks.\n\
1277");
1278
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001279#ifdef Py_TRACE_REFS
Guido van Rossumded690f1996-05-24 20:48:31 +00001280/* Defined in objects.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001281extern PyObject *_Py_GetObjects(PyObject *, PyObject *);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001282#endif
Guido van Rossumded690f1996-05-24 20:48:31 +00001283
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001284#ifdef DYNAMIC_EXECUTION_PROFILE
1285/* Defined in ceval.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001286extern PyObject *_Py_GetDXProfile(PyObject *, PyObject *);
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001287#endif
1288
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001289#ifdef __cplusplus
1290}
1291#endif
1292
Christian Heimes15ebc882008-02-04 18:48:49 +00001293static PyObject *
1294sys_clear_type_cache(PyObject* self, PyObject* args)
1295{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001296 PyType_ClearCache();
1297 Py_RETURN_NONE;
Christian Heimes15ebc882008-02-04 18:48:49 +00001298}
1299
1300PyDoc_STRVAR(sys_clear_type_cache__doc__,
1301"_clear_type_cache() -> None\n\
1302Clear the internal type lookup cache.");
1303
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001304static PyObject *
1305sys_is_finalizing(PyObject* self, PyObject* args)
1306{
1307 return PyBool_FromLong(_Py_Finalizing != NULL);
1308}
1309
1310PyDoc_STRVAR(is_finalizing_doc,
1311"is_finalizing()\n\
1312Return True if Python is exiting.");
1313
Christian Heimes15ebc882008-02-04 18:48:49 +00001314
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001315static PyMethodDef sys_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 /* Might as well keep this in alphabetic order */
1317 {"callstats", (PyCFunction)PyEval_GetCallStats, METH_NOARGS,
1318 callstats_doc},
1319 {"_clear_type_cache", sys_clear_type_cache, METH_NOARGS,
1320 sys_clear_type_cache__doc__},
1321 {"_current_frames", sys_current_frames, METH_NOARGS,
1322 current_frames_doc},
1323 {"displayhook", sys_displayhook, METH_O, displayhook_doc},
1324 {"exc_info", sys_exc_info, METH_NOARGS, exc_info_doc},
1325 {"excepthook", sys_excepthook, METH_VARARGS, excepthook_doc},
1326 {"exit", sys_exit, METH_VARARGS, exit_doc},
1327 {"getdefaultencoding", (PyCFunction)sys_getdefaultencoding,
1328 METH_NOARGS, getdefaultencoding_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001329#ifdef HAVE_DLOPEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001330 {"getdlopenflags", (PyCFunction)sys_getdlopenflags, METH_NOARGS,
1331 getdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001332#endif
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001333 {"getallocatedblocks", (PyCFunction)sys_getallocatedblocks, METH_NOARGS,
1334 getallocatedblocks_doc},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001335#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001336 {"getcounts", (PyCFunction)sys_getcounts, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001337#endif
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001338#ifdef DYNAMIC_EXECUTION_PROFILE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001339 {"getdxp", _Py_GetDXProfile, METH_VARARGS},
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001340#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001341 {"getfilesystemencoding", (PyCFunction)sys_getfilesystemencoding,
1342 METH_NOARGS, getfilesystemencoding_doc},
Steve Dowercc16be82016-09-08 10:35:16 -07001343 { "getfilesystemencodeerrors", (PyCFunction)sys_getfilesystemencodeerrors,
1344 METH_NOARGS, getfilesystemencodeerrors_doc },
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001345#ifdef Py_TRACE_REFS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001346 {"getobjects", _Py_GetObjects, METH_VARARGS},
Tim Peters4be93d02002-07-07 19:59:50 +00001347#endif
1348#ifdef Py_REF_DEBUG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001349 {"gettotalrefcount", (PyCFunction)sys_gettotalrefcount, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001350#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001351 {"getrefcount", (PyCFunction)sys_getrefcount, METH_O, getrefcount_doc},
1352 {"getrecursionlimit", (PyCFunction)sys_getrecursionlimit, METH_NOARGS,
1353 getrecursionlimit_doc},
1354 {"getsizeof", (PyCFunction)sys_getsizeof,
1355 METH_VARARGS | METH_KEYWORDS, getsizeof_doc},
1356 {"_getframe", sys_getframe, METH_VARARGS, getframe_doc},
Mark Hammond8696ebc2002-10-08 02:44:31 +00001357#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001358 {"getwindowsversion", (PyCFunction)sys_getwindowsversion, METH_NOARGS,
1359 getwindowsversion_doc},
Steve Dowercc16be82016-09-08 10:35:16 -07001360 {"_enablelegacywindowsfsencoding", (PyCFunction)sys_enablelegacywindowsfsencoding,
1361 METH_NOARGS, enablelegacywindowsfsencoding_doc },
Mark Hammond8696ebc2002-10-08 02:44:31 +00001362#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001363 {"intern", sys_intern, METH_VARARGS, intern_doc},
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001364 {"is_finalizing", sys_is_finalizing, METH_NOARGS, is_finalizing_doc},
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001365#ifdef USE_MALLOPT
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001366 {"mdebug", sys_mdebug, METH_VARARGS},
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001367#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001368 {"setcheckinterval", sys_setcheckinterval, METH_VARARGS,
1369 setcheckinterval_doc},
1370 {"getcheckinterval", sys_getcheckinterval, METH_NOARGS,
1371 getcheckinterval_doc},
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001372#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001373 {"setswitchinterval", sys_setswitchinterval, METH_VARARGS,
1374 setswitchinterval_doc},
1375 {"getswitchinterval", sys_getswitchinterval, METH_NOARGS,
1376 getswitchinterval_doc},
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001377#endif
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001378#ifdef HAVE_DLOPEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 {"setdlopenflags", sys_setdlopenflags, METH_VARARGS,
1380 setdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001381#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001382 {"setprofile", sys_setprofile, METH_O, setprofile_doc},
1383 {"getprofile", sys_getprofile, METH_NOARGS, getprofile_doc},
1384 {"setrecursionlimit", sys_setrecursionlimit, METH_VARARGS,
1385 setrecursionlimit_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001386 {"settrace", sys_settrace, METH_O, settrace_doc},
1387 {"gettrace", sys_gettrace, METH_NOARGS, gettrace_doc},
1388 {"call_tracing", sys_call_tracing, METH_VARARGS, call_tracing_doc},
Victor Stinnered0b87d2013-12-19 17:16:42 +01001389 {"_debugmallocstats", sys_debugmallocstats, METH_NOARGS,
David Malcolm49526f42012-06-22 14:55:41 -04001390 debugmallocstats_doc},
Yury Selivanov75445082015-05-11 22:57:16 -04001391 {"set_coroutine_wrapper", sys_set_coroutine_wrapper, METH_O,
1392 set_coroutine_wrapper_doc},
1393 {"get_coroutine_wrapper", sys_get_coroutine_wrapper, METH_NOARGS,
1394 get_coroutine_wrapper_doc},
Yury Selivanov87672d72016-09-09 00:05:42 -07001395 {"set_asyncgen_hooks", (PyCFunction)sys_set_asyncgen_hooks,
Yury Selivanoveb636452016-09-08 22:01:51 -07001396 METH_VARARGS | METH_KEYWORDS, set_asyncgen_hooks_doc},
1397 {"get_asyncgen_hooks", sys_get_asyncgen_hooks, METH_NOARGS,
1398 get_asyncgen_hooks_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001399 {NULL, NULL} /* sentinel */
Guido van Rossum3f5da241990-12-20 15:06:42 +00001400};
1401
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001402static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001403list_builtin_module_names(void)
Guido van Rossum34679b71993-01-26 13:33:44 +00001404{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001405 PyObject *list = PyList_New(0);
1406 int i;
1407 if (list == NULL)
1408 return NULL;
1409 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1410 PyObject *name = PyUnicode_FromString(
1411 PyImport_Inittab[i].name);
1412 if (name == NULL)
1413 break;
1414 PyList_Append(list, name);
1415 Py_DECREF(name);
1416 }
1417 if (PyList_Sort(list) != 0) {
1418 Py_DECREF(list);
1419 list = NULL;
1420 }
1421 if (list) {
1422 PyObject *v = PyList_AsTuple(list);
1423 Py_DECREF(list);
1424 list = v;
1425 }
1426 return list;
Guido van Rossum34679b71993-01-26 13:33:44 +00001427}
1428
Guido van Rossum23fff912000-12-15 22:02:05 +00001429static PyObject *warnoptions = NULL;
1430
1431void
1432PySys_ResetWarnOptions(void)
1433{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001434 if (warnoptions == NULL || !PyList_Check(warnoptions))
1435 return;
1436 PyList_SetSlice(warnoptions, 0, PyList_GET_SIZE(warnoptions), NULL);
Guido van Rossum23fff912000-12-15 22:02:05 +00001437}
1438
1439void
Victor Stinner9ca9c252010-05-19 16:53:30 +00001440PySys_AddWarnOptionUnicode(PyObject *unicode)
Guido van Rossum23fff912000-12-15 22:02:05 +00001441{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001442 if (warnoptions == NULL || !PyList_Check(warnoptions)) {
1443 Py_XDECREF(warnoptions);
1444 warnoptions = PyList_New(0);
1445 if (warnoptions == NULL)
1446 return;
1447 }
Victor Stinner9ca9c252010-05-19 16:53:30 +00001448 PyList_Append(warnoptions, unicode);
1449}
1450
1451void
1452PySys_AddWarnOption(const wchar_t *s)
1453{
1454 PyObject *unicode;
1455 unicode = PyUnicode_FromWideChar(s, -1);
1456 if (unicode == NULL)
1457 return;
1458 PySys_AddWarnOptionUnicode(unicode);
1459 Py_DECREF(unicode);
Guido van Rossum23fff912000-12-15 22:02:05 +00001460}
1461
Christian Heimes33fe8092008-04-13 13:53:33 +00001462int
1463PySys_HasWarnOptions(void)
1464{
1465 return (warnoptions != NULL && (PyList_Size(warnoptions) > 0)) ? 1 : 0;
1466}
1467
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001468static PyObject *xoptions = NULL;
1469
1470static PyObject *
1471get_xoptions(void)
1472{
1473 if (xoptions == NULL || !PyDict_Check(xoptions)) {
1474 Py_XDECREF(xoptions);
1475 xoptions = PyDict_New();
1476 }
1477 return xoptions;
1478}
1479
1480void
1481PySys_AddXOption(const wchar_t *s)
1482{
1483 PyObject *opts;
1484 PyObject *name = NULL, *value = NULL;
1485 const wchar_t *name_end;
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001486
1487 opts = get_xoptions();
1488 if (opts == NULL)
1489 goto error;
1490
1491 name_end = wcschr(s, L'=');
1492 if (!name_end) {
1493 name = PyUnicode_FromWideChar(s, -1);
1494 value = Py_True;
1495 Py_INCREF(value);
1496 }
1497 else {
1498 name = PyUnicode_FromWideChar(s, name_end - s);
1499 value = PyUnicode_FromWideChar(name_end + 1, -1);
1500 }
1501 if (name == NULL || value == NULL)
1502 goto error;
Brett Cannonb94767f2011-02-22 20:15:44 +00001503 PyDict_SetItem(opts, name, value);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001504 Py_DECREF(name);
1505 Py_DECREF(value);
1506 return;
1507
1508error:
1509 Py_XDECREF(name);
1510 Py_XDECREF(value);
1511 /* No return value, therefore clear error state if possible */
Victor Stinnerbfd316e2016-01-20 11:12:38 +01001512 if (_PyThreadState_UncheckedGet())
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001513 PyErr_Clear();
1514}
1515
1516PyObject *
1517PySys_GetXOptions(void)
1518{
1519 return get_xoptions();
1520}
1521
Guido van Rossum40552d01998-08-06 03:34:39 +00001522/* XXX This doc string is too long to be a single string literal in VC++ 5.0.
1523 Two literals concatenated works just fine. If you have a K&R compiler
1524 or other abomination that however *does* understand longer strings,
1525 get rid of the !!! comment in the middle and the quotes that surround it. */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001526PyDoc_VAR(sys_doc) =
1527PyDoc_STR(
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001528"This module provides access to some objects used or maintained by the\n\
1529interpreter and to functions that interact strongly with the interpreter.\n\
1530\n\
1531Dynamic objects:\n\
1532\n\
1533argv -- command line arguments; argv[0] is the script pathname if known\n\
1534path -- module search path; path[0] is the script directory, else ''\n\
1535modules -- dictionary of loaded modules\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001536\n\
1537displayhook -- called to show results in an interactive session\n\
1538excepthook -- called to handle any uncaught exception other than SystemExit\n\
1539 To customize printing in an interactive session or to install a custom\n\
1540 top-level exception handler, assign other functions to replace these.\n\
1541\n\
Benjamin Peterson06157a42008-07-15 00:28:36 +00001542stdin -- standard input file object; used by input()\n\
Georg Brandl88fc6642007-02-09 21:28:07 +00001543stdout -- standard output file object; used by print()\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001544stderr -- standard error object; used for error messages\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001545 By assigning other file objects (or objects that behave like files)\n\
1546 to these, it is possible to redirect all of the interpreter's I/O.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001547\n\
1548last_type -- type of last uncaught exception\n\
1549last_value -- value of last uncaught exception\n\
1550last_traceback -- traceback of last uncaught exception\n\
1551 These three are only available in an interactive session after a\n\
1552 traceback has been printed.\n\
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001553"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001554)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001555/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001556PyDoc_STR(
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001557"\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001558Static objects:\n\
1559\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001560builtin_module_names -- tuple of module names built into this interpreter\n\
1561copyright -- copyright notice pertaining to this interpreter\n\
1562exec_prefix -- prefix used to find the machine-specific Python library\n\
Petri Lehtinen4b0eab62012-02-02 21:23:15 +02001563executable -- absolute path of the executable binary of the Python interpreter\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001564float_info -- a struct sequence with information about the float implementation.\n\
1565float_repr_style -- string indicating the style of repr() output for floats\n\
Christian Heimes985ecdc2013-11-20 11:46:18 +01001566hash_info -- a struct sequence with information about the hash algorithm.\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001567hexversion -- version information encoded as a single integer\n\
Barry Warsaw409da152012-06-03 16:18:47 -04001568implementation -- Python implementation information.\n\
Mark Dickinsonbd792642009-03-18 20:06:12 +00001569int_info -- a struct sequence with information about the int implementation.\n\
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001570maxsize -- the largest supported length of containers.\n\
Serhiy Storchakad3faf432015-01-18 11:28:37 +02001571maxunicode -- the value of the largest Unicode code point\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001572platform -- platform identifier\n\
1573prefix -- prefix used to find the Python library\n\
1574thread_info -- a struct sequence with information about the thread implementation.\n\
Fred Drake801c08d2000-04-13 15:29:10 +00001575version -- the version of this interpreter as a string\n\
Eric Smith0e5b5622009-02-06 01:32:42 +00001576version_info -- version information as a named tuple\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001577"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001578)
Steve Dowercc16be82016-09-08 10:35:16 -07001579#ifdef MS_COREDLL
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001580/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001581PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001582"dllhandle -- [Windows only] integer handle of the Python DLL\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001583winver -- [Windows only] version number of the Python DLL\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001584"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001585)
Steve Dowercc16be82016-09-08 10:35:16 -07001586#endif /* MS_COREDLL */
1587#ifdef MS_WINDOWS
1588/* concatenating string here */
1589PyDoc_STR(
1590"_enablelegacywindowsfsencoding -- [Windows only] \n\
1591"
1592)
1593#endif
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001594PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001595"__stdin__ -- the original stdin; don't touch!\n\
1596__stdout__ -- the original stdout; don't touch!\n\
1597__stderr__ -- the original stderr; don't touch!\n\
1598__displayhook__ -- the original displayhook; don't touch!\n\
1599__excepthook__ -- the original excepthook; don't touch!\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001600\n\
1601Functions:\n\
1602\n\
Georg Brandl1a3284e2007-12-02 09:40:06 +00001603displayhook() -- print an object to the screen, and save it in builtins._\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001604excepthook() -- print an exception and its traceback to sys.stderr\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001605exc_info() -- return thread-safe information about the current exception\n\
1606exit() -- exit the interpreter by raising SystemExit\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001607getdlopenflags() -- returns flags to be used for dlopen() calls\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001608getprofile() -- get the global profiling function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001609getrefcount() -- return the reference count for an object (plus one :-)\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001610getrecursionlimit() -- return the max recursion depth for the interpreter\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001611getsizeof() -- return the size of an object in bytes\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001612gettrace() -- get the global debug tracing function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001613setcheckinterval() -- control how often the interpreter checks for events\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001614setdlopenflags() -- set the flags to be used for dlopen() calls\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001615setprofile() -- set the global profiling function\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001616setrecursionlimit() -- set the max recursion depth for the interpreter\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001617settrace() -- set the global debug tracing function\n\
Fred Drakeccede592000-08-14 20:59:57 +00001618"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001619)
Fred Drakeccede592000-08-14 20:59:57 +00001620/* end of sys_doc */ ;
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001621
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001622
1623PyDoc_STRVAR(flags__doc__,
1624"sys.flags\n\
1625\n\
1626Flags provided through command line arguments or environment vars.");
1627
1628static PyTypeObject FlagsType;
1629
1630static PyStructSequence_Field flags_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001631 {"debug", "-d"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001632 {"inspect", "-i"},
1633 {"interactive", "-i"},
1634 {"optimize", "-O or -OO"},
1635 {"dont_write_bytecode", "-B"},
1636 {"no_user_site", "-s"},
1637 {"no_site", "-S"},
1638 {"ignore_environment", "-E"},
1639 {"verbose", "-v"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001640 /* {"unbuffered", "-u"}, */
1641 /* {"skip_first", "-x"}, */
Georg Brandl8aa7e992010-12-28 18:30:18 +00001642 {"bytes_warning", "-b"},
1643 {"quiet", "-q"},
Georg Brandl09a7c722012-02-20 21:31:46 +01001644 {"hash_randomization", "-R"},
Christian Heimesad73a9c2013-08-10 16:36:18 +02001645 {"isolated", "-I"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001646 {0}
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001647};
1648
1649static PyStructSequence_Desc flags_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 "sys.flags", /* name */
1651 flags__doc__, /* doc */
1652 flags_fields, /* fields */
Christian Heimesad73a9c2013-08-10 16:36:18 +02001653 13
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001654};
1655
1656static PyObject*
1657make_flags(void)
1658{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001659 int pos = 0;
1660 PyObject *seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 seq = PyStructSequence_New(&FlagsType);
1663 if (seq == NULL)
1664 return NULL;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001665
1666#define SetFlag(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001667 PyStructSequence_SET_ITEM(seq, pos++, PyLong_FromLong(flag))
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001668
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001669 SetFlag(Py_DebugFlag);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001670 SetFlag(Py_InspectFlag);
1671 SetFlag(Py_InteractiveFlag);
1672 SetFlag(Py_OptimizeFlag);
1673 SetFlag(Py_DontWriteBytecodeFlag);
1674 SetFlag(Py_NoUserSiteDirectory);
1675 SetFlag(Py_NoSiteFlag);
1676 SetFlag(Py_IgnoreEnvironmentFlag);
1677 SetFlag(Py_VerboseFlag);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001678 /* SetFlag(saw_unbuffered_flag); */
1679 /* SetFlag(skipfirstline); */
Christian Heimes33fe8092008-04-13 13:53:33 +00001680 SetFlag(Py_BytesWarningFlag);
Georg Brandl8aa7e992010-12-28 18:30:18 +00001681 SetFlag(Py_QuietFlag);
Georg Brandl2daf6ae2012-02-20 19:54:16 +01001682 SetFlag(Py_HashRandomizationFlag);
Christian Heimesad73a9c2013-08-10 16:36:18 +02001683 SetFlag(Py_IsolatedFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001684#undef SetFlag
1685
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001686 if (PyErr_Occurred()) {
Serhiy Storchaka87a854d2013-12-17 14:59:42 +02001687 Py_DECREF(seq);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001688 return NULL;
1689 }
1690 return seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001691}
1692
Eric Smith0e5b5622009-02-06 01:32:42 +00001693PyDoc_STRVAR(version_info__doc__,
1694"sys.version_info\n\
1695\n\
1696Version information as a named tuple.");
1697
1698static PyTypeObject VersionInfoType;
1699
1700static PyStructSequence_Field version_info_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001701 {"major", "Major release number"},
1702 {"minor", "Minor release number"},
1703 {"micro", "Patch release number"},
1704 {"releaselevel", "'alpha', 'beta', 'candidate', or 'release'"},
1705 {"serial", "Serial release number"},
1706 {0}
Eric Smith0e5b5622009-02-06 01:32:42 +00001707};
1708
1709static PyStructSequence_Desc version_info_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001710 "sys.version_info", /* name */
1711 version_info__doc__, /* doc */
1712 version_info_fields, /* fields */
1713 5
Eric Smith0e5b5622009-02-06 01:32:42 +00001714};
1715
1716static PyObject *
1717make_version_info(void)
1718{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001719 PyObject *version_info;
1720 char *s;
1721 int pos = 0;
Eric Smith0e5b5622009-02-06 01:32:42 +00001722
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001723 version_info = PyStructSequence_New(&VersionInfoType);
1724 if (version_info == NULL) {
1725 return NULL;
1726 }
Eric Smith0e5b5622009-02-06 01:32:42 +00001727
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001728 /*
1729 * These release level checks are mutually exclusive and cover
1730 * the field, so don't get too fancy with the pre-processor!
1731 */
Eric Smith0e5b5622009-02-06 01:32:42 +00001732#if PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_ALPHA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001733 s = "alpha";
Eric Smith0e5b5622009-02-06 01:32:42 +00001734#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_BETA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001735 s = "beta";
Eric Smith0e5b5622009-02-06 01:32:42 +00001736#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_GAMMA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001737 s = "candidate";
Eric Smith0e5b5622009-02-06 01:32:42 +00001738#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_FINAL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001739 s = "final";
Eric Smith0e5b5622009-02-06 01:32:42 +00001740#endif
1741
1742#define SetIntItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001743 PyStructSequence_SET_ITEM(version_info, pos++, PyLong_FromLong(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001744#define SetStrItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001745 PyStructSequence_SET_ITEM(version_info, pos++, PyUnicode_FromString(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001746
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001747 SetIntItem(PY_MAJOR_VERSION);
1748 SetIntItem(PY_MINOR_VERSION);
1749 SetIntItem(PY_MICRO_VERSION);
1750 SetStrItem(s);
1751 SetIntItem(PY_RELEASE_SERIAL);
Eric Smith0e5b5622009-02-06 01:32:42 +00001752#undef SetIntItem
1753#undef SetStrItem
1754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001755 if (PyErr_Occurred()) {
1756 Py_CLEAR(version_info);
1757 return NULL;
1758 }
1759 return version_info;
Eric Smith0e5b5622009-02-06 01:32:42 +00001760}
1761
Brett Cannon3adc7b72012-07-09 14:22:12 -04001762/* sys.implementation values */
1763#define NAME "cpython"
1764const char *_PySys_ImplName = NAME;
Victor Stinnercf01b682015-11-05 11:21:38 +01001765#define MAJOR Py_STRINGIFY(PY_MAJOR_VERSION)
1766#define MINOR Py_STRINGIFY(PY_MINOR_VERSION)
Ned Deily529ea5d2014-06-30 23:31:14 -07001767#define TAG NAME "-" MAJOR MINOR
Brett Cannon3adc7b72012-07-09 14:22:12 -04001768const char *_PySys_ImplCacheTag = TAG;
1769#undef NAME
Brett Cannon3adc7b72012-07-09 14:22:12 -04001770#undef MAJOR
1771#undef MINOR
1772#undef TAG
1773
Barry Warsaw409da152012-06-03 16:18:47 -04001774static PyObject *
1775make_impl_info(PyObject *version_info)
1776{
1777 int res;
1778 PyObject *impl_info, *value, *ns;
1779
1780 impl_info = PyDict_New();
1781 if (impl_info == NULL)
1782 return NULL;
1783
1784 /* populate the dict */
1785
Brett Cannon3adc7b72012-07-09 14:22:12 -04001786 value = PyUnicode_FromString(_PySys_ImplName);
Barry Warsaw409da152012-06-03 16:18:47 -04001787 if (value == NULL)
1788 goto error;
1789 res = PyDict_SetItemString(impl_info, "name", value);
1790 Py_DECREF(value);
1791 if (res < 0)
1792 goto error;
1793
Brett Cannon3adc7b72012-07-09 14:22:12 -04001794 value = PyUnicode_FromString(_PySys_ImplCacheTag);
Barry Warsaw409da152012-06-03 16:18:47 -04001795 if (value == NULL)
1796 goto error;
1797 res = PyDict_SetItemString(impl_info, "cache_tag", value);
1798 Py_DECREF(value);
1799 if (res < 0)
1800 goto error;
Barry Warsaw409da152012-06-03 16:18:47 -04001801
1802 res = PyDict_SetItemString(impl_info, "version", version_info);
1803 if (res < 0)
1804 goto error;
1805
1806 value = PyLong_FromLong(PY_VERSION_HEX);
1807 if (value == NULL)
1808 goto error;
1809 res = PyDict_SetItemString(impl_info, "hexversion", value);
1810 Py_DECREF(value);
1811 if (res < 0)
1812 goto error;
1813
doko@ubuntu.com55532312016-06-14 08:55:19 +02001814#ifdef MULTIARCH
1815 value = PyUnicode_FromString(MULTIARCH);
1816 if (value == NULL)
1817 goto error;
1818 res = PyDict_SetItemString(impl_info, "_multiarch", value);
1819 Py_DECREF(value);
1820 if (res < 0)
1821 goto error;
1822#endif
1823
Barry Warsaw409da152012-06-03 16:18:47 -04001824 /* dict ready */
1825
1826 ns = _PyNamespace_New(impl_info);
1827 Py_DECREF(impl_info);
1828 return ns;
1829
1830error:
1831 Py_CLEAR(impl_info);
1832 return NULL;
1833}
1834
Martin v. Löwis1a214512008-06-11 05:26:20 +00001835static struct PyModuleDef sysmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001836 PyModuleDef_HEAD_INIT,
1837 "sys",
1838 sys_doc,
1839 -1, /* multiple "initialization" just copies the module dict. */
1840 sys_methods,
1841 NULL,
1842 NULL,
1843 NULL,
1844 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00001845};
1846
Guido van Rossum25ce5661997-08-02 03:10:38 +00001847PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001848_PySys_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001849{
Victor Stinner58049602013-07-22 22:40:00 +02001850 PyObject *m, *sysdict, *version_info;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02001851 int res;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001852
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001853 m = PyModule_Create(&sysmodule);
1854 if (m == NULL)
1855 return NULL;
1856 sysdict = PyModule_GetDict(m);
Victor Stinner8fea2522013-10-27 17:15:42 +01001857#define SET_SYS_FROM_STRING_BORROW(key, value) \
Victor Stinner58049602013-07-22 22:40:00 +02001858 do { \
Victor Stinner58049602013-07-22 22:40:00 +02001859 PyObject *v = (value); \
1860 if (v == NULL) \
1861 return NULL; \
1862 res = PyDict_SetItemString(sysdict, key, v); \
1863 if (res < 0) { \
Victor Stinner8fea2522013-10-27 17:15:42 +01001864 return NULL; \
1865 } \
1866 } while (0)
1867#define SET_SYS_FROM_STRING(key, value) \
1868 do { \
Victor Stinner8fea2522013-10-27 17:15:42 +01001869 PyObject *v = (value); \
1870 if (v == NULL) \
1871 return NULL; \
1872 res = PyDict_SetItemString(sysdict, key, v); \
1873 Py_DECREF(v); \
1874 if (res < 0) { \
Victor Stinner58049602013-07-22 22:40:00 +02001875 return NULL; \
1876 } \
1877 } while (0)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001878
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001879 /* Check that stdin is not a directory
1880 Using shell redirection, you can redirect stdin to a directory,
1881 crashing the Python interpreter. Catch this common mistake here
1882 and output a useful error message. Note that under MS Windows,
1883 the shell already prevents that. */
Martin v. Löwisec59d042009-01-12 07:59:10 +00001884#if !defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001885 {
Steve Dowerf2f373f2015-02-21 08:44:05 -08001886 struct _Py_stat_struct sb;
Victor Stinnere134a7f2015-03-30 10:09:31 +02001887 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001888 S_ISDIR(sb.st_mode)) {
1889 /* There's nothing more we can do. */
1890 /* Py_FatalError() will core dump, so just exit. */
1891 PySys_WriteStderr("Python error: <stdin> is a directory, cannot continue\n");
1892 exit(EXIT_FAILURE);
1893 }
1894 }
Martin v. Löwisec59d042009-01-12 07:59:10 +00001895#endif
Neal Norwitz11bd1192005-10-03 00:54:56 +00001896
Nick Coghland6009512014-11-20 21:39:37 +10001897 /* stdin/stdout/stderr are set in pylifecycle.c */
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001898
Victor Stinner8fea2522013-10-27 17:15:42 +01001899 SET_SYS_FROM_STRING_BORROW("__displayhook__",
1900 PyDict_GetItemString(sysdict, "displayhook"));
1901 SET_SYS_FROM_STRING_BORROW("__excepthook__",
1902 PyDict_GetItemString(sysdict, "excepthook"));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001903 SET_SYS_FROM_STRING("version",
1904 PyUnicode_FromString(Py_GetVersion()));
1905 SET_SYS_FROM_STRING("hexversion",
1906 PyLong_FromLong(PY_VERSION_HEX));
Georg Brandl1ca2e792011-03-05 20:51:24 +01001907 SET_SYS_FROM_STRING("_mercurial",
1908 Py_BuildValue("(szz)", "CPython", _Py_hgidentifier(),
1909 _Py_hgversion()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001910 SET_SYS_FROM_STRING("dont_write_bytecode",
1911 PyBool_FromLong(Py_DontWriteBytecodeFlag));
1912 SET_SYS_FROM_STRING("api_version",
1913 PyLong_FromLong(PYTHON_API_VERSION));
1914 SET_SYS_FROM_STRING("copyright",
1915 PyUnicode_FromString(Py_GetCopyright()));
1916 SET_SYS_FROM_STRING("platform",
1917 PyUnicode_FromString(Py_GetPlatform()));
1918 SET_SYS_FROM_STRING("executable",
1919 PyUnicode_FromWideChar(
1920 Py_GetProgramFullPath(), -1));
1921 SET_SYS_FROM_STRING("prefix",
1922 PyUnicode_FromWideChar(Py_GetPrefix(), -1));
1923 SET_SYS_FROM_STRING("exec_prefix",
1924 PyUnicode_FromWideChar(Py_GetExecPrefix(), -1));
Vinay Sajip7ded1f02012-05-26 03:45:29 +01001925 SET_SYS_FROM_STRING("base_prefix",
1926 PyUnicode_FromWideChar(Py_GetPrefix(), -1));
1927 SET_SYS_FROM_STRING("base_exec_prefix",
1928 PyUnicode_FromWideChar(Py_GetExecPrefix(), -1));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001929 SET_SYS_FROM_STRING("maxsize",
1930 PyLong_FromSsize_t(PY_SSIZE_T_MAX));
1931 SET_SYS_FROM_STRING("float_info",
1932 PyFloat_GetInfo());
1933 SET_SYS_FROM_STRING("int_info",
1934 PyLong_GetInfo());
Mark Dickinsondc787d22010-05-23 13:33:13 +00001935 /* initialize hash_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02001936 if (Hash_InfoType.tp_name == NULL) {
1937 if (PyStructSequence_InitType2(&Hash_InfoType, &hash_info_desc) < 0)
1938 return NULL;
1939 }
Mark Dickinsondc787d22010-05-23 13:33:13 +00001940 SET_SYS_FROM_STRING("hash_info",
1941 get_hash_info());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001942 SET_SYS_FROM_STRING("maxunicode",
Ezio Melotti48a2f8f2011-09-29 00:18:19 +03001943 PyLong_FromLong(0x10FFFF));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001944 SET_SYS_FROM_STRING("builtin_module_names",
1945 list_builtin_module_names());
Christian Heimes743e0cd2012-10-17 23:52:17 +02001946#if PY_BIG_ENDIAN
1947 SET_SYS_FROM_STRING("byteorder",
1948 PyUnicode_FromString("big"));
1949#else
1950 SET_SYS_FROM_STRING("byteorder",
1951 PyUnicode_FromString("little"));
1952#endif
Fred Drake099325e2000-08-14 15:47:03 +00001953
Guido van Rossum8b9ea871996-08-23 18:14:47 +00001954#ifdef MS_COREDLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001955 SET_SYS_FROM_STRING("dllhandle",
1956 PyLong_FromVoidPtr(PyWin_DLLhModule));
1957 SET_SYS_FROM_STRING("winver",
1958 PyUnicode_FromString(PyWin_DLLVersionString));
Guido van Rossumc606fe11996-04-09 02:37:57 +00001959#endif
Barry Warsaw8cf4eae2010-10-16 01:04:07 +00001960#ifdef ABIFLAGS
1961 SET_SYS_FROM_STRING("abiflags",
1962 PyUnicode_FromString(ABIFLAGS));
1963#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001964 if (warnoptions == NULL) {
1965 warnoptions = PyList_New(0);
Victor Stinner58049602013-07-22 22:40:00 +02001966 if (warnoptions == NULL)
1967 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001968 }
1969 else {
1970 Py_INCREF(warnoptions);
1971 }
Victor Stinner8fea2522013-10-27 17:15:42 +01001972 SET_SYS_FROM_STRING_BORROW("warnoptions", warnoptions);
Tim Peters216b78b2006-01-06 02:40:53 +00001973
Victor Stinner8fea2522013-10-27 17:15:42 +01001974 SET_SYS_FROM_STRING_BORROW("_xoptions", get_xoptions());
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001975
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001976 /* version_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02001977 if (VersionInfoType.tp_name == NULL) {
1978 if (PyStructSequence_InitType2(&VersionInfoType,
1979 &version_info_desc) < 0)
1980 return NULL;
1981 }
Barry Warsaw409da152012-06-03 16:18:47 -04001982 version_info = make_version_info();
1983 SET_SYS_FROM_STRING("version_info", version_info);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001984 /* prevent user from creating new instances */
1985 VersionInfoType.tp_init = NULL;
1986 VersionInfoType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02001987 res = PyDict_DelItemString(VersionInfoType.tp_dict, "__new__");
1988 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1989 PyErr_Clear();
Eric Smith0e5b5622009-02-06 01:32:42 +00001990
Barry Warsaw409da152012-06-03 16:18:47 -04001991 /* implementation */
1992 SET_SYS_FROM_STRING("implementation", make_impl_info(version_info));
1993
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001994 /* flags */
Victor Stinner1c8f0592013-07-22 22:24:54 +02001995 if (FlagsType.tp_name == 0) {
1996 if (PyStructSequence_InitType2(&FlagsType, &flags_desc) < 0)
1997 return NULL;
1998 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001999 SET_SYS_FROM_STRING("flags", make_flags());
2000 /* prevent user from creating new instances */
2001 FlagsType.tp_init = NULL;
2002 FlagsType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02002003 res = PyDict_DelItemString(FlagsType.tp_dict, "__new__");
2004 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
2005 PyErr_Clear();
Eric Smithf7bb5782010-01-27 00:44:57 +00002006
2007#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002008 /* getwindowsversion */
2009 if (WindowsVersionType.tp_name == 0)
Victor Stinner1c8f0592013-07-22 22:24:54 +02002010 if (PyStructSequence_InitType2(&WindowsVersionType,
2011 &windows_version_desc) < 0)
2012 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002013 /* prevent user from creating new instances */
2014 WindowsVersionType.tp_init = NULL;
2015 WindowsVersionType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02002016 res = PyDict_DelItemString(WindowsVersionType.tp_dict, "__new__");
2017 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
2018 PyErr_Clear();
Eric Smithf7bb5782010-01-27 00:44:57 +00002019#endif
2020
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002021 /* float repr style: 0.03 (short) vs 0.029999999999999999 (legacy) */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002022#ifndef PY_NO_SHORT_FLOAT_REPR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002023 SET_SYS_FROM_STRING("float_repr_style",
2024 PyUnicode_FromString("short"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002025#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002026 SET_SYS_FROM_STRING("float_repr_style",
2027 PyUnicode_FromString("legacy"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002028#endif
2029
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002030#ifdef WITH_THREAD
2031 SET_SYS_FROM_STRING("thread_info", PyThread_GetInfo());
2032#endif
2033
Yury Selivanoveb636452016-09-08 22:01:51 -07002034 /* initialize asyncgen_hooks */
2035 if (AsyncGenHooksType.tp_name == NULL) {
2036 if (PyStructSequence_InitType2(
2037 &AsyncGenHooksType, &asyncgen_hooks_desc) < 0) {
2038 return NULL;
2039 }
2040 }
2041
Christian Heimes7b3ce6a2008-01-31 14:31:45 +00002042#undef SET_SYS_FROM_STRING
Benjamin Peterson93813432014-03-28 18:52:45 -04002043#undef SET_SYS_FROM_STRING_BORROW
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002044 if (PyErr_Occurred())
2045 return NULL;
2046 return m;
Guido van Rossum5b3138b1990-11-18 17:41:40 +00002047}
2048
Guido van Rossum65bf9f21997-04-29 18:33:38 +00002049static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00002050makepathobject(const wchar_t *path, wchar_t delim)
Guido van Rossum5b3138b1990-11-18 17:41:40 +00002051{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002052 int i, n;
2053 const wchar_t *p;
2054 PyObject *v, *w;
Tim Peters216b78b2006-01-06 02:40:53 +00002055
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002056 n = 1;
2057 p = path;
2058 while ((p = wcschr(p, delim)) != NULL) {
2059 n++;
2060 p++;
2061 }
2062 v = PyList_New(n);
2063 if (v == NULL)
2064 return NULL;
2065 for (i = 0; ; i++) {
2066 p = wcschr(path, delim);
2067 if (p == NULL)
2068 p = path + wcslen(path); /* End of string */
2069 w = PyUnicode_FromWideChar(path, (Py_ssize_t)(p - path));
2070 if (w == NULL) {
2071 Py_DECREF(v);
2072 return NULL;
2073 }
2074 PyList_SetItem(v, i, w);
2075 if (*p == '\0')
2076 break;
2077 path = p+1;
2078 }
2079 return v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002080}
2081
2082void
Martin v. Löwis790465f2008-04-05 20:41:37 +00002083PySys_SetPath(const wchar_t *path)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002084{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002085 PyObject *v;
2086 if ((v = makepathobject(path, DELIM)) == NULL)
2087 Py_FatalError("can't create sys.path");
Victor Stinnerbd303c12013-11-07 23:07:29 +01002088 if (_PySys_SetObjectId(&PyId_path, v) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002089 Py_FatalError("can't assign sys.path");
2090 Py_DECREF(v);
Guido van Rossum3f5da241990-12-20 15:06:42 +00002091}
2092
Guido van Rossum65bf9f21997-04-29 18:33:38 +00002093static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00002094makeargvobject(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00002095{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002096 PyObject *av;
2097 if (argc <= 0 || argv == NULL) {
2098 /* Ensure at least one (empty) argument is seen */
2099 static wchar_t *empty_argv[1] = {L""};
2100 argv = empty_argv;
2101 argc = 1;
2102 }
2103 av = PyList_New(argc);
2104 if (av != NULL) {
2105 int i;
2106 for (i = 0; i < argc; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002107 PyObject *v = PyUnicode_FromWideChar(argv[i], -1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002108 if (v == NULL) {
2109 Py_DECREF(av);
2110 av = NULL;
2111 break;
2112 }
2113 PyList_SetItem(av, i, v);
2114 }
2115 }
2116 return av;
Guido van Rossum3f5da241990-12-20 15:06:42 +00002117}
2118
Nick Coghland26c18a2010-08-17 13:06:11 +00002119#define _HAVE_SCRIPT_ARGUMENT(argc, argv) \
2120 (argc > 0 && argv0 != NULL && \
2121 wcscmp(argv0, L"-c") != 0 && wcscmp(argv0, L"-m") != 0)
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002122
2123static void
2124sys_update_path(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00002125{
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002126 wchar_t *argv0;
2127 wchar_t *p = NULL;
2128 Py_ssize_t n = 0;
2129 PyObject *a;
2130 PyObject *path;
2131#ifdef HAVE_READLINK
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002132 wchar_t link[MAXPATHLEN+1];
2133 wchar_t argv0copy[2*MAXPATHLEN+1];
2134 int nr = 0;
2135#endif
Guido van Rossum162e38c2003-02-19 15:25:10 +00002136#if defined(HAVE_REALPATH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002137 wchar_t fullpath[MAXPATHLEN];
Larry Hastings10108a72016-09-05 15:11:23 -07002138#elif defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002139 wchar_t fullpath[MAX_PATH];
Thomas Heller27bb71e2003-01-08 14:33:48 +00002140#endif
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002141
Victor Stinnerbd303c12013-11-07 23:07:29 +01002142 path = _PySys_GetObjectId(&PyId_path);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002143 if (path == NULL)
2144 return;
2145
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002146 argv0 = argv[0];
2147
2148#ifdef HAVE_READLINK
2149 if (_HAVE_SCRIPT_ARGUMENT(argc, argv))
2150 nr = _Py_wreadlink(argv0, link, MAXPATHLEN);
2151 if (nr > 0) {
2152 /* It's a symlink */
2153 link[nr] = '\0';
2154 if (link[0] == SEP)
2155 argv0 = link; /* Link to absolute path */
2156 else if (wcschr(link, SEP) == NULL)
2157 ; /* Link without path */
2158 else {
2159 /* Must join(dirname(argv0), link) */
2160 wchar_t *q = wcsrchr(argv0, SEP);
2161 if (q == NULL)
2162 argv0 = link; /* argv0 without path */
2163 else {
Christian Heimes60a60672013-07-22 12:53:32 +02002164 /* Must make a copy, argv0copy has room for 2 * MAXPATHLEN */
2165 wcsncpy(argv0copy, argv0, MAXPATHLEN);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002166 q = wcsrchr(argv0copy, SEP);
Christian Heimes60a60672013-07-22 12:53:32 +02002167 wcsncpy(q+1, link, MAXPATHLEN);
2168 q[MAXPATHLEN + 1] = L'\0';
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002169 argv0 = argv0copy;
2170 }
2171 }
2172 }
2173#endif /* HAVE_READLINK */
2174#if SEP == '\\' /* Special case for MS filename syntax */
2175 if (_HAVE_SCRIPT_ARGUMENT(argc, argv)) {
2176 wchar_t *q;
Larry Hastings10108a72016-09-05 15:11:23 -07002177#if defined(MS_WINDOWS)
2178 /* Replace the first element in argv with the full path. */
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002179 wchar_t *ptemp;
2180 if (GetFullPathNameW(argv0,
Victor Stinner63941882011-09-29 00:42:28 +02002181 Py_ARRAY_LENGTH(fullpath),
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002182 fullpath,
2183 &ptemp)) {
2184 argv0 = fullpath;
2185 }
2186#endif
2187 p = wcsrchr(argv0, SEP);
2188 /* Test for alternate separator */
2189 q = wcsrchr(p ? p : argv0, '/');
2190 if (q != NULL)
2191 p = q;
2192 if (p != NULL) {
2193 n = p + 1 - argv0;
2194 if (n > 1 && p[-1] != ':')
2195 n--; /* Drop trailing separator */
2196 }
2197 }
2198#else /* All other filename syntaxes */
2199 if (_HAVE_SCRIPT_ARGUMENT(argc, argv)) {
2200#if defined(HAVE_REALPATH)
Victor Stinner23847142013-11-15 17:33:43 +01002201 if (_Py_wrealpath(argv0, fullpath, Py_ARRAY_LENGTH(fullpath))) {
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002202 argv0 = fullpath;
2203 }
2204#endif
2205 p = wcsrchr(argv0, SEP);
2206 }
2207 if (p != NULL) {
2208 n = p + 1 - argv0;
2209#if SEP == '/' /* Special case for Unix filename syntax */
2210 if (n > 1)
2211 n--; /* Drop trailing separator */
2212#endif /* Unix */
2213 }
2214#endif /* All others */
2215 a = PyUnicode_FromWideChar(argv0, n);
2216 if (a == NULL)
2217 Py_FatalError("no mem for sys.path insertion");
2218 if (PyList_Insert(path, 0, a) < 0)
2219 Py_FatalError("sys.path.insert(0) failed");
2220 Py_DECREF(a);
2221}
2222
2223void
2224PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)
2225{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002226 PyObject *av = makeargvobject(argc, argv);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002227 if (av == NULL)
2228 Py_FatalError("no mem for sys.argv");
2229 if (PySys_SetObject("argv", av) != 0)
2230 Py_FatalError("can't assign sys.argv");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002231 Py_DECREF(av);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002232 if (updatepath)
2233 sys_update_path(argc, argv);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002234}
Guido van Rossuma890e681998-05-12 14:59:24 +00002235
Antoine Pitrouf978fac2010-05-21 17:25:34 +00002236void
2237PySys_SetArgv(int argc, wchar_t **argv)
2238{
Christian Heimesad73a9c2013-08-10 16:36:18 +02002239 PySys_SetArgvEx(argc, argv, Py_IsolatedFlag == 0);
Antoine Pitrouf978fac2010-05-21 17:25:34 +00002240}
2241
Victor Stinner14284c22010-04-23 12:02:30 +00002242/* Reimplementation of PyFile_WriteString() no calling indirectly
2243 PyErr_CheckSignals(): avoid the call to PyObject_Str(). */
2244
2245static int
Victor Stinner79766632010-08-16 17:36:42 +00002246sys_pyfile_write_unicode(PyObject *unicode, PyObject *file)
Victor Stinner14284c22010-04-23 12:02:30 +00002247{
Victor Stinnerc3ccaae2016-08-20 01:24:22 +02002248 PyObject *writer = NULL, *result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002249 int err;
Victor Stinner14284c22010-04-23 12:02:30 +00002250
Victor Stinnerecccc4f2010-06-08 20:46:00 +00002251 if (file == NULL)
2252 return -1;
2253
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02002254 writer = _PyObject_GetAttrId(file, &PyId_write);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002255 if (writer == NULL)
2256 goto error;
Victor Stinner14284c22010-04-23 12:02:30 +00002257
Victor Stinner559bb6a2016-08-22 22:48:54 +02002258 result = _PyObject_CallArg1(writer, unicode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002259 if (result == NULL) {
2260 goto error;
2261 } else {
2262 err = 0;
2263 goto finally;
2264 }
Victor Stinner14284c22010-04-23 12:02:30 +00002265
2266error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002267 err = -1;
Victor Stinner14284c22010-04-23 12:02:30 +00002268finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002269 Py_XDECREF(writer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002270 Py_XDECREF(result);
2271 return err;
Victor Stinner14284c22010-04-23 12:02:30 +00002272}
2273
Victor Stinner79766632010-08-16 17:36:42 +00002274static int
2275sys_pyfile_write(const char *text, PyObject *file)
2276{
2277 PyObject *unicode = NULL;
2278 int err;
2279
2280 if (file == NULL)
2281 return -1;
2282
2283 unicode = PyUnicode_FromString(text);
2284 if (unicode == NULL)
2285 return -1;
2286
2287 err = sys_pyfile_write_unicode(unicode, file);
2288 Py_DECREF(unicode);
2289 return err;
2290}
Guido van Rossuma890e681998-05-12 14:59:24 +00002291
2292/* APIs to write to sys.stdout or sys.stderr using a printf-like interface.
2293 Adapted from code submitted by Just van Rossum.
2294
2295 PySys_WriteStdout(format, ...)
2296 PySys_WriteStderr(format, ...)
2297
2298 The first function writes to sys.stdout; the second to sys.stderr. When
2299 there is a problem, they write to the real (C level) stdout or stderr;
Guido van Rossum8442af31998-10-12 18:22:10 +00002300 no exceptions are raised.
Guido van Rossuma890e681998-05-12 14:59:24 +00002301
Victor Stinner14284c22010-04-23 12:02:30 +00002302 PyErr_CheckSignals() is not called to avoid the execution of the Python
Victor Stinner79766632010-08-16 17:36:42 +00002303 signal handlers: they may raise a new exception whereas sys_write()
2304 ignores all exceptions.
Victor Stinner14284c22010-04-23 12:02:30 +00002305
Guido van Rossuma890e681998-05-12 14:59:24 +00002306 Both take a printf-style format string as their first argument followed
2307 by a variable length argument list determined by the format string.
2308
2309 *** WARNING ***
2310
2311 The format should limit the total size of the formatted output string to
2312 1000 bytes. In particular, this means that no unrestricted "%s" formats
2313 should occur; these should be limited using "%.<N>s where <N> is a
2314 decimal number calculated so that <N> plus the maximum size of other
2315 formatted text does not exceed 1000 bytes. Also watch out for "%f",
2316 which can print hundreds of digits for very large numbers.
2317
2318 */
2319
2320static void
Victor Stinner09054372013-11-06 22:41:44 +01002321sys_write(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Guido van Rossuma890e681998-05-12 14:59:24 +00002322{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002323 PyObject *file;
2324 PyObject *error_type, *error_value, *error_traceback;
2325 char buffer[1001];
2326 int written;
Guido van Rossuma890e681998-05-12 14:59:24 +00002327
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002328 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Victor Stinner09054372013-11-06 22:41:44 +01002329 file = _PySys_GetObjectId(key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002330 written = PyOS_vsnprintf(buffer, sizeof(buffer), format, va);
2331 if (sys_pyfile_write(buffer, file) != 0) {
2332 PyErr_Clear();
2333 fputs(buffer, fp);
2334 }
2335 if (written < 0 || (size_t)written >= sizeof(buffer)) {
2336 const char *truncated = "... truncated";
Victor Stinner79766632010-08-16 17:36:42 +00002337 if (sys_pyfile_write(truncated, file) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002338 fputs(truncated, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002339 }
2340 PyErr_Restore(error_type, error_value, error_traceback);
Guido van Rossuma890e681998-05-12 14:59:24 +00002341}
2342
2343void
Guido van Rossuma890e681998-05-12 14:59:24 +00002344PySys_WriteStdout(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00002345{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002346 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00002347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002348 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002349 sys_write(&PyId_stdout, stdout, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002350 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00002351}
2352
2353void
Guido van Rossuma890e681998-05-12 14:59:24 +00002354PySys_WriteStderr(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00002355{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002356 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00002357
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002358 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002359 sys_write(&PyId_stderr, stderr, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00002360 va_end(va);
2361}
2362
2363static void
Victor Stinner09054372013-11-06 22:41:44 +01002364sys_format(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Victor Stinner79766632010-08-16 17:36:42 +00002365{
2366 PyObject *file, *message;
2367 PyObject *error_type, *error_value, *error_traceback;
2368 char *utf8;
2369
2370 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Victor Stinner09054372013-11-06 22:41:44 +01002371 file = _PySys_GetObjectId(key);
Victor Stinner79766632010-08-16 17:36:42 +00002372 message = PyUnicode_FromFormatV(format, va);
2373 if (message != NULL) {
2374 if (sys_pyfile_write_unicode(message, file) != 0) {
2375 PyErr_Clear();
2376 utf8 = _PyUnicode_AsString(message);
2377 if (utf8 != NULL)
2378 fputs(utf8, fp);
2379 }
2380 Py_DECREF(message);
2381 }
2382 PyErr_Restore(error_type, error_value, error_traceback);
2383}
2384
2385void
2386PySys_FormatStdout(const char *format, ...)
2387{
2388 va_list va;
2389
2390 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002391 sys_format(&PyId_stdout, stdout, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00002392 va_end(va);
2393}
2394
2395void
2396PySys_FormatStderr(const char *format, ...)
2397{
2398 va_list va;
2399
2400 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002401 sys_format(&PyId_stderr, stderr, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002402 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00002403}