blob: 5f7c0ebba6311586ad61c72b60e9b86f263d6d1f [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* System module */
3
4/*
5Various bits of information used by the interpreter are collected in
6module 'sys'.
Guido van Rossum3f5da241990-12-20 15:06:42 +00007Function member:
Guido van Rossumcc8914f1995-03-20 15:09:40 +00008- exit(sts): raise SystemExit
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00009Data members:
10- stdin, stdout, stderr: standard file objects
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000011- modules: the table of modules (dictionary)
Guido van Rossum3f5da241990-12-20 15:06:42 +000012- path: module search path (list of strings)
13- argv: script arguments (list of strings)
14- ps1, ps2: optional primary and secondary prompts (strings)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000015*/
16
Guido van Rossum65bf9f21997-04-29 18:33:38 +000017#include "Python.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000018#include "code.h"
Barry Warsawb6a54d22000-12-06 21:47:46 +000019#include "frameobject.h"
Victor Stinnerd5c355c2011-04-30 14:53:09 +020020#include "pythread.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000021
Guido van Rossume2437a11992-03-23 18:20:18 +000022#include "osdefs.h"
Guido van Rossum3f5da241990-12-20 15:06:42 +000023
Mark Hammond8696ebc2002-10-08 02:44:31 +000024#ifdef MS_WINDOWS
25#define WIN32_LEAN_AND_MEAN
Amaury Forgeot d'Arc06cfe952007-11-10 13:55:44 +000026#include <windows.h>
Mark Hammond8696ebc2002-10-08 02:44:31 +000027#endif /* MS_WINDOWS */
28
Guido van Rossum9b38a141996-09-11 23:12:24 +000029#ifdef MS_COREDLL
Guido van Rossumc606fe11996-04-09 02:37:57 +000030extern void *PyWin_DLLhModule;
Guido van Rossum6c1e5f21997-09-29 23:34:23 +000031/* A string loaded from the DLL at startup: */
32extern const char *PyWin_DLLVersionString;
Guido van Rossumc606fe11996-04-09 02:37:57 +000033#endif
34
Martin v. Löwis5467d4c2003-05-10 07:10:12 +000035#ifdef HAVE_LANGINFO_H
36#include <locale.h>
37#include <langinfo.h>
38#endif
39
Victor Stinnerbd303c12013-11-07 23:07:29 +010040_Py_IDENTIFIER(_);
41_Py_IDENTIFIER(__sizeof__);
42_Py_IDENTIFIER(buffer);
43_Py_IDENTIFIER(builtins);
44_Py_IDENTIFIER(encoding);
45_Py_IDENTIFIER(path);
46_Py_IDENTIFIER(stdout);
47_Py_IDENTIFIER(stderr);
48_Py_IDENTIFIER(write);
49
Guido van Rossum65bf9f21997-04-29 18:33:38 +000050PyObject *
Victor Stinnerd67bd452013-11-06 22:36:40 +010051_PySys_GetObjectId(_Py_Identifier *key)
52{
53 PyThreadState *tstate = PyThreadState_GET();
54 PyObject *sd = tstate->interp->sysdict;
55 if (sd == NULL)
56 return NULL;
57 return _PyDict_GetItemId(sd, key);
58}
59
60PyObject *
Neal Norwitzf3081322007-08-25 00:32:45 +000061PySys_GetObject(const char *name)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000062{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000063 PyThreadState *tstate = PyThreadState_GET();
64 PyObject *sd = tstate->interp->sysdict;
65 if (sd == NULL)
66 return NULL;
67 return PyDict_GetItemString(sd, name);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000068}
69
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000070int
Victor Stinnerd67bd452013-11-06 22:36:40 +010071_PySys_SetObjectId(_Py_Identifier *key, PyObject *v)
72{
73 PyThreadState *tstate = PyThreadState_GET();
74 PyObject *sd = tstate->interp->sysdict;
75 if (v == NULL) {
76 if (_PyDict_GetItemId(sd, key) == NULL)
77 return 0;
78 else
79 return _PyDict_DelItemId(sd, key);
80 }
81 else
82 return _PyDict_SetItemId(sd, key, v);
83}
84
85int
Neal Norwitzf3081322007-08-25 00:32:45 +000086PySys_SetObject(const char *name, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000087{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000088 PyThreadState *tstate = PyThreadState_GET();
89 PyObject *sd = tstate->interp->sysdict;
90 if (v == NULL) {
91 if (PyDict_GetItemString(sd, name) == NULL)
92 return 0;
93 else
94 return PyDict_DelItemString(sd, name);
95 }
96 else
97 return PyDict_SetItemString(sd, name, v);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000098}
99
Victor Stinner13d49ee2010-12-04 17:24:33 +0000100/* Write repr(o) to sys.stdout using sys.stdout.encoding and 'backslashreplace'
101 error handler. If sys.stdout has a buffer attribute, use
102 sys.stdout.buffer.write(encoded), otherwise redecode the string and use
103 sys.stdout.write(redecoded).
104
105 Helper function for sys_displayhook(). */
106static int
107sys_displayhook_unencodable(PyObject *outf, PyObject *o)
108{
109 PyObject *stdout_encoding = NULL;
110 PyObject *encoded, *escaped_str, *repr_str, *buffer, *result;
111 char *stdout_encoding_str;
112 int ret;
113
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200114 stdout_encoding = _PyObject_GetAttrId(outf, &PyId_encoding);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000115 if (stdout_encoding == NULL)
116 goto error;
117 stdout_encoding_str = _PyUnicode_AsString(stdout_encoding);
118 if (stdout_encoding_str == NULL)
119 goto error;
120
121 repr_str = PyObject_Repr(o);
122 if (repr_str == NULL)
123 goto error;
124 encoded = PyUnicode_AsEncodedString(repr_str,
125 stdout_encoding_str,
126 "backslashreplace");
127 Py_DECREF(repr_str);
128 if (encoded == NULL)
129 goto error;
130
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200131 buffer = _PyObject_GetAttrId(outf, &PyId_buffer);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000132 if (buffer) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200133 result = _PyObject_CallMethodId(buffer, &PyId_write, "(O)", encoded);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000134 Py_DECREF(buffer);
135 Py_DECREF(encoded);
136 if (result == NULL)
137 goto error;
138 Py_DECREF(result);
139 }
140 else {
141 PyErr_Clear();
142 escaped_str = PyUnicode_FromEncodedObject(encoded,
143 stdout_encoding_str,
144 "strict");
145 Py_DECREF(encoded);
146 if (PyFile_WriteObject(escaped_str, outf, Py_PRINT_RAW) != 0) {
147 Py_DECREF(escaped_str);
148 goto error;
149 }
150 Py_DECREF(escaped_str);
151 }
152 ret = 0;
153 goto finally;
154
155error:
156 ret = -1;
157finally:
158 Py_XDECREF(stdout_encoding);
159 return ret;
160}
161
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000162static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000163sys_displayhook(PyObject *self, PyObject *o)
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000164{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000165 PyObject *outf;
166 PyInterpreterState *interp = PyThreadState_GET()->interp;
167 PyObject *modules = interp->modules;
Victor Stinnerd02fbb82013-11-06 18:27:13 +0100168 PyObject *builtins;
169 static PyObject *newline = NULL;
Victor Stinner13d49ee2010-12-04 17:24:33 +0000170 int err;
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000171
Victor Stinnerd02fbb82013-11-06 18:27:13 +0100172 builtins = _PyDict_GetItemId(modules, &PyId_builtins);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000173 if (builtins == NULL) {
174 PyErr_SetString(PyExc_RuntimeError, "lost builtins module");
175 return NULL;
176 }
Moshe Zadka03897ea2001-07-23 13:32:43 +0000177
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000178 /* Print value except if None */
179 /* After printing, also assign to '_' */
180 /* Before, set '_' to None to avoid recursion */
181 if (o == Py_None) {
182 Py_INCREF(Py_None);
183 return Py_None;
184 }
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200185 if (_PyObject_SetAttrId(builtins, &PyId__, Py_None) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 return NULL;
Victor Stinnerbd303c12013-11-07 23:07:29 +0100187 outf = _PySys_GetObjectId(&PyId_stdout);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000188 if (outf == NULL || outf == Py_None) {
189 PyErr_SetString(PyExc_RuntimeError, "lost sys.stdout");
190 return NULL;
191 }
Victor Stinner13d49ee2010-12-04 17:24:33 +0000192 if (PyFile_WriteObject(o, outf, 0) != 0) {
193 if (PyErr_ExceptionMatches(PyExc_UnicodeEncodeError)) {
194 /* repr(o) is not encodable to sys.stdout.encoding with
195 * sys.stdout.errors error handler (which is probably 'strict') */
196 PyErr_Clear();
197 err = sys_displayhook_unencodable(outf, o);
198 if (err)
199 return NULL;
200 }
201 else {
202 return NULL;
203 }
204 }
Victor Stinnerd02fbb82013-11-06 18:27:13 +0100205 if (newline == NULL) {
206 newline = PyUnicode_FromString("\n");
207 if (newline == NULL)
208 return NULL;
209 }
210 if (PyFile_WriteObject(newline, outf, Py_PRINT_RAW) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000211 return NULL;
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200212 if (_PyObject_SetAttrId(builtins, &PyId__, o) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000213 return NULL;
214 Py_INCREF(Py_None);
215 return Py_None;
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000216}
217
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000218PyDoc_STRVAR(displayhook_doc,
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000219"displayhook(object) -> None\n"
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000220"\n"
Florent Xicluna5749e852010-03-03 11:54:54 +0000221"Print an object to sys.stdout and also save it in builtins._\n"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000222);
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000223
224static PyObject *
225sys_excepthook(PyObject* self, PyObject* args)
226{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000227 PyObject *exc, *value, *tb;
228 if (!PyArg_UnpackTuple(args, "excepthook", 3, 3, &exc, &value, &tb))
229 return NULL;
230 PyErr_Display(exc, value, tb);
231 Py_INCREF(Py_None);
232 return Py_None;
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000233}
234
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000235PyDoc_STRVAR(excepthook_doc,
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000236"excepthook(exctype, value, traceback) -> None\n"
237"\n"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000238"Handle an exception by displaying it with a traceback on sys.stderr.\n"
239);
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000240
241static PyObject *
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000242sys_exc_info(PyObject *self, PyObject *noargs)
Guido van Rossuma027efa1997-05-05 20:56:21 +0000243{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000244 PyThreadState *tstate;
245 tstate = PyThreadState_GET();
246 return Py_BuildValue(
247 "(OOO)",
248 tstate->exc_type != NULL ? tstate->exc_type : Py_None,
249 tstate->exc_value != NULL ? tstate->exc_value : Py_None,
250 tstate->exc_traceback != NULL ?
251 tstate->exc_traceback : Py_None);
Guido van Rossuma027efa1997-05-05 20:56:21 +0000252}
253
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000254PyDoc_STRVAR(exc_info_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000255"exc_info() -> (type, value, traceback)\n\
256\n\
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000257Return information about the most recent exception caught by an except\n\
258clause in the current stack frame or in an older stack frame."
259);
260
261static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000262sys_exit(PyObject *self, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000263{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000264 PyObject *exit_code = 0;
265 if (!PyArg_UnpackTuple(args, "exit", 0, 1, &exit_code))
266 return NULL;
267 /* Raise SystemExit so callers may catch it or clean up. */
268 PyErr_SetObject(PyExc_SystemExit, exit_code);
269 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000270}
271
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000272PyDoc_STRVAR(exit_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000273"exit([status])\n\
274\n\
275Exit the interpreter by raising SystemExit(status).\n\
276If the status is omitted or None, it defaults to zero (i.e., success).\n\
Ezio Melotti4af4d272013-08-26 14:00:39 +0300277If the status is an integer, it will be used as the system exit status.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000278If it is another kind of object, it will be printed and the system\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000279exit status will be one (i.e., failure)."
280);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000281
Martin v. Löwis107b7da2001-11-09 20:59:39 +0000282
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000283static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000284sys_getdefaultencoding(PyObject *self)
Fred Drake8b4d01d2000-05-09 19:57:01 +0000285{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000286 return PyUnicode_FromString(PyUnicode_GetDefaultEncoding());
Fred Drake8b4d01d2000-05-09 19:57:01 +0000287}
288
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000289PyDoc_STRVAR(getdefaultencoding_doc,
Marc-André Lemburg99964b82000-06-07 09:13:41 +0000290"getdefaultencoding() -> string\n\
Fred Drake8b4d01d2000-05-09 19:57:01 +0000291\n\
292Return the current default string encoding used by the Unicode \n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000293implementation."
294);
Fred Drake8b4d01d2000-05-09 19:57:01 +0000295
296static PyObject *
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000297sys_getfilesystemencoding(PyObject *self)
298{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000299 if (Py_FileSystemDefaultEncoding)
300 return PyUnicode_FromString(Py_FileSystemDefaultEncoding);
Victor Stinner27181ac2011-03-31 13:39:03 +0200301 PyErr_SetString(PyExc_RuntimeError,
302 "filesystem encoding is not initialized");
303 return NULL;
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000304}
305
306PyDoc_STRVAR(getfilesystemencoding_doc,
307"getfilesystemencoding() -> string\n\
308\n\
309Return the encoding used to convert Unicode filenames in\n\
310operating system filenames."
311);
312
Martin v. Löwis04dc25c2008-10-03 16:09:28 +0000313static PyObject *
Georg Brandl66a796e2006-12-19 20:50:34 +0000314sys_intern(PyObject *self, PyObject *args)
315{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000316 PyObject *s;
317 if (!PyArg_ParseTuple(args, "U:intern", &s))
318 return NULL;
319 if (PyUnicode_CheckExact(s)) {
320 Py_INCREF(s);
321 PyUnicode_InternInPlace(&s);
322 return s;
323 }
324 else {
325 PyErr_Format(PyExc_TypeError,
326 "can't intern %.400s", s->ob_type->tp_name);
327 return NULL;
328 }
Georg Brandl66a796e2006-12-19 20:50:34 +0000329}
330
331PyDoc_STRVAR(intern_doc,
332"intern(string) -> string\n\
333\n\
334``Intern'' the given string. This enters the string in the (global)\n\
335table of interned strings whose purpose is to speed up dictionary lookups.\n\
336Return the string itself or the previously interned string object with the\n\
337same value.");
338
339
Fred Drake5755ce62001-06-27 19:19:46 +0000340/*
341 * Cached interned string objects used for calling the profile and
342 * trace functions. Initialized by trace_init().
343 */
Nicholas Bastinc69ebe82004-03-24 21:57:10 +0000344static PyObject *whatstrings[7] = {NULL, NULL, NULL, NULL, NULL, NULL, NULL};
Fred Drake5755ce62001-06-27 19:19:46 +0000345
346static int
347trace_init(void)
348{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 static char *whatnames[7] = {"call", "exception", "line", "return",
350 "c_call", "c_exception", "c_return"};
351 PyObject *name;
352 int i;
353 for (i = 0; i < 7; ++i) {
354 if (whatstrings[i] == NULL) {
355 name = PyUnicode_InternFromString(whatnames[i]);
356 if (name == NULL)
357 return -1;
358 whatstrings[i] = name;
359 }
360 }
361 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000362}
363
364
365static PyObject *
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100366call_trampoline(PyObject* callback,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 PyFrameObject *frame, int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000368{
Victor Stinner41bb43a2013-10-29 01:19:37 +0100369 PyObject *args;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000370 PyObject *whatstr;
371 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000372
Victor Stinner41bb43a2013-10-29 01:19:37 +0100373 args = PyTuple_New(3);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000374 if (args == NULL)
375 return NULL;
Victor Stinner41bb43a2013-10-29 01:19:37 +0100376 if (PyFrame_FastToLocalsWithError(frame) < 0)
377 return NULL;
378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000379 Py_INCREF(frame);
380 whatstr = whatstrings[what];
381 Py_INCREF(whatstr);
382 if (arg == NULL)
383 arg = Py_None;
384 Py_INCREF(arg);
385 PyTuple_SET_ITEM(args, 0, (PyObject *)frame);
386 PyTuple_SET_ITEM(args, 1, whatstr);
387 PyTuple_SET_ITEM(args, 2, arg);
Fred Drake5755ce62001-06-27 19:19:46 +0000388
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000389 /* call the Python-level function */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000390 result = PyEval_CallObject(callback, args);
391 PyFrame_LocalsToFast(frame, 1);
392 if (result == NULL)
393 PyTraceBack_Here(frame);
Fred Drake5755ce62001-06-27 19:19:46 +0000394
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000395 /* cleanup */
396 Py_DECREF(args);
397 return result;
Fred Drake5755ce62001-06-27 19:19:46 +0000398}
399
400static int
401profile_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000402 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000403{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000404 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000406 if (arg == NULL)
407 arg = Py_None;
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100408 result = call_trampoline(self, frame, what, arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000409 if (result == NULL) {
410 PyEval_SetProfile(NULL, NULL);
411 return -1;
412 }
413 Py_DECREF(result);
414 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000415}
416
417static int
418trace_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000419 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000420{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000421 PyObject *callback;
422 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000423
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000424 if (what == PyTrace_CALL)
425 callback = self;
426 else
427 callback = frame->f_trace;
428 if (callback == NULL)
429 return 0;
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100430 result = call_trampoline(callback, frame, what, arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000431 if (result == NULL) {
432 PyEval_SetTrace(NULL, NULL);
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200433 Py_CLEAR(frame->f_trace);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000434 return -1;
435 }
436 if (result != Py_None) {
437 PyObject *temp = frame->f_trace;
438 frame->f_trace = NULL;
439 Py_XDECREF(temp);
440 frame->f_trace = result;
441 }
442 else {
443 Py_DECREF(result);
444 }
445 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000446}
Fred Draked0838392001-06-16 21:02:31 +0000447
Fred Drake8b4d01d2000-05-09 19:57:01 +0000448static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000449sys_settrace(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000450{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000451 if (trace_init() == -1)
452 return NULL;
453 if (args == Py_None)
454 PyEval_SetTrace(NULL, NULL);
455 else
456 PyEval_SetTrace(trace_trampoline, args);
457 Py_INCREF(Py_None);
458 return Py_None;
Guido van Rossume2437a11992-03-23 18:20:18 +0000459}
460
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000461PyDoc_STRVAR(settrace_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000462"settrace(function)\n\
463\n\
464Set the global debug tracing function. It will be called on each\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000465function call. See the debugger chapter in the library manual."
466);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000467
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000468static PyObject *
Christian Heimes9bd667a2008-01-20 15:14:11 +0000469sys_gettrace(PyObject *self, PyObject *args)
470{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000471 PyThreadState *tstate = PyThreadState_GET();
472 PyObject *temp = tstate->c_traceobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000474 if (temp == NULL)
475 temp = Py_None;
476 Py_INCREF(temp);
477 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000478}
479
480PyDoc_STRVAR(gettrace_doc,
481"gettrace()\n\
482\n\
483Return the global debug tracing function set with sys.settrace.\n\
484See the debugger chapter in the library manual."
485);
486
487static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000488sys_setprofile(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000489{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000490 if (trace_init() == -1)
491 return NULL;
492 if (args == Py_None)
493 PyEval_SetProfile(NULL, NULL);
494 else
495 PyEval_SetProfile(profile_trampoline, args);
496 Py_INCREF(Py_None);
497 return Py_None;
Guido van Rossume2437a11992-03-23 18:20:18 +0000498}
499
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000500PyDoc_STRVAR(setprofile_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000501"setprofile(function)\n\
502\n\
503Set the profiling function. It will be called on each function call\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000504and return. See the profiler chapter in the library manual."
505);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000506
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000507static PyObject *
Christian Heimes9bd667a2008-01-20 15:14:11 +0000508sys_getprofile(PyObject *self, PyObject *args)
509{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000510 PyThreadState *tstate = PyThreadState_GET();
511 PyObject *temp = tstate->c_profileobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000513 if (temp == NULL)
514 temp = Py_None;
515 Py_INCREF(temp);
516 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000517}
518
519PyDoc_STRVAR(getprofile_doc,
520"getprofile()\n\
521\n\
522Return the profiling function set with sys.setprofile.\n\
523See the profiler chapter in the library manual."
524);
525
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000526static int _check_interval = 100;
527
Christian Heimes9bd667a2008-01-20 15:14:11 +0000528static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000529sys_setcheckinterval(PyObject *self, PyObject *args)
Guido van Rossuma0d7a231995-01-09 17:46:13 +0000530{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000531 if (PyErr_WarnEx(PyExc_DeprecationWarning,
532 "sys.getcheckinterval() and sys.setcheckinterval() "
533 "are deprecated. Use sys.setswitchinterval() "
534 "instead.", 1) < 0)
535 return NULL;
536 if (!PyArg_ParseTuple(args, "i:setcheckinterval", &_check_interval))
537 return NULL;
538 Py_INCREF(Py_None);
539 return Py_None;
Guido van Rossuma0d7a231995-01-09 17:46:13 +0000540}
541
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000542PyDoc_STRVAR(setcheckinterval_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000543"setcheckinterval(n)\n\
544\n\
545Tell the Python interpreter to check for asynchronous events every\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000546n instructions. This also affects how often thread switches occur."
547);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000548
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000549static PyObject *
Tim Peterse5e065b2003-07-06 18:36:54 +0000550sys_getcheckinterval(PyObject *self, PyObject *args)
551{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000552 if (PyErr_WarnEx(PyExc_DeprecationWarning,
553 "sys.getcheckinterval() and sys.setcheckinterval() "
554 "are deprecated. Use sys.getswitchinterval() "
555 "instead.", 1) < 0)
556 return NULL;
557 return PyLong_FromLong(_check_interval);
Tim Peterse5e065b2003-07-06 18:36:54 +0000558}
559
560PyDoc_STRVAR(getcheckinterval_doc,
561"getcheckinterval() -> current check interval; see setcheckinterval()."
562);
563
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000564#ifdef WITH_THREAD
565static PyObject *
566sys_setswitchinterval(PyObject *self, PyObject *args)
567{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000568 double d;
569 if (!PyArg_ParseTuple(args, "d:setswitchinterval", &d))
570 return NULL;
571 if (d <= 0.0) {
572 PyErr_SetString(PyExc_ValueError,
573 "switch interval must be strictly positive");
574 return NULL;
575 }
576 _PyEval_SetSwitchInterval((unsigned long) (1e6 * d));
577 Py_INCREF(Py_None);
578 return Py_None;
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000579}
580
581PyDoc_STRVAR(setswitchinterval_doc,
582"setswitchinterval(n)\n\
583\n\
584Set the ideal thread switching delay inside the Python interpreter\n\
585The actual frequency of switching threads can be lower if the\n\
586interpreter executes long sequences of uninterruptible code\n\
587(this is implementation-specific and workload-dependent).\n\
588\n\
589The parameter must represent the desired switching delay in seconds\n\
590A typical value is 0.005 (5 milliseconds)."
591);
592
593static PyObject *
594sys_getswitchinterval(PyObject *self, PyObject *args)
595{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000596 return PyFloat_FromDouble(1e-6 * _PyEval_GetSwitchInterval());
Antoine Pitrou074e5ed2009-11-10 19:50:40 +0000597}
598
599PyDoc_STRVAR(getswitchinterval_doc,
600"getswitchinterval() -> current thread switch interval; see setswitchinterval()."
601);
602
603#endif /* WITH_THREAD */
604
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000605#ifdef WITH_TSC
606static PyObject *
607sys_settscdump(PyObject *self, PyObject *args)
608{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000609 int bool;
610 PyThreadState *tstate = PyThreadState_Get();
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000611
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000612 if (!PyArg_ParseTuple(args, "i:settscdump", &bool))
613 return NULL;
614 if (bool)
615 tstate->interp->tscdump = 1;
616 else
617 tstate->interp->tscdump = 0;
618 Py_INCREF(Py_None);
619 return Py_None;
Tim Peters216b78b2006-01-06 02:40:53 +0000620
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000621}
622
Tim Peters216b78b2006-01-06 02:40:53 +0000623PyDoc_STRVAR(settscdump_doc,
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000624"settscdump(bool)\n\
625\n\
626If true, tell the Python interpreter to dump VM measurements to\n\
627stderr. If false, turn off dump. The measurements are based on the\n\
Michael W. Hudson800ba232004-08-12 18:19:17 +0000628processor's time-stamp counter."
Tim Peters216b78b2006-01-06 02:40:53 +0000629);
Neal Norwitz0f5aed42004-06-13 20:32:17 +0000630#endif /* TSC */
Martin v. Löwisf30d60e2004-06-08 08:17:44 +0000631
Tim Peterse5e065b2003-07-06 18:36:54 +0000632static PyObject *
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000633sys_setrecursionlimit(PyObject *self, PyObject *args)
634{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000635 int new_limit;
636 if (!PyArg_ParseTuple(args, "i:setrecursionlimit", &new_limit))
637 return NULL;
638 if (new_limit <= 0) {
639 PyErr_SetString(PyExc_ValueError,
640 "recursion limit must be positive");
641 return NULL;
642 }
643 Py_SetRecursionLimit(new_limit);
644 Py_INCREF(Py_None);
645 return Py_None;
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000646}
647
Yury Selivanov75445082015-05-11 22:57:16 -0400648static PyObject *
649sys_set_coroutine_wrapper(PyObject *self, PyObject *wrapper)
650{
651 if (wrapper != Py_None) {
652 if (!PyCallable_Check(wrapper)) {
653 PyErr_Format(PyExc_TypeError,
654 "callable expected, got %.50s",
655 Py_TYPE(wrapper)->tp_name);
656 return NULL;
657 }
Yury Selivanov75445082015-05-11 22:57:16 -0400658 PyEval_SetCoroutineWrapper(wrapper);
659 }
660 else
661 PyEval_SetCoroutineWrapper(NULL);
Yury Selivanov75445082015-05-11 22:57:16 -0400662 Py_RETURN_NONE;
663}
664
665PyDoc_STRVAR(set_coroutine_wrapper_doc,
666"set_coroutine_wrapper(wrapper)\n\
667\n\
668Set a wrapper for coroutine objects."
669);
670
671static PyObject *
672sys_get_coroutine_wrapper(PyObject *self, PyObject *args)
673{
674 PyObject *wrapper = PyEval_GetCoroutineWrapper();
675 if (wrapper == NULL) {
676 wrapper = Py_None;
677 }
678 Py_INCREF(wrapper);
679 return wrapper;
680}
681
682PyDoc_STRVAR(get_coroutine_wrapper_doc,
683"get_coroutine_wrapper()\n\
684\n\
685Return the wrapper for coroutine objects set by sys.set_coroutine_wrapper."
686);
687
688
Mark Dickinsondc787d22010-05-23 13:33:13 +0000689static PyTypeObject Hash_InfoType;
690
691PyDoc_STRVAR(hash_info_doc,
692"hash_info\n\
693\n\
694A struct sequence providing parameters used for computing\n\
Christian Heimes985ecdc2013-11-20 11:46:18 +0100695hashes. The attributes are read only.");
Mark Dickinsondc787d22010-05-23 13:33:13 +0000696
697static PyStructSequence_Field hash_info_fields[] = {
698 {"width", "width of the type used for hashing, in bits"},
699 {"modulus", "prime number giving the modulus on which the hash "
700 "function is based"},
701 {"inf", "value to be used for hash of a positive infinity"},
702 {"nan", "value to be used for hash of a nan"},
703 {"imag", "multiplier used for the imaginary part of a complex number"},
Christian Heimes985ecdc2013-11-20 11:46:18 +0100704 {"algorithm", "name of the algorithm for hashing of str, bytes and "
705 "memoryviews"},
706 {"hash_bits", "internal output size of hash algorithm"},
707 {"seed_bits", "seed size of hash algorithm"},
708 {"cutoff", "small string optimization cutoff"},
Mark Dickinsondc787d22010-05-23 13:33:13 +0000709 {NULL, NULL}
710};
711
712static PyStructSequence_Desc hash_info_desc = {
713 "sys.hash_info",
714 hash_info_doc,
715 hash_info_fields,
Christian Heimes985ecdc2013-11-20 11:46:18 +0100716 9,
Mark Dickinsondc787d22010-05-23 13:33:13 +0000717};
718
Matthias Klosed885e952010-07-06 10:53:30 +0000719static PyObject *
Mark Dickinsondc787d22010-05-23 13:33:13 +0000720get_hash_info(void)
721{
722 PyObject *hash_info;
723 int field = 0;
Christian Heimes985ecdc2013-11-20 11:46:18 +0100724 PyHash_FuncDef *hashfunc;
Mark Dickinsondc787d22010-05-23 13:33:13 +0000725 hash_info = PyStructSequence_New(&Hash_InfoType);
726 if (hash_info == NULL)
727 return NULL;
Christian Heimes985ecdc2013-11-20 11:46:18 +0100728 hashfunc = PyHash_GetFuncDef();
Mark Dickinsondc787d22010-05-23 13:33:13 +0000729 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000730 PyLong_FromLong(8*sizeof(Py_hash_t)));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000731 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8035bc52010-10-23 16:20:50 +0000732 PyLong_FromSsize_t(_PyHASH_MODULUS));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000733 PyStructSequence_SET_ITEM(hash_info, field++,
734 PyLong_FromLong(_PyHASH_INF));
735 PyStructSequence_SET_ITEM(hash_info, field++,
736 PyLong_FromLong(_PyHASH_NAN));
737 PyStructSequence_SET_ITEM(hash_info, field++,
738 PyLong_FromLong(_PyHASH_IMAG));
Christian Heimes985ecdc2013-11-20 11:46:18 +0100739 PyStructSequence_SET_ITEM(hash_info, field++,
740 PyUnicode_FromString(hashfunc->name));
741 PyStructSequence_SET_ITEM(hash_info, field++,
742 PyLong_FromLong(hashfunc->hash_bits));
743 PyStructSequence_SET_ITEM(hash_info, field++,
744 PyLong_FromLong(hashfunc->seed_bits));
745 PyStructSequence_SET_ITEM(hash_info, field++,
746 PyLong_FromLong(Py_HASH_CUTOFF));
Mark Dickinsondc787d22010-05-23 13:33:13 +0000747 if (PyErr_Occurred()) {
748 Py_CLEAR(hash_info);
749 return NULL;
750 }
751 return hash_info;
752}
753
754
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000755PyDoc_STRVAR(setrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000756"setrecursionlimit(n)\n\
757\n\
758Set the maximum depth of the Python interpreter stack to n. This\n\
759limit prevents infinite recursion from causing an overflow of the C\n\
760stack and crashing Python. The highest possible limit is platform-\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000761dependent."
762);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000763
764static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000765sys_getrecursionlimit(PyObject *self)
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000766{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000767 return PyLong_FromLong(Py_GetRecursionLimit());
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000768}
769
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000770PyDoc_STRVAR(getrecursionlimit_doc,
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000771"getrecursionlimit()\n\
772\n\
773Return the current value of the recursion limit, the maximum depth\n\
774of the Python interpreter stack. This limit prevents infinite\n\
Jack Jansene739a0d2002-06-26 20:39:20 +0000775recursion from causing an overflow of the C stack and crashing Python."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000776);
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +0000777
Mark Hammond8696ebc2002-10-08 02:44:31 +0000778#ifdef MS_WINDOWS
779PyDoc_STRVAR(getwindowsversion_doc,
780"getwindowsversion()\n\
781\n\
Eric Smithf7bb5782010-01-27 00:44:57 +0000782Return information about the running version of Windows as a named tuple.\n\
783The members are named: major, minor, build, platform, service_pack,\n\
784service_pack_major, service_pack_minor, suite_mask, and product_type. For\n\
Ezio Melotti4969f702011-03-15 05:59:46 +0200785backward compatibility, only the first 5 items are available by indexing.\n\
Eric Smithf7bb5782010-01-27 00:44:57 +0000786All elements are numbers, except service_pack which is a string. Platform\n\
787may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7,\n\
7883 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain\n\
789controller, 3 for a server."
Mark Hammond8696ebc2002-10-08 02:44:31 +0000790);
791
Eric Smithf7bb5782010-01-27 00:44:57 +0000792static PyTypeObject WindowsVersionType = {0, 0, 0, 0, 0, 0};
793
794static PyStructSequence_Field windows_version_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000795 {"major", "Major version number"},
796 {"minor", "Minor version number"},
797 {"build", "Build number"},
798 {"platform", "Operating system platform"},
799 {"service_pack", "Latest Service Pack installed on the system"},
800 {"service_pack_major", "Service Pack major version number"},
801 {"service_pack_minor", "Service Pack minor version number"},
802 {"suite_mask", "Bit mask identifying available product suites"},
803 {"product_type", "System product type"},
804 {0}
Eric Smithf7bb5782010-01-27 00:44:57 +0000805};
806
807static PyStructSequence_Desc windows_version_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000808 "sys.getwindowsversion", /* name */
809 getwindowsversion_doc, /* doc */
810 windows_version_fields, /* fields */
811 5 /* For backward compatibility,
812 only the first 5 items are accessible
813 via indexing, the rest are name only */
Eric Smithf7bb5782010-01-27 00:44:57 +0000814};
815
Steve Dower3e96f322015-03-02 08:01:10 -0800816/* Disable deprecation warnings about GetVersionEx as the result is
817 being passed straight through to the caller, who is responsible for
818 using it correctly. */
819#pragma warning(push)
820#pragma warning(disable:4996)
821
Mark Hammond8696ebc2002-10-08 02:44:31 +0000822static PyObject *
823sys_getwindowsversion(PyObject *self)
824{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000825 PyObject *version;
826 int pos = 0;
827 OSVERSIONINFOEX ver;
828 ver.dwOSVersionInfoSize = sizeof(ver);
829 if (!GetVersionEx((OSVERSIONINFO*) &ver))
830 return PyErr_SetFromWindowsErr(0);
Eric Smithf7bb5782010-01-27 00:44:57 +0000831
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000832 version = PyStructSequence_New(&WindowsVersionType);
833 if (version == NULL)
834 return NULL;
Eric Smithf7bb5782010-01-27 00:44:57 +0000835
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000836 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMajorVersion));
837 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMinorVersion));
838 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwBuildNumber));
839 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwPlatformId));
840 PyStructSequence_SET_ITEM(version, pos++, PyUnicode_FromString(ver.szCSDVersion));
841 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMajor));
842 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMinor));
843 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wSuiteMask));
844 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wProductType));
Eric Smithf7bb5782010-01-27 00:44:57 +0000845
Serhiy Storchaka48d761e2013-12-17 15:11:24 +0200846 if (PyErr_Occurred()) {
847 Py_DECREF(version);
848 return NULL;
849 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000850 return version;
Mark Hammond8696ebc2002-10-08 02:44:31 +0000851}
852
Steve Dower3e96f322015-03-02 08:01:10 -0800853#pragma warning(pop)
854
Mark Hammond8696ebc2002-10-08 02:44:31 +0000855#endif /* MS_WINDOWS */
856
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000857#ifdef HAVE_DLOPEN
858static PyObject *
859sys_setdlopenflags(PyObject *self, PyObject *args)
860{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 int new_val;
862 PyThreadState *tstate = PyThreadState_GET();
863 if (!PyArg_ParseTuple(args, "i:setdlopenflags", &new_val))
864 return NULL;
865 if (!tstate)
866 return NULL;
867 tstate->interp->dlopenflags = new_val;
868 Py_INCREF(Py_None);
869 return Py_None;
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000870}
871
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000872PyDoc_STRVAR(setdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000873"setdlopenflags(n) -> None\n\
874\n\
Alexandre Vassalotti260484d2009-07-17 11:43:26 +0000875Set the flags used by the interpreter for dlopen calls, such as when the\n\
876interpreter loads extension modules. Among other things, this will enable\n\
877a lazy resolving of symbols when importing a module, if called as\n\
878sys.setdlopenflags(0). To share symbols across extension modules, call as\n\
Andrew Kuchlingc61b9132013-06-21 10:58:41 -0400879sys.setdlopenflags(os.RTLD_GLOBAL). Symbolic names for the flag modules\n\
Victor Stinnerf4afa432011-10-31 11:48:09 +0100880can be found in the os module (RTLD_xxx constants, e.g. os.RTLD_LAZY).");
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000881
882static PyObject *
883sys_getdlopenflags(PyObject *self, PyObject *args)
884{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000885 PyThreadState *tstate = PyThreadState_GET();
886 if (!tstate)
887 return NULL;
888 return PyLong_FromLong(tstate->interp->dlopenflags);
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000889}
890
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000891PyDoc_STRVAR(getdlopenflags_doc,
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000892"getdlopenflags() -> int\n\
893\n\
Alexandre Vassalotti260484d2009-07-17 11:43:26 +0000894Return the current value of the flags that are used for dlopen calls.\n\
Andrew Kuchlingc61b9132013-06-21 10:58:41 -0400895The flag constants are defined in the os module.");
Alexandre Vassalotti260484d2009-07-17 11:43:26 +0000896
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000897#endif /* HAVE_DLOPEN */
Martin v. Löwisf0473d52001-07-18 16:17:16 +0000898
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000899#ifdef USE_MALLOPT
900/* Link with -lmalloc (or -lmpc) on an SGI */
901#include <malloc.h>
902
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000903static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000904sys_mdebug(PyObject *self, PyObject *args)
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000905{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000906 int flag;
907 if (!PyArg_ParseTuple(args, "i:mdebug", &flag))
908 return NULL;
909 mallopt(M_DEBUG, flag);
910 Py_INCREF(Py_None);
911 return Py_None;
Guido van Rossum14b4adb1992-09-03 20:25:30 +0000912}
913#endif /* USE_MALLOPT */
914
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +0300915size_t
916_PySys_GetSizeOf(PyObject *o)
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000917{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 PyObject *res = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000919 PyObject *method;
Serhiy Storchaka030e92d2014-11-15 13:21:37 +0200920 Py_ssize_t size;
Benjamin Petersona5758c02009-05-09 18:15:04 +0000921
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000922 /* Make sure the type is initialized. float gets initialized late */
923 if (PyType_Ready(Py_TYPE(o)) < 0)
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +0300924 return (size_t)-1;
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000925
Benjamin Petersonce798522012-01-22 11:24:29 -0500926 method = _PyObject_LookupSpecial(o, &PyId___sizeof__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000927 if (method == NULL) {
928 if (!PyErr_Occurred())
929 PyErr_Format(PyExc_TypeError,
930 "Type %.100s doesn't define __sizeof__",
931 Py_TYPE(o)->tp_name);
932 }
933 else {
934 res = PyObject_CallFunctionObjArgs(method, NULL);
935 Py_DECREF(method);
936 }
937
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +0300938 if (res == NULL)
939 return (size_t)-1;
940
Serhiy Storchaka030e92d2014-11-15 13:21:37 +0200941 size = PyLong_AsSsize_t(res);
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +0300942 Py_DECREF(res);
Serhiy Storchaka030e92d2014-11-15 13:21:37 +0200943 if (size == -1 && PyErr_Occurred())
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +0300944 return (size_t)-1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000945
Serhiy Storchaka030e92d2014-11-15 13:21:37 +0200946 if (size < 0) {
947 PyErr_SetString(PyExc_ValueError, "__sizeof__() should return >= 0");
948 return (size_t)-1;
949 }
950
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000951 /* add gc_head size */
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +0300952 if (PyObject_IS_GC(o))
Serhiy Storchaka030e92d2014-11-15 13:21:37 +0200953 return ((size_t)size) + sizeof(PyGC_Head);
954 return (size_t)size;
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +0300955}
956
957static PyObject *
958sys_getsizeof(PyObject *self, PyObject *args, PyObject *kwds)
959{
960 static char *kwlist[] = {"object", "default", 0};
961 size_t size;
962 PyObject *o, *dflt = NULL;
963
964 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|O:getsizeof",
965 kwlist, &o, &dflt))
966 return NULL;
967
968 size = _PySys_GetSizeOf(o);
969
970 if (size == (size_t)-1 && PyErr_Occurred()) {
971 /* Has a default value been given */
972 if (dflt != NULL && PyErr_ExceptionMatches(PyExc_TypeError)) {
973 PyErr_Clear();
974 Py_INCREF(dflt);
975 return dflt;
976 }
977 else
978 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000979 }
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +0300980
981 return PyLong_FromSize_t(size);
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000982}
983
984PyDoc_STRVAR(getsizeof_doc,
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +0000985"getsizeof(object, default) -> int\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +0000986\n\
987Return the size of object in bytes.");
988
989static PyObject *
Fred Drakea7688822001-10-24 20:47:48 +0000990sys_getrefcount(PyObject *self, PyObject *arg)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000991{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000992 return PyLong_FromSsize_t(arg->ob_refcnt);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +0000993}
994
Tim Peters4be93d02002-07-07 19:59:50 +0000995#ifdef Py_REF_DEBUG
Mark Hammond440d8982000-06-20 08:12:48 +0000996static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000997sys_gettotalrefcount(PyObject *self)
Mark Hammond440d8982000-06-20 08:12:48 +0000998{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000999 return PyLong_FromSsize_t(_Py_GetRefTotal());
Mark Hammond440d8982000-06-20 08:12:48 +00001000}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001001#endif /* Py_REF_DEBUG */
Mark Hammond440d8982000-06-20 08:12:48 +00001002
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001003PyDoc_STRVAR(getrefcount_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001004"getrefcount(object) -> integer\n\
1005\n\
Fred Drakeba3ff1b2002-06-20 21:36:19 +00001006Return the reference count of object. The count returned is generally\n\
1007one higher than you might expect, because it includes the (temporary)\n\
1008reference as an argument to getrefcount()."
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001009);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001010
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001011static PyObject *
1012sys_getallocatedblocks(PyObject *self)
1013{
1014 return PyLong_FromSsize_t(_Py_GetAllocatedBlocks());
1015}
1016
1017PyDoc_STRVAR(getallocatedblocks_doc,
1018"getallocatedblocks() -> integer\n\
1019\n\
1020Return the number of memory blocks currently allocated, regardless of their\n\
1021size."
1022);
1023
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001024#ifdef COUNT_ALLOCS
1025static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001026sys_getcounts(PyObject *self)
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001027{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001028 extern PyObject *get_counts(void);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001029
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001030 return get_counts();
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001031}
1032#endif
1033
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001034PyDoc_STRVAR(getframe_doc,
Barry Warsawb6a54d22000-12-06 21:47:46 +00001035"_getframe([depth]) -> frameobject\n\
1036\n\
1037Return a frame object from the call stack. If optional integer depth is\n\
1038given, return the frame object that many calls below the top of the stack.\n\
1039If that is deeper than the call stack, ValueError is raised. The default\n\
1040for depth is zero, returning the frame at the top of the call stack.\n\
1041\n\
1042This function should be used for internal and specialized\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001043purposes only."
1044);
Barry Warsawb6a54d22000-12-06 21:47:46 +00001045
1046static PyObject *
1047sys_getframe(PyObject *self, PyObject *args)
1048{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001049 PyFrameObject *f = PyThreadState_GET()->frame;
1050 int depth = -1;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001051
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001052 if (!PyArg_ParseTuple(args, "|i:_getframe", &depth))
1053 return NULL;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001054
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 while (depth > 0 && f != NULL) {
1056 f = f->f_back;
1057 --depth;
1058 }
1059 if (f == NULL) {
1060 PyErr_SetString(PyExc_ValueError,
1061 "call stack is not deep enough");
1062 return NULL;
1063 }
1064 Py_INCREF(f);
1065 return (PyObject*)f;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001066}
1067
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001068PyDoc_STRVAR(current_frames_doc,
1069"_current_frames() -> dictionary\n\
1070\n\
1071Return a dictionary mapping each current thread T's thread id to T's\n\
1072current stack frame.\n\
1073\n\
1074This function should be used for specialized purposes only."
1075);
1076
1077static PyObject *
1078sys_current_frames(PyObject *self, PyObject *noargs)
1079{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001080 return _PyThread_CurrentFrames();
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001081}
1082
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001083PyDoc_STRVAR(call_tracing_doc,
1084"call_tracing(func, args) -> object\n\
1085\n\
1086Call func(*args), while tracing is enabled. The tracing state is\n\
1087saved, and restored afterwards. This is intended to be called from\n\
1088a debugger from a checkpoint, to recursively debug some other code."
1089);
1090
1091static PyObject *
1092sys_call_tracing(PyObject *self, PyObject *args)
1093{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001094 PyObject *func, *funcargs;
1095 if (!PyArg_ParseTuple(args, "OO!:call_tracing", &func, &PyTuple_Type, &funcargs))
1096 return NULL;
1097 return _PyEval_CallTracing(func, funcargs);
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001098}
1099
Jeremy Hylton985eba52003-02-05 23:13:00 +00001100PyDoc_STRVAR(callstats_doc,
1101"callstats() -> tuple of integers\n\
1102\n\
1103Return a tuple of function call statistics, if CALL_PROFILE was defined\n\
1104when Python was built. Otherwise, return None.\n\
1105\n\
1106When enabled, this function returns detailed, implementation-specific\n\
1107details about the number of function calls executed. The return value is\n\
1108a 11-tuple where the entries in the tuple are counts of:\n\
11090. all function calls\n\
11101. calls to PyFunction_Type objects\n\
11112. PyFunction calls that do not create an argument tuple\n\
11123. PyFunction calls that do not create an argument tuple\n\
1113 and bypass PyEval_EvalCodeEx()\n\
11144. PyMethod calls\n\
11155. PyMethod calls on bound methods\n\
11166. PyType calls\n\
11177. PyCFunction calls\n\
11188. generator calls\n\
11199. All other calls\n\
112010. Number of stack pops performed by call_function()"
1121);
Barry Warsawb6a54d22000-12-06 21:47:46 +00001122
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001123#ifdef __cplusplus
1124extern "C" {
1125#endif
1126
David Malcolm49526f42012-06-22 14:55:41 -04001127static PyObject *
1128sys_debugmallocstats(PyObject *self, PyObject *args)
1129{
1130#ifdef WITH_PYMALLOC
1131 _PyObject_DebugMallocStats(stderr);
1132 fputc('\n', stderr);
1133#endif
1134 _PyObject_DebugTypeStats(stderr);
1135
1136 Py_RETURN_NONE;
1137}
1138PyDoc_STRVAR(debugmallocstats_doc,
1139"_debugmallocstats()\n\
1140\n\
1141Print summary info to stderr about the state of\n\
1142pymalloc's structures.\n\
1143\n\
1144In Py_DEBUG mode, also perform some expensive internal consistency\n\
1145checks.\n\
1146");
1147
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001148#ifdef Py_TRACE_REFS
Guido van Rossumded690f1996-05-24 20:48:31 +00001149/* Defined in objects.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001150extern PyObject *_Py_GetObjects(PyObject *, PyObject *);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001151#endif
Guido van Rossumded690f1996-05-24 20:48:31 +00001152
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001153#ifdef DYNAMIC_EXECUTION_PROFILE
1154/* Defined in ceval.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001155extern PyObject *_Py_GetDXProfile(PyObject *, PyObject *);
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001156#endif
1157
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001158#ifdef __cplusplus
1159}
1160#endif
1161
Christian Heimes15ebc882008-02-04 18:48:49 +00001162static PyObject *
1163sys_clear_type_cache(PyObject* self, PyObject* args)
1164{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001165 PyType_ClearCache();
1166 Py_RETURN_NONE;
Christian Heimes15ebc882008-02-04 18:48:49 +00001167}
1168
1169PyDoc_STRVAR(sys_clear_type_cache__doc__,
1170"_clear_type_cache() -> None\n\
1171Clear the internal type lookup cache.");
1172
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001173static PyObject *
1174sys_is_finalizing(PyObject* self, PyObject* args)
1175{
1176 return PyBool_FromLong(_Py_Finalizing != NULL);
1177}
1178
1179PyDoc_STRVAR(is_finalizing_doc,
1180"is_finalizing()\n\
1181Return True if Python is exiting.");
1182
Christian Heimes15ebc882008-02-04 18:48:49 +00001183
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001184static PyMethodDef sys_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001185 /* Might as well keep this in alphabetic order */
1186 {"callstats", (PyCFunction)PyEval_GetCallStats, METH_NOARGS,
1187 callstats_doc},
1188 {"_clear_type_cache", sys_clear_type_cache, METH_NOARGS,
1189 sys_clear_type_cache__doc__},
1190 {"_current_frames", sys_current_frames, METH_NOARGS,
1191 current_frames_doc},
1192 {"displayhook", sys_displayhook, METH_O, displayhook_doc},
1193 {"exc_info", sys_exc_info, METH_NOARGS, exc_info_doc},
1194 {"excepthook", sys_excepthook, METH_VARARGS, excepthook_doc},
1195 {"exit", sys_exit, METH_VARARGS, exit_doc},
1196 {"getdefaultencoding", (PyCFunction)sys_getdefaultencoding,
1197 METH_NOARGS, getdefaultencoding_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001198#ifdef HAVE_DLOPEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001199 {"getdlopenflags", (PyCFunction)sys_getdlopenflags, METH_NOARGS,
1200 getdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001201#endif
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001202 {"getallocatedblocks", (PyCFunction)sys_getallocatedblocks, METH_NOARGS,
1203 getallocatedblocks_doc},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001204#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001205 {"getcounts", (PyCFunction)sys_getcounts, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001206#endif
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001207#ifdef DYNAMIC_EXECUTION_PROFILE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001208 {"getdxp", _Py_GetDXProfile, METH_VARARGS},
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001209#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001210 {"getfilesystemencoding", (PyCFunction)sys_getfilesystemencoding,
1211 METH_NOARGS, getfilesystemencoding_doc},
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001212#ifdef Py_TRACE_REFS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001213 {"getobjects", _Py_GetObjects, METH_VARARGS},
Tim Peters4be93d02002-07-07 19:59:50 +00001214#endif
1215#ifdef Py_REF_DEBUG
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001216 {"gettotalrefcount", (PyCFunction)sys_gettotalrefcount, METH_NOARGS},
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001217#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001218 {"getrefcount", (PyCFunction)sys_getrefcount, METH_O, getrefcount_doc},
1219 {"getrecursionlimit", (PyCFunction)sys_getrecursionlimit, METH_NOARGS,
1220 getrecursionlimit_doc},
1221 {"getsizeof", (PyCFunction)sys_getsizeof,
1222 METH_VARARGS | METH_KEYWORDS, getsizeof_doc},
1223 {"_getframe", sys_getframe, METH_VARARGS, getframe_doc},
Mark Hammond8696ebc2002-10-08 02:44:31 +00001224#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001225 {"getwindowsversion", (PyCFunction)sys_getwindowsversion, METH_NOARGS,
1226 getwindowsversion_doc},
Mark Hammond8696ebc2002-10-08 02:44:31 +00001227#endif /* MS_WINDOWS */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001228 {"intern", sys_intern, METH_VARARGS, intern_doc},
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001229 {"is_finalizing", sys_is_finalizing, METH_NOARGS, is_finalizing_doc},
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001230#ifdef USE_MALLOPT
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001231 {"mdebug", sys_mdebug, METH_VARARGS},
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001232#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001233 {"setcheckinterval", sys_setcheckinterval, METH_VARARGS,
1234 setcheckinterval_doc},
1235 {"getcheckinterval", sys_getcheckinterval, METH_NOARGS,
1236 getcheckinterval_doc},
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001237#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001238 {"setswitchinterval", sys_setswitchinterval, METH_VARARGS,
1239 setswitchinterval_doc},
1240 {"getswitchinterval", sys_getswitchinterval, METH_NOARGS,
1241 getswitchinterval_doc},
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001242#endif
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001243#ifdef HAVE_DLOPEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001244 {"setdlopenflags", sys_setdlopenflags, METH_VARARGS,
1245 setdlopenflags_doc},
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001246#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001247 {"setprofile", sys_setprofile, METH_O, setprofile_doc},
1248 {"getprofile", sys_getprofile, METH_NOARGS, getprofile_doc},
1249 {"setrecursionlimit", sys_setrecursionlimit, METH_VARARGS,
1250 setrecursionlimit_doc},
Martin v. Löwisf30d60e2004-06-08 08:17:44 +00001251#ifdef WITH_TSC
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001252 {"settscdump", sys_settscdump, METH_VARARGS, settscdump_doc},
Martin v. Löwisf30d60e2004-06-08 08:17:44 +00001253#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001254 {"settrace", sys_settrace, METH_O, settrace_doc},
1255 {"gettrace", sys_gettrace, METH_NOARGS, gettrace_doc},
1256 {"call_tracing", sys_call_tracing, METH_VARARGS, call_tracing_doc},
Victor Stinnered0b87d2013-12-19 17:16:42 +01001257 {"_debugmallocstats", sys_debugmallocstats, METH_NOARGS,
David Malcolm49526f42012-06-22 14:55:41 -04001258 debugmallocstats_doc},
Yury Selivanov75445082015-05-11 22:57:16 -04001259 {"set_coroutine_wrapper", sys_set_coroutine_wrapper, METH_O,
1260 set_coroutine_wrapper_doc},
1261 {"get_coroutine_wrapper", sys_get_coroutine_wrapper, METH_NOARGS,
1262 get_coroutine_wrapper_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001263 {NULL, NULL} /* sentinel */
Guido van Rossum3f5da241990-12-20 15:06:42 +00001264};
1265
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001266static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001267list_builtin_module_names(void)
Guido van Rossum34679b71993-01-26 13:33:44 +00001268{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269 PyObject *list = PyList_New(0);
1270 int i;
1271 if (list == NULL)
1272 return NULL;
1273 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1274 PyObject *name = PyUnicode_FromString(
1275 PyImport_Inittab[i].name);
1276 if (name == NULL)
1277 break;
1278 PyList_Append(list, name);
1279 Py_DECREF(name);
1280 }
1281 if (PyList_Sort(list) != 0) {
1282 Py_DECREF(list);
1283 list = NULL;
1284 }
1285 if (list) {
1286 PyObject *v = PyList_AsTuple(list);
1287 Py_DECREF(list);
1288 list = v;
1289 }
1290 return list;
Guido van Rossum34679b71993-01-26 13:33:44 +00001291}
1292
Guido van Rossum23fff912000-12-15 22:02:05 +00001293static PyObject *warnoptions = NULL;
1294
1295void
1296PySys_ResetWarnOptions(void)
1297{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001298 if (warnoptions == NULL || !PyList_Check(warnoptions))
1299 return;
1300 PyList_SetSlice(warnoptions, 0, PyList_GET_SIZE(warnoptions), NULL);
Guido van Rossum23fff912000-12-15 22:02:05 +00001301}
1302
1303void
Victor Stinner9ca9c252010-05-19 16:53:30 +00001304PySys_AddWarnOptionUnicode(PyObject *unicode)
Guido van Rossum23fff912000-12-15 22:02:05 +00001305{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001306 if (warnoptions == NULL || !PyList_Check(warnoptions)) {
1307 Py_XDECREF(warnoptions);
1308 warnoptions = PyList_New(0);
1309 if (warnoptions == NULL)
1310 return;
1311 }
Victor Stinner9ca9c252010-05-19 16:53:30 +00001312 PyList_Append(warnoptions, unicode);
1313}
1314
1315void
1316PySys_AddWarnOption(const wchar_t *s)
1317{
1318 PyObject *unicode;
1319 unicode = PyUnicode_FromWideChar(s, -1);
1320 if (unicode == NULL)
1321 return;
1322 PySys_AddWarnOptionUnicode(unicode);
1323 Py_DECREF(unicode);
Guido van Rossum23fff912000-12-15 22:02:05 +00001324}
1325
Christian Heimes33fe8092008-04-13 13:53:33 +00001326int
1327PySys_HasWarnOptions(void)
1328{
1329 return (warnoptions != NULL && (PyList_Size(warnoptions) > 0)) ? 1 : 0;
1330}
1331
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001332static PyObject *xoptions = NULL;
1333
1334static PyObject *
1335get_xoptions(void)
1336{
1337 if (xoptions == NULL || !PyDict_Check(xoptions)) {
1338 Py_XDECREF(xoptions);
1339 xoptions = PyDict_New();
1340 }
1341 return xoptions;
1342}
1343
1344void
1345PySys_AddXOption(const wchar_t *s)
1346{
1347 PyObject *opts;
1348 PyObject *name = NULL, *value = NULL;
1349 const wchar_t *name_end;
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001350
1351 opts = get_xoptions();
1352 if (opts == NULL)
1353 goto error;
1354
1355 name_end = wcschr(s, L'=');
1356 if (!name_end) {
1357 name = PyUnicode_FromWideChar(s, -1);
1358 value = Py_True;
1359 Py_INCREF(value);
1360 }
1361 else {
1362 name = PyUnicode_FromWideChar(s, name_end - s);
1363 value = PyUnicode_FromWideChar(name_end + 1, -1);
1364 }
1365 if (name == NULL || value == NULL)
1366 goto error;
Brett Cannonb94767f2011-02-22 20:15:44 +00001367 PyDict_SetItem(opts, name, value);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001368 Py_DECREF(name);
1369 Py_DECREF(value);
1370 return;
1371
1372error:
1373 Py_XDECREF(name);
1374 Py_XDECREF(value);
1375 /* No return value, therefore clear error state if possible */
1376 if (_Py_atomic_load_relaxed(&_PyThreadState_Current))
1377 PyErr_Clear();
1378}
1379
1380PyObject *
1381PySys_GetXOptions(void)
1382{
1383 return get_xoptions();
1384}
1385
Guido van Rossum40552d01998-08-06 03:34:39 +00001386/* XXX This doc string is too long to be a single string literal in VC++ 5.0.
1387 Two literals concatenated works just fine. If you have a K&R compiler
1388 or other abomination that however *does* understand longer strings,
1389 get rid of the !!! comment in the middle and the quotes that surround it. */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001390PyDoc_VAR(sys_doc) =
1391PyDoc_STR(
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001392"This module provides access to some objects used or maintained by the\n\
1393interpreter and to functions that interact strongly with the interpreter.\n\
1394\n\
1395Dynamic objects:\n\
1396\n\
1397argv -- command line arguments; argv[0] is the script pathname if known\n\
1398path -- module search path; path[0] is the script directory, else ''\n\
1399modules -- dictionary of loaded modules\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001400\n\
1401displayhook -- called to show results in an interactive session\n\
1402excepthook -- called to handle any uncaught exception other than SystemExit\n\
1403 To customize printing in an interactive session or to install a custom\n\
1404 top-level exception handler, assign other functions to replace these.\n\
1405\n\
Benjamin Peterson06157a42008-07-15 00:28:36 +00001406stdin -- standard input file object; used by input()\n\
Georg Brandl88fc6642007-02-09 21:28:07 +00001407stdout -- standard output file object; used by print()\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001408stderr -- standard error object; used for error messages\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001409 By assigning other file objects (or objects that behave like files)\n\
1410 to these, it is possible to redirect all of the interpreter's I/O.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001411\n\
1412last_type -- type of last uncaught exception\n\
1413last_value -- value of last uncaught exception\n\
1414last_traceback -- traceback of last uncaught exception\n\
1415 These three are only available in an interactive session after a\n\
1416 traceback has been printed.\n\
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001417"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001418)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001419/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001420PyDoc_STR(
Guido van Rossuma71b5f41999-01-14 19:07:00 +00001421"\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001422Static objects:\n\
1423\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001424builtin_module_names -- tuple of module names built into this interpreter\n\
1425copyright -- copyright notice pertaining to this interpreter\n\
1426exec_prefix -- prefix used to find the machine-specific Python library\n\
Petri Lehtinen4b0eab62012-02-02 21:23:15 +02001427executable -- absolute path of the executable binary of the Python interpreter\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001428float_info -- a struct sequence with information about the float implementation.\n\
1429float_repr_style -- string indicating the style of repr() output for floats\n\
Christian Heimes985ecdc2013-11-20 11:46:18 +01001430hash_info -- a struct sequence with information about the hash algorithm.\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001431hexversion -- version information encoded as a single integer\n\
Barry Warsaw409da152012-06-03 16:18:47 -04001432implementation -- Python implementation information.\n\
Mark Dickinsonbd792642009-03-18 20:06:12 +00001433int_info -- a struct sequence with information about the int implementation.\n\
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001434maxsize -- the largest supported length of containers.\n\
Serhiy Storchakad3faf432015-01-18 11:28:37 +02001435maxunicode -- the value of the largest Unicode code point\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001436platform -- platform identifier\n\
1437prefix -- prefix used to find the Python library\n\
1438thread_info -- a struct sequence with information about the thread implementation.\n\
Fred Drake801c08d2000-04-13 15:29:10 +00001439version -- the version of this interpreter as a string\n\
Eric Smith0e5b5622009-02-06 01:32:42 +00001440version_info -- version information as a named tuple\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001441"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001442)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001443#ifdef MS_WINDOWS
1444/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001445PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001446"dllhandle -- [Windows only] integer handle of the Python DLL\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001447winver -- [Windows only] version number of the Python DLL\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001448"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001449)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001450#endif /* MS_WINDOWS */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001451PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001452"__stdin__ -- the original stdin; don't touch!\n\
1453__stdout__ -- the original stdout; don't touch!\n\
1454__stderr__ -- the original stderr; don't touch!\n\
1455__displayhook__ -- the original displayhook; don't touch!\n\
1456__excepthook__ -- the original excepthook; don't touch!\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001457\n\
1458Functions:\n\
1459\n\
Georg Brandl1a3284e2007-12-02 09:40:06 +00001460displayhook() -- print an object to the screen, and save it in builtins._\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00001461excepthook() -- print an exception and its traceback to sys.stderr\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001462exc_info() -- return thread-safe information about the current exception\n\
1463exit() -- exit the interpreter by raising SystemExit\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001464getdlopenflags() -- returns flags to be used for dlopen() calls\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001465getprofile() -- get the global profiling function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001466getrefcount() -- return the reference count for an object (plus one :-)\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001467getrecursionlimit() -- return the max recursion depth for the interpreter\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001468getsizeof() -- return the size of an object in bytes\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00001469gettrace() -- get the global debug tracing function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001470setcheckinterval() -- control how often the interpreter checks for events\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001471setdlopenflags() -- set the flags to be used for dlopen() calls\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001472setprofile() -- set the global profiling function\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001473setrecursionlimit() -- set the max recursion depth for the interpreter\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001474settrace() -- set the global debug tracing function\n\
Fred Drakeccede592000-08-14 20:59:57 +00001475"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001476)
Fred Drakeccede592000-08-14 20:59:57 +00001477/* end of sys_doc */ ;
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001478
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001479
1480PyDoc_STRVAR(flags__doc__,
1481"sys.flags\n\
1482\n\
1483Flags provided through command line arguments or environment vars.");
1484
1485static PyTypeObject FlagsType;
1486
1487static PyStructSequence_Field flags_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001488 {"debug", "-d"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001489 {"inspect", "-i"},
1490 {"interactive", "-i"},
1491 {"optimize", "-O or -OO"},
1492 {"dont_write_bytecode", "-B"},
1493 {"no_user_site", "-s"},
1494 {"no_site", "-S"},
1495 {"ignore_environment", "-E"},
1496 {"verbose", "-v"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 /* {"unbuffered", "-u"}, */
1498 /* {"skip_first", "-x"}, */
Georg Brandl8aa7e992010-12-28 18:30:18 +00001499 {"bytes_warning", "-b"},
1500 {"quiet", "-q"},
Georg Brandl09a7c722012-02-20 21:31:46 +01001501 {"hash_randomization", "-R"},
Christian Heimesad73a9c2013-08-10 16:36:18 +02001502 {"isolated", "-I"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001503 {0}
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001504};
1505
1506static PyStructSequence_Desc flags_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001507 "sys.flags", /* name */
1508 flags__doc__, /* doc */
1509 flags_fields, /* fields */
Christian Heimesad73a9c2013-08-10 16:36:18 +02001510 13
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001511};
1512
1513static PyObject*
1514make_flags(void)
1515{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001516 int pos = 0;
1517 PyObject *seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001518
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001519 seq = PyStructSequence_New(&FlagsType);
1520 if (seq == NULL)
1521 return NULL;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001522
1523#define SetFlag(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001524 PyStructSequence_SET_ITEM(seq, pos++, PyLong_FromLong(flag))
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001525
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001526 SetFlag(Py_DebugFlag);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001527 SetFlag(Py_InspectFlag);
1528 SetFlag(Py_InteractiveFlag);
1529 SetFlag(Py_OptimizeFlag);
1530 SetFlag(Py_DontWriteBytecodeFlag);
1531 SetFlag(Py_NoUserSiteDirectory);
1532 SetFlag(Py_NoSiteFlag);
1533 SetFlag(Py_IgnoreEnvironmentFlag);
1534 SetFlag(Py_VerboseFlag);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001535 /* SetFlag(saw_unbuffered_flag); */
1536 /* SetFlag(skipfirstline); */
Christian Heimes33fe8092008-04-13 13:53:33 +00001537 SetFlag(Py_BytesWarningFlag);
Georg Brandl8aa7e992010-12-28 18:30:18 +00001538 SetFlag(Py_QuietFlag);
Georg Brandl2daf6ae2012-02-20 19:54:16 +01001539 SetFlag(Py_HashRandomizationFlag);
Christian Heimesad73a9c2013-08-10 16:36:18 +02001540 SetFlag(Py_IsolatedFlag);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001541#undef SetFlag
1542
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001543 if (PyErr_Occurred()) {
Serhiy Storchaka87a854d2013-12-17 14:59:42 +02001544 Py_DECREF(seq);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001545 return NULL;
1546 }
1547 return seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00001548}
1549
Eric Smith0e5b5622009-02-06 01:32:42 +00001550PyDoc_STRVAR(version_info__doc__,
1551"sys.version_info\n\
1552\n\
1553Version information as a named tuple.");
1554
1555static PyTypeObject VersionInfoType;
1556
1557static PyStructSequence_Field version_info_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 {"major", "Major release number"},
1559 {"minor", "Minor release number"},
1560 {"micro", "Patch release number"},
1561 {"releaselevel", "'alpha', 'beta', 'candidate', or 'release'"},
1562 {"serial", "Serial release number"},
1563 {0}
Eric Smith0e5b5622009-02-06 01:32:42 +00001564};
1565
1566static PyStructSequence_Desc version_info_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 "sys.version_info", /* name */
1568 version_info__doc__, /* doc */
1569 version_info_fields, /* fields */
1570 5
Eric Smith0e5b5622009-02-06 01:32:42 +00001571};
1572
1573static PyObject *
1574make_version_info(void)
1575{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001576 PyObject *version_info;
1577 char *s;
1578 int pos = 0;
Eric Smith0e5b5622009-02-06 01:32:42 +00001579
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001580 version_info = PyStructSequence_New(&VersionInfoType);
1581 if (version_info == NULL) {
1582 return NULL;
1583 }
Eric Smith0e5b5622009-02-06 01:32:42 +00001584
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 /*
1586 * These release level checks are mutually exclusive and cover
1587 * the field, so don't get too fancy with the pre-processor!
1588 */
Eric Smith0e5b5622009-02-06 01:32:42 +00001589#if PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_ALPHA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 s = "alpha";
Eric Smith0e5b5622009-02-06 01:32:42 +00001591#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_BETA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001592 s = "beta";
Eric Smith0e5b5622009-02-06 01:32:42 +00001593#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_GAMMA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001594 s = "candidate";
Eric Smith0e5b5622009-02-06 01:32:42 +00001595#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_FINAL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 s = "final";
Eric Smith0e5b5622009-02-06 01:32:42 +00001597#endif
1598
1599#define SetIntItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001600 PyStructSequence_SET_ITEM(version_info, pos++, PyLong_FromLong(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001601#define SetStrItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 PyStructSequence_SET_ITEM(version_info, pos++, PyUnicode_FromString(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00001603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 SetIntItem(PY_MAJOR_VERSION);
1605 SetIntItem(PY_MINOR_VERSION);
1606 SetIntItem(PY_MICRO_VERSION);
1607 SetStrItem(s);
1608 SetIntItem(PY_RELEASE_SERIAL);
Eric Smith0e5b5622009-02-06 01:32:42 +00001609#undef SetIntItem
1610#undef SetStrItem
1611
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 if (PyErr_Occurred()) {
1613 Py_CLEAR(version_info);
1614 return NULL;
1615 }
1616 return version_info;
Eric Smith0e5b5622009-02-06 01:32:42 +00001617}
1618
Brett Cannon3adc7b72012-07-09 14:22:12 -04001619/* sys.implementation values */
1620#define NAME "cpython"
1621const char *_PySys_ImplName = NAME;
1622#define QUOTE(arg) #arg
1623#define STRIFY(name) QUOTE(name)
1624#define MAJOR STRIFY(PY_MAJOR_VERSION)
1625#define MINOR STRIFY(PY_MINOR_VERSION)
Ned Deily529ea5d2014-06-30 23:31:14 -07001626#define TAG NAME "-" MAJOR MINOR
Brett Cannon3adc7b72012-07-09 14:22:12 -04001627const char *_PySys_ImplCacheTag = TAG;
1628#undef NAME
1629#undef QUOTE
1630#undef STRIFY
1631#undef MAJOR
1632#undef MINOR
1633#undef TAG
1634
Barry Warsaw409da152012-06-03 16:18:47 -04001635static PyObject *
1636make_impl_info(PyObject *version_info)
1637{
1638 int res;
1639 PyObject *impl_info, *value, *ns;
1640
1641 impl_info = PyDict_New();
1642 if (impl_info == NULL)
1643 return NULL;
1644
1645 /* populate the dict */
1646
Brett Cannon3adc7b72012-07-09 14:22:12 -04001647 value = PyUnicode_FromString(_PySys_ImplName);
Barry Warsaw409da152012-06-03 16:18:47 -04001648 if (value == NULL)
1649 goto error;
1650 res = PyDict_SetItemString(impl_info, "name", value);
1651 Py_DECREF(value);
1652 if (res < 0)
1653 goto error;
1654
Brett Cannon3adc7b72012-07-09 14:22:12 -04001655 value = PyUnicode_FromString(_PySys_ImplCacheTag);
Barry Warsaw409da152012-06-03 16:18:47 -04001656 if (value == NULL)
1657 goto error;
1658 res = PyDict_SetItemString(impl_info, "cache_tag", value);
1659 Py_DECREF(value);
1660 if (res < 0)
1661 goto error;
Barry Warsaw409da152012-06-03 16:18:47 -04001662
1663 res = PyDict_SetItemString(impl_info, "version", version_info);
1664 if (res < 0)
1665 goto error;
1666
1667 value = PyLong_FromLong(PY_VERSION_HEX);
1668 if (value == NULL)
1669 goto error;
1670 res = PyDict_SetItemString(impl_info, "hexversion", value);
1671 Py_DECREF(value);
1672 if (res < 0)
1673 goto error;
1674
1675 /* dict ready */
1676
1677 ns = _PyNamespace_New(impl_info);
1678 Py_DECREF(impl_info);
1679 return ns;
1680
1681error:
1682 Py_CLEAR(impl_info);
1683 return NULL;
1684}
1685
Martin v. Löwis1a214512008-06-11 05:26:20 +00001686static struct PyModuleDef sysmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001687 PyModuleDef_HEAD_INIT,
1688 "sys",
1689 sys_doc,
1690 -1, /* multiple "initialization" just copies the module dict. */
1691 sys_methods,
1692 NULL,
1693 NULL,
1694 NULL,
1695 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00001696};
1697
Guido van Rossum25ce5661997-08-02 03:10:38 +00001698PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001699_PySys_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001700{
Victor Stinner58049602013-07-22 22:40:00 +02001701 PyObject *m, *sysdict, *version_info;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02001702 int res;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001703
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001704 m = PyModule_Create(&sysmodule);
1705 if (m == NULL)
1706 return NULL;
1707 sysdict = PyModule_GetDict(m);
Victor Stinner8fea2522013-10-27 17:15:42 +01001708#define SET_SYS_FROM_STRING_BORROW(key, value) \
Victor Stinner58049602013-07-22 22:40:00 +02001709 do { \
Victor Stinner58049602013-07-22 22:40:00 +02001710 PyObject *v = (value); \
1711 if (v == NULL) \
1712 return NULL; \
1713 res = PyDict_SetItemString(sysdict, key, v); \
1714 if (res < 0) { \
Victor Stinner8fea2522013-10-27 17:15:42 +01001715 return NULL; \
1716 } \
1717 } while (0)
1718#define SET_SYS_FROM_STRING(key, value) \
1719 do { \
Victor Stinner8fea2522013-10-27 17:15:42 +01001720 PyObject *v = (value); \
1721 if (v == NULL) \
1722 return NULL; \
1723 res = PyDict_SetItemString(sysdict, key, v); \
1724 Py_DECREF(v); \
1725 if (res < 0) { \
Victor Stinner58049602013-07-22 22:40:00 +02001726 return NULL; \
1727 } \
1728 } while (0)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001729
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001730 /* Check that stdin is not a directory
1731 Using shell redirection, you can redirect stdin to a directory,
1732 crashing the Python interpreter. Catch this common mistake here
1733 and output a useful error message. Note that under MS Windows,
1734 the shell already prevents that. */
Martin v. Löwisec59d042009-01-12 07:59:10 +00001735#if !defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001736 {
Steve Dowerf2f373f2015-02-21 08:44:05 -08001737 struct _Py_stat_struct sb;
Victor Stinnere134a7f2015-03-30 10:09:31 +02001738 if (_Py_fstat_noraise(fileno(stdin), &sb) == 0 &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001739 S_ISDIR(sb.st_mode)) {
1740 /* There's nothing more we can do. */
1741 /* Py_FatalError() will core dump, so just exit. */
1742 PySys_WriteStderr("Python error: <stdin> is a directory, cannot continue\n");
1743 exit(EXIT_FAILURE);
1744 }
1745 }
Martin v. Löwisec59d042009-01-12 07:59:10 +00001746#endif
Neal Norwitz11bd1192005-10-03 00:54:56 +00001747
Nick Coghland6009512014-11-20 21:39:37 +10001748 /* stdin/stdout/stderr are set in pylifecycle.c */
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001749
Victor Stinner8fea2522013-10-27 17:15:42 +01001750 SET_SYS_FROM_STRING_BORROW("__displayhook__",
1751 PyDict_GetItemString(sysdict, "displayhook"));
1752 SET_SYS_FROM_STRING_BORROW("__excepthook__",
1753 PyDict_GetItemString(sysdict, "excepthook"));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001754 SET_SYS_FROM_STRING("version",
1755 PyUnicode_FromString(Py_GetVersion()));
1756 SET_SYS_FROM_STRING("hexversion",
1757 PyLong_FromLong(PY_VERSION_HEX));
Georg Brandl1ca2e792011-03-05 20:51:24 +01001758 SET_SYS_FROM_STRING("_mercurial",
1759 Py_BuildValue("(szz)", "CPython", _Py_hgidentifier(),
1760 _Py_hgversion()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001761 SET_SYS_FROM_STRING("dont_write_bytecode",
1762 PyBool_FromLong(Py_DontWriteBytecodeFlag));
1763 SET_SYS_FROM_STRING("api_version",
1764 PyLong_FromLong(PYTHON_API_VERSION));
1765 SET_SYS_FROM_STRING("copyright",
1766 PyUnicode_FromString(Py_GetCopyright()));
1767 SET_SYS_FROM_STRING("platform",
1768 PyUnicode_FromString(Py_GetPlatform()));
1769 SET_SYS_FROM_STRING("executable",
1770 PyUnicode_FromWideChar(
1771 Py_GetProgramFullPath(), -1));
1772 SET_SYS_FROM_STRING("prefix",
1773 PyUnicode_FromWideChar(Py_GetPrefix(), -1));
1774 SET_SYS_FROM_STRING("exec_prefix",
1775 PyUnicode_FromWideChar(Py_GetExecPrefix(), -1));
Vinay Sajip7ded1f02012-05-26 03:45:29 +01001776 SET_SYS_FROM_STRING("base_prefix",
1777 PyUnicode_FromWideChar(Py_GetPrefix(), -1));
1778 SET_SYS_FROM_STRING("base_exec_prefix",
1779 PyUnicode_FromWideChar(Py_GetExecPrefix(), -1));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001780 SET_SYS_FROM_STRING("maxsize",
1781 PyLong_FromSsize_t(PY_SSIZE_T_MAX));
1782 SET_SYS_FROM_STRING("float_info",
1783 PyFloat_GetInfo());
1784 SET_SYS_FROM_STRING("int_info",
1785 PyLong_GetInfo());
Mark Dickinsondc787d22010-05-23 13:33:13 +00001786 /* initialize hash_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02001787 if (Hash_InfoType.tp_name == NULL) {
1788 if (PyStructSequence_InitType2(&Hash_InfoType, &hash_info_desc) < 0)
1789 return NULL;
1790 }
Mark Dickinsondc787d22010-05-23 13:33:13 +00001791 SET_SYS_FROM_STRING("hash_info",
1792 get_hash_info());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001793 SET_SYS_FROM_STRING("maxunicode",
Ezio Melotti48a2f8f2011-09-29 00:18:19 +03001794 PyLong_FromLong(0x10FFFF));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001795 SET_SYS_FROM_STRING("builtin_module_names",
1796 list_builtin_module_names());
Christian Heimes743e0cd2012-10-17 23:52:17 +02001797#if PY_BIG_ENDIAN
1798 SET_SYS_FROM_STRING("byteorder",
1799 PyUnicode_FromString("big"));
1800#else
1801 SET_SYS_FROM_STRING("byteorder",
1802 PyUnicode_FromString("little"));
1803#endif
Fred Drake099325e2000-08-14 15:47:03 +00001804
Guido van Rossum8b9ea871996-08-23 18:14:47 +00001805#ifdef MS_COREDLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001806 SET_SYS_FROM_STRING("dllhandle",
1807 PyLong_FromVoidPtr(PyWin_DLLhModule));
1808 SET_SYS_FROM_STRING("winver",
1809 PyUnicode_FromString(PyWin_DLLVersionString));
Guido van Rossumc606fe11996-04-09 02:37:57 +00001810#endif
Barry Warsaw8cf4eae2010-10-16 01:04:07 +00001811#ifdef ABIFLAGS
1812 SET_SYS_FROM_STRING("abiflags",
1813 PyUnicode_FromString(ABIFLAGS));
1814#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001815 if (warnoptions == NULL) {
1816 warnoptions = PyList_New(0);
Victor Stinner58049602013-07-22 22:40:00 +02001817 if (warnoptions == NULL)
1818 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001819 }
1820 else {
1821 Py_INCREF(warnoptions);
1822 }
Victor Stinner8fea2522013-10-27 17:15:42 +01001823 SET_SYS_FROM_STRING_BORROW("warnoptions", warnoptions);
Tim Peters216b78b2006-01-06 02:40:53 +00001824
Victor Stinner8fea2522013-10-27 17:15:42 +01001825 SET_SYS_FROM_STRING_BORROW("_xoptions", get_xoptions());
Antoine Pitrou9583cac2010-10-21 13:42:28 +00001826
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001827 /* version_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02001828 if (VersionInfoType.tp_name == NULL) {
1829 if (PyStructSequence_InitType2(&VersionInfoType,
1830 &version_info_desc) < 0)
1831 return NULL;
1832 }
Barry Warsaw409da152012-06-03 16:18:47 -04001833 version_info = make_version_info();
1834 SET_SYS_FROM_STRING("version_info", version_info);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001835 /* prevent user from creating new instances */
1836 VersionInfoType.tp_init = NULL;
1837 VersionInfoType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02001838 res = PyDict_DelItemString(VersionInfoType.tp_dict, "__new__");
1839 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1840 PyErr_Clear();
Eric Smith0e5b5622009-02-06 01:32:42 +00001841
Barry Warsaw409da152012-06-03 16:18:47 -04001842 /* implementation */
1843 SET_SYS_FROM_STRING("implementation", make_impl_info(version_info));
1844
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001845 /* flags */
Victor Stinner1c8f0592013-07-22 22:24:54 +02001846 if (FlagsType.tp_name == 0) {
1847 if (PyStructSequence_InitType2(&FlagsType, &flags_desc) < 0)
1848 return NULL;
1849 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001850 SET_SYS_FROM_STRING("flags", make_flags());
1851 /* prevent user from creating new instances */
1852 FlagsType.tp_init = NULL;
1853 FlagsType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02001854 res = PyDict_DelItemString(FlagsType.tp_dict, "__new__");
1855 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1856 PyErr_Clear();
Eric Smithf7bb5782010-01-27 00:44:57 +00001857
1858#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001859 /* getwindowsversion */
1860 if (WindowsVersionType.tp_name == 0)
Victor Stinner1c8f0592013-07-22 22:24:54 +02001861 if (PyStructSequence_InitType2(&WindowsVersionType,
1862 &windows_version_desc) < 0)
1863 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001864 /* prevent user from creating new instances */
1865 WindowsVersionType.tp_init = NULL;
1866 WindowsVersionType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02001867 res = PyDict_DelItemString(WindowsVersionType.tp_dict, "__new__");
1868 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
1869 PyErr_Clear();
Eric Smithf7bb5782010-01-27 00:44:57 +00001870#endif
1871
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001872 /* float repr style: 0.03 (short) vs 0.029999999999999999 (legacy) */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001873#ifndef PY_NO_SHORT_FLOAT_REPR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001874 SET_SYS_FROM_STRING("float_repr_style",
1875 PyUnicode_FromString("short"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001876#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001877 SET_SYS_FROM_STRING("float_repr_style",
1878 PyUnicode_FromString("legacy"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00001879#endif
1880
Victor Stinnerd5c355c2011-04-30 14:53:09 +02001881#ifdef WITH_THREAD
1882 SET_SYS_FROM_STRING("thread_info", PyThread_GetInfo());
1883#endif
1884
Christian Heimes7b3ce6a2008-01-31 14:31:45 +00001885#undef SET_SYS_FROM_STRING
Benjamin Peterson93813432014-03-28 18:52:45 -04001886#undef SET_SYS_FROM_STRING_BORROW
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001887 if (PyErr_Occurred())
1888 return NULL;
1889 return m;
Guido van Rossum5b3138b1990-11-18 17:41:40 +00001890}
1891
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001892static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00001893makepathobject(const wchar_t *path, wchar_t delim)
Guido van Rossum5b3138b1990-11-18 17:41:40 +00001894{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001895 int i, n;
1896 const wchar_t *p;
1897 PyObject *v, *w;
Tim Peters216b78b2006-01-06 02:40:53 +00001898
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001899 n = 1;
1900 p = path;
1901 while ((p = wcschr(p, delim)) != NULL) {
1902 n++;
1903 p++;
1904 }
1905 v = PyList_New(n);
1906 if (v == NULL)
1907 return NULL;
1908 for (i = 0; ; i++) {
1909 p = wcschr(path, delim);
1910 if (p == NULL)
1911 p = path + wcslen(path); /* End of string */
1912 w = PyUnicode_FromWideChar(path, (Py_ssize_t)(p - path));
1913 if (w == NULL) {
1914 Py_DECREF(v);
1915 return NULL;
1916 }
1917 PyList_SetItem(v, i, w);
1918 if (*p == '\0')
1919 break;
1920 path = p+1;
1921 }
1922 return v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001923}
1924
1925void
Martin v. Löwis790465f2008-04-05 20:41:37 +00001926PySys_SetPath(const wchar_t *path)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001927{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001928 PyObject *v;
1929 if ((v = makepathobject(path, DELIM)) == NULL)
1930 Py_FatalError("can't create sys.path");
Victor Stinnerbd303c12013-11-07 23:07:29 +01001931 if (_PySys_SetObjectId(&PyId_path, v) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001932 Py_FatalError("can't assign sys.path");
1933 Py_DECREF(v);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001934}
1935
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001936static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00001937makeargvobject(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001938{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001939 PyObject *av;
1940 if (argc <= 0 || argv == NULL) {
1941 /* Ensure at least one (empty) argument is seen */
1942 static wchar_t *empty_argv[1] = {L""};
1943 argv = empty_argv;
1944 argc = 1;
1945 }
1946 av = PyList_New(argc);
1947 if (av != NULL) {
1948 int i;
1949 for (i = 0; i < argc; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001950 PyObject *v = PyUnicode_FromWideChar(argv[i], -1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001951 if (v == NULL) {
1952 Py_DECREF(av);
1953 av = NULL;
1954 break;
1955 }
1956 PyList_SetItem(av, i, v);
1957 }
1958 }
1959 return av;
Guido van Rossum3f5da241990-12-20 15:06:42 +00001960}
1961
Nick Coghland26c18a2010-08-17 13:06:11 +00001962#define _HAVE_SCRIPT_ARGUMENT(argc, argv) \
1963 (argc > 0 && argv0 != NULL && \
1964 wcscmp(argv0, L"-c") != 0 && wcscmp(argv0, L"-m") != 0)
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001965
1966static void
1967sys_update_path(int argc, wchar_t **argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001968{
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001969 wchar_t *argv0;
1970 wchar_t *p = NULL;
1971 Py_ssize_t n = 0;
1972 PyObject *a;
1973 PyObject *path;
1974#ifdef HAVE_READLINK
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001975 wchar_t link[MAXPATHLEN+1];
1976 wchar_t argv0copy[2*MAXPATHLEN+1];
1977 int nr = 0;
1978#endif
Guido van Rossum162e38c2003-02-19 15:25:10 +00001979#if defined(HAVE_REALPATH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001980 wchar_t fullpath[MAXPATHLEN];
Martin v. Löwisec59d042009-01-12 07:59:10 +00001981#elif defined(MS_WINDOWS) && !defined(MS_WINCE)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001982 wchar_t fullpath[MAX_PATH];
Thomas Heller27bb71e2003-01-08 14:33:48 +00001983#endif
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001984
Victor Stinnerbd303c12013-11-07 23:07:29 +01001985 path = _PySys_GetObjectId(&PyId_path);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001986 if (path == NULL)
1987 return;
1988
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00001989 argv0 = argv[0];
1990
1991#ifdef HAVE_READLINK
1992 if (_HAVE_SCRIPT_ARGUMENT(argc, argv))
1993 nr = _Py_wreadlink(argv0, link, MAXPATHLEN);
1994 if (nr > 0) {
1995 /* It's a symlink */
1996 link[nr] = '\0';
1997 if (link[0] == SEP)
1998 argv0 = link; /* Link to absolute path */
1999 else if (wcschr(link, SEP) == NULL)
2000 ; /* Link without path */
2001 else {
2002 /* Must join(dirname(argv0), link) */
2003 wchar_t *q = wcsrchr(argv0, SEP);
2004 if (q == NULL)
2005 argv0 = link; /* argv0 without path */
2006 else {
Christian Heimes60a60672013-07-22 12:53:32 +02002007 /* Must make a copy, argv0copy has room for 2 * MAXPATHLEN */
2008 wcsncpy(argv0copy, argv0, MAXPATHLEN);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002009 q = wcsrchr(argv0copy, SEP);
Christian Heimes60a60672013-07-22 12:53:32 +02002010 wcsncpy(q+1, link, MAXPATHLEN);
2011 q[MAXPATHLEN + 1] = L'\0';
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002012 argv0 = argv0copy;
2013 }
2014 }
2015 }
2016#endif /* HAVE_READLINK */
2017#if SEP == '\\' /* Special case for MS filename syntax */
2018 if (_HAVE_SCRIPT_ARGUMENT(argc, argv)) {
2019 wchar_t *q;
2020#if defined(MS_WINDOWS) && !defined(MS_WINCE)
2021 /* This code here replaces the first element in argv with the full
2022 path that it represents. Under CE, there are no relative paths so
2023 the argument must be the full path anyway. */
2024 wchar_t *ptemp;
2025 if (GetFullPathNameW(argv0,
Victor Stinner63941882011-09-29 00:42:28 +02002026 Py_ARRAY_LENGTH(fullpath),
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002027 fullpath,
2028 &ptemp)) {
2029 argv0 = fullpath;
2030 }
2031#endif
2032 p = wcsrchr(argv0, SEP);
2033 /* Test for alternate separator */
2034 q = wcsrchr(p ? p : argv0, '/');
2035 if (q != NULL)
2036 p = q;
2037 if (p != NULL) {
2038 n = p + 1 - argv0;
2039 if (n > 1 && p[-1] != ':')
2040 n--; /* Drop trailing separator */
2041 }
2042 }
2043#else /* All other filename syntaxes */
2044 if (_HAVE_SCRIPT_ARGUMENT(argc, argv)) {
2045#if defined(HAVE_REALPATH)
Victor Stinner23847142013-11-15 17:33:43 +01002046 if (_Py_wrealpath(argv0, fullpath, Py_ARRAY_LENGTH(fullpath))) {
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002047 argv0 = fullpath;
2048 }
2049#endif
2050 p = wcsrchr(argv0, SEP);
2051 }
2052 if (p != NULL) {
2053 n = p + 1 - argv0;
2054#if SEP == '/' /* Special case for Unix filename syntax */
2055 if (n > 1)
2056 n--; /* Drop trailing separator */
2057#endif /* Unix */
2058 }
2059#endif /* All others */
2060 a = PyUnicode_FromWideChar(argv0, n);
2061 if (a == NULL)
2062 Py_FatalError("no mem for sys.path insertion");
2063 if (PyList_Insert(path, 0, a) < 0)
2064 Py_FatalError("sys.path.insert(0) failed");
2065 Py_DECREF(a);
2066}
2067
2068void
2069PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)
2070{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002071 PyObject *av = makeargvobject(argc, argv);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002072 if (av == NULL)
2073 Py_FatalError("no mem for sys.argv");
2074 if (PySys_SetObject("argv", av) != 0)
2075 Py_FatalError("can't assign sys.argv");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002076 Py_DECREF(av);
Victor Stinnerc08ec9f2010-10-06 22:44:06 +00002077 if (updatepath)
2078 sys_update_path(argc, argv);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002079}
Guido van Rossuma890e681998-05-12 14:59:24 +00002080
Antoine Pitrouf978fac2010-05-21 17:25:34 +00002081void
2082PySys_SetArgv(int argc, wchar_t **argv)
2083{
Christian Heimesad73a9c2013-08-10 16:36:18 +02002084 PySys_SetArgvEx(argc, argv, Py_IsolatedFlag == 0);
Antoine Pitrouf978fac2010-05-21 17:25:34 +00002085}
2086
Victor Stinner14284c22010-04-23 12:02:30 +00002087/* Reimplementation of PyFile_WriteString() no calling indirectly
2088 PyErr_CheckSignals(): avoid the call to PyObject_Str(). */
2089
2090static int
Victor Stinner79766632010-08-16 17:36:42 +00002091sys_pyfile_write_unicode(PyObject *unicode, PyObject *file)
Victor Stinner14284c22010-04-23 12:02:30 +00002092{
Victor Stinner79766632010-08-16 17:36:42 +00002093 PyObject *writer = NULL, *args = NULL, *result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002094 int err;
Victor Stinner14284c22010-04-23 12:02:30 +00002095
Victor Stinnerecccc4f2010-06-08 20:46:00 +00002096 if (file == NULL)
2097 return -1;
2098
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02002099 writer = _PyObject_GetAttrId(file, &PyId_write);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002100 if (writer == NULL)
2101 goto error;
Victor Stinner14284c22010-04-23 12:02:30 +00002102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002103 args = PyTuple_Pack(1, unicode);
2104 if (args == NULL)
2105 goto error;
Victor Stinner14284c22010-04-23 12:02:30 +00002106
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002107 result = PyEval_CallObject(writer, args);
2108 if (result == NULL) {
2109 goto error;
2110 } else {
2111 err = 0;
2112 goto finally;
2113 }
Victor Stinner14284c22010-04-23 12:02:30 +00002114
2115error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002116 err = -1;
Victor Stinner14284c22010-04-23 12:02:30 +00002117finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002118 Py_XDECREF(writer);
2119 Py_XDECREF(args);
2120 Py_XDECREF(result);
2121 return err;
Victor Stinner14284c22010-04-23 12:02:30 +00002122}
2123
Victor Stinner79766632010-08-16 17:36:42 +00002124static int
2125sys_pyfile_write(const char *text, PyObject *file)
2126{
2127 PyObject *unicode = NULL;
2128 int err;
2129
2130 if (file == NULL)
2131 return -1;
2132
2133 unicode = PyUnicode_FromString(text);
2134 if (unicode == NULL)
2135 return -1;
2136
2137 err = sys_pyfile_write_unicode(unicode, file);
2138 Py_DECREF(unicode);
2139 return err;
2140}
Guido van Rossuma890e681998-05-12 14:59:24 +00002141
2142/* APIs to write to sys.stdout or sys.stderr using a printf-like interface.
2143 Adapted from code submitted by Just van Rossum.
2144
2145 PySys_WriteStdout(format, ...)
2146 PySys_WriteStderr(format, ...)
2147
2148 The first function writes to sys.stdout; the second to sys.stderr. When
2149 there is a problem, they write to the real (C level) stdout or stderr;
Guido van Rossum8442af31998-10-12 18:22:10 +00002150 no exceptions are raised.
Guido van Rossuma890e681998-05-12 14:59:24 +00002151
Victor Stinner14284c22010-04-23 12:02:30 +00002152 PyErr_CheckSignals() is not called to avoid the execution of the Python
Victor Stinner79766632010-08-16 17:36:42 +00002153 signal handlers: they may raise a new exception whereas sys_write()
2154 ignores all exceptions.
Victor Stinner14284c22010-04-23 12:02:30 +00002155
Guido van Rossuma890e681998-05-12 14:59:24 +00002156 Both take a printf-style format string as their first argument followed
2157 by a variable length argument list determined by the format string.
2158
2159 *** WARNING ***
2160
2161 The format should limit the total size of the formatted output string to
2162 1000 bytes. In particular, this means that no unrestricted "%s" formats
2163 should occur; these should be limited using "%.<N>s where <N> is a
2164 decimal number calculated so that <N> plus the maximum size of other
2165 formatted text does not exceed 1000 bytes. Also watch out for "%f",
2166 which can print hundreds of digits for very large numbers.
2167
2168 */
2169
2170static void
Victor Stinner09054372013-11-06 22:41:44 +01002171sys_write(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Guido van Rossuma890e681998-05-12 14:59:24 +00002172{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002173 PyObject *file;
2174 PyObject *error_type, *error_value, *error_traceback;
2175 char buffer[1001];
2176 int written;
Guido van Rossuma890e681998-05-12 14:59:24 +00002177
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002178 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Victor Stinner09054372013-11-06 22:41:44 +01002179 file = _PySys_GetObjectId(key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002180 written = PyOS_vsnprintf(buffer, sizeof(buffer), format, va);
2181 if (sys_pyfile_write(buffer, file) != 0) {
2182 PyErr_Clear();
2183 fputs(buffer, fp);
2184 }
2185 if (written < 0 || (size_t)written >= sizeof(buffer)) {
2186 const char *truncated = "... truncated";
Victor Stinner79766632010-08-16 17:36:42 +00002187 if (sys_pyfile_write(truncated, file) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002188 fputs(truncated, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002189 }
2190 PyErr_Restore(error_type, error_value, error_traceback);
Guido van Rossuma890e681998-05-12 14:59:24 +00002191}
2192
2193void
Guido van Rossuma890e681998-05-12 14:59:24 +00002194PySys_WriteStdout(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00002195{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002196 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00002197
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002198 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002199 sys_write(&PyId_stdout, stdout, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002200 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00002201}
2202
2203void
Guido van Rossuma890e681998-05-12 14:59:24 +00002204PySys_WriteStderr(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00002205{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002206 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00002207
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002208 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002209 sys_write(&PyId_stderr, stderr, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00002210 va_end(va);
2211}
2212
2213static void
Victor Stinner09054372013-11-06 22:41:44 +01002214sys_format(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Victor Stinner79766632010-08-16 17:36:42 +00002215{
2216 PyObject *file, *message;
2217 PyObject *error_type, *error_value, *error_traceback;
2218 char *utf8;
2219
2220 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Victor Stinner09054372013-11-06 22:41:44 +01002221 file = _PySys_GetObjectId(key);
Victor Stinner79766632010-08-16 17:36:42 +00002222 message = PyUnicode_FromFormatV(format, va);
2223 if (message != NULL) {
2224 if (sys_pyfile_write_unicode(message, file) != 0) {
2225 PyErr_Clear();
2226 utf8 = _PyUnicode_AsString(message);
2227 if (utf8 != NULL)
2228 fputs(utf8, fp);
2229 }
2230 Py_DECREF(message);
2231 }
2232 PyErr_Restore(error_type, error_value, error_traceback);
2233}
2234
2235void
2236PySys_FormatStdout(const char *format, ...)
2237{
2238 va_list va;
2239
2240 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002241 sys_format(&PyId_stdout, stdout, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00002242 va_end(va);
2243}
2244
2245void
2246PySys_FormatStderr(const char *format, ...)
2247{
2248 va_list va;
2249
2250 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01002251 sys_format(&PyId_stderr, stderr, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002252 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00002253}