blob: 6d2cc96b5ebbdf2ffaeca3b13dfa838cf84f2d34 [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"
Eric Snow2ebc5ce2017-09-07 23:51:28 -060018#include "internal/pystate.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000019#include "code.h"
Barry Warsawb6a54d22000-12-06 21:47:46 +000020#include "frameobject.h"
Victor Stinnerd5c355c2011-04-30 14:53:09 +020021#include "pythread.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000022
Guido van Rossume2437a11992-03-23 18:20:18 +000023#include "osdefs.h"
Stefan Krah1845d142016-04-25 21:38:53 +020024#include <locale.h>
Guido van Rossum3f5da241990-12-20 15:06:42 +000025
Mark Hammond8696ebc2002-10-08 02:44:31 +000026#ifdef MS_WINDOWS
27#define WIN32_LEAN_AND_MEAN
Amaury Forgeot d'Arc06cfe952007-11-10 13:55:44 +000028#include <windows.h>
Mark Hammond8696ebc2002-10-08 02:44:31 +000029#endif /* MS_WINDOWS */
30
Guido van Rossum9b38a141996-09-11 23:12:24 +000031#ifdef MS_COREDLL
Guido van Rossumc606fe11996-04-09 02:37:57 +000032extern void *PyWin_DLLhModule;
Guido van Rossum6c1e5f21997-09-29 23:34:23 +000033/* A string loaded from the DLL at startup: */
34extern const char *PyWin_DLLVersionString;
Guido van Rossumc606fe11996-04-09 02:37:57 +000035#endif
36
Victor Stinnerbd303c12013-11-07 23:07:29 +010037_Py_IDENTIFIER(_);
38_Py_IDENTIFIER(__sizeof__);
Eric Snowdae02762017-09-14 00:35:58 -070039_Py_IDENTIFIER(_xoptions);
Victor Stinnerbd303c12013-11-07 23:07:29 +010040_Py_IDENTIFIER(buffer);
41_Py_IDENTIFIER(builtins);
42_Py_IDENTIFIER(encoding);
43_Py_IDENTIFIER(path);
44_Py_IDENTIFIER(stdout);
45_Py_IDENTIFIER(stderr);
Eric Snowdae02762017-09-14 00:35:58 -070046_Py_IDENTIFIER(warnoptions);
Victor Stinnerbd303c12013-11-07 23:07:29 +010047_Py_IDENTIFIER(write);
48
Guido van Rossum65bf9f21997-04-29 18:33:38 +000049PyObject *
Victor Stinnerd67bd452013-11-06 22:36:40 +010050_PySys_GetObjectId(_Py_Identifier *key)
51{
52 PyThreadState *tstate = PyThreadState_GET();
53 PyObject *sd = tstate->interp->sysdict;
54 if (sd == NULL)
55 return NULL;
56 return _PyDict_GetItemId(sd, key);
57}
58
59PyObject *
Neal Norwitzf3081322007-08-25 00:32:45 +000060PySys_GetObject(const char *name)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000061{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000062 PyThreadState *tstate = PyThreadState_GET();
63 PyObject *sd = tstate->interp->sysdict;
64 if (sd == NULL)
65 return NULL;
66 return PyDict_GetItemString(sd, name);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000067}
68
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000069int
Victor Stinnerd67bd452013-11-06 22:36:40 +010070_PySys_SetObjectId(_Py_Identifier *key, PyObject *v)
71{
72 PyThreadState *tstate = PyThreadState_GET();
73 PyObject *sd = tstate->interp->sysdict;
74 if (v == NULL) {
75 if (_PyDict_GetItemId(sd, key) == NULL)
76 return 0;
77 else
78 return _PyDict_DelItemId(sd, key);
79 }
80 else
81 return _PyDict_SetItemId(sd, key, v);
82}
83
84int
Neal Norwitzf3081322007-08-25 00:32:45 +000085PySys_SetObject(const char *name, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000086{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000087 PyThreadState *tstate = PyThreadState_GET();
88 PyObject *sd = tstate->interp->sysdict;
89 if (v == NULL) {
90 if (PyDict_GetItemString(sd, name) == NULL)
91 return 0;
92 else
93 return PyDict_DelItemString(sd, name);
94 }
95 else
96 return PyDict_SetItemString(sd, name, v);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000097}
98
Victor Stinner13d49ee2010-12-04 17:24:33 +000099/* Write repr(o) to sys.stdout using sys.stdout.encoding and 'backslashreplace'
100 error handler. If sys.stdout has a buffer attribute, use
101 sys.stdout.buffer.write(encoded), otherwise redecode the string and use
102 sys.stdout.write(redecoded).
103
104 Helper function for sys_displayhook(). */
105static int
106sys_displayhook_unencodable(PyObject *outf, PyObject *o)
107{
108 PyObject *stdout_encoding = NULL;
109 PyObject *encoded, *escaped_str, *repr_str, *buffer, *result;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200110 const char *stdout_encoding_str;
Victor Stinner13d49ee2010-12-04 17:24:33 +0000111 int ret;
112
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200113 stdout_encoding = _PyObject_GetAttrId(outf, &PyId_encoding);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000114 if (stdout_encoding == NULL)
115 goto error;
Serhiy Storchaka06515832016-11-20 09:13:07 +0200116 stdout_encoding_str = PyUnicode_AsUTF8(stdout_encoding);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000117 if (stdout_encoding_str == NULL)
118 goto error;
119
120 repr_str = PyObject_Repr(o);
121 if (repr_str == NULL)
122 goto error;
123 encoded = PyUnicode_AsEncodedString(repr_str,
124 stdout_encoding_str,
125 "backslashreplace");
126 Py_DECREF(repr_str);
127 if (encoded == NULL)
128 goto error;
129
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200130 buffer = _PyObject_GetAttrId(outf, &PyId_buffer);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000131 if (buffer) {
Victor Stinner7e425412016-12-09 00:36:19 +0100132 result = _PyObject_CallMethodIdObjArgs(buffer, &PyId_write, encoded, NULL);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000133 Py_DECREF(buffer);
134 Py_DECREF(encoded);
135 if (result == NULL)
136 goto error;
137 Py_DECREF(result);
138 }
139 else {
140 PyErr_Clear();
141 escaped_str = PyUnicode_FromEncodedObject(encoded,
142 stdout_encoding_str,
143 "strict");
144 Py_DECREF(encoded);
145 if (PyFile_WriteObject(escaped_str, outf, Py_PRINT_RAW) != 0) {
146 Py_DECREF(escaped_str);
147 goto error;
148 }
149 Py_DECREF(escaped_str);
150 }
151 ret = 0;
152 goto finally;
153
154error:
155 ret = -1;
156finally:
157 Py_XDECREF(stdout_encoding);
158 return ret;
159}
160
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000161static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000162sys_displayhook(PyObject *self, PyObject *o)
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000163{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000164 PyObject *outf;
Victor Stinnerd02fbb82013-11-06 18:27:13 +0100165 PyObject *builtins;
166 static PyObject *newline = NULL;
Victor Stinner13d49ee2010-12-04 17:24:33 +0000167 int err;
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000168
Eric Snow3f9eee62017-09-15 16:35:20 -0600169 builtins = _PyImport_GetModuleId(&PyId_builtins);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000170 if (builtins == NULL) {
171 PyErr_SetString(PyExc_RuntimeError, "lost builtins module");
172 return NULL;
173 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600174 Py_DECREF(builtins);
Moshe Zadka03897ea2001-07-23 13:32:43 +0000175
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000176 /* Print value except if None */
177 /* After printing, also assign to '_' */
178 /* Before, set '_' to None to avoid recursion */
179 if (o == Py_None) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200180 Py_RETURN_NONE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000181 }
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200182 if (_PyObject_SetAttrId(builtins, &PyId__, Py_None) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000183 return NULL;
Victor Stinnerbd303c12013-11-07 23:07:29 +0100184 outf = _PySys_GetObjectId(&PyId_stdout);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000185 if (outf == NULL || outf == Py_None) {
186 PyErr_SetString(PyExc_RuntimeError, "lost sys.stdout");
187 return NULL;
188 }
Victor Stinner13d49ee2010-12-04 17:24:33 +0000189 if (PyFile_WriteObject(o, outf, 0) != 0) {
190 if (PyErr_ExceptionMatches(PyExc_UnicodeEncodeError)) {
191 /* repr(o) is not encodable to sys.stdout.encoding with
192 * sys.stdout.errors error handler (which is probably 'strict') */
193 PyErr_Clear();
194 err = sys_displayhook_unencodable(outf, o);
195 if (err)
196 return NULL;
197 }
198 else {
199 return NULL;
200 }
201 }
Victor Stinnerd02fbb82013-11-06 18:27:13 +0100202 if (newline == NULL) {
203 newline = PyUnicode_FromString("\n");
204 if (newline == NULL)
205 return NULL;
206 }
207 if (PyFile_WriteObject(newline, outf, Py_PRINT_RAW) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000208 return NULL;
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200209 if (_PyObject_SetAttrId(builtins, &PyId__, o) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000210 return NULL;
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200211 Py_RETURN_NONE;
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000212}
213
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000214PyDoc_STRVAR(displayhook_doc,
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000215"displayhook(object) -> None\n"
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000216"\n"
Florent Xicluna5749e852010-03-03 11:54:54 +0000217"Print an object to sys.stdout and also save it in builtins._\n"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000218);
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000219
220static PyObject *
221sys_excepthook(PyObject* self, PyObject* args)
222{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000223 PyObject *exc, *value, *tb;
224 if (!PyArg_UnpackTuple(args, "excepthook", 3, 3, &exc, &value, &tb))
225 return NULL;
226 PyErr_Display(exc, value, tb);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200227 Py_RETURN_NONE;
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000228}
229
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000230PyDoc_STRVAR(excepthook_doc,
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000231"excepthook(exctype, value, traceback) -> None\n"
232"\n"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000233"Handle an exception by displaying it with a traceback on sys.stderr.\n"
234);
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000235
236static PyObject *
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000237sys_exc_info(PyObject *self, PyObject *noargs)
Guido van Rossuma027efa1997-05-05 20:56:21 +0000238{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000239 PyThreadState *tstate;
240 tstate = PyThreadState_GET();
241 return Py_BuildValue(
242 "(OOO)",
243 tstate->exc_type != NULL ? tstate->exc_type : Py_None,
244 tstate->exc_value != NULL ? tstate->exc_value : Py_None,
245 tstate->exc_traceback != NULL ?
246 tstate->exc_traceback : Py_None);
Guido van Rossuma027efa1997-05-05 20:56:21 +0000247}
248
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000249PyDoc_STRVAR(exc_info_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000250"exc_info() -> (type, value, traceback)\n\
251\n\
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000252Return information about the most recent exception caught by an except\n\
253clause in the current stack frame or in an older stack frame."
254);
255
256static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000257sys_exit(PyObject *self, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000258{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000259 PyObject *exit_code = 0;
260 if (!PyArg_UnpackTuple(args, "exit", 0, 1, &exit_code))
261 return NULL;
262 /* Raise SystemExit so callers may catch it or clean up. */
263 PyErr_SetObject(PyExc_SystemExit, exit_code);
264 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000265}
266
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000267PyDoc_STRVAR(exit_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000268"exit([status])\n\
269\n\
270Exit the interpreter by raising SystemExit(status).\n\
271If the status is omitted or None, it defaults to zero (i.e., success).\n\
Ezio Melotti4af4d272013-08-26 14:00:39 +0300272If the status is an integer, it will be used as the system exit status.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000273If it is another kind of object, it will be printed and the system\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000274exit status will be one (i.e., failure)."
275);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000276
Martin v. Löwis107b7da2001-11-09 20:59:39 +0000277
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000278static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000279sys_getdefaultencoding(PyObject *self)
Fred Drake8b4d01d2000-05-09 19:57:01 +0000280{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000281 return PyUnicode_FromString(PyUnicode_GetDefaultEncoding());
Fred Drake8b4d01d2000-05-09 19:57:01 +0000282}
283
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000284PyDoc_STRVAR(getdefaultencoding_doc,
Marc-André Lemburg99964b82000-06-07 09:13:41 +0000285"getdefaultencoding() -> string\n\
Fred Drake8b4d01d2000-05-09 19:57:01 +0000286\n\
287Return the current default string encoding used by the Unicode \n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000288implementation."
289);
Fred Drake8b4d01d2000-05-09 19:57:01 +0000290
291static PyObject *
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000292sys_getfilesystemencoding(PyObject *self)
293{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000294 if (Py_FileSystemDefaultEncoding)
295 return PyUnicode_FromString(Py_FileSystemDefaultEncoding);
Victor Stinner27181ac2011-03-31 13:39:03 +0200296 PyErr_SetString(PyExc_RuntimeError,
297 "filesystem encoding is not initialized");
298 return NULL;
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000299}
300
301PyDoc_STRVAR(getfilesystemencoding_doc,
302"getfilesystemencoding() -> string\n\
303\n\
304Return the encoding used to convert Unicode filenames in\n\
305operating system filenames."
306);
307
Martin v. Löwis04dc25c2008-10-03 16:09:28 +0000308static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -0700309sys_getfilesystemencodeerrors(PyObject *self)
310{
311 if (Py_FileSystemDefaultEncodeErrors)
312 return PyUnicode_FromString(Py_FileSystemDefaultEncodeErrors);
313 PyErr_SetString(PyExc_RuntimeError,
314 "filesystem encoding is not initialized");
315 return NULL;
316}
317
318PyDoc_STRVAR(getfilesystemencodeerrors_doc,
319 "getfilesystemencodeerrors() -> string\n\
320\n\
321Return the error mode used to convert Unicode filenames in\n\
322operating system filenames."
323);
324
325static PyObject *
Georg Brandl66a796e2006-12-19 20:50:34 +0000326sys_intern(PyObject *self, PyObject *args)
327{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000328 PyObject *s;
329 if (!PyArg_ParseTuple(args, "U:intern", &s))
330 return NULL;
331 if (PyUnicode_CheckExact(s)) {
332 Py_INCREF(s);
333 PyUnicode_InternInPlace(&s);
334 return s;
335 }
336 else {
337 PyErr_Format(PyExc_TypeError,
338 "can't intern %.400s", s->ob_type->tp_name);
339 return NULL;
340 }
Georg Brandl66a796e2006-12-19 20:50:34 +0000341}
342
343PyDoc_STRVAR(intern_doc,
344"intern(string) -> string\n\
345\n\
346``Intern'' the given string. This enters the string in the (global)\n\
347table of interned strings whose purpose is to speed up dictionary lookups.\n\
348Return the string itself or the previously interned string object with the\n\
349same value.");
350
351
Fred Drake5755ce62001-06-27 19:19:46 +0000352/*
353 * Cached interned string objects used for calling the profile and
354 * trace functions. Initialized by trace_init().
355 */
Nick Coghlan5a851672017-09-08 10:14:16 +1000356static PyObject *whatstrings[8] = {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL};
Fred Drake5755ce62001-06-27 19:19:46 +0000357
358static int
359trace_init(void)
360{
Nick Coghlan5a851672017-09-08 10:14:16 +1000361 static const char * const whatnames[8] = {
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200362 "call", "exception", "line", "return",
Nick Coghlan5a851672017-09-08 10:14:16 +1000363 "c_call", "c_exception", "c_return",
364 "opcode"
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200365 };
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000366 PyObject *name;
367 int i;
Nick Coghlan5a851672017-09-08 10:14:16 +1000368 for (i = 0; i < 8; ++i) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000369 if (whatstrings[i] == NULL) {
370 name = PyUnicode_InternFromString(whatnames[i]);
371 if (name == NULL)
372 return -1;
373 whatstrings[i] = name;
374 }
375 }
376 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000377}
378
379
380static PyObject *
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100381call_trampoline(PyObject* callback,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000382 PyFrameObject *frame, int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000383{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000384 PyObject *result;
Victor Stinner78da82b2016-08-20 01:22:57 +0200385 PyObject *stack[3];
Fred Drake5755ce62001-06-27 19:19:46 +0000386
Victor Stinner78da82b2016-08-20 01:22:57 +0200387 if (PyFrame_FastToLocalsWithError(frame) < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000388 return NULL;
Victor Stinner78da82b2016-08-20 01:22:57 +0200389 }
Victor Stinner41bb43a2013-10-29 01:19:37 +0100390
Victor Stinner78da82b2016-08-20 01:22:57 +0200391 stack[0] = (PyObject *)frame;
392 stack[1] = whatstrings[what];
393 stack[2] = (arg != NULL) ? arg : Py_None;
Fred Drake5755ce62001-06-27 19:19:46 +0000394
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000395 /* call the Python-level function */
Victor Stinner559bb6a2016-08-22 22:48:54 +0200396 result = _PyObject_FastCall(callback, stack, 3);
Fred Drake5755ce62001-06-27 19:19:46 +0000397
Victor Stinner78da82b2016-08-20 01:22:57 +0200398 PyFrame_LocalsToFast(frame, 1);
399 if (result == NULL) {
400 PyTraceBack_Here(frame);
401 }
402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000403 return result;
Fred Drake5755ce62001-06-27 19:19:46 +0000404}
405
406static int
407profile_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000408 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000409{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000410 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000411
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000412 if (arg == NULL)
413 arg = Py_None;
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100414 result = call_trampoline(self, frame, what, arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000415 if (result == NULL) {
416 PyEval_SetProfile(NULL, NULL);
417 return -1;
418 }
419 Py_DECREF(result);
420 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000421}
422
423static int
424trace_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000425 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000426{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000427 PyObject *callback;
428 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000429
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000430 if (what == PyTrace_CALL)
431 callback = self;
432 else
433 callback = frame->f_trace;
434 if (callback == NULL)
435 return 0;
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100436 result = call_trampoline(callback, frame, what, arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000437 if (result == NULL) {
438 PyEval_SetTrace(NULL, NULL);
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200439 Py_CLEAR(frame->f_trace);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000440 return -1;
441 }
442 if (result != Py_None) {
Serhiy Storchakaec397562016-04-06 09:50:03 +0300443 Py_XSETREF(frame->f_trace, result);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000444 }
445 else {
446 Py_DECREF(result);
447 }
448 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000449}
Fred Draked0838392001-06-16 21:02:31 +0000450
Fred Drake8b4d01d2000-05-09 19:57:01 +0000451static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000452sys_settrace(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000453{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000454 if (trace_init() == -1)
455 return NULL;
456 if (args == Py_None)
457 PyEval_SetTrace(NULL, NULL);
458 else
459 PyEval_SetTrace(trace_trampoline, args);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200460 Py_RETURN_NONE;
Guido van Rossume2437a11992-03-23 18:20:18 +0000461}
462
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000463PyDoc_STRVAR(settrace_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000464"settrace(function)\n\
465\n\
466Set the global debug tracing function. It will be called on each\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000467function call. See the debugger chapter in the library manual."
468);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000469
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000470static PyObject *
Christian Heimes9bd667a2008-01-20 15:14:11 +0000471sys_gettrace(PyObject *self, PyObject *args)
472{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000473 PyThreadState *tstate = PyThreadState_GET();
474 PyObject *temp = tstate->c_traceobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000475
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000476 if (temp == NULL)
477 temp = Py_None;
478 Py_INCREF(temp);
479 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000480}
481
482PyDoc_STRVAR(gettrace_doc,
483"gettrace()\n\
484\n\
485Return the global debug tracing function set with sys.settrace.\n\
486See the debugger chapter in the library manual."
487);
488
489static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000490sys_setprofile(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000491{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000492 if (trace_init() == -1)
493 return NULL;
494 if (args == Py_None)
495 PyEval_SetProfile(NULL, NULL);
496 else
497 PyEval_SetProfile(profile_trampoline, args);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200498 Py_RETURN_NONE;
Guido van Rossume2437a11992-03-23 18:20:18 +0000499}
500
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000501PyDoc_STRVAR(setprofile_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000502"setprofile(function)\n\
503\n\
504Set the profiling function. It will be called on each function call\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000505and return. See the profiler chapter in the library manual."
506);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000507
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000508static PyObject *
Christian Heimes9bd667a2008-01-20 15:14:11 +0000509sys_getprofile(PyObject *self, PyObject *args)
510{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000511 PyThreadState *tstate = PyThreadState_GET();
512 PyObject *temp = tstate->c_profileobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000513
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514 if (temp == NULL)
515 temp = Py_None;
516 Py_INCREF(temp);
517 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000518}
519
520PyDoc_STRVAR(getprofile_doc,
521"getprofile()\n\
522\n\
523Return the profiling function set with sys.setprofile.\n\
524See the profiler chapter in the library manual."
525);
526
527static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000528sys_setcheckinterval(PyObject *self, PyObject *args)
Guido van Rossuma0d7a231995-01-09 17:46:13 +0000529{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000530 if (PyErr_WarnEx(PyExc_DeprecationWarning,
531 "sys.getcheckinterval() and sys.setcheckinterval() "
532 "are deprecated. Use sys.setswitchinterval() "
533 "instead.", 1) < 0)
534 return NULL;
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600535 PyInterpreterState *interp = PyThreadState_GET()->interp;
536 if (!PyArg_ParseTuple(args, "i:setcheckinterval", &interp->check_interval))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000537 return NULL;
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200538 Py_RETURN_NONE;
Guido van Rossuma0d7a231995-01-09 17:46:13 +0000539}
540
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000541PyDoc_STRVAR(setcheckinterval_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000542"setcheckinterval(n)\n\
543\n\
544Tell the Python interpreter to check for asynchronous events every\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000545n instructions. This also affects how often thread switches occur."
546);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000547
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000548static PyObject *
Tim Peterse5e065b2003-07-06 18:36:54 +0000549sys_getcheckinterval(PyObject *self, PyObject *args)
550{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000551 if (PyErr_WarnEx(PyExc_DeprecationWarning,
552 "sys.getcheckinterval() and sys.setcheckinterval() "
553 "are deprecated. Use sys.getswitchinterval() "
554 "instead.", 1) < 0)
555 return NULL;
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600556 PyInterpreterState *interp = PyThreadState_GET()->interp;
557 return PyLong_FromLong(interp->check_interval);
Tim Peterse5e065b2003-07-06 18:36:54 +0000558}
559
560PyDoc_STRVAR(getcheckinterval_doc,
561"getcheckinterval() -> current check interval; see setcheckinterval()."
562);
563
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000564static PyObject *
565sys_setswitchinterval(PyObject *self, PyObject *args)
566{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000567 double d;
568 if (!PyArg_ParseTuple(args, "d:setswitchinterval", &d))
569 return NULL;
570 if (d <= 0.0) {
571 PyErr_SetString(PyExc_ValueError,
572 "switch interval must be strictly positive");
573 return NULL;
574 }
575 _PyEval_SetSwitchInterval((unsigned long) (1e6 * d));
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200576 Py_RETURN_NONE;
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000577}
578
579PyDoc_STRVAR(setswitchinterval_doc,
580"setswitchinterval(n)\n\
581\n\
582Set the ideal thread switching delay inside the Python interpreter\n\
583The actual frequency of switching threads can be lower if the\n\
584interpreter executes long sequences of uninterruptible code\n\
585(this is implementation-specific and workload-dependent).\n\
586\n\
587The parameter must represent the desired switching delay in seconds\n\
588A typical value is 0.005 (5 milliseconds)."
589);
590
591static PyObject *
592sys_getswitchinterval(PyObject *self, PyObject *args)
593{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000594 return PyFloat_FromDouble(1e-6 * _PyEval_GetSwitchInterval());
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000595}
596
597PyDoc_STRVAR(getswitchinterval_doc,
598"getswitchinterval() -> current thread switch interval; see setswitchinterval()."
599);
600
Tim Peterse5e065b2003-07-06 18:36:54 +0000601static PyObject *
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000602sys_setrecursionlimit(PyObject *self, PyObject *args)
603{
Victor Stinner50856d52015-10-13 00:11:21 +0200604 int new_limit, mark;
605 PyThreadState *tstate;
606
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000607 if (!PyArg_ParseTuple(args, "i:setrecursionlimit", &new_limit))
608 return NULL;
Victor Stinner50856d52015-10-13 00:11:21 +0200609
610 if (new_limit < 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000611 PyErr_SetString(PyExc_ValueError,
Victor Stinner50856d52015-10-13 00:11:21 +0200612 "recursion limit must be greater or equal than 1");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000613 return NULL;
614 }
Victor Stinner50856d52015-10-13 00:11:21 +0200615
616 /* Issue #25274: When the recursion depth hits the recursion limit in
617 _Py_CheckRecursiveCall(), the overflowed flag of the thread state is
618 set to 1 and a RecursionError is raised. The overflowed flag is reset
619 to 0 when the recursion depth goes below the low-water mark: see
620 Py_LeaveRecursiveCall().
621
622 Reject too low new limit if the current recursion depth is higher than
623 the new low-water mark. Otherwise it may not be possible anymore to
624 reset the overflowed flag to 0. */
625 mark = _Py_RecursionLimitLowerWaterMark(new_limit);
626 tstate = PyThreadState_GET();
627 if (tstate->recursion_depth >= mark) {
628 PyErr_Format(PyExc_RecursionError,
629 "cannot set the recursion limit to %i at "
630 "the recursion depth %i: the limit is too low",
631 new_limit, tstate->recursion_depth);
632 return NULL;
633 }
634
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000635 Py_SetRecursionLimit(new_limit);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200636 Py_RETURN_NONE;
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000637}
638
Yury Selivanov75445082015-05-11 22:57:16 -0400639static PyObject *
640sys_set_coroutine_wrapper(PyObject *self, PyObject *wrapper)
641{
642 if (wrapper != Py_None) {
643 if (!PyCallable_Check(wrapper)) {
644 PyErr_Format(PyExc_TypeError,
645 "callable expected, got %.50s",
646 Py_TYPE(wrapper)->tp_name);
647 return NULL;
648 }
Yury Selivanovd8cf3822015-06-01 12:15:23 -0400649 _PyEval_SetCoroutineWrapper(wrapper);
Yury Selivanov75445082015-05-11 22:57:16 -0400650 }
Benjamin Petersonbaa2e562015-05-12 11:32:41 -0400651 else {
Yury Selivanovd8cf3822015-06-01 12:15:23 -0400652 _PyEval_SetCoroutineWrapper(NULL);
Benjamin Petersonbaa2e562015-05-12 11:32:41 -0400653 }
Yury Selivanov75445082015-05-11 22:57:16 -0400654 Py_RETURN_NONE;
655}
656
657PyDoc_STRVAR(set_coroutine_wrapper_doc,
658"set_coroutine_wrapper(wrapper)\n\
659\n\
660Set a wrapper for coroutine objects."
661);
662
663static PyObject *
664sys_get_coroutine_wrapper(PyObject *self, PyObject *args)
665{
Yury Selivanovd8cf3822015-06-01 12:15:23 -0400666 PyObject *wrapper = _PyEval_GetCoroutineWrapper();
Yury Selivanov75445082015-05-11 22:57:16 -0400667 if (wrapper == NULL) {
668 wrapper = Py_None;
669 }
670 Py_INCREF(wrapper);
671 return wrapper;
672}
673
674PyDoc_STRVAR(get_coroutine_wrapper_doc,
675"get_coroutine_wrapper()\n\
676\n\
677Return the wrapper for coroutine objects set by sys.set_coroutine_wrapper."
678);
679
680
Yury Selivanoveb636452016-09-08 22:01:51 -0700681static PyTypeObject AsyncGenHooksType;
682
683PyDoc_STRVAR(asyncgen_hooks_doc,
684"asyncgen_hooks\n\
685\n\
686A struct sequence providing information about asynhronous\n\
687generators hooks. The attributes are read only.");
688
689static PyStructSequence_Field asyncgen_hooks_fields[] = {
690 {"firstiter", "Hook to intercept first iteration"},
691 {"finalizer", "Hook to intercept finalization"},
692 {0}
693};
694
695static PyStructSequence_Desc asyncgen_hooks_desc = {
696 "asyncgen_hooks", /* name */
697 asyncgen_hooks_doc, /* doc */
698 asyncgen_hooks_fields , /* fields */
699 2
700};
701
702
703static PyObject *
704sys_set_asyncgen_hooks(PyObject *self, PyObject *args, PyObject *kw)
705{
706 static char *keywords[] = {"firstiter", "finalizer", NULL};
707 PyObject *firstiter = NULL;
708 PyObject *finalizer = NULL;
709
710 if (!PyArg_ParseTupleAndKeywords(
711 args, kw, "|OO", keywords,
712 &firstiter, &finalizer)) {
713 return NULL;
714 }
715
716 if (finalizer && finalizer != Py_None) {
717 if (!PyCallable_Check(finalizer)) {
718 PyErr_Format(PyExc_TypeError,
719 "callable finalizer expected, got %.50s",
720 Py_TYPE(finalizer)->tp_name);
721 return NULL;
722 }
723 _PyEval_SetAsyncGenFinalizer(finalizer);
724 }
725 else if (finalizer == Py_None) {
726 _PyEval_SetAsyncGenFinalizer(NULL);
727 }
728
729 if (firstiter && firstiter != Py_None) {
730 if (!PyCallable_Check(firstiter)) {
731 PyErr_Format(PyExc_TypeError,
732 "callable firstiter expected, got %.50s",
733 Py_TYPE(firstiter)->tp_name);
734 return NULL;
735 }
736 _PyEval_SetAsyncGenFirstiter(firstiter);
737 }
738 else if (firstiter == Py_None) {
739 _PyEval_SetAsyncGenFirstiter(NULL);
740 }
741
742 Py_RETURN_NONE;
743}
744
745PyDoc_STRVAR(set_asyncgen_hooks_doc,
746"set_asyncgen_hooks(*, firstiter=None, finalizer=None)\n\
747\n\
748Set a finalizer for async generators objects."
749);
750
751static PyObject *
752sys_get_asyncgen_hooks(PyObject *self, PyObject *args)
753{
754 PyObject *res;
755 PyObject *firstiter = _PyEval_GetAsyncGenFirstiter();
756 PyObject *finalizer = _PyEval_GetAsyncGenFinalizer();
757
758 res = PyStructSequence_New(&AsyncGenHooksType);
759 if (res == NULL) {
760 return NULL;
761 }
762
763 if (firstiter == NULL) {
764 firstiter = Py_None;
765 }
766
767 if (finalizer == NULL) {
768 finalizer = Py_None;
769 }
770
771 Py_INCREF(firstiter);
772 PyStructSequence_SET_ITEM(res, 0, firstiter);
773
774 Py_INCREF(finalizer);
775 PyStructSequence_SET_ITEM(res, 1, finalizer);
776
777 return res;
778}
779
780PyDoc_STRVAR(get_asyncgen_hooks_doc,
781"get_asyncgen_hooks()\n\
782\n\
783Return a namedtuple of installed asynchronous generators hooks \
784(firstiter, finalizer)."
785);
786
787
Mark Dickinsondc787d22010-05-23 13:33:13 +0000788static PyTypeObject Hash_InfoType;
789
790PyDoc_STRVAR(hash_info_doc,
791"hash_info\n\
792\n\
793A struct sequence providing parameters used for computing\n\
Christian Heimes985ecdc2013-11-20 11:46:18 +0100794hashes. The attributes are read only.");
Mark Dickinsondc787d22010-05-23 13:33:13 +0000795
796static PyStructSequence_Field hash_info_fields[] = {
797 {"width", "width of the type used for hashing, in bits"},
798 {"modulus", "prime number giving the modulus on which the hash "
799 "function is based"},
800 {"inf", "value to be used for hash of a positive infinity"},
801 {"nan", "value to be used for hash of a nan"},
802 {"imag", "multiplier used for the imaginary part of a complex number"},
Christian Heimes985ecdc2013-11-20 11:46:18 +0100803 {"algorithm", "name of the algorithm for hashing of str, bytes and "
804 "memoryviews"},
805 {"hash_bits", "internal output size of hash algorithm"},
806 {"seed_bits", "seed size of hash algorithm"},
807 {"cutoff", "small string optimization cutoff"},
Mark Dickinsondc787d22010-05-23 13:33:13 +0000808 {NULL, NULL}
809};
810
811static PyStructSequence_Desc hash_info_desc = {
812 "sys.hash_info",
813 hash_info_doc,
814 hash_info_fields,
Christian Heimes985ecdc2013-11-20 11:46:18 +0100815 9,
Mark Dickinsondc787d22010-05-23 13:33:13 +0000816};
817
Matthias Klosed885e952010-07-06 10:53:30 +0000818static PyObject *
Mark Dickinsondc787d22010-05-23 13:33:13 +0000819get_hash_info(void)
820{
821 PyObject *hash_info;
822 int field = 0;
Christian Heimes985ecdc2013-11-20 11:46:18 +0100823 PyHash_FuncDef *hashfunc;
Mark Dickinsondc787d22010-05-23 13:33:13 +0000824 hash_info = PyStructSequence_New(&Hash_InfoType);
825 if (hash_info == NULL)
826 return NULL;
Christian Heimes985ecdc2013-11-20 11:46:18 +0100827 hashfunc = PyHash_GetFuncDef();
Mark Dickinsondc787d22010-05-23 13:33:13 +0000828 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000829 PyLong_FromLong(8*sizeof(Py_hash_t)));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000830 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000831 PyLong_FromSsize_t(_PyHASH_MODULUS));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000832 PyStructSequence_SET_ITEM(hash_info, field++,
833 PyLong_FromLong(_PyHASH_INF));
834 PyStructSequence_SET_ITEM(hash_info, field++,
835 PyLong_FromLong(_PyHASH_NAN));
836 PyStructSequence_SET_ITEM(hash_info, field++,
837 PyLong_FromLong(_PyHASH_IMAG));
Christian Heimes985ecdc2013-11-20 11:46:18 +0100838 PyStructSequence_SET_ITEM(hash_info, field++,
839 PyUnicode_FromString(hashfunc->name));
840 PyStructSequence_SET_ITEM(hash_info, field++,
841 PyLong_FromLong(hashfunc->hash_bits));
842 PyStructSequence_SET_ITEM(hash_info, field++,
843 PyLong_FromLong(hashfunc->seed_bits));
844 PyStructSequence_SET_ITEM(hash_info, field++,
845 PyLong_FromLong(Py_HASH_CUTOFF));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000846 if (PyErr_Occurred()) {
847 Py_CLEAR(hash_info);
848 return NULL;
849 }
850 return hash_info;
851}
852
853
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000854PyDoc_STRVAR(setrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000855"setrecursionlimit(n)\n\
856\n\
857Set the maximum depth of the Python interpreter stack to n. This\n\
858limit prevents infinite recursion from causing an overflow of the C\n\
859stack and crashing Python. The highest possible limit is platform-\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000860dependent."
861);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000862
863static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000864sys_getrecursionlimit(PyObject *self)
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000865{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000866 return PyLong_FromLong(Py_GetRecursionLimit());
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000867}
868
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000869PyDoc_STRVAR(getrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000870"getrecursionlimit()\n\
871\n\
872Return the current value of the recursion limit, the maximum depth\n\
873of the Python interpreter stack. This limit prevents infinite\n\
Jack Jansene739a0d2002-06-26 20:39:20 +0000874recursion from causing an overflow of the C stack and crashing Python."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000875);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000876
Mark Hammond8696ebc2002-10-08 02:44:31 +0000877#ifdef MS_WINDOWS
878PyDoc_STRVAR(getwindowsversion_doc,
879"getwindowsversion()\n\
880\n\
Eric Smithf7bb5782010-01-27 00:44:57 +0000881Return information about the running version of Windows as a named tuple.\n\
882The members are named: major, minor, build, platform, service_pack,\n\
883service_pack_major, service_pack_minor, suite_mask, and product_type. For\n\
Ezio Melotti4969f702011-03-15 05:59:46 +0200884backward compatibility, only the first 5 items are available by indexing.\n\
Steve Dower74f4af72016-09-17 17:27:48 -0700885All elements are numbers, except service_pack and platform_type which are\n\
886strings, and platform_version which is a 3-tuple. Platform is always 2.\n\
887Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a\n\
888server. Platform_version is a 3-tuple containing a version number that is\n\
889intended for identifying the OS rather than feature detection."
Mark Hammond8696ebc2002-10-08 02:44:31 +0000890);
891
Eric Smithf7bb5782010-01-27 00:44:57 +0000892static PyTypeObject WindowsVersionType = {0, 0, 0, 0, 0, 0};
893
894static PyStructSequence_Field windows_version_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000895 {"major", "Major version number"},
896 {"minor", "Minor version number"},
897 {"build", "Build number"},
898 {"platform", "Operating system platform"},
899 {"service_pack", "Latest Service Pack installed on the system"},
900 {"service_pack_major", "Service Pack major version number"},
901 {"service_pack_minor", "Service Pack minor version number"},
902 {"suite_mask", "Bit mask identifying available product suites"},
903 {"product_type", "System product type"},
Steve Dower74f4af72016-09-17 17:27:48 -0700904 {"platform_version", "Diagnostic version number"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 {0}
Eric Smithf7bb5782010-01-27 00:44:57 +0000906};
907
908static PyStructSequence_Desc windows_version_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000909 "sys.getwindowsversion", /* name */
910 getwindowsversion_doc, /* doc */
911 windows_version_fields, /* fields */
912 5 /* For backward compatibility,
913 only the first 5 items are accessible
914 via indexing, the rest are name only */
Eric Smithf7bb5782010-01-27 00:44:57 +0000915};
916
Steve Dower3e96f322015-03-02 08:01:10 -0800917/* Disable deprecation warnings about GetVersionEx as the result is
918 being passed straight through to the caller, who is responsible for
919 using it correctly. */
920#pragma warning(push)
921#pragma warning(disable:4996)
922
Mark Hammond8696ebc2002-10-08 02:44:31 +0000923static PyObject *
924sys_getwindowsversion(PyObject *self)
925{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000926 PyObject *version;
927 int pos = 0;
928 OSVERSIONINFOEX ver;
Steve Dower74f4af72016-09-17 17:27:48 -0700929 DWORD realMajor, realMinor, realBuild;
930 HANDLE hKernel32;
931 wchar_t kernel32_path[MAX_PATH];
932 LPVOID verblock;
933 DWORD verblock_size;
934
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000935 ver.dwOSVersionInfoSize = sizeof(ver);
936 if (!GetVersionEx((OSVERSIONINFO*) &ver))
937 return PyErr_SetFromWindowsErr(0);
Eric Smithf7bb5782010-01-27 00:44:57 +0000938
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000939 version = PyStructSequence_New(&WindowsVersionType);
940 if (version == NULL)
941 return NULL;
Eric Smithf7bb5782010-01-27 00:44:57 +0000942
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000943 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMajorVersion));
944 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMinorVersion));
945 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwBuildNumber));
946 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwPlatformId));
947 PyStructSequence_SET_ITEM(version, pos++, PyUnicode_FromString(ver.szCSDVersion));
948 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMajor));
949 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMinor));
950 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wSuiteMask));
951 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wProductType));
Eric Smithf7bb5782010-01-27 00:44:57 +0000952
Steve Dower74f4af72016-09-17 17:27:48 -0700953 realMajor = ver.dwMajorVersion;
954 realMinor = ver.dwMinorVersion;
955 realBuild = ver.dwBuildNumber;
956
957 // GetVersion will lie if we are running in a compatibility mode.
958 // We need to read the version info from a system file resource
959 // to accurately identify the OS version. If we fail for any reason,
960 // just return whatever GetVersion said.
961 hKernel32 = GetModuleHandleW(L"kernel32.dll");
962 if (hKernel32 && GetModuleFileNameW(hKernel32, kernel32_path, MAX_PATH) &&
963 (verblock_size = GetFileVersionInfoSizeW(kernel32_path, NULL)) &&
964 (verblock = PyMem_RawMalloc(verblock_size))) {
965 VS_FIXEDFILEINFO *ffi;
966 UINT ffi_len;
967
968 if (GetFileVersionInfoW(kernel32_path, 0, verblock_size, verblock) &&
969 VerQueryValueW(verblock, L"", (LPVOID)&ffi, &ffi_len)) {
970 realMajor = HIWORD(ffi->dwProductVersionMS);
971 realMinor = LOWORD(ffi->dwProductVersionMS);
972 realBuild = HIWORD(ffi->dwProductVersionLS);
973 }
974 PyMem_RawFree(verblock);
975 }
Segev Finer48fb7662017-06-04 20:52:27 +0300976 PyStructSequence_SET_ITEM(version, pos++, Py_BuildValue("(kkk)",
977 realMajor,
978 realMinor,
979 realBuild
Steve Dower74f4af72016-09-17 17:27:48 -0700980 ));
981
Serhiy Storchaka48d761e2013-12-17 15:11:24 +0200982 if (PyErr_Occurred()) {
983 Py_DECREF(version);
984 return NULL;
985 }
Steve Dower74f4af72016-09-17 17:27:48 -0700986
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000987 return version;
Mark Hammond8696ebc2002-10-08 02:44:31 +0000988}
989
Steve Dower3e96f322015-03-02 08:01:10 -0800990#pragma warning(pop)
991
Steve Dowercc16be82016-09-08 10:35:16 -0700992PyDoc_STRVAR(enablelegacywindowsfsencoding_doc,
993"_enablelegacywindowsfsencoding()\n\
994\n\
995Changes the default filesystem encoding to mbcs:replace for consistency\n\
996with earlier versions of Python. See PEP 529 for more information.\n\
997\n\
998This is equivalent to defining the PYTHONLEGACYWINDOWSFSENCODING \n\
999environment variable before launching Python."
1000);
1001
1002static PyObject *
1003sys_enablelegacywindowsfsencoding(PyObject *self)
1004{
1005 Py_FileSystemDefaultEncoding = "mbcs";
1006 Py_FileSystemDefaultEncodeErrors = "replace";
1007 Py_RETURN_NONE;
1008}
1009
Mark Hammond8696ebc2002-10-08 02:44:31 +00001010#endif /* MS_WINDOWS */
1011
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001012#ifdef HAVE_DLOPEN
1013static PyObject *
1014sys_setdlopenflags(PyObject *self, PyObject *args)
1015{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001016 int new_val;
1017 PyThreadState *tstate = PyThreadState_GET();
1018 if (!PyArg_ParseTuple(args, "i:setdlopenflags", &new_val))
1019 return NULL;
1020 if (!tstate)
1021 return NULL;
1022 tstate->interp->dlopenflags = new_val;
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001023 Py_RETURN_NONE;
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001024}
1025
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001026PyDoc_STRVAR(setdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001027"setdlopenflags(n) -> None\n\
1028\n\
Alexandre Vassalotti260484d2009-07-17 11:43:26 +00001029Set the flags used by the interpreter for dlopen calls, such as when the\n\
1030interpreter loads extension modules. Among other things, this will enable\n\
1031a lazy resolving of symbols when importing a module, if called as\n\
1032sys.setdlopenflags(0). To share symbols across extension modules, call as\n\
Andrew Kuchlingc61b9132013-06-21 10:58:41 -04001033sys.setdlopenflags(os.RTLD_GLOBAL). Symbolic names for the flag modules\n\
Victor Stinnerf4afa432011-10-31 11:48:09 +01001034can be found in the os module (RTLD_xxx constants, e.g. os.RTLD_LAZY).");
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001035
1036static PyObject *
1037sys_getdlopenflags(PyObject *self, PyObject *args)
1038{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001039 PyThreadState *tstate = PyThreadState_GET();
1040 if (!tstate)
1041 return NULL;
1042 return PyLong_FromLong(tstate->interp->dlopenflags);
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001043}
1044
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001045PyDoc_STRVAR(getdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001046"getdlopenflags() -> int\n\
1047\n\
Alexandre Vassalotti260484d2009-07-17 11:43:26 +00001048Return the current value of the flags that are used for dlopen calls.\n\
Andrew Kuchlingc61b9132013-06-21 10:58:41 -04001049The flag constants are defined in the os module.");
Alexandre Vassalotti260484d2009-07-17 11:43:26 +00001050
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001051#endif /* HAVE_DLOPEN */
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001052
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001053#ifdef USE_MALLOPT
1054/* Link with -lmalloc (or -lmpc) on an SGI */
1055#include <malloc.h>
1056
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001057static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001058sys_mdebug(PyObject *self, PyObject *args)
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001059{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001060 int flag;
1061 if (!PyArg_ParseTuple(args, "i:mdebug", &flag))
1062 return NULL;
1063 mallopt(M_DEBUG, flag);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001064 Py_RETURN_NONE;
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001065}
1066#endif /* USE_MALLOPT */
1067
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001068size_t
1069_PySys_GetSizeOf(PyObject *o)
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001070{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001071 PyObject *res = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001072 PyObject *method;
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001073 Py_ssize_t size;
Benjamin Petersona5758c02009-05-09 18:15:04 +00001074
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001075 /* Make sure the type is initialized. float gets initialized late */
1076 if (PyType_Ready(Py_TYPE(o)) < 0)
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001077 return (size_t)-1;
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +00001078
Benjamin Petersonce798522012-01-22 11:24:29 -05001079 method = _PyObject_LookupSpecial(o, &PyId___sizeof__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001080 if (method == NULL) {
1081 if (!PyErr_Occurred())
1082 PyErr_Format(PyExc_TypeError,
1083 "Type %.100s doesn't define __sizeof__",
1084 Py_TYPE(o)->tp_name);
1085 }
1086 else {
Victor Stinnerf17c3de2016-12-06 18:46:19 +01001087 res = _PyObject_CallNoArg(method);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001088 Py_DECREF(method);
1089 }
1090
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001091 if (res == NULL)
1092 return (size_t)-1;
1093
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001094 size = PyLong_AsSsize_t(res);
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001095 Py_DECREF(res);
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001096 if (size == -1 && PyErr_Occurred())
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001097 return (size_t)-1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001098
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001099 if (size < 0) {
1100 PyErr_SetString(PyExc_ValueError, "__sizeof__() should return >= 0");
1101 return (size_t)-1;
1102 }
1103
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001104 /* add gc_head size */
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001105 if (PyObject_IS_GC(o))
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001106 return ((size_t)size) + sizeof(PyGC_Head);
1107 return (size_t)size;
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001108}
1109
1110static PyObject *
1111sys_getsizeof(PyObject *self, PyObject *args, PyObject *kwds)
1112{
1113 static char *kwlist[] = {"object", "default", 0};
1114 size_t size;
1115 PyObject *o, *dflt = NULL;
1116
1117 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|O:getsizeof",
1118 kwlist, &o, &dflt))
1119 return NULL;
1120
1121 size = _PySys_GetSizeOf(o);
1122
1123 if (size == (size_t)-1 && PyErr_Occurred()) {
1124 /* Has a default value been given */
1125 if (dflt != NULL && PyErr_ExceptionMatches(PyExc_TypeError)) {
1126 PyErr_Clear();
1127 Py_INCREF(dflt);
1128 return dflt;
1129 }
1130 else
1131 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001132 }
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001133
1134 return PyLong_FromSize_t(size);
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001135}
1136
1137PyDoc_STRVAR(getsizeof_doc,
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +00001138"getsizeof(object, default) -> int\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001139\n\
1140Return the size of object in bytes.");
1141
1142static PyObject *
Fred Drakea7688822001-10-24 20:47:48 +00001143sys_getrefcount(PyObject *self, PyObject *arg)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001144{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001145 return PyLong_FromSsize_t(arg->ob_refcnt);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001146}
1147
Tim Peters4be93d02002-07-07 19:59:50 +00001148#ifdef Py_REF_DEBUG
Mark Hammond440d8982000-06-20 08:12:48 +00001149static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001150sys_gettotalrefcount(PyObject *self)
Mark Hammond440d8982000-06-20 08:12:48 +00001151{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001152 return PyLong_FromSsize_t(_Py_GetRefTotal());
Mark Hammond440d8982000-06-20 08:12:48 +00001153}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001154#endif /* Py_REF_DEBUG */
Mark Hammond440d8982000-06-20 08:12:48 +00001155
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001156PyDoc_STRVAR(getrefcount_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001157"getrefcount(object) -> integer\n\
1158\n\
Fred Drakeba3ff1b2002-06-20 21:36:19 +00001159Return the reference count of object. The count returned is generally\n\
1160one higher than you might expect, because it includes the (temporary)\n\
1161reference as an argument to getrefcount()."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001162);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001163
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001164static PyObject *
1165sys_getallocatedblocks(PyObject *self)
1166{
1167 return PyLong_FromSsize_t(_Py_GetAllocatedBlocks());
1168}
1169
1170PyDoc_STRVAR(getallocatedblocks_doc,
1171"getallocatedblocks() -> integer\n\
1172\n\
1173Return the number of memory blocks currently allocated, regardless of their\n\
1174size."
1175);
1176
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001177#ifdef COUNT_ALLOCS
1178static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001179sys_getcounts(PyObject *self)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001180{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001181 extern PyObject *get_counts(void);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001182
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001183 return get_counts();
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001184}
1185#endif
1186
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001187PyDoc_STRVAR(getframe_doc,
Barry Warsawb6a54d22000-12-06 21:47:46 +00001188"_getframe([depth]) -> frameobject\n\
1189\n\
1190Return a frame object from the call stack. If optional integer depth is\n\
1191given, return the frame object that many calls below the top of the stack.\n\
1192If that is deeper than the call stack, ValueError is raised. The default\n\
1193for depth is zero, returning the frame at the top of the call stack.\n\
1194\n\
1195This function should be used for internal and specialized\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001196purposes only."
1197);
Barry Warsawb6a54d22000-12-06 21:47:46 +00001198
1199static PyObject *
1200sys_getframe(PyObject *self, PyObject *args)
1201{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001202 PyFrameObject *f = PyThreadState_GET()->frame;
1203 int depth = -1;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001204
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001205 if (!PyArg_ParseTuple(args, "|i:_getframe", &depth))
1206 return NULL;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001207
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001208 while (depth > 0 && f != NULL) {
1209 f = f->f_back;
1210 --depth;
1211 }
1212 if (f == NULL) {
1213 PyErr_SetString(PyExc_ValueError,
1214 "call stack is not deep enough");
1215 return NULL;
1216 }
1217 Py_INCREF(f);
1218 return (PyObject*)f;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001219}
1220
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001221PyDoc_STRVAR(current_frames_doc,
1222"_current_frames() -> dictionary\n\
1223\n\
1224Return a dictionary mapping each current thread T's thread id to T's\n\
1225current stack frame.\n\
1226\n\
1227This function should be used for specialized purposes only."
1228);
1229
1230static PyObject *
1231sys_current_frames(PyObject *self, PyObject *noargs)
1232{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001233 return _PyThread_CurrentFrames();
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001234}
1235
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001236PyDoc_STRVAR(call_tracing_doc,
1237"call_tracing(func, args) -> object\n\
1238\n\
1239Call func(*args), while tracing is enabled. The tracing state is\n\
1240saved, and restored afterwards. This is intended to be called from\n\
1241a debugger from a checkpoint, to recursively debug some other code."
1242);
1243
1244static PyObject *
1245sys_call_tracing(PyObject *self, PyObject *args)
1246{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001247 PyObject *func, *funcargs;
1248 if (!PyArg_ParseTuple(args, "OO!:call_tracing", &func, &PyTuple_Type, &funcargs))
1249 return NULL;
1250 return _PyEval_CallTracing(func, funcargs);
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001251}
1252
Jeremy Hylton985eba52003-02-05 23:13:00 +00001253PyDoc_STRVAR(callstats_doc,
1254"callstats() -> tuple of integers\n\
1255\n\
1256Return a tuple of function call statistics, if CALL_PROFILE was defined\n\
1257when Python was built. Otherwise, return None.\n\
1258\n\
1259When enabled, this function returns detailed, implementation-specific\n\
1260details about the number of function calls executed. The return value is\n\
1261a 11-tuple where the entries in the tuple are counts of:\n\
12620. all function calls\n\
12631. calls to PyFunction_Type objects\n\
12642. PyFunction calls that do not create an argument tuple\n\
12653. PyFunction calls that do not create an argument tuple\n\
1266 and bypass PyEval_EvalCodeEx()\n\
12674. PyMethod calls\n\
12685. PyMethod calls on bound methods\n\
12696. PyType calls\n\
12707. PyCFunction calls\n\
12718. generator calls\n\
12729. All other calls\n\
127310. Number of stack pops performed by call_function()"
1274);
Barry Warsawb6a54d22000-12-06 21:47:46 +00001275
Victor Stinner048afd92016-11-28 11:59:04 +01001276static PyObject *
1277sys_callstats(PyObject *self)
1278{
1279 if (PyErr_WarnEx(PyExc_DeprecationWarning,
1280 "sys.callstats() has been deprecated in Python 3.7 "
1281 "and will be removed in the future", 1) < 0) {
1282 return NULL;
1283 }
1284
1285 Py_RETURN_NONE;
1286}
1287
1288
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001289#ifdef __cplusplus
1290extern "C" {
1291#endif
1292
David Malcolm49526f42012-06-22 14:55:41 -04001293static PyObject *
1294sys_debugmallocstats(PyObject *self, PyObject *args)
1295{
1296#ifdef WITH_PYMALLOC
Victor Stinner34be8072016-03-14 12:04:26 +01001297 if (_PyMem_PymallocEnabled()) {
1298 _PyObject_DebugMallocStats(stderr);
1299 fputc('\n', stderr);
1300 }
David Malcolm49526f42012-06-22 14:55:41 -04001301#endif
1302 _PyObject_DebugTypeStats(stderr);
1303
1304 Py_RETURN_NONE;
1305}
1306PyDoc_STRVAR(debugmallocstats_doc,
1307"_debugmallocstats()\n\
1308\n\
1309Print summary info to stderr about the state of\n\
1310pymalloc's structures.\n\
1311\n\
1312In Py_DEBUG mode, also perform some expensive internal consistency\n\
1313checks.\n\
1314");
1315
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001316#ifdef Py_TRACE_REFS
Guido van Rossumded690f1996-05-24 20:48:31 +00001317/* Defined in objects.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001318extern PyObject *_Py_GetObjects(PyObject *, PyObject *);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001319#endif
Guido van Rossumded690f1996-05-24 20:48:31 +00001320
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001321#ifdef DYNAMIC_EXECUTION_PROFILE
1322/* Defined in ceval.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001323extern PyObject *_Py_GetDXProfile(PyObject *, PyObject *);
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001324#endif
1325
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001326#ifdef __cplusplus
1327}
1328#endif
1329
Christian Heimes15ebc882008-02-04 18:48:49 +00001330static PyObject *
1331sys_clear_type_cache(PyObject* self, PyObject* args)
1332{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001333 PyType_ClearCache();
1334 Py_RETURN_NONE;
Christian Heimes15ebc882008-02-04 18:48:49 +00001335}
1336
1337PyDoc_STRVAR(sys_clear_type_cache__doc__,
1338"_clear_type_cache() -> None\n\
1339Clear the internal type lookup cache.");
1340
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001341static PyObject *
1342sys_is_finalizing(PyObject* self, PyObject* args)
1343{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001344 return PyBool_FromLong(_Py_IsFinalizing());
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001345}
1346
1347PyDoc_STRVAR(is_finalizing_doc,
1348"is_finalizing()\n\
1349Return True if Python is exiting.");
1350
Christian Heimes15ebc882008-02-04 18:48:49 +00001351
Victor Stinnerd6958ac2016-12-02 01:13:46 +01001352#ifdef ANDROID_API_LEVEL
1353PyDoc_STRVAR(getandroidapilevel_doc,
1354"getandroidapilevel()\n\
1355\n\
1356Return the build time API version of Android as an integer.");
1357
1358static PyObject *
1359sys_getandroidapilevel(PyObject *self)
1360{
1361 return PyLong_FromLong(ANDROID_API_LEVEL);
1362}
1363#endif /* ANDROID_API_LEVEL */
1364
1365
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001366static PyMethodDef sys_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001367 /* Might as well keep this in alphabetic order */
Victor Stinner048afd92016-11-28 11:59:04 +01001368 {"callstats", (PyCFunction)sys_callstats, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001369 callstats_doc},
1370 {"_clear_type_cache", sys_clear_type_cache, METH_NOARGS,
1371 sys_clear_type_cache__doc__},
1372 {"_current_frames", sys_current_frames, METH_NOARGS,
1373 current_frames_doc},
1374 {"displayhook", sys_displayhook, METH_O, displayhook_doc},
1375 {"exc_info", sys_exc_info, METH_NOARGS, exc_info_doc},
1376 {"excepthook", sys_excepthook, METH_VARARGS, excepthook_doc},
1377 {"exit", sys_exit, METH_VARARGS, exit_doc},
1378 {"getdefaultencoding", (PyCFunction)sys_getdefaultencoding,
1379 METH_NOARGS, getdefaultencoding_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001380#ifdef HAVE_DLOPEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001381 {"getdlopenflags", (PyCFunction)sys_getdlopenflags, METH_NOARGS,
1382 getdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001383#endif
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001384 {"getallocatedblocks", (PyCFunction)sys_getallocatedblocks, METH_NOARGS,
1385 getallocatedblocks_doc},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001386#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001387 {"getcounts", (PyCFunction)sys_getcounts, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001388#endif
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001389#ifdef DYNAMIC_EXECUTION_PROFILE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001390 {"getdxp", _Py_GetDXProfile, METH_VARARGS},
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001391#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001392 {"getfilesystemencoding", (PyCFunction)sys_getfilesystemencoding,
1393 METH_NOARGS, getfilesystemencoding_doc},
Steve Dowercc16be82016-09-08 10:35:16 -07001394 { "getfilesystemencodeerrors", (PyCFunction)sys_getfilesystemencodeerrors,
1395 METH_NOARGS, getfilesystemencodeerrors_doc },
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001396#ifdef Py_TRACE_REFS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001397 {"getobjects", _Py_GetObjects, METH_VARARGS},
Tim Peters4be93d02002-07-07 19:59:50 +00001398#endif
1399#ifdef Py_REF_DEBUG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001400 {"gettotalrefcount", (PyCFunction)sys_gettotalrefcount, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001401#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 {"getrefcount", (PyCFunction)sys_getrefcount, METH_O, getrefcount_doc},
1403 {"getrecursionlimit", (PyCFunction)sys_getrecursionlimit, METH_NOARGS,
1404 getrecursionlimit_doc},
1405 {"getsizeof", (PyCFunction)sys_getsizeof,
1406 METH_VARARGS | METH_KEYWORDS, getsizeof_doc},
1407 {"_getframe", sys_getframe, METH_VARARGS, getframe_doc},
Mark Hammond8696ebc2002-10-08 02:44:31 +00001408#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001409 {"getwindowsversion", (PyCFunction)sys_getwindowsversion, METH_NOARGS,
1410 getwindowsversion_doc},
Steve Dowercc16be82016-09-08 10:35:16 -07001411 {"_enablelegacywindowsfsencoding", (PyCFunction)sys_enablelegacywindowsfsencoding,
1412 METH_NOARGS, enablelegacywindowsfsencoding_doc },
Mark Hammond8696ebc2002-10-08 02:44:31 +00001413#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 {"intern", sys_intern, METH_VARARGS, intern_doc},
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001415 {"is_finalizing", sys_is_finalizing, METH_NOARGS, is_finalizing_doc},
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001416#ifdef USE_MALLOPT
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001417 {"mdebug", sys_mdebug, METH_VARARGS},
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001418#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 {"setcheckinterval", sys_setcheckinterval, METH_VARARGS,
1420 setcheckinterval_doc},
1421 {"getcheckinterval", sys_getcheckinterval, METH_NOARGS,
1422 getcheckinterval_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001423 {"setswitchinterval", sys_setswitchinterval, METH_VARARGS,
1424 setswitchinterval_doc},
1425 {"getswitchinterval", sys_getswitchinterval, METH_NOARGS,
1426 getswitchinterval_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001427#ifdef HAVE_DLOPEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 {"setdlopenflags", sys_setdlopenflags, METH_VARARGS,
1429 setdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001430#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001431 {"setprofile", sys_setprofile, METH_O, setprofile_doc},
1432 {"getprofile", sys_getprofile, METH_NOARGS, getprofile_doc},
1433 {"setrecursionlimit", sys_setrecursionlimit, METH_VARARGS,
1434 setrecursionlimit_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001435 {"settrace", sys_settrace, METH_O, settrace_doc},
1436 {"gettrace", sys_gettrace, METH_NOARGS, gettrace_doc},
1437 {"call_tracing", sys_call_tracing, METH_VARARGS, call_tracing_doc},
Victor Stinnered0b87d2013-12-19 17:16:42 +01001438 {"_debugmallocstats", sys_debugmallocstats, METH_NOARGS,
David Malcolm49526f42012-06-22 14:55:41 -04001439 debugmallocstats_doc},
Yury Selivanov75445082015-05-11 22:57:16 -04001440 {"set_coroutine_wrapper", sys_set_coroutine_wrapper, METH_O,
1441 set_coroutine_wrapper_doc},
1442 {"get_coroutine_wrapper", sys_get_coroutine_wrapper, METH_NOARGS,
1443 get_coroutine_wrapper_doc},
Yury Selivanov87672d72016-09-09 00:05:42 -07001444 {"set_asyncgen_hooks", (PyCFunction)sys_set_asyncgen_hooks,
Yury Selivanoveb636452016-09-08 22:01:51 -07001445 METH_VARARGS | METH_KEYWORDS, set_asyncgen_hooks_doc},
1446 {"get_asyncgen_hooks", sys_get_asyncgen_hooks, METH_NOARGS,
1447 get_asyncgen_hooks_doc},
Victor Stinnerd6958ac2016-12-02 01:13:46 +01001448#ifdef ANDROID_API_LEVEL
1449 {"getandroidapilevel", (PyCFunction)sys_getandroidapilevel, METH_NOARGS,
1450 getandroidapilevel_doc},
1451#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001452 {NULL, NULL} /* sentinel */
Guido van Rossum3f5da241990-12-20 15:06:42 +00001453};
1454
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001455static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001456list_builtin_module_names(void)
Guido van Rossum34679b71993-01-26 13:33:44 +00001457{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001458 PyObject *list = PyList_New(0);
1459 int i;
1460 if (list == NULL)
1461 return NULL;
1462 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1463 PyObject *name = PyUnicode_FromString(
1464 PyImport_Inittab[i].name);
1465 if (name == NULL)
1466 break;
1467 PyList_Append(list, name);
1468 Py_DECREF(name);
1469 }
1470 if (PyList_Sort(list) != 0) {
1471 Py_DECREF(list);
1472 list = NULL;
1473 }
1474 if (list) {
1475 PyObject *v = PyList_AsTuple(list);
1476 Py_DECREF(list);
1477 list = v;
1478 }
1479 return list;
Guido van Rossum34679b71993-01-26 13:33:44 +00001480}
1481
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001482static PyObject *
1483get_warnoptions(void)
1484{
Eric Snowdae02762017-09-14 00:35:58 -07001485 PyObject *warnoptions = _PySys_GetObjectId(&PyId_warnoptions);
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001486 if (warnoptions == NULL || !PyList_Check(warnoptions)) {
1487 Py_XDECREF(warnoptions);
1488 warnoptions = PyList_New(0);
1489 if (warnoptions == NULL)
1490 return NULL;
Eric Snowdae02762017-09-14 00:35:58 -07001491 if (_PySys_SetObjectId(&PyId_warnoptions, warnoptions)) {
1492 Py_DECREF(warnoptions);
1493 return NULL;
1494 }
1495 Py_DECREF(warnoptions);
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001496 }
1497 return warnoptions;
1498}
Guido van Rossum23fff912000-12-15 22:02:05 +00001499
1500void
1501PySys_ResetWarnOptions(void)
1502{
Eric Snowdae02762017-09-14 00:35:58 -07001503 PyObject *warnoptions = _PySys_GetObjectId(&PyId_warnoptions);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001504 if (warnoptions == NULL || !PyList_Check(warnoptions))
1505 return;
1506 PyList_SetSlice(warnoptions, 0, PyList_GET_SIZE(warnoptions), NULL);
Guido van Rossum23fff912000-12-15 22:02:05 +00001507}
1508
1509void
Victor Stinner9ca9c252010-05-19 16:53:30 +00001510PySys_AddWarnOptionUnicode(PyObject *unicode)
Guido van Rossum23fff912000-12-15 22:02:05 +00001511{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001512 PyObject *warnoptions = get_warnoptions();
1513 if (warnoptions == NULL)
1514 return;
Victor Stinner9ca9c252010-05-19 16:53:30 +00001515 PyList_Append(warnoptions, unicode);
1516}
1517
1518void
1519PySys_AddWarnOption(const wchar_t *s)
1520{
1521 PyObject *unicode;
1522 unicode = PyUnicode_FromWideChar(s, -1);
1523 if (unicode == NULL)
1524 return;
1525 PySys_AddWarnOptionUnicode(unicode);
1526 Py_DECREF(unicode);
Guido van Rossum23fff912000-12-15 22:02:05 +00001527}
1528
Christian Heimes33fe8092008-04-13 13:53:33 +00001529int
1530PySys_HasWarnOptions(void)
1531{
Eric Snowdae02762017-09-14 00:35:58 -07001532 PyObject *warnoptions = _PySys_GetObjectId(&PyId_warnoptions);
Christian Heimes33fe8092008-04-13 13:53:33 +00001533 return (warnoptions != NULL && (PyList_Size(warnoptions) > 0)) ? 1 : 0;
1534}
1535
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001536static PyObject *
1537get_xoptions(void)
1538{
Eric Snowdae02762017-09-14 00:35:58 -07001539 PyObject *xoptions = _PySys_GetObjectId(&PyId__xoptions);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001540 if (xoptions == NULL || !PyDict_Check(xoptions)) {
1541 Py_XDECREF(xoptions);
1542 xoptions = PyDict_New();
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001543 if (xoptions == NULL)
1544 return NULL;
Eric Snowdae02762017-09-14 00:35:58 -07001545 if (_PySys_SetObjectId(&PyId__xoptions, xoptions)) {
1546 Py_DECREF(xoptions);
1547 return NULL;
1548 }
1549 Py_DECREF(xoptions);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001550 }
1551 return xoptions;
1552}
1553
1554void
1555PySys_AddXOption(const wchar_t *s)
1556{
1557 PyObject *opts;
1558 PyObject *name = NULL, *value = NULL;
1559 const wchar_t *name_end;
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001560
1561 opts = get_xoptions();
1562 if (opts == NULL)
1563 goto error;
1564
1565 name_end = wcschr(s, L'=');
1566 if (!name_end) {
1567 name = PyUnicode_FromWideChar(s, -1);
1568 value = Py_True;
1569 Py_INCREF(value);
1570 }
1571 else {
1572 name = PyUnicode_FromWideChar(s, name_end - s);
1573 value = PyUnicode_FromWideChar(name_end + 1, -1);
1574 }
1575 if (name == NULL || value == NULL)
1576 goto error;
Brett Cannonb94767f2011-02-22 20:15:44 +00001577 PyDict_SetItem(opts, name, value);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001578 Py_DECREF(name);
1579 Py_DECREF(value);
1580 return;
1581
1582error:
1583 Py_XDECREF(name);
1584 Py_XDECREF(value);
1585 /* No return value, therefore clear error state if possible */
Victor Stinner0cae6092016-11-11 01:43:56 +01001586 if (_PyThreadState_UncheckedGet()) {
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001587 PyErr_Clear();
Victor Stinner0cae6092016-11-11 01:43:56 +01001588 }
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001589}
1590
1591PyObject *
1592PySys_GetXOptions(void)
1593{
1594 return get_xoptions();
1595}
1596
Guido van Rossum40552d01998-08-06 03:34:39 +00001597/* XXX This doc string is too long to be a single string literal in VC++ 5.0.
1598 Two literals concatenated works just fine. If you have a K&R compiler
1599 or other abomination that however *does* understand longer strings,
1600 get rid of the !!! comment in the middle and the quotes that surround it. */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001601PyDoc_VAR(sys_doc) =
1602PyDoc_STR(
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001603"This module provides access to some objects used or maintained by the\n\
1604interpreter and to functions that interact strongly with the interpreter.\n\
1605\n\
1606Dynamic objects:\n\
1607\n\
1608argv -- command line arguments; argv[0] is the script pathname if known\n\
1609path -- module search path; path[0] is the script directory, else ''\n\
1610modules -- dictionary of loaded modules\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001611\n\
1612displayhook -- called to show results in an interactive session\n\
1613excepthook -- called to handle any uncaught exception other than SystemExit\n\
1614 To customize printing in an interactive session or to install a custom\n\
1615 top-level exception handler, assign other functions to replace these.\n\
1616\n\
Benjamin Peterson06157a42008-07-15 00:28:36 +00001617stdin -- standard input file object; used by input()\n\
Georg Brandl88fc6642007-02-09 21:28:07 +00001618stdout -- standard output file object; used by print()\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001619stderr -- standard error object; used for error messages\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001620 By assigning other file objects (or objects that behave like files)\n\
1621 to these, it is possible to redirect all of the interpreter's I/O.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001622\n\
1623last_type -- type of last uncaught exception\n\
1624last_value -- value of last uncaught exception\n\
1625last_traceback -- traceback of last uncaught exception\n\
1626 These three are only available in an interactive session after a\n\
1627 traceback has been printed.\n\
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001628"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001629)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001630/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001631PyDoc_STR(
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001632"\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001633Static objects:\n\
1634\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001635builtin_module_names -- tuple of module names built into this interpreter\n\
1636copyright -- copyright notice pertaining to this interpreter\n\
1637exec_prefix -- prefix used to find the machine-specific Python library\n\
Petri Lehtinen4b0eab62012-02-02 21:23:15 +02001638executable -- absolute path of the executable binary of the Python interpreter\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001639float_info -- a struct sequence with information about the float implementation.\n\
1640float_repr_style -- string indicating the style of repr() output for floats\n\
Christian Heimes985ecdc2013-11-20 11:46:18 +01001641hash_info -- a struct sequence with information about the hash algorithm.\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001642hexversion -- version information encoded as a single integer\n\
Barry Warsaw409da152012-06-03 16:18:47 -04001643implementation -- Python implementation information.\n\
Mark Dickinsonbd792642009-03-18 20:06:12 +00001644int_info -- a struct sequence with information about the int implementation.\n\
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001645maxsize -- the largest supported length of containers.\n\
Serhiy Storchakad3faf432015-01-18 11:28:37 +02001646maxunicode -- the value of the largest Unicode code point\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001647platform -- platform identifier\n\
1648prefix -- prefix used to find the Python library\n\
1649thread_info -- a struct sequence with information about the thread implementation.\n\
Fred Drake801c08d2000-04-13 15:29:10 +00001650version -- the version of this interpreter as a string\n\
Eric Smith0e5b5622009-02-06 01:32:42 +00001651version_info -- version information as a named tuple\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001652"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001653)
Steve Dowercc16be82016-09-08 10:35:16 -07001654#ifdef MS_COREDLL
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001655/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001656PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001657"dllhandle -- [Windows only] integer handle of the Python DLL\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001658winver -- [Windows only] version number of the Python DLL\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001659"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001660)
Steve Dowercc16be82016-09-08 10:35:16 -07001661#endif /* MS_COREDLL */
1662#ifdef MS_WINDOWS
1663/* concatenating string here */
1664PyDoc_STR(
1665"_enablelegacywindowsfsencoding -- [Windows only] \n\
1666"
1667)
1668#endif
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001669PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001670"__stdin__ -- the original stdin; don't touch!\n\
1671__stdout__ -- the original stdout; don't touch!\n\
1672__stderr__ -- the original stderr; don't touch!\n\
1673__displayhook__ -- the original displayhook; don't touch!\n\
1674__excepthook__ -- the original excepthook; don't touch!\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001675\n\
1676Functions:\n\
1677\n\
Georg Brandl1a3284e2007-12-02 09:40:06 +00001678displayhook() -- print an object to the screen, and save it in builtins._\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001679excepthook() -- print an exception and its traceback to sys.stderr\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001680exc_info() -- return thread-safe information about the current exception\n\
1681exit() -- exit the interpreter by raising SystemExit\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001682getdlopenflags() -- returns flags to be used for dlopen() calls\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001683getprofile() -- get the global profiling function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001684getrefcount() -- return the reference count for an object (plus one :-)\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001685getrecursionlimit() -- return the max recursion depth for the interpreter\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001686getsizeof() -- return the size of an object in bytes\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001687gettrace() -- get the global debug tracing function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001688setcheckinterval() -- control how often the interpreter checks for events\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001689setdlopenflags() -- set the flags to be used for dlopen() calls\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001690setprofile() -- set the global profiling function\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001691setrecursionlimit() -- set the max recursion depth for the interpreter\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001692settrace() -- set the global debug tracing function\n\
Fred Drakeccede592000-08-14 20:59:57 +00001693"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001694)
Fred Drakeccede592000-08-14 20:59:57 +00001695/* end of sys_doc */ ;
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001696
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001697
1698PyDoc_STRVAR(flags__doc__,
1699"sys.flags\n\
1700\n\
1701Flags provided through command line arguments or environment vars.");
1702
1703static PyTypeObject FlagsType;
1704
1705static PyStructSequence_Field flags_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001706 {"debug", "-d"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001707 {"inspect", "-i"},
1708 {"interactive", "-i"},
1709 {"optimize", "-O or -OO"},
1710 {"dont_write_bytecode", "-B"},
1711 {"no_user_site", "-s"},
1712 {"no_site", "-S"},
1713 {"ignore_environment", "-E"},
1714 {"verbose", "-v"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001715 /* {"unbuffered", "-u"}, */
1716 /* {"skip_first", "-x"}, */
Georg Brandl8aa7e992010-12-28 18:30:18 +00001717 {"bytes_warning", "-b"},
1718 {"quiet", "-q"},
Georg Brandl09a7c722012-02-20 21:31:46 +01001719 {"hash_randomization", "-R"},
Christian Heimesad73a9c2013-08-10 16:36:18 +02001720 {"isolated", "-I"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001721 {0}
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001722};
1723
1724static PyStructSequence_Desc flags_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001725 "sys.flags", /* name */
1726 flags__doc__, /* doc */
1727 flags_fields, /* fields */
Christian Heimesad73a9c2013-08-10 16:36:18 +02001728 13
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001729};
1730
1731static PyObject*
1732make_flags(void)
1733{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001734 int pos = 0;
1735 PyObject *seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001736
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001737 seq = PyStructSequence_New(&FlagsType);
1738 if (seq == NULL)
1739 return NULL;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001740
1741#define SetFlag(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001742 PyStructSequence_SET_ITEM(seq, pos++, PyLong_FromLong(flag))
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001743
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001744 SetFlag(Py_DebugFlag);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001745 SetFlag(Py_InspectFlag);
1746 SetFlag(Py_InteractiveFlag);
1747 SetFlag(Py_OptimizeFlag);
1748 SetFlag(Py_DontWriteBytecodeFlag);
1749 SetFlag(Py_NoUserSiteDirectory);
1750 SetFlag(Py_NoSiteFlag);
1751 SetFlag(Py_IgnoreEnvironmentFlag);
1752 SetFlag(Py_VerboseFlag);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001753 /* SetFlag(saw_unbuffered_flag); */
1754 /* SetFlag(skipfirstline); */
Christian Heimes33fe8092008-04-13 13:53:33 +00001755 SetFlag(Py_BytesWarningFlag);
Georg Brandl8aa7e992010-12-28 18:30:18 +00001756 SetFlag(Py_QuietFlag);
Georg Brandl2daf6ae2012-02-20 19:54:16 +01001757 SetFlag(Py_HashRandomizationFlag);
Christian Heimesad73a9c2013-08-10 16:36:18 +02001758 SetFlag(Py_IsolatedFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001759#undef SetFlag
1760
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001761 if (PyErr_Occurred()) {
Serhiy Storchaka87a854d2013-12-17 14:59:42 +02001762 Py_DECREF(seq);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001763 return NULL;
1764 }
1765 return seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001766}
1767
Eric Smith0e5b5622009-02-06 01:32:42 +00001768PyDoc_STRVAR(version_info__doc__,
1769"sys.version_info\n\
1770\n\
1771Version information as a named tuple.");
1772
1773static PyTypeObject VersionInfoType;
1774
1775static PyStructSequence_Field version_info_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001776 {"major", "Major release number"},
1777 {"minor", "Minor release number"},
1778 {"micro", "Patch release number"},
Ned Deilyda4887a2016-11-04 17:03:34 -04001779 {"releaselevel", "'alpha', 'beta', 'candidate', or 'final'"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001780 {"serial", "Serial release number"},
1781 {0}
Eric Smith0e5b5622009-02-06 01:32:42 +00001782};
1783
1784static PyStructSequence_Desc version_info_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001785 "sys.version_info", /* name */
1786 version_info__doc__, /* doc */
1787 version_info_fields, /* fields */
1788 5
Eric Smith0e5b5622009-02-06 01:32:42 +00001789};
1790
1791static PyObject *
1792make_version_info(void)
1793{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001794 PyObject *version_info;
1795 char *s;
1796 int pos = 0;
Eric Smith0e5b5622009-02-06 01:32:42 +00001797
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001798 version_info = PyStructSequence_New(&VersionInfoType);
1799 if (version_info == NULL) {
1800 return NULL;
1801 }
Eric Smith0e5b5622009-02-06 01:32:42 +00001802
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001803 /*
1804 * These release level checks are mutually exclusive and cover
1805 * the field, so don't get too fancy with the pre-processor!
1806 */
Eric Smith0e5b5622009-02-06 01:32:42 +00001807#if PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_ALPHA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001808 s = "alpha";
Eric Smith0e5b5622009-02-06 01:32:42 +00001809#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_BETA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001810 s = "beta";
Eric Smith0e5b5622009-02-06 01:32:42 +00001811#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_GAMMA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001812 s = "candidate";
Eric Smith0e5b5622009-02-06 01:32:42 +00001813#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_FINAL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001814 s = "final";
Eric Smith0e5b5622009-02-06 01:32:42 +00001815#endif
1816
1817#define SetIntItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001818 PyStructSequence_SET_ITEM(version_info, pos++, PyLong_FromLong(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001819#define SetStrItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001820 PyStructSequence_SET_ITEM(version_info, pos++, PyUnicode_FromString(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001821
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001822 SetIntItem(PY_MAJOR_VERSION);
1823 SetIntItem(PY_MINOR_VERSION);
1824 SetIntItem(PY_MICRO_VERSION);
1825 SetStrItem(s);
1826 SetIntItem(PY_RELEASE_SERIAL);
Eric Smith0e5b5622009-02-06 01:32:42 +00001827#undef SetIntItem
1828#undef SetStrItem
1829
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001830 if (PyErr_Occurred()) {
1831 Py_CLEAR(version_info);
1832 return NULL;
1833 }
1834 return version_info;
Eric Smith0e5b5622009-02-06 01:32:42 +00001835}
1836
Brett Cannon3adc7b72012-07-09 14:22:12 -04001837/* sys.implementation values */
1838#define NAME "cpython"
1839const char *_PySys_ImplName = NAME;
Victor Stinnercf01b682015-11-05 11:21:38 +01001840#define MAJOR Py_STRINGIFY(PY_MAJOR_VERSION)
1841#define MINOR Py_STRINGIFY(PY_MINOR_VERSION)
Ned Deily529ea5d2014-06-30 23:31:14 -07001842#define TAG NAME "-" MAJOR MINOR
Brett Cannon3adc7b72012-07-09 14:22:12 -04001843const char *_PySys_ImplCacheTag = TAG;
1844#undef NAME
Brett Cannon3adc7b72012-07-09 14:22:12 -04001845#undef MAJOR
1846#undef MINOR
1847#undef TAG
1848
Barry Warsaw409da152012-06-03 16:18:47 -04001849static PyObject *
1850make_impl_info(PyObject *version_info)
1851{
1852 int res;
1853 PyObject *impl_info, *value, *ns;
1854
1855 impl_info = PyDict_New();
1856 if (impl_info == NULL)
1857 return NULL;
1858
1859 /* populate the dict */
1860
Brett Cannon3adc7b72012-07-09 14:22:12 -04001861 value = PyUnicode_FromString(_PySys_ImplName);
Barry Warsaw409da152012-06-03 16:18:47 -04001862 if (value == NULL)
1863 goto error;
1864 res = PyDict_SetItemString(impl_info, "name", value);
1865 Py_DECREF(value);
1866 if (res < 0)
1867 goto error;
1868
Brett Cannon3adc7b72012-07-09 14:22:12 -04001869 value = PyUnicode_FromString(_PySys_ImplCacheTag);
Barry Warsaw409da152012-06-03 16:18:47 -04001870 if (value == NULL)
1871 goto error;
1872 res = PyDict_SetItemString(impl_info, "cache_tag", value);
1873 Py_DECREF(value);
1874 if (res < 0)
1875 goto error;
Barry Warsaw409da152012-06-03 16:18:47 -04001876
1877 res = PyDict_SetItemString(impl_info, "version", version_info);
1878 if (res < 0)
1879 goto error;
1880
1881 value = PyLong_FromLong(PY_VERSION_HEX);
1882 if (value == NULL)
1883 goto error;
1884 res = PyDict_SetItemString(impl_info, "hexversion", value);
1885 Py_DECREF(value);
1886 if (res < 0)
1887 goto error;
1888
doko@ubuntu.com55532312016-06-14 08:55:19 +02001889#ifdef MULTIARCH
1890 value = PyUnicode_FromString(MULTIARCH);
1891 if (value == NULL)
1892 goto error;
1893 res = PyDict_SetItemString(impl_info, "_multiarch", value);
1894 Py_DECREF(value);
1895 if (res < 0)
1896 goto error;
1897#endif
1898
Barry Warsaw409da152012-06-03 16:18:47 -04001899 /* dict ready */
1900
1901 ns = _PyNamespace_New(impl_info);
1902 Py_DECREF(impl_info);
1903 return ns;
1904
1905error:
1906 Py_CLEAR(impl_info);
1907 return NULL;
1908}
1909
Martin v. Löwis1a214512008-06-11 05:26:20 +00001910static struct PyModuleDef sysmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001911 PyModuleDef_HEAD_INIT,
1912 "sys",
1913 sys_doc,
1914 -1, /* multiple "initialization" just copies the module dict. */
1915 sys_methods,
1916 NULL,
1917 NULL,
1918 NULL,
1919 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00001920};
1921
Eric Snow6b4be192017-05-22 21:36:03 -07001922/* Updating the sys namespace, returning NULL pointer on error */
Victor Stinner8fea2522013-10-27 17:15:42 +01001923#define SET_SYS_FROM_STRING_BORROW(key, value) \
Victor Stinner58049602013-07-22 22:40:00 +02001924 do { \
Victor Stinner58049602013-07-22 22:40:00 +02001925 PyObject *v = (value); \
1926 if (v == NULL) \
1927 return NULL; \
1928 res = PyDict_SetItemString(sysdict, key, v); \
1929 if (res < 0) { \
Victor Stinner8fea2522013-10-27 17:15:42 +01001930 return NULL; \
1931 } \
1932 } while (0)
1933#define SET_SYS_FROM_STRING(key, value) \
1934 do { \
Victor Stinner8fea2522013-10-27 17:15:42 +01001935 PyObject *v = (value); \
1936 if (v == NULL) \
1937 return NULL; \
1938 res = PyDict_SetItemString(sysdict, key, v); \
1939 Py_DECREF(v); \
1940 if (res < 0) { \
Victor Stinner58049602013-07-22 22:40:00 +02001941 return NULL; \
1942 } \
1943 } while (0)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001944
Eric Snow6b4be192017-05-22 21:36:03 -07001945PyObject *
1946_PySys_BeginInit(void)
1947{
1948 PyObject *m, *sysdict, *version_info;
1949 int res;
1950
Eric Snowd393c1b2017-09-14 12:18:12 -06001951 m = _PyModule_CreateInitialized(&sysmodule, PYTHON_API_VERSION);
Eric Snow6b4be192017-05-22 21:36:03 -07001952 if (m == NULL)
1953 return NULL;
1954 sysdict = PyModule_GetDict(m);
1955
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001956 /* Check that stdin is not a directory
1957 Using shell redirection, you can redirect stdin to a directory,
1958 crashing the Python interpreter. Catch this common mistake here
1959 and output a useful error message. Note that under MS Windows,
1960 the shell already prevents that. */
Martin v. Löwisec59d042009-01-12 07:59:10 +00001961#if !defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001962 {
Steve Dowerf2f373f2015-02-21 08:44:05 -08001963 struct _Py_stat_struct sb;
Victor Stinnere134a7f2015-03-30 10:09:31 +02001964 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001965 S_ISDIR(sb.st_mode)) {
1966 /* There's nothing more we can do. */
1967 /* Py_FatalError() will core dump, so just exit. */
1968 PySys_WriteStderr("Python error: <stdin> is a directory, cannot continue\n");
1969 exit(EXIT_FAILURE);
1970 }
1971 }
Martin v. Löwisec59d042009-01-12 07:59:10 +00001972#endif
Neal Norwitz11bd1192005-10-03 00:54:56 +00001973
Nick Coghland6009512014-11-20 21:39:37 +10001974 /* stdin/stdout/stderr are set in pylifecycle.c */
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001975
Victor Stinner8fea2522013-10-27 17:15:42 +01001976 SET_SYS_FROM_STRING_BORROW("__displayhook__",
1977 PyDict_GetItemString(sysdict, "displayhook"));
1978 SET_SYS_FROM_STRING_BORROW("__excepthook__",
1979 PyDict_GetItemString(sysdict, "excepthook"));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001980 SET_SYS_FROM_STRING("version",
1981 PyUnicode_FromString(Py_GetVersion()));
1982 SET_SYS_FROM_STRING("hexversion",
1983 PyLong_FromLong(PY_VERSION_HEX));
Ned Deily5c4b0d02017-03-04 00:19:55 -05001984 SET_SYS_FROM_STRING("_git",
1985 Py_BuildValue("(szz)", "CPython", _Py_gitidentifier(),
1986 _Py_gitversion()));
INADA Naoki6b42eb12017-06-29 15:31:38 +09001987 SET_SYS_FROM_STRING("_framework", PyUnicode_FromString(_PYTHONFRAMEWORK));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001988 SET_SYS_FROM_STRING("api_version",
1989 PyLong_FromLong(PYTHON_API_VERSION));
1990 SET_SYS_FROM_STRING("copyright",
1991 PyUnicode_FromString(Py_GetCopyright()));
1992 SET_SYS_FROM_STRING("platform",
1993 PyUnicode_FromString(Py_GetPlatform()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001994 SET_SYS_FROM_STRING("maxsize",
1995 PyLong_FromSsize_t(PY_SSIZE_T_MAX));
1996 SET_SYS_FROM_STRING("float_info",
1997 PyFloat_GetInfo());
1998 SET_SYS_FROM_STRING("int_info",
1999 PyLong_GetInfo());
Mark Dickinsondc787d22010-05-23 13:33:13 +00002000 /* initialize hash_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002001 if (Hash_InfoType.tp_name == NULL) {
2002 if (PyStructSequence_InitType2(&Hash_InfoType, &hash_info_desc) < 0)
2003 return NULL;
2004 }
Mark Dickinsondc787d22010-05-23 13:33:13 +00002005 SET_SYS_FROM_STRING("hash_info",
2006 get_hash_info());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002007 SET_SYS_FROM_STRING("maxunicode",
Ezio Melotti48a2f8f2011-09-29 00:18:19 +03002008 PyLong_FromLong(0x10FFFF));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002009 SET_SYS_FROM_STRING("builtin_module_names",
2010 list_builtin_module_names());
Christian Heimes743e0cd2012-10-17 23:52:17 +02002011#if PY_BIG_ENDIAN
2012 SET_SYS_FROM_STRING("byteorder",
2013 PyUnicode_FromString("big"));
2014#else
2015 SET_SYS_FROM_STRING("byteorder",
2016 PyUnicode_FromString("little"));
2017#endif
Fred Drake099325e2000-08-14 15:47:03 +00002018
Guido van Rossum8b9ea871996-08-23 18:14:47 +00002019#ifdef MS_COREDLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002020 SET_SYS_FROM_STRING("dllhandle",
2021 PyLong_FromVoidPtr(PyWin_DLLhModule));
2022 SET_SYS_FROM_STRING("winver",
2023 PyUnicode_FromString(PyWin_DLLVersionString));
Guido van Rossumc606fe11996-04-09 02:37:57 +00002024#endif
Barry Warsaw8cf4eae2010-10-16 01:04:07 +00002025#ifdef ABIFLAGS
2026 SET_SYS_FROM_STRING("abiflags",
2027 PyUnicode_FromString(ABIFLAGS));
2028#endif
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002029
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002030 /* version_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002031 if (VersionInfoType.tp_name == NULL) {
2032 if (PyStructSequence_InitType2(&VersionInfoType,
2033 &version_info_desc) < 0)
2034 return NULL;
2035 }
Barry Warsaw409da152012-06-03 16:18:47 -04002036 version_info = make_version_info();
2037 SET_SYS_FROM_STRING("version_info", version_info);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002038 /* prevent user from creating new instances */
2039 VersionInfoType.tp_init = NULL;
2040 VersionInfoType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02002041 res = PyDict_DelItemString(VersionInfoType.tp_dict, "__new__");
2042 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
2043 PyErr_Clear();
Eric Smith0e5b5622009-02-06 01:32:42 +00002044
Barry Warsaw409da152012-06-03 16:18:47 -04002045 /* implementation */
2046 SET_SYS_FROM_STRING("implementation", make_impl_info(version_info));
2047
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002048 /* flags */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002049 if (FlagsType.tp_name == 0) {
2050 if (PyStructSequence_InitType2(&FlagsType, &flags_desc) < 0)
2051 return NULL;
2052 }
Eric Snow6b4be192017-05-22 21:36:03 -07002053 /* Set flags to their default values */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002054 SET_SYS_FROM_STRING("flags", make_flags());
Eric Smithf7bb5782010-01-27 00:44:57 +00002055
2056#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002057 /* getwindowsversion */
2058 if (WindowsVersionType.tp_name == 0)
Victor Stinner1c8f0592013-07-22 22:24:54 +02002059 if (PyStructSequence_InitType2(&WindowsVersionType,
2060 &windows_version_desc) < 0)
2061 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002062 /* prevent user from creating new instances */
2063 WindowsVersionType.tp_init = NULL;
2064 WindowsVersionType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02002065 res = PyDict_DelItemString(WindowsVersionType.tp_dict, "__new__");
2066 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
2067 PyErr_Clear();
Eric Smithf7bb5782010-01-27 00:44:57 +00002068#endif
2069
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002070 /* float repr style: 0.03 (short) vs 0.029999999999999999 (legacy) */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002071#ifndef PY_NO_SHORT_FLOAT_REPR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002072 SET_SYS_FROM_STRING("float_repr_style",
2073 PyUnicode_FromString("short"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002074#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002075 SET_SYS_FROM_STRING("float_repr_style",
2076 PyUnicode_FromString("legacy"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002077#endif
2078
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002079 SET_SYS_FROM_STRING("thread_info", PyThread_GetInfo());
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002080
Yury Selivanoveb636452016-09-08 22:01:51 -07002081 /* initialize asyncgen_hooks */
2082 if (AsyncGenHooksType.tp_name == NULL) {
2083 if (PyStructSequence_InitType2(
2084 &AsyncGenHooksType, &asyncgen_hooks_desc) < 0) {
2085 return NULL;
2086 }
2087 }
2088
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002089 if (PyErr_Occurred())
2090 return NULL;
2091 return m;
Guido van Rossum5b3138b1990-11-18 17:41:40 +00002092}
2093
Eric Snow6b4be192017-05-22 21:36:03 -07002094#undef SET_SYS_FROM_STRING
2095#undef SET_SYS_FROM_STRING_BORROW
2096
2097/* Updating the sys namespace, returning integer error codes */
Eric Snow6b4be192017-05-22 21:36:03 -07002098#define SET_SYS_FROM_STRING_INT_RESULT(key, value) \
2099 do { \
2100 PyObject *v = (value); \
2101 if (v == NULL) \
2102 return -1; \
2103 res = PyDict_SetItemString(sysdict, key, v); \
2104 Py_DECREF(v); \
2105 if (res < 0) { \
2106 return res; \
2107 } \
2108 } while (0)
2109
2110int
2111_PySys_EndInit(PyObject *sysdict)
2112{
2113 int res;
2114
2115 /* Set flags to their final values */
2116 SET_SYS_FROM_STRING_INT_RESULT("flags", make_flags());
2117 /* prevent user from creating new instances */
2118 FlagsType.tp_init = NULL;
2119 FlagsType.tp_new = NULL;
2120 res = PyDict_DelItemString(FlagsType.tp_dict, "__new__");
2121 if (res < 0) {
2122 if (!PyErr_ExceptionMatches(PyExc_KeyError)) {
2123 return res;
2124 }
2125 PyErr_Clear();
2126 }
2127
2128 SET_SYS_FROM_STRING_INT_RESULT("dont_write_bytecode",
2129 PyBool_FromLong(Py_DontWriteBytecodeFlag));
2130 SET_SYS_FROM_STRING_INT_RESULT("executable",
2131 PyUnicode_FromWideChar(
2132 Py_GetProgramFullPath(), -1));
2133 SET_SYS_FROM_STRING_INT_RESULT("prefix",
2134 PyUnicode_FromWideChar(Py_GetPrefix(), -1));
2135 SET_SYS_FROM_STRING_INT_RESULT("exec_prefix",
2136 PyUnicode_FromWideChar(Py_GetExecPrefix(), -1));
2137 SET_SYS_FROM_STRING_INT_RESULT("base_prefix",
2138 PyUnicode_FromWideChar(Py_GetPrefix(), -1));
2139 SET_SYS_FROM_STRING_INT_RESULT("base_exec_prefix",
2140 PyUnicode_FromWideChar(Py_GetExecPrefix(), -1));
2141
Eric Snowdae02762017-09-14 00:35:58 -07002142 if (get_warnoptions() == NULL)
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002143 return -1;
Victor Stinner865de272017-06-08 13:27:47 +02002144
Eric Snowdae02762017-09-14 00:35:58 -07002145 if (get_xoptions() == NULL)
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002146 return -1;
Eric Snow6b4be192017-05-22 21:36:03 -07002147
2148 if (PyErr_Occurred())
2149 return -1;
2150 return 0;
2151}
2152
2153#undef SET_SYS_FROM_STRING_INT_RESULT
Eric Snow6b4be192017-05-22 21:36:03 -07002154
Guido van Rossum65bf9f21997-04-29 18:33:38 +00002155static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00002156makepathobject(const wchar_t *path, wchar_t delim)
Guido van Rossum5b3138b1990-11-18 17:41:40 +00002157{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002158 int i, n;
2159 const wchar_t *p;
2160 PyObject *v, *w;
Tim Peters216b78b2006-01-06 02:40:53 +00002161
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002162 n = 1;
2163 p = path;
2164 while ((p = wcschr(p, delim)) != NULL) {
2165 n++;
2166 p++;
2167 }
2168 v = PyList_New(n);
2169 if (v == NULL)
2170 return NULL;
2171 for (i = 0; ; i++) {
2172 p = wcschr(path, delim);
2173 if (p == NULL)
2174 p = path + wcslen(path); /* End of string */
2175 w = PyUnicode_FromWideChar(path, (Py_ssize_t)(p - path));
2176 if (w == NULL) {
2177 Py_DECREF(v);
2178 return NULL;
2179 }
2180 PyList_SetItem(v, i, w);
2181 if (*p == '\0')
2182 break;
2183 path = p+1;
2184 }
2185 return v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002186}
2187
2188void
Martin v. Löwis790465f2008-04-05 20:41:37 +00002189PySys_SetPath(const wchar_t *path)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002190{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002191 PyObject *v;
2192 if ((v = makepathobject(path, DELIM)) == NULL)
2193 Py_FatalError("can't create sys.path");
Victor Stinnerbd303c12013-11-07 23:07:29 +01002194 if (_PySys_SetObjectId(&PyId_path, v) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002195 Py_FatalError("can't assign sys.path");
2196 Py_DECREF(v);
Guido van Rossum3f5da241990-12-20 15:06:42 +00002197}
2198
Guido van Rossum65bf9f21997-04-29 18:33:38 +00002199static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00002200makeargvobject(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00002201{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002202 PyObject *av;
2203 if (argc <= 0 || argv == NULL) {
2204 /* Ensure at least one (empty) argument is seen */
2205 static wchar_t *empty_argv[1] = {L""};
2206 argv = empty_argv;
2207 argc = 1;
2208 }
2209 av = PyList_New(argc);
2210 if (av != NULL) {
2211 int i;
2212 for (i = 0; i < argc; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002213 PyObject *v = PyUnicode_FromWideChar(argv[i], -1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002214 if (v == NULL) {
2215 Py_DECREF(av);
2216 av = NULL;
2217 break;
2218 }
2219 PyList_SetItem(av, i, v);
2220 }
2221 }
2222 return av;
Guido van Rossum3f5da241990-12-20 15:06:42 +00002223}
2224
Nick Coghland26c18a2010-08-17 13:06:11 +00002225#define _HAVE_SCRIPT_ARGUMENT(argc, argv) \
2226 (argc > 0 && argv0 != NULL && \
2227 wcscmp(argv0, L"-c") != 0 && wcscmp(argv0, L"-m") != 0)
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002228
2229static void
2230sys_update_path(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00002231{
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002232 wchar_t *argv0;
2233 wchar_t *p = NULL;
2234 Py_ssize_t n = 0;
2235 PyObject *a;
2236 PyObject *path;
2237#ifdef HAVE_READLINK
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002238 wchar_t link[MAXPATHLEN+1];
2239 wchar_t argv0copy[2*MAXPATHLEN+1];
2240 int nr = 0;
2241#endif
Guido van Rossum162e38c2003-02-19 15:25:10 +00002242#if defined(HAVE_REALPATH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002243 wchar_t fullpath[MAXPATHLEN];
Larry Hastings10108a72016-09-05 15:11:23 -07002244#elif defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002245 wchar_t fullpath[MAX_PATH];
Thomas Heller27bb71e2003-01-08 14:33:48 +00002246#endif
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002247
Victor Stinnerbd303c12013-11-07 23:07:29 +01002248 path = _PySys_GetObjectId(&PyId_path);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002249 if (path == NULL)
2250 return;
2251
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002252 argv0 = argv[0];
2253
2254#ifdef HAVE_READLINK
2255 if (_HAVE_SCRIPT_ARGUMENT(argc, argv))
2256 nr = _Py_wreadlink(argv0, link, MAXPATHLEN);
2257 if (nr > 0) {
2258 /* It's a symlink */
2259 link[nr] = '\0';
2260 if (link[0] == SEP)
2261 argv0 = link; /* Link to absolute path */
2262 else if (wcschr(link, SEP) == NULL)
2263 ; /* Link without path */
2264 else {
2265 /* Must join(dirname(argv0), link) */
2266 wchar_t *q = wcsrchr(argv0, SEP);
2267 if (q == NULL)
2268 argv0 = link; /* argv0 without path */
2269 else {
Christian Heimes60a60672013-07-22 12:53:32 +02002270 /* Must make a copy, argv0copy has room for 2 * MAXPATHLEN */
2271 wcsncpy(argv0copy, argv0, MAXPATHLEN);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002272 q = wcsrchr(argv0copy, SEP);
Christian Heimes60a60672013-07-22 12:53:32 +02002273 wcsncpy(q+1, link, MAXPATHLEN);
2274 q[MAXPATHLEN + 1] = L'\0';
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002275 argv0 = argv0copy;
2276 }
2277 }
2278 }
2279#endif /* HAVE_READLINK */
2280#if SEP == '\\' /* Special case for MS filename syntax */
2281 if (_HAVE_SCRIPT_ARGUMENT(argc, argv)) {
2282 wchar_t *q;
Larry Hastings10108a72016-09-05 15:11:23 -07002283#if defined(MS_WINDOWS)
2284 /* Replace the first element in argv with the full path. */
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002285 wchar_t *ptemp;
2286 if (GetFullPathNameW(argv0,
Victor Stinner63941882011-09-29 00:42:28 +02002287 Py_ARRAY_LENGTH(fullpath),
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002288 fullpath,
2289 &ptemp)) {
2290 argv0 = fullpath;
2291 }
2292#endif
2293 p = wcsrchr(argv0, SEP);
2294 /* Test for alternate separator */
2295 q = wcsrchr(p ? p : argv0, '/');
2296 if (q != NULL)
2297 p = q;
2298 if (p != NULL) {
2299 n = p + 1 - argv0;
2300 if (n > 1 && p[-1] != ':')
2301 n--; /* Drop trailing separator */
2302 }
2303 }
2304#else /* All other filename syntaxes */
2305 if (_HAVE_SCRIPT_ARGUMENT(argc, argv)) {
2306#if defined(HAVE_REALPATH)
Victor Stinner23847142013-11-15 17:33:43 +01002307 if (_Py_wrealpath(argv0, fullpath, Py_ARRAY_LENGTH(fullpath))) {
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002308 argv0 = fullpath;
2309 }
2310#endif
2311 p = wcsrchr(argv0, SEP);
2312 }
2313 if (p != NULL) {
2314 n = p + 1 - argv0;
2315#if SEP == '/' /* Special case for Unix filename syntax */
2316 if (n > 1)
2317 n--; /* Drop trailing separator */
2318#endif /* Unix */
2319 }
2320#endif /* All others */
2321 a = PyUnicode_FromWideChar(argv0, n);
2322 if (a == NULL)
2323 Py_FatalError("no mem for sys.path insertion");
2324 if (PyList_Insert(path, 0, a) < 0)
2325 Py_FatalError("sys.path.insert(0) failed");
2326 Py_DECREF(a);
2327}
2328
2329void
2330PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)
2331{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002332 PyObject *av = makeargvobject(argc, argv);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002333 if (av == NULL)
2334 Py_FatalError("no mem for sys.argv");
2335 if (PySys_SetObject("argv", av) != 0)
2336 Py_FatalError("can't assign sys.argv");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002337 Py_DECREF(av);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002338 if (updatepath)
2339 sys_update_path(argc, argv);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002340}
Guido van Rossuma890e681998-05-12 14:59:24 +00002341
Antoine Pitrouf978fac2010-05-21 17:25:34 +00002342void
2343PySys_SetArgv(int argc, wchar_t **argv)
2344{
Christian Heimesad73a9c2013-08-10 16:36:18 +02002345 PySys_SetArgvEx(argc, argv, Py_IsolatedFlag == 0);
Antoine Pitrouf978fac2010-05-21 17:25:34 +00002346}
2347
Victor Stinner14284c22010-04-23 12:02:30 +00002348/* Reimplementation of PyFile_WriteString() no calling indirectly
2349 PyErr_CheckSignals(): avoid the call to PyObject_Str(). */
2350
2351static int
Victor Stinner79766632010-08-16 17:36:42 +00002352sys_pyfile_write_unicode(PyObject *unicode, PyObject *file)
Victor Stinner14284c22010-04-23 12:02:30 +00002353{
Victor Stinnerc3ccaae2016-08-20 01:24:22 +02002354 PyObject *writer = NULL, *result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002355 int err;
Victor Stinner14284c22010-04-23 12:02:30 +00002356
Victor Stinnerecccc4f2010-06-08 20:46:00 +00002357 if (file == NULL)
2358 return -1;
2359
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02002360 writer = _PyObject_GetAttrId(file, &PyId_write);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002361 if (writer == NULL)
2362 goto error;
Victor Stinner14284c22010-04-23 12:02:30 +00002363
Victor Stinner7bfb42d2016-12-05 17:04:32 +01002364 result = PyObject_CallFunctionObjArgs(writer, unicode, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002365 if (result == NULL) {
2366 goto error;
2367 } else {
2368 err = 0;
2369 goto finally;
2370 }
Victor Stinner14284c22010-04-23 12:02:30 +00002371
2372error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002373 err = -1;
Victor Stinner14284c22010-04-23 12:02:30 +00002374finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002375 Py_XDECREF(writer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002376 Py_XDECREF(result);
2377 return err;
Victor Stinner14284c22010-04-23 12:02:30 +00002378}
2379
Victor Stinner79766632010-08-16 17:36:42 +00002380static int
2381sys_pyfile_write(const char *text, PyObject *file)
2382{
2383 PyObject *unicode = NULL;
2384 int err;
2385
2386 if (file == NULL)
2387 return -1;
2388
2389 unicode = PyUnicode_FromString(text);
2390 if (unicode == NULL)
2391 return -1;
2392
2393 err = sys_pyfile_write_unicode(unicode, file);
2394 Py_DECREF(unicode);
2395 return err;
2396}
Guido van Rossuma890e681998-05-12 14:59:24 +00002397
2398/* APIs to write to sys.stdout or sys.stderr using a printf-like interface.
2399 Adapted from code submitted by Just van Rossum.
2400
2401 PySys_WriteStdout(format, ...)
2402 PySys_WriteStderr(format, ...)
2403
2404 The first function writes to sys.stdout; the second to sys.stderr. When
2405 there is a problem, they write to the real (C level) stdout or stderr;
Guido van Rossum8442af31998-10-12 18:22:10 +00002406 no exceptions are raised.
Guido van Rossuma890e681998-05-12 14:59:24 +00002407
Victor Stinner14284c22010-04-23 12:02:30 +00002408 PyErr_CheckSignals() is not called to avoid the execution of the Python
Victor Stinner79766632010-08-16 17:36:42 +00002409 signal handlers: they may raise a new exception whereas sys_write()
2410 ignores all exceptions.
Victor Stinner14284c22010-04-23 12:02:30 +00002411
Guido van Rossuma890e681998-05-12 14:59:24 +00002412 Both take a printf-style format string as their first argument followed
2413 by a variable length argument list determined by the format string.
2414
2415 *** WARNING ***
2416
2417 The format should limit the total size of the formatted output string to
2418 1000 bytes. In particular, this means that no unrestricted "%s" formats
2419 should occur; these should be limited using "%.<N>s where <N> is a
2420 decimal number calculated so that <N> plus the maximum size of other
2421 formatted text does not exceed 1000 bytes. Also watch out for "%f",
2422 which can print hundreds of digits for very large numbers.
2423
2424 */
2425
2426static void
Victor Stinner09054372013-11-06 22:41:44 +01002427sys_write(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Guido van Rossuma890e681998-05-12 14:59:24 +00002428{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002429 PyObject *file;
2430 PyObject *error_type, *error_value, *error_traceback;
2431 char buffer[1001];
2432 int written;
Guido van Rossuma890e681998-05-12 14:59:24 +00002433
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002434 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Victor Stinner09054372013-11-06 22:41:44 +01002435 file = _PySys_GetObjectId(key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002436 written = PyOS_vsnprintf(buffer, sizeof(buffer), format, va);
2437 if (sys_pyfile_write(buffer, file) != 0) {
2438 PyErr_Clear();
2439 fputs(buffer, fp);
2440 }
2441 if (written < 0 || (size_t)written >= sizeof(buffer)) {
2442 const char *truncated = "... truncated";
Victor Stinner79766632010-08-16 17:36:42 +00002443 if (sys_pyfile_write(truncated, file) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 fputs(truncated, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002445 }
2446 PyErr_Restore(error_type, error_value, error_traceback);
Guido van Rossuma890e681998-05-12 14:59:24 +00002447}
2448
2449void
Guido van Rossuma890e681998-05-12 14:59:24 +00002450PySys_WriteStdout(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00002451{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002452 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00002453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002454 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002455 sys_write(&PyId_stdout, stdout, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002456 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00002457}
2458
2459void
Guido van Rossuma890e681998-05-12 14:59:24 +00002460PySys_WriteStderr(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00002461{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002462 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00002463
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002464 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002465 sys_write(&PyId_stderr, stderr, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00002466 va_end(va);
2467}
2468
2469static void
Victor Stinner09054372013-11-06 22:41:44 +01002470sys_format(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Victor Stinner79766632010-08-16 17:36:42 +00002471{
2472 PyObject *file, *message;
2473 PyObject *error_type, *error_value, *error_traceback;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02002474 const char *utf8;
Victor Stinner79766632010-08-16 17:36:42 +00002475
2476 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Victor Stinner09054372013-11-06 22:41:44 +01002477 file = _PySys_GetObjectId(key);
Victor Stinner79766632010-08-16 17:36:42 +00002478 message = PyUnicode_FromFormatV(format, va);
2479 if (message != NULL) {
2480 if (sys_pyfile_write_unicode(message, file) != 0) {
2481 PyErr_Clear();
Serhiy Storchaka06515832016-11-20 09:13:07 +02002482 utf8 = PyUnicode_AsUTF8(message);
Victor Stinner79766632010-08-16 17:36:42 +00002483 if (utf8 != NULL)
2484 fputs(utf8, fp);
2485 }
2486 Py_DECREF(message);
2487 }
2488 PyErr_Restore(error_type, error_value, error_traceback);
2489}
2490
2491void
2492PySys_FormatStdout(const char *format, ...)
2493{
2494 va_list va;
2495
2496 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002497 sys_format(&PyId_stdout, stdout, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00002498 va_end(va);
2499}
2500
2501void
2502PySys_FormatStderr(const char *format, ...)
2503{
2504 va_list va;
2505
2506 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002507 sys_format(&PyId_stderr, stderr, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002508 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00002509}