blob: 6a49d8992324087d5b1d44ad261e25e548085ab5 [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 Stinner331a6a52019-05-27 16:39:22 +020020#include "pycore_initconfig.h"
Victor Stinner621cebe2018-11-12 16:53:38 +010021#include "pycore_pylifecycle.h"
22#include "pycore_pymem.h"
Victor Stinnera1c249c2018-11-01 03:15:58 +010023#include "pycore_pathconfig.h"
Victor Stinner621cebe2018-11-12 16:53:38 +010024#include "pycore_pystate.h"
Steve Dowerb82e17e2019-05-23 08:45:22 -070025#include "pycore_tupleobject.h"
Victor Stinnerd5c355c2011-04-30 14:53:09 +020026#include "pythread.h"
Steve Dowerb82e17e2019-05-23 08:45:22 -070027#include "pydtrace.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000028
Guido van Rossume2437a11992-03-23 18:20:18 +000029#include "osdefs.h"
Stefan Krah1845d142016-04-25 21:38:53 +020030#include <locale.h>
Guido van Rossum3f5da241990-12-20 15:06:42 +000031
Mark Hammond8696ebc2002-10-08 02:44:31 +000032#ifdef MS_WINDOWS
33#define WIN32_LEAN_AND_MEAN
Amaury Forgeot d'Arc06cfe952007-11-10 13:55:44 +000034#include <windows.h>
Mark Hammond8696ebc2002-10-08 02:44:31 +000035#endif /* MS_WINDOWS */
36
Guido van Rossum9b38a141996-09-11 23:12:24 +000037#ifdef MS_COREDLL
Guido van Rossumc606fe11996-04-09 02:37:57 +000038extern void *PyWin_DLLhModule;
Guido van Rossum6c1e5f21997-09-29 23:34:23 +000039/* A string loaded from the DLL at startup: */
40extern const char *PyWin_DLLVersionString;
Guido van Rossumc606fe11996-04-09 02:37:57 +000041#endif
42
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -080043/*[clinic input]
44module sys
45[clinic start generated code]*/
46/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3726b388feee8cea]*/
47
48#include "clinic/sysmodule.c.h"
49
Victor Stinnerbd303c12013-11-07 23:07:29 +010050_Py_IDENTIFIER(_);
51_Py_IDENTIFIER(__sizeof__);
Eric Snowdae02762017-09-14 00:35:58 -070052_Py_IDENTIFIER(_xoptions);
Victor Stinnerbd303c12013-11-07 23:07:29 +010053_Py_IDENTIFIER(buffer);
54_Py_IDENTIFIER(builtins);
55_Py_IDENTIFIER(encoding);
56_Py_IDENTIFIER(path);
57_Py_IDENTIFIER(stdout);
58_Py_IDENTIFIER(stderr);
Eric Snowdae02762017-09-14 00:35:58 -070059_Py_IDENTIFIER(warnoptions);
Victor Stinnerbd303c12013-11-07 23:07:29 +010060_Py_IDENTIFIER(write);
61
Guido van Rossum65bf9f21997-04-29 18:33:38 +000062PyObject *
Victor Stinnerd67bd452013-11-06 22:36:40 +010063_PySys_GetObjectId(_Py_Identifier *key)
64{
Victor Stinnercaba55b2018-08-03 15:33:52 +020065 PyObject *sd = _PyInterpreterState_GET_UNSAFE()->sysdict;
66 if (sd == NULL) {
Victor Stinnerd67bd452013-11-06 22:36:40 +010067 return NULL;
Victor Stinnercaba55b2018-08-03 15:33:52 +020068 }
Victor Stinnerd67bd452013-11-06 22:36:40 +010069 return _PyDict_GetItemId(sd, key);
70}
71
72PyObject *
Neal Norwitzf3081322007-08-25 00:32:45 +000073PySys_GetObject(const char *name)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000074{
Victor Stinnercaba55b2018-08-03 15:33:52 +020075 PyObject *sd = _PyInterpreterState_GET_UNSAFE()->sysdict;
76 if (sd == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000077 return NULL;
Victor Stinnercaba55b2018-08-03 15:33:52 +020078 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000079 return PyDict_GetItemString(sd, name);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000080}
81
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000082int
Victor Stinnerd67bd452013-11-06 22:36:40 +010083_PySys_SetObjectId(_Py_Identifier *key, PyObject *v)
84{
Victor Stinnercaba55b2018-08-03 15:33:52 +020085 PyObject *sd = _PyInterpreterState_GET_UNSAFE()->sysdict;
Victor Stinnerd67bd452013-11-06 22:36:40 +010086 if (v == NULL) {
Victor Stinnercaba55b2018-08-03 15:33:52 +020087 if (_PyDict_GetItemId(sd, key) == NULL) {
Victor Stinnerd67bd452013-11-06 22:36:40 +010088 return 0;
Victor Stinnercaba55b2018-08-03 15:33:52 +020089 }
90 else {
Victor Stinnerd67bd452013-11-06 22:36:40 +010091 return _PyDict_DelItemId(sd, key);
Victor Stinnercaba55b2018-08-03 15:33:52 +020092 }
Victor Stinnerd67bd452013-11-06 22:36:40 +010093 }
Victor Stinnercaba55b2018-08-03 15:33:52 +020094 else {
Victor Stinnerd67bd452013-11-06 22:36:40 +010095 return _PyDict_SetItemId(sd, key, v);
Victor Stinnercaba55b2018-08-03 15:33:52 +020096 }
Victor Stinnerd67bd452013-11-06 22:36:40 +010097}
98
99int
Neal Norwitzf3081322007-08-25 00:32:45 +0000100PySys_SetObject(const char *name, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000101{
Victor Stinnercaba55b2018-08-03 15:33:52 +0200102 PyObject *sd = _PyInterpreterState_GET_UNSAFE()->sysdict;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000103 if (v == NULL) {
Victor Stinnercaba55b2018-08-03 15:33:52 +0200104 if (PyDict_GetItemString(sd, name) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000105 return 0;
Victor Stinnercaba55b2018-08-03 15:33:52 +0200106 }
107 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000108 return PyDict_DelItemString(sd, name);
Victor Stinnercaba55b2018-08-03 15:33:52 +0200109 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000110 }
Victor Stinnercaba55b2018-08-03 15:33:52 +0200111 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000112 return PyDict_SetItemString(sd, name, v);
Victor Stinnercaba55b2018-08-03 15:33:52 +0200113 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000114}
115
Steve Dowerb82e17e2019-05-23 08:45:22 -0700116static int
117should_audit(void)
118{
119 PyThreadState *ts = _PyThreadState_GET();
120 if (!ts) {
121 return 0;
122 }
Victor Stinner0fd2c302019-06-04 03:15:09 +0200123 PyInterpreterState *is = ts ? ts->interp : NULL;
124 return _PyRuntime.audit_hook_head
Steve Dowerb82e17e2019-05-23 08:45:22 -0700125 || (is && is->audit_hooks)
126 || PyDTrace_AUDIT_ENABLED();
127}
128
129int
130PySys_Audit(const char *event, const char *argFormat, ...)
131{
132 PyObject *eventName = NULL;
133 PyObject *eventArgs = NULL;
134 PyObject *hooks = NULL;
135 PyObject *hook = NULL;
136 int res = -1;
137
138 /* N format is inappropriate, because you do not know
139 whether the reference is consumed by the call.
140 Assert rather than exception for perf reasons */
141 assert(!argFormat || !strchr(argFormat, 'N'));
142
143 /* Early exit when no hooks are registered */
144 if (!should_audit()) {
145 return 0;
146 }
147
148 _Py_AuditHookEntry *e = _PyRuntime.audit_hook_head;
149 PyThreadState *ts = _PyThreadState_GET();
150 PyInterpreterState *is = ts ? ts->interp : NULL;
151 int dtrace = PyDTrace_AUDIT_ENABLED();
152
153 PyObject *exc_type, *exc_value, *exc_tb;
154 if (ts) {
155 PyErr_Fetch(&exc_type, &exc_value, &exc_tb);
156 }
157
158 /* Initialize event args now */
159 if (argFormat && argFormat[0]) {
160 va_list args;
161 va_start(args, argFormat);
162 eventArgs = Py_VaBuildValue(argFormat, args);
Steve Dower6c794772019-06-21 09:45:13 -0700163 va_end(args);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700164 if (eventArgs && !PyTuple_Check(eventArgs)) {
165 PyObject *argTuple = PyTuple_Pack(1, eventArgs);
166 Py_DECREF(eventArgs);
167 eventArgs = argTuple;
168 }
169 } else {
170 eventArgs = PyTuple_New(0);
171 }
172 if (!eventArgs) {
173 goto exit;
174 }
175
176 /* Call global hooks */
177 for (; e; e = e->next) {
178 if (e->hookCFunction(event, eventArgs, e->userData) < 0) {
179 goto exit;
180 }
181 }
182
183 /* Dtrace USDT point */
184 if (dtrace) {
185 PyDTrace_AUDIT(event, (void *)eventArgs);
186 }
187
188 /* Call interpreter hooks */
189 if (is && is->audit_hooks) {
190 eventName = PyUnicode_FromString(event);
191 if (!eventName) {
192 goto exit;
193 }
194
195 hooks = PyObject_GetIter(is->audit_hooks);
196 if (!hooks) {
197 goto exit;
198 }
199
200 /* Disallow tracing in hooks unless explicitly enabled */
201 ts->tracing++;
202 ts->use_tracing = 0;
203 while ((hook = PyIter_Next(hooks)) != NULL) {
204 PyObject *o;
205 int canTrace = -1;
206 o = PyObject_GetAttrString(hook, "__cantrace__");
207 if (o) {
208 canTrace = PyObject_IsTrue(o);
209 Py_DECREF(o);
210 } else if (PyErr_Occurred() &&
211 PyErr_ExceptionMatches(PyExc_AttributeError)) {
212 PyErr_Clear();
213 canTrace = 0;
214 }
215 if (canTrace < 0) {
216 break;
217 }
218 if (canTrace) {
219 ts->use_tracing = (ts->c_tracefunc || ts->c_profilefunc);
220 ts->tracing--;
221 }
222 o = PyObject_CallFunctionObjArgs(hook, eventName,
223 eventArgs, NULL);
224 if (canTrace) {
225 ts->tracing++;
226 ts->use_tracing = 0;
227 }
228 if (!o) {
229 break;
230 }
231 Py_DECREF(o);
232 Py_CLEAR(hook);
233 }
234 ts->use_tracing = (ts->c_tracefunc || ts->c_profilefunc);
235 ts->tracing--;
236 if (PyErr_Occurred()) {
237 goto exit;
238 }
239 }
240
241 res = 0;
242
243exit:
244 Py_XDECREF(hook);
245 Py_XDECREF(hooks);
246 Py_XDECREF(eventName);
247 Py_XDECREF(eventArgs);
248
249 if (ts) {
250 if (!res) {
251 PyErr_Restore(exc_type, exc_value, exc_tb);
252 } else {
253 assert(PyErr_Occurred());
254 Py_XDECREF(exc_type);
255 Py_XDECREF(exc_value);
256 Py_XDECREF(exc_tb);
257 }
258 }
259
260 return res;
261}
262
263/* We expose this function primarily for our own cleanup during
264 * finalization. In general, it should not need to be called,
265 * and as such it is not defined in any header files.
266 */
267void _PySys_ClearAuditHooks(void) {
268 /* Must be finalizing to clear hooks */
269 _PyRuntimeState *runtime = &_PyRuntime;
270 PyThreadState *ts = _PyRuntimeState_GetThreadState(runtime);
271 assert(!ts || _Py_CURRENTLY_FINALIZING(runtime, ts));
272 if (!ts || !_Py_CURRENTLY_FINALIZING(runtime, ts))
273 return;
274
275 if (Py_VerboseFlag) {
276 PySys_WriteStderr("# clear sys.audit hooks\n");
277 }
278
279 /* Hooks can abort later hooks for this event, but cannot
280 abort the clear operation itself. */
281 PySys_Audit("cpython._PySys_ClearAuditHooks", NULL);
282 PyErr_Clear();
283
Victor Stinner0fd2c302019-06-04 03:15:09 +0200284 _Py_AuditHookEntry *e = _PyRuntime.audit_hook_head, *n;
285 _PyRuntime.audit_hook_head = NULL;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700286 while (e) {
287 n = e->next;
288 PyMem_RawFree(e);
289 e = n;
290 }
291}
292
293int
294PySys_AddAuditHook(Py_AuditHookFunction hook, void *userData)
295{
296 /* Invoke existing audit hooks to allow them an opportunity to abort. */
297 /* Cannot invoke hooks until we are initialized */
298 if (Py_IsInitialized()) {
299 if (PySys_Audit("sys.addaudithook", NULL) < 0) {
300 if (PyErr_ExceptionMatches(PyExc_Exception)) {
301 /* We do not report errors derived from Exception */
302 PyErr_Clear();
303 return 0;
304 }
305 return -1;
306 }
307 }
308
Victor Stinner0fd2c302019-06-04 03:15:09 +0200309 _Py_AuditHookEntry *e = _PyRuntime.audit_hook_head;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700310 if (!e) {
311 e = (_Py_AuditHookEntry*)PyMem_RawMalloc(sizeof(_Py_AuditHookEntry));
Victor Stinner0fd2c302019-06-04 03:15:09 +0200312 _PyRuntime.audit_hook_head = e;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700313 } else {
314 while (e->next)
315 e = e->next;
316 e = e->next = (_Py_AuditHookEntry*)PyMem_RawMalloc(
317 sizeof(_Py_AuditHookEntry));
318 }
319
320 if (!e) {
321 if (Py_IsInitialized())
322 PyErr_NoMemory();
323 return -1;
324 }
325
326 e->next = NULL;
327 e->hookCFunction = (Py_AuditHookFunction)hook;
328 e->userData = userData;
329
330 return 0;
331}
332
333/*[clinic input]
334sys.addaudithook
335
336 hook: object
337
338Adds a new audit hook callback.
339[clinic start generated code]*/
340
341static PyObject *
342sys_addaudithook_impl(PyObject *module, PyObject *hook)
343/*[clinic end generated code: output=4f9c17aaeb02f44e input=0f3e191217a45e34]*/
344{
345 /* Invoke existing audit hooks to allow them an opportunity to abort. */
346 if (PySys_Audit("sys.addaudithook", NULL) < 0) {
347 if (PyErr_ExceptionMatches(PyExc_Exception)) {
348 /* We do not report errors derived from Exception */
349 PyErr_Clear();
350 Py_RETURN_NONE;
351 }
352 return NULL;
353 }
354
355 PyInterpreterState *is = _PyInterpreterState_Get();
356
357 if (is->audit_hooks == NULL) {
358 is->audit_hooks = PyList_New(0);
359 if (is->audit_hooks == NULL) {
360 return NULL;
361 }
362 }
363
364 if (PyList_Append(is->audit_hooks, hook) < 0) {
365 return NULL;
366 }
367
368 Py_RETURN_NONE;
369}
370
371PyDoc_STRVAR(audit_doc,
372"audit(event, *args)\n\
373\n\
374Passes the event to any audit hooks that are attached.");
375
376static PyObject *
377sys_audit(PyObject *self, PyObject *const *args, Py_ssize_t argc)
378{
379 if (argc == 0) {
380 PyErr_SetString(PyExc_TypeError, "audit() missing 1 required positional argument: 'event'");
381 return NULL;
382 }
383
384 if (!should_audit()) {
385 Py_RETURN_NONE;
386 }
387
388 PyObject *auditEvent = args[0];
389 if (!auditEvent) {
390 PyErr_SetString(PyExc_TypeError, "expected str for argument 'event'");
391 return NULL;
392 }
393 if (!PyUnicode_Check(auditEvent)) {
394 PyErr_Format(PyExc_TypeError, "expected str for argument 'event', not %.200s",
395 Py_TYPE(auditEvent)->tp_name);
396 return NULL;
397 }
398 const char *event = PyUnicode_AsUTF8(auditEvent);
399 if (!event) {
400 return NULL;
401 }
402
403 PyObject *auditArgs = _PyTuple_FromArray(args + 1, argc - 1);
404 if (!auditArgs) {
405 return NULL;
406 }
407
408 int res = PySys_Audit(event, "O", auditArgs);
409 Py_DECREF(auditArgs);
410
411 if (res < 0) {
412 return NULL;
413 }
414
415 Py_RETURN_NONE;
416}
417
418
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400419static PyObject *
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200420sys_breakpointhook(PyObject *self, PyObject *const *args, Py_ssize_t nargs, PyObject *keywords)
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400421{
422 assert(!PyErr_Occurred());
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300423 char *envar = Py_GETENV("PYTHONBREAKPOINT");
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400424
425 if (envar == NULL || strlen(envar) == 0) {
426 envar = "pdb.set_trace";
427 }
428 else if (!strcmp(envar, "0")) {
429 /* The breakpoint is explicitly no-op'd. */
430 Py_RETURN_NONE;
431 }
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300432 /* According to POSIX the string returned by getenv() might be invalidated
433 * or the string content might be overwritten by a subsequent call to
434 * getenv(). Since importing a module can performs the getenv() calls,
435 * we need to save a copy of envar. */
436 envar = _PyMem_RawStrdup(envar);
437 if (envar == NULL) {
438 PyErr_NoMemory();
439 return NULL;
440 }
Serhiy Storchaka4ae06c52017-12-12 13:55:04 +0200441 const char *last_dot = strrchr(envar, '.');
442 const char *attrname = NULL;
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400443 PyObject *modulepath = NULL;
444
445 if (last_dot == NULL) {
446 /* The breakpoint is a built-in, e.g. PYTHONBREAKPOINT=int */
447 modulepath = PyUnicode_FromString("builtins");
448 attrname = envar;
449 }
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200450 else if (last_dot != envar) {
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400451 /* Split on the last dot; */
452 modulepath = PyUnicode_FromStringAndSize(envar, last_dot - envar);
453 attrname = last_dot + 1;
454 }
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200455 else {
456 goto warn;
457 }
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400458 if (modulepath == NULL) {
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300459 PyMem_RawFree(envar);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400460 return NULL;
461 }
462
Anthony Sottiledce345c2018-11-01 10:25:05 -0700463 PyObject *module = PyImport_Import(modulepath);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400464 Py_DECREF(modulepath);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400465
466 if (module == NULL) {
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200467 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
468 goto warn;
469 }
470 PyMem_RawFree(envar);
471 return NULL;
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400472 }
473
474 PyObject *hook = PyObject_GetAttrString(module, attrname);
475 Py_DECREF(module);
476
477 if (hook == NULL) {
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200478 if (PyErr_ExceptionMatches(PyExc_AttributeError)) {
479 goto warn;
480 }
481 PyMem_RawFree(envar);
482 return NULL;
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400483 }
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300484 PyMem_RawFree(envar);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200485 PyObject *retval = _PyObject_Vectorcall(hook, args, nargs, keywords);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400486 Py_DECREF(hook);
487 return retval;
488
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200489 warn:
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400490 /* If any of the imports went wrong, then warn and ignore. */
491 PyErr_Clear();
492 int status = PyErr_WarnFormat(
493 PyExc_RuntimeWarning, 0,
494 "Ignoring unimportable $PYTHONBREAKPOINT: \"%s\"", envar);
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300495 PyMem_RawFree(envar);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400496 if (status < 0) {
497 /* Printing the warning raised an exception. */
498 return NULL;
499 }
500 /* The warning was (probably) issued. */
501 Py_RETURN_NONE;
502}
503
504PyDoc_STRVAR(breakpointhook_doc,
505"breakpointhook(*args, **kws)\n"
506"\n"
507"This hook function is called by built-in breakpoint().\n"
508);
509
Victor Stinner13d49ee2010-12-04 17:24:33 +0000510/* Write repr(o) to sys.stdout using sys.stdout.encoding and 'backslashreplace'
511 error handler. If sys.stdout has a buffer attribute, use
512 sys.stdout.buffer.write(encoded), otherwise redecode the string and use
513 sys.stdout.write(redecoded).
514
515 Helper function for sys_displayhook(). */
516static int
517sys_displayhook_unencodable(PyObject *outf, PyObject *o)
518{
519 PyObject *stdout_encoding = NULL;
520 PyObject *encoded, *escaped_str, *repr_str, *buffer, *result;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200521 const char *stdout_encoding_str;
Victor Stinner13d49ee2010-12-04 17:24:33 +0000522 int ret;
523
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200524 stdout_encoding = _PyObject_GetAttrId(outf, &PyId_encoding);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000525 if (stdout_encoding == NULL)
526 goto error;
Serhiy Storchaka06515832016-11-20 09:13:07 +0200527 stdout_encoding_str = PyUnicode_AsUTF8(stdout_encoding);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000528 if (stdout_encoding_str == NULL)
529 goto error;
530
531 repr_str = PyObject_Repr(o);
532 if (repr_str == NULL)
533 goto error;
534 encoded = PyUnicode_AsEncodedString(repr_str,
535 stdout_encoding_str,
536 "backslashreplace");
537 Py_DECREF(repr_str);
538 if (encoded == NULL)
539 goto error;
540
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200541 buffer = _PyObject_GetAttrId(outf, &PyId_buffer);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000542 if (buffer) {
Victor Stinner7e425412016-12-09 00:36:19 +0100543 result = _PyObject_CallMethodIdObjArgs(buffer, &PyId_write, encoded, NULL);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000544 Py_DECREF(buffer);
545 Py_DECREF(encoded);
546 if (result == NULL)
547 goto error;
548 Py_DECREF(result);
549 }
550 else {
551 PyErr_Clear();
552 escaped_str = PyUnicode_FromEncodedObject(encoded,
553 stdout_encoding_str,
554 "strict");
555 Py_DECREF(encoded);
556 if (PyFile_WriteObject(escaped_str, outf, Py_PRINT_RAW) != 0) {
557 Py_DECREF(escaped_str);
558 goto error;
559 }
560 Py_DECREF(escaped_str);
561 }
562 ret = 0;
563 goto finally;
564
565error:
566 ret = -1;
567finally:
568 Py_XDECREF(stdout_encoding);
569 return ret;
570}
571
Tal Einatede0b6f2018-12-31 17:12:08 +0200572/*[clinic input]
573sys.displayhook
574
575 object as o: object
576 /
577
578Print an object to sys.stdout and also save it in builtins._
579[clinic start generated code]*/
580
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000581static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200582sys_displayhook(PyObject *module, PyObject *o)
583/*[clinic end generated code: output=347477d006df92ed input=08ba730166d7ef72]*/
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000584{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000585 PyObject *outf;
Victor Stinnerd02fbb82013-11-06 18:27:13 +0100586 PyObject *builtins;
587 static PyObject *newline = NULL;
Victor Stinner13d49ee2010-12-04 17:24:33 +0000588 int err;
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000589
Eric Snow3f9eee62017-09-15 16:35:20 -0600590 builtins = _PyImport_GetModuleId(&PyId_builtins);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000591 if (builtins == NULL) {
Stefan Krah027b09c2019-03-25 21:50:58 +0100592 if (!PyErr_Occurred()) {
593 PyErr_SetString(PyExc_RuntimeError, "lost builtins module");
594 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000595 return NULL;
596 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600597 Py_DECREF(builtins);
Moshe Zadka03897ea2001-07-23 13:32:43 +0000598
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000599 /* Print value except if None */
600 /* After printing, also assign to '_' */
601 /* Before, set '_' to None to avoid recursion */
602 if (o == Py_None) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200603 Py_RETURN_NONE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000604 }
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200605 if (_PyObject_SetAttrId(builtins, &PyId__, Py_None) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000606 return NULL;
Victor Stinnerbd303c12013-11-07 23:07:29 +0100607 outf = _PySys_GetObjectId(&PyId_stdout);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000608 if (outf == NULL || outf == Py_None) {
609 PyErr_SetString(PyExc_RuntimeError, "lost sys.stdout");
610 return NULL;
611 }
Victor Stinner13d49ee2010-12-04 17:24:33 +0000612 if (PyFile_WriteObject(o, outf, 0) != 0) {
613 if (PyErr_ExceptionMatches(PyExc_UnicodeEncodeError)) {
614 /* repr(o) is not encodable to sys.stdout.encoding with
615 * sys.stdout.errors error handler (which is probably 'strict') */
616 PyErr_Clear();
617 err = sys_displayhook_unencodable(outf, o);
618 if (err)
619 return NULL;
620 }
621 else {
622 return NULL;
623 }
624 }
Victor Stinnerd02fbb82013-11-06 18:27:13 +0100625 if (newline == NULL) {
626 newline = PyUnicode_FromString("\n");
627 if (newline == NULL)
628 return NULL;
629 }
630 if (PyFile_WriteObject(newline, outf, Py_PRINT_RAW) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000631 return NULL;
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200632 if (_PyObject_SetAttrId(builtins, &PyId__, o) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000633 return NULL;
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200634 Py_RETURN_NONE;
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000635}
636
Tal Einatede0b6f2018-12-31 17:12:08 +0200637
638/*[clinic input]
639sys.excepthook
640
641 exctype: object
642 value: object
643 traceback: object
644 /
645
646Handle an exception by displaying it with a traceback on sys.stderr.
647[clinic start generated code]*/
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000648
649static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200650sys_excepthook_impl(PyObject *module, PyObject *exctype, PyObject *value,
651 PyObject *traceback)
652/*[clinic end generated code: output=18d99fdda21b6b5e input=ecf606fa826f19d9]*/
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000653{
Tal Einatede0b6f2018-12-31 17:12:08 +0200654 PyErr_Display(exctype, value, traceback);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200655 Py_RETURN_NONE;
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000656}
657
Tal Einatede0b6f2018-12-31 17:12:08 +0200658
659/*[clinic input]
660sys.exc_info
661
662Return current exception information: (type, value, traceback).
663
664Return information about the most recent exception caught by an except
665clause in the current stack frame or in an older stack frame.
666[clinic start generated code]*/
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000667
668static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200669sys_exc_info_impl(PyObject *module)
670/*[clinic end generated code: output=3afd0940cf3a4d30 input=b5c5bf077788a3e5]*/
Guido van Rossuma027efa1997-05-05 20:56:21 +0000671{
Victor Stinner50b48572018-11-01 01:51:40 +0100672 _PyErr_StackItem *err_info = _PyErr_GetTopmostException(_PyThreadState_GET());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000673 return Py_BuildValue(
674 "(OOO)",
Mark Shannonae3087c2017-10-22 22:41:51 +0100675 err_info->exc_type != NULL ? err_info->exc_type : Py_None,
676 err_info->exc_value != NULL ? err_info->exc_value : Py_None,
677 err_info->exc_traceback != NULL ?
678 err_info->exc_traceback : Py_None);
Guido van Rossuma027efa1997-05-05 20:56:21 +0000679}
680
Tal Einatede0b6f2018-12-31 17:12:08 +0200681
682/*[clinic input]
Victor Stinneref9d9b62019-05-22 11:28:22 +0200683sys.unraisablehook
684
685 unraisable: object
686 /
687
688Handle an unraisable exception.
689
690The unraisable argument has the following attributes:
691
692* exc_type: Exception type.
Victor Stinner71c52e32019-05-27 08:57:14 +0200693* exc_value: Exception value, can be None.
694* exc_traceback: Exception traceback, can be None.
695* err_msg: Error message, can be None.
696* object: Object causing the exception, can be None.
Victor Stinneref9d9b62019-05-22 11:28:22 +0200697[clinic start generated code]*/
698
699static PyObject *
700sys_unraisablehook(PyObject *module, PyObject *unraisable)
Victor Stinner71c52e32019-05-27 08:57:14 +0200701/*[clinic end generated code: output=bb92838b32abaa14 input=ec3af148294af8d3]*/
Victor Stinneref9d9b62019-05-22 11:28:22 +0200702{
703 return _PyErr_WriteUnraisableDefaultHook(unraisable);
704}
705
706
707/*[clinic input]
Tal Einatede0b6f2018-12-31 17:12:08 +0200708sys.exit
709
710 status: object = NULL
711 /
712
713Exit the interpreter by raising SystemExit(status).
714
715If the status is omitted or None, it defaults to zero (i.e., success).
716If the status is an integer, it will be used as the system exit status.
717If it is another kind of object, it will be printed and the system
718exit status will be one (i.e., failure).
719[clinic start generated code]*/
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000720
721static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200722sys_exit_impl(PyObject *module, PyObject *status)
723/*[clinic end generated code: output=13870986c1ab2ec0 input=a737351f86685e9c]*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000724{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000725 /* Raise SystemExit so callers may catch it or clean up. */
Tal Einatede0b6f2018-12-31 17:12:08 +0200726 PyErr_SetObject(PyExc_SystemExit, status);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000727 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000728}
729
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000730
Martin v. Löwis107b7da2001-11-09 20:59:39 +0000731
Tal Einatede0b6f2018-12-31 17:12:08 +0200732/*[clinic input]
733sys.getdefaultencoding
734
735Return the current default encoding used by the Unicode implementation.
736[clinic start generated code]*/
737
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000738static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200739sys_getdefaultencoding_impl(PyObject *module)
740/*[clinic end generated code: output=256d19dfcc0711e6 input=d416856ddbef6909]*/
Fred Drake8b4d01d2000-05-09 19:57:01 +0000741{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000742 return PyUnicode_FromString(PyUnicode_GetDefaultEncoding());
Fred Drake8b4d01d2000-05-09 19:57:01 +0000743}
744
Tal Einatede0b6f2018-12-31 17:12:08 +0200745/*[clinic input]
746sys.getfilesystemencoding
747
748Return the encoding used to convert Unicode filenames to OS filenames.
749[clinic start generated code]*/
Fred Drake8b4d01d2000-05-09 19:57:01 +0000750
751static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200752sys_getfilesystemencoding_impl(PyObject *module)
753/*[clinic end generated code: output=1dc4bdbe9be44aa7 input=8475f8649b8c7d8c]*/
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000754{
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200755 PyInterpreterState *interp = _PyInterpreterState_GET_UNSAFE();
Victor Stinner331a6a52019-05-27 16:39:22 +0200756 const PyConfig *config = &interp->config;
Victor Stinner709d23d2019-05-02 14:56:30 -0400757 return PyUnicode_FromWideChar(config->filesystem_encoding, -1);
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000758}
759
Tal Einatede0b6f2018-12-31 17:12:08 +0200760/*[clinic input]
761sys.getfilesystemencodeerrors
762
763Return the error mode used Unicode to OS filename conversion.
764[clinic start generated code]*/
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000765
Martin v. Löwis04dc25c2008-10-03 16:09:28 +0000766static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200767sys_getfilesystemencodeerrors_impl(PyObject *module)
768/*[clinic end generated code: output=ba77b36bbf7c96f5 input=22a1e8365566f1e5]*/
Steve Dowercc16be82016-09-08 10:35:16 -0700769{
Victor Stinnerb2457ef2018-08-29 13:25:36 +0200770 PyInterpreterState *interp = _PyInterpreterState_GET_UNSAFE();
Victor Stinner331a6a52019-05-27 16:39:22 +0200771 const PyConfig *config = &interp->config;
Victor Stinner709d23d2019-05-02 14:56:30 -0400772 return PyUnicode_FromWideChar(config->filesystem_errors, -1);
Steve Dowercc16be82016-09-08 10:35:16 -0700773}
774
Tal Einatede0b6f2018-12-31 17:12:08 +0200775/*[clinic input]
776sys.intern
777
778 string as s: unicode
779 /
780
781``Intern'' the given string.
782
783This enters the string in the (global) table of interned strings whose
784purpose is to speed up dictionary lookups. Return the string itself or
785the previously interned string object with the same value.
786[clinic start generated code]*/
Steve Dowercc16be82016-09-08 10:35:16 -0700787
788static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200789sys_intern_impl(PyObject *module, PyObject *s)
790/*[clinic end generated code: output=be680c24f5c9e5d6 input=849483c006924e2f]*/
Georg Brandl66a796e2006-12-19 20:50:34 +0000791{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000792 if (PyUnicode_CheckExact(s)) {
793 Py_INCREF(s);
794 PyUnicode_InternInPlace(&s);
795 return s;
796 }
797 else {
798 PyErr_Format(PyExc_TypeError,
Tal Einatede0b6f2018-12-31 17:12:08 +0200799 "can't intern %.400s", s->ob_type->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000800 return NULL;
801 }
Georg Brandl66a796e2006-12-19 20:50:34 +0000802}
803
Georg Brandl66a796e2006-12-19 20:50:34 +0000804
Fred Drake5755ce62001-06-27 19:19:46 +0000805/*
806 * Cached interned string objects used for calling the profile and
807 * trace functions. Initialized by trace_init().
808 */
Nick Coghlan5a851672017-09-08 10:14:16 +1000809static PyObject *whatstrings[8] = {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL};
Fred Drake5755ce62001-06-27 19:19:46 +0000810
811static int
812trace_init(void)
813{
Nick Coghlan5a851672017-09-08 10:14:16 +1000814 static const char * const whatnames[8] = {
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200815 "call", "exception", "line", "return",
Nick Coghlan5a851672017-09-08 10:14:16 +1000816 "c_call", "c_exception", "c_return",
817 "opcode"
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200818 };
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000819 PyObject *name;
820 int i;
Nick Coghlan5a851672017-09-08 10:14:16 +1000821 for (i = 0; i < 8; ++i) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000822 if (whatstrings[i] == NULL) {
823 name = PyUnicode_InternFromString(whatnames[i]);
824 if (name == NULL)
825 return -1;
826 whatstrings[i] = name;
827 }
828 }
829 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000830}
831
832
833static PyObject *
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100834call_trampoline(PyObject* callback,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000835 PyFrameObject *frame, int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000836{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000837 PyObject *result;
Victor Stinner78da82b2016-08-20 01:22:57 +0200838 PyObject *stack[3];
Fred Drake5755ce62001-06-27 19:19:46 +0000839
Victor Stinner78da82b2016-08-20 01:22:57 +0200840 if (PyFrame_FastToLocalsWithError(frame) < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000841 return NULL;
Victor Stinner78da82b2016-08-20 01:22:57 +0200842 }
Victor Stinner41bb43a2013-10-29 01:19:37 +0100843
Victor Stinner78da82b2016-08-20 01:22:57 +0200844 stack[0] = (PyObject *)frame;
845 stack[1] = whatstrings[what];
846 stack[2] = (arg != NULL) ? arg : Py_None;
Fred Drake5755ce62001-06-27 19:19:46 +0000847
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000848 /* call the Python-level function */
Victor Stinner559bb6a2016-08-22 22:48:54 +0200849 result = _PyObject_FastCall(callback, stack, 3);
Fred Drake5755ce62001-06-27 19:19:46 +0000850
Victor Stinner78da82b2016-08-20 01:22:57 +0200851 PyFrame_LocalsToFast(frame, 1);
852 if (result == NULL) {
853 PyTraceBack_Here(frame);
854 }
855
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000856 return result;
Fred Drake5755ce62001-06-27 19:19:46 +0000857}
858
859static int
860profile_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000862{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000863 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000864
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000865 if (arg == NULL)
866 arg = Py_None;
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100867 result = call_trampoline(self, frame, what, arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000868 if (result == NULL) {
869 PyEval_SetProfile(NULL, NULL);
870 return -1;
871 }
872 Py_DECREF(result);
873 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000874}
875
876static int
877trace_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000878 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000879{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000880 PyObject *callback;
881 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000882
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000883 if (what == PyTrace_CALL)
884 callback = self;
885 else
886 callback = frame->f_trace;
887 if (callback == NULL)
888 return 0;
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100889 result = call_trampoline(callback, frame, what, arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000890 if (result == NULL) {
891 PyEval_SetTrace(NULL, NULL);
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200892 Py_CLEAR(frame->f_trace);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000893 return -1;
894 }
895 if (result != Py_None) {
Serhiy Storchakaec397562016-04-06 09:50:03 +0300896 Py_XSETREF(frame->f_trace, result);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000897 }
898 else {
899 Py_DECREF(result);
900 }
901 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000902}
Fred Draked0838392001-06-16 21:02:31 +0000903
Fred Drake8b4d01d2000-05-09 19:57:01 +0000904static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000905sys_settrace(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000906{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000907 if (trace_init() == -1)
908 return NULL;
909 if (args == Py_None)
910 PyEval_SetTrace(NULL, NULL);
911 else
912 PyEval_SetTrace(trace_trampoline, args);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200913 Py_RETURN_NONE;
Guido van Rossume2437a11992-03-23 18:20:18 +0000914}
915
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000916PyDoc_STRVAR(settrace_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000917"settrace(function)\n\
918\n\
919Set the global debug tracing function. It will be called on each\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000920function call. See the debugger chapter in the library manual."
921);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000922
Tal Einatede0b6f2018-12-31 17:12:08 +0200923/*[clinic input]
924sys.gettrace
925
926Return the global debug tracing function set with sys.settrace.
927
928See the debugger chapter in the library manual.
929[clinic start generated code]*/
930
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000931static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200932sys_gettrace_impl(PyObject *module)
933/*[clinic end generated code: output=e97e3a4d8c971b6e input=373b51bb2147f4d8]*/
Christian Heimes9bd667a2008-01-20 15:14:11 +0000934{
Victor Stinner50b48572018-11-01 01:51:40 +0100935 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000936 PyObject *temp = tstate->c_traceobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000937
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000938 if (temp == NULL)
939 temp = Py_None;
940 Py_INCREF(temp);
941 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000942}
943
Christian Heimes9bd667a2008-01-20 15:14:11 +0000944static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000945sys_setprofile(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000946{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000947 if (trace_init() == -1)
948 return NULL;
949 if (args == Py_None)
950 PyEval_SetProfile(NULL, NULL);
951 else
952 PyEval_SetProfile(profile_trampoline, args);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200953 Py_RETURN_NONE;
Guido van Rossume2437a11992-03-23 18:20:18 +0000954}
955
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000956PyDoc_STRVAR(setprofile_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000957"setprofile(function)\n\
958\n\
959Set the profiling function. It will be called on each function call\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000960and return. See the profiler chapter in the library manual."
961);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000962
Tal Einatede0b6f2018-12-31 17:12:08 +0200963/*[clinic input]
964sys.getprofile
965
966Return the profiling function set with sys.setprofile.
967
968See the profiler chapter in the library manual.
969[clinic start generated code]*/
970
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000971static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200972sys_getprofile_impl(PyObject *module)
973/*[clinic end generated code: output=579b96b373448188 input=1b3209d89a32965d]*/
Christian Heimes9bd667a2008-01-20 15:14:11 +0000974{
Victor Stinner50b48572018-11-01 01:51:40 +0100975 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000976 PyObject *temp = tstate->c_profileobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 if (temp == NULL)
979 temp = Py_None;
980 Py_INCREF(temp);
981 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000982}
983
Tal Einatede0b6f2018-12-31 17:12:08 +0200984/*[clinic input]
985sys.setcheckinterval
986
987 n: int
988 /
989
990Set the async event check interval to n instructions.
991
992This tells the Python interpreter to check for asynchronous events
993every n instructions.
994
995This also affects how often thread switches occur.
996[clinic start generated code]*/
Christian Heimes9bd667a2008-01-20 15:14:11 +0000997
998static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200999sys_setcheckinterval_impl(PyObject *module, int n)
1000/*[clinic end generated code: output=3f686cef07e6e178 input=7a35b17bf22a6227]*/
Guido van Rossuma0d7a231995-01-09 17:46:13 +00001001{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001002 if (PyErr_WarnEx(PyExc_DeprecationWarning,
1003 "sys.getcheckinterval() and sys.setcheckinterval() "
1004 "are deprecated. Use sys.setswitchinterval() "
1005 "instead.", 1) < 0)
1006 return NULL;
Victor Stinnercaba55b2018-08-03 15:33:52 +02001007
Victor Stinnercaba55b2018-08-03 15:33:52 +02001008 PyInterpreterState *interp = _PyInterpreterState_Get();
Tal Einatede0b6f2018-12-31 17:12:08 +02001009 interp->check_interval = n;
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001010 Py_RETURN_NONE;
Guido van Rossuma0d7a231995-01-09 17:46:13 +00001011}
1012
Tal Einatede0b6f2018-12-31 17:12:08 +02001013/*[clinic input]
1014sys.getcheckinterval
1015
1016Return the current check interval; see sys.setcheckinterval().
1017[clinic start generated code]*/
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001018
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001019static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001020sys_getcheckinterval_impl(PyObject *module)
1021/*[clinic end generated code: output=1b5060bf2b23a47c input=4b6589cbcca1db4e]*/
Tim Peterse5e065b2003-07-06 18:36:54 +00001022{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001023 if (PyErr_WarnEx(PyExc_DeprecationWarning,
1024 "sys.getcheckinterval() and sys.setcheckinterval() "
1025 "are deprecated. Use sys.getswitchinterval() "
1026 "instead.", 1) < 0)
1027 return NULL;
Victor Stinnercaba55b2018-08-03 15:33:52 +02001028 PyInterpreterState *interp = _PyInterpreterState_Get();
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001029 return PyLong_FromLong(interp->check_interval);
Tim Peterse5e065b2003-07-06 18:36:54 +00001030}
1031
Tal Einatede0b6f2018-12-31 17:12:08 +02001032/*[clinic input]
1033sys.setswitchinterval
1034
1035 interval: double
1036 /
1037
1038Set the ideal thread switching delay inside the Python interpreter.
1039
1040The actual frequency of switching threads can be lower if the
1041interpreter executes long sequences of uninterruptible code
1042(this is implementation-specific and workload-dependent).
1043
1044The parameter must represent the desired switching delay in seconds
1045A typical value is 0.005 (5 milliseconds).
1046[clinic start generated code]*/
Tim Peterse5e065b2003-07-06 18:36:54 +00001047
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001048static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001049sys_setswitchinterval_impl(PyObject *module, double interval)
1050/*[clinic end generated code: output=65a19629e5153983 input=561b477134df91d9]*/
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001051{
Tal Einatede0b6f2018-12-31 17:12:08 +02001052 if (interval <= 0.0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053 PyErr_SetString(PyExc_ValueError,
1054 "switch interval must be strictly positive");
1055 return NULL;
1056 }
Tal Einatede0b6f2018-12-31 17:12:08 +02001057 _PyEval_SetSwitchInterval((unsigned long) (1e6 * interval));
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001058 Py_RETURN_NONE;
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001059}
1060
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001061
Tal Einatede0b6f2018-12-31 17:12:08 +02001062/*[clinic input]
1063sys.getswitchinterval -> double
1064
1065Return the current thread switch interval; see sys.setswitchinterval().
1066[clinic start generated code]*/
1067
1068static double
1069sys_getswitchinterval_impl(PyObject *module)
1070/*[clinic end generated code: output=a38c277c85b5096d input=bdf9d39c0ebbbb6f]*/
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001071{
Tal Einatede0b6f2018-12-31 17:12:08 +02001072 return 1e-6 * _PyEval_GetSwitchInterval();
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001073}
1074
Tal Einatede0b6f2018-12-31 17:12:08 +02001075/*[clinic input]
1076sys.setrecursionlimit
1077
1078 limit as new_limit: int
1079 /
1080
1081Set the maximum depth of the Python interpreter stack to n.
1082
1083This limit prevents infinite recursion from causing an overflow of the C
1084stack and crashing Python. The highest possible limit is platform-
1085dependent.
1086[clinic start generated code]*/
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001087
Tim Peterse5e065b2003-07-06 18:36:54 +00001088static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001089sys_setrecursionlimit_impl(PyObject *module, int new_limit)
1090/*[clinic end generated code: output=35e1c64754800ace input=b0f7a23393924af3]*/
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001091{
Tal Einatede0b6f2018-12-31 17:12:08 +02001092 int mark;
Victor Stinner50856d52015-10-13 00:11:21 +02001093 PyThreadState *tstate;
1094
Victor Stinner50856d52015-10-13 00:11:21 +02001095 if (new_limit < 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001096 PyErr_SetString(PyExc_ValueError,
Victor Stinner50856d52015-10-13 00:11:21 +02001097 "recursion limit must be greater or equal than 1");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001098 return NULL;
1099 }
Victor Stinner50856d52015-10-13 00:11:21 +02001100
1101 /* Issue #25274: When the recursion depth hits the recursion limit in
1102 _Py_CheckRecursiveCall(), the overflowed flag of the thread state is
1103 set to 1 and a RecursionError is raised. The overflowed flag is reset
1104 to 0 when the recursion depth goes below the low-water mark: see
1105 Py_LeaveRecursiveCall().
1106
1107 Reject too low new limit if the current recursion depth is higher than
1108 the new low-water mark. Otherwise it may not be possible anymore to
1109 reset the overflowed flag to 0. */
1110 mark = _Py_RecursionLimitLowerWaterMark(new_limit);
Victor Stinner50b48572018-11-01 01:51:40 +01001111 tstate = _PyThreadState_GET();
Victor Stinner50856d52015-10-13 00:11:21 +02001112 if (tstate->recursion_depth >= mark) {
1113 PyErr_Format(PyExc_RecursionError,
1114 "cannot set the recursion limit to %i at "
1115 "the recursion depth %i: the limit is too low",
1116 new_limit, tstate->recursion_depth);
1117 return NULL;
1118 }
1119
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001120 Py_SetRecursionLimit(new_limit);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001121 Py_RETURN_NONE;
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001122}
1123
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001124/*[clinic input]
1125sys.set_coroutine_origin_tracking_depth
1126
1127 depth: int
1128
1129Enable or disable origin tracking for coroutine objects in this thread.
1130
Tal Einatede0b6f2018-12-31 17:12:08 +02001131Coroutine objects will track 'depth' frames of traceback information
1132about where they came from, available in their cr_origin attribute.
1133
1134Set a depth of 0 to disable.
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001135[clinic start generated code]*/
1136
1137static PyObject *
1138sys_set_coroutine_origin_tracking_depth_impl(PyObject *module, int depth)
Tal Einatede0b6f2018-12-31 17:12:08 +02001139/*[clinic end generated code: output=0a2123c1cc6759c5 input=a1d0a05f89d2c426]*/
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001140{
1141 if (depth < 0) {
1142 PyErr_SetString(PyExc_ValueError, "depth must be >= 0");
1143 return NULL;
1144 }
1145 _PyEval_SetCoroutineOriginTrackingDepth(depth);
1146 Py_RETURN_NONE;
1147}
1148
1149/*[clinic input]
1150sys.get_coroutine_origin_tracking_depth -> int
1151
1152Check status of origin tracking for coroutine objects in this thread.
1153[clinic start generated code]*/
1154
1155static int
1156sys_get_coroutine_origin_tracking_depth_impl(PyObject *module)
1157/*[clinic end generated code: output=3699f7be95a3afb8 input=335266a71205b61a]*/
1158{
1159 return _PyEval_GetCoroutineOriginTrackingDepth();
1160}
1161
Yury Selivanoveb636452016-09-08 22:01:51 -07001162static PyTypeObject AsyncGenHooksType;
1163
1164PyDoc_STRVAR(asyncgen_hooks_doc,
1165"asyncgen_hooks\n\
1166\n\
1167A struct sequence providing information about asynhronous\n\
1168generators hooks. The attributes are read only.");
1169
1170static PyStructSequence_Field asyncgen_hooks_fields[] = {
1171 {"firstiter", "Hook to intercept first iteration"},
1172 {"finalizer", "Hook to intercept finalization"},
1173 {0}
1174};
1175
1176static PyStructSequence_Desc asyncgen_hooks_desc = {
1177 "asyncgen_hooks", /* name */
1178 asyncgen_hooks_doc, /* doc */
1179 asyncgen_hooks_fields , /* fields */
1180 2
1181};
1182
Yury Selivanoveb636452016-09-08 22:01:51 -07001183static PyObject *
1184sys_set_asyncgen_hooks(PyObject *self, PyObject *args, PyObject *kw)
1185{
1186 static char *keywords[] = {"firstiter", "finalizer", NULL};
1187 PyObject *firstiter = NULL;
1188 PyObject *finalizer = NULL;
1189
1190 if (!PyArg_ParseTupleAndKeywords(
1191 args, kw, "|OO", keywords,
1192 &firstiter, &finalizer)) {
1193 return NULL;
1194 }
1195
1196 if (finalizer && finalizer != Py_None) {
1197 if (!PyCallable_Check(finalizer)) {
1198 PyErr_Format(PyExc_TypeError,
1199 "callable finalizer expected, got %.50s",
1200 Py_TYPE(finalizer)->tp_name);
1201 return NULL;
1202 }
1203 _PyEval_SetAsyncGenFinalizer(finalizer);
1204 }
1205 else if (finalizer == Py_None) {
1206 _PyEval_SetAsyncGenFinalizer(NULL);
1207 }
1208
1209 if (firstiter && firstiter != Py_None) {
1210 if (!PyCallable_Check(firstiter)) {
1211 PyErr_Format(PyExc_TypeError,
1212 "callable firstiter expected, got %.50s",
1213 Py_TYPE(firstiter)->tp_name);
1214 return NULL;
1215 }
1216 _PyEval_SetAsyncGenFirstiter(firstiter);
1217 }
1218 else if (firstiter == Py_None) {
1219 _PyEval_SetAsyncGenFirstiter(NULL);
1220 }
1221
1222 Py_RETURN_NONE;
1223}
1224
1225PyDoc_STRVAR(set_asyncgen_hooks_doc,
Tal Einatede0b6f2018-12-31 17:12:08 +02001226"set_asyncgen_hooks(* [, firstiter] [, finalizer])\n\
Yury Selivanoveb636452016-09-08 22:01:51 -07001227\n\
1228Set a finalizer for async generators objects."
1229);
1230
Tal Einatede0b6f2018-12-31 17:12:08 +02001231/*[clinic input]
1232sys.get_asyncgen_hooks
1233
1234Return the installed asynchronous generators hooks.
1235
1236This returns a namedtuple of the form (firstiter, finalizer).
1237[clinic start generated code]*/
1238
Yury Selivanoveb636452016-09-08 22:01:51 -07001239static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001240sys_get_asyncgen_hooks_impl(PyObject *module)
1241/*[clinic end generated code: output=53a253707146f6cf input=3676b9ea62b14625]*/
Yury Selivanoveb636452016-09-08 22:01:51 -07001242{
1243 PyObject *res;
1244 PyObject *firstiter = _PyEval_GetAsyncGenFirstiter();
1245 PyObject *finalizer = _PyEval_GetAsyncGenFinalizer();
1246
1247 res = PyStructSequence_New(&AsyncGenHooksType);
1248 if (res == NULL) {
1249 return NULL;
1250 }
1251
1252 if (firstiter == NULL) {
1253 firstiter = Py_None;
1254 }
1255
1256 if (finalizer == NULL) {
1257 finalizer = Py_None;
1258 }
1259
1260 Py_INCREF(firstiter);
1261 PyStructSequence_SET_ITEM(res, 0, firstiter);
1262
1263 Py_INCREF(finalizer);
1264 PyStructSequence_SET_ITEM(res, 1, finalizer);
1265
1266 return res;
1267}
1268
Yury Selivanoveb636452016-09-08 22:01:51 -07001269
Mark Dickinsondc787d22010-05-23 13:33:13 +00001270static PyTypeObject Hash_InfoType;
1271
1272PyDoc_STRVAR(hash_info_doc,
1273"hash_info\n\
1274\n\
1275A struct sequence providing parameters used for computing\n\
Christian Heimes985ecdc2013-11-20 11:46:18 +01001276hashes. The attributes are read only.");
Mark Dickinsondc787d22010-05-23 13:33:13 +00001277
1278static PyStructSequence_Field hash_info_fields[] = {
1279 {"width", "width of the type used for hashing, in bits"},
1280 {"modulus", "prime number giving the modulus on which the hash "
1281 "function is based"},
1282 {"inf", "value to be used for hash of a positive infinity"},
1283 {"nan", "value to be used for hash of a nan"},
1284 {"imag", "multiplier used for the imaginary part of a complex number"},
Christian Heimes985ecdc2013-11-20 11:46:18 +01001285 {"algorithm", "name of the algorithm for hashing of str, bytes and "
1286 "memoryviews"},
1287 {"hash_bits", "internal output size of hash algorithm"},
1288 {"seed_bits", "seed size of hash algorithm"},
1289 {"cutoff", "small string optimization cutoff"},
Mark Dickinsondc787d22010-05-23 13:33:13 +00001290 {NULL, NULL}
1291};
1292
1293static PyStructSequence_Desc hash_info_desc = {
1294 "sys.hash_info",
1295 hash_info_doc,
1296 hash_info_fields,
Christian Heimes985ecdc2013-11-20 11:46:18 +01001297 9,
Mark Dickinsondc787d22010-05-23 13:33:13 +00001298};
1299
Matthias Klosed885e952010-07-06 10:53:30 +00001300static PyObject *
Mark Dickinsondc787d22010-05-23 13:33:13 +00001301get_hash_info(void)
1302{
1303 PyObject *hash_info;
1304 int field = 0;
Christian Heimes985ecdc2013-11-20 11:46:18 +01001305 PyHash_FuncDef *hashfunc;
Mark Dickinsondc787d22010-05-23 13:33:13 +00001306 hash_info = PyStructSequence_New(&Hash_InfoType);
1307 if (hash_info == NULL)
1308 return NULL;
Christian Heimes985ecdc2013-11-20 11:46:18 +01001309 hashfunc = PyHash_GetFuncDef();
Mark Dickinsondc787d22010-05-23 13:33:13 +00001310 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001311 PyLong_FromLong(8*sizeof(Py_hash_t)));
Mark Dickinsondc787d22010-05-23 13:33:13 +00001312 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8035bc52010-10-23 16:20:50 +00001313 PyLong_FromSsize_t(_PyHASH_MODULUS));
Mark Dickinsondc787d22010-05-23 13:33:13 +00001314 PyStructSequence_SET_ITEM(hash_info, field++,
1315 PyLong_FromLong(_PyHASH_INF));
1316 PyStructSequence_SET_ITEM(hash_info, field++,
1317 PyLong_FromLong(_PyHASH_NAN));
1318 PyStructSequence_SET_ITEM(hash_info, field++,
1319 PyLong_FromLong(_PyHASH_IMAG));
Christian Heimes985ecdc2013-11-20 11:46:18 +01001320 PyStructSequence_SET_ITEM(hash_info, field++,
1321 PyUnicode_FromString(hashfunc->name));
1322 PyStructSequence_SET_ITEM(hash_info, field++,
1323 PyLong_FromLong(hashfunc->hash_bits));
1324 PyStructSequence_SET_ITEM(hash_info, field++,
1325 PyLong_FromLong(hashfunc->seed_bits));
1326 PyStructSequence_SET_ITEM(hash_info, field++,
1327 PyLong_FromLong(Py_HASH_CUTOFF));
Mark Dickinsondc787d22010-05-23 13:33:13 +00001328 if (PyErr_Occurred()) {
1329 Py_CLEAR(hash_info);
1330 return NULL;
1331 }
1332 return hash_info;
1333}
Tal Einatede0b6f2018-12-31 17:12:08 +02001334/*[clinic input]
1335sys.getrecursionlimit
Mark Dickinsondc787d22010-05-23 13:33:13 +00001336
Tal Einatede0b6f2018-12-31 17:12:08 +02001337Return the current value of the recursion limit.
Mark Dickinsondc787d22010-05-23 13:33:13 +00001338
Tal Einatede0b6f2018-12-31 17:12:08 +02001339The recursion limit is the maximum depth of the Python interpreter
1340stack. This limit prevents infinite recursion from causing an overflow
1341of the C stack and crashing Python.
1342[clinic start generated code]*/
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001343
1344static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001345sys_getrecursionlimit_impl(PyObject *module)
1346/*[clinic end generated code: output=d571fb6b4549ef2e input=1c6129fd2efaeea8]*/
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001347{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001348 return PyLong_FromLong(Py_GetRecursionLimit());
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001349}
1350
Mark Hammond8696ebc2002-10-08 02:44:31 +00001351#ifdef MS_WINDOWS
Mark Hammond8696ebc2002-10-08 02:44:31 +00001352
Eric Smithf7bb5782010-01-27 00:44:57 +00001353static PyTypeObject WindowsVersionType = {0, 0, 0, 0, 0, 0};
1354
1355static PyStructSequence_Field windows_version_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001356 {"major", "Major version number"},
1357 {"minor", "Minor version number"},
1358 {"build", "Build number"},
1359 {"platform", "Operating system platform"},
1360 {"service_pack", "Latest Service Pack installed on the system"},
1361 {"service_pack_major", "Service Pack major version number"},
1362 {"service_pack_minor", "Service Pack minor version number"},
1363 {"suite_mask", "Bit mask identifying available product suites"},
1364 {"product_type", "System product type"},
Steve Dower74f4af72016-09-17 17:27:48 -07001365 {"platform_version", "Diagnostic version number"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001366 {0}
Eric Smithf7bb5782010-01-27 00:44:57 +00001367};
1368
1369static PyStructSequence_Desc windows_version_desc = {
Tal Einatede0b6f2018-12-31 17:12:08 +02001370 "sys.getwindowsversion", /* name */
1371 sys_getwindowsversion__doc__, /* doc */
1372 windows_version_fields, /* fields */
1373 5 /* For backward compatibility,
1374 only the first 5 items are accessible
1375 via indexing, the rest are name only */
Eric Smithf7bb5782010-01-27 00:44:57 +00001376};
1377
Steve Dower3e96f322015-03-02 08:01:10 -08001378/* Disable deprecation warnings about GetVersionEx as the result is
1379 being passed straight through to the caller, who is responsible for
1380 using it correctly. */
1381#pragma warning(push)
1382#pragma warning(disable:4996)
1383
Tal Einatede0b6f2018-12-31 17:12:08 +02001384/*[clinic input]
1385sys.getwindowsversion
1386
1387Return info about the running version of Windows as a named tuple.
1388
1389The members are named: major, minor, build, platform, service_pack,
1390service_pack_major, service_pack_minor, suite_mask, product_type and
1391platform_version. For backward compatibility, only the first 5 items
1392are available by indexing. All elements are numbers, except
1393service_pack and platform_type which are strings, and platform_version
1394which is a 3-tuple. Platform is always 2. Product_type may be 1 for a
1395workstation, 2 for a domain controller, 3 for a server.
1396Platform_version is a 3-tuple containing a version number that is
1397intended for identifying the OS rather than feature detection.
1398[clinic start generated code]*/
1399
Mark Hammond8696ebc2002-10-08 02:44:31 +00001400static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001401sys_getwindowsversion_impl(PyObject *module)
1402/*[clinic end generated code: output=1ec063280b932857 input=73a228a328fee63a]*/
Mark Hammond8696ebc2002-10-08 02:44:31 +00001403{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001404 PyObject *version;
1405 int pos = 0;
Minmin Gong8ebc6452019-02-02 20:26:55 -08001406 OSVERSIONINFOEXW ver;
Steve Dower74f4af72016-09-17 17:27:48 -07001407 DWORD realMajor, realMinor, realBuild;
1408 HANDLE hKernel32;
1409 wchar_t kernel32_path[MAX_PATH];
1410 LPVOID verblock;
1411 DWORD verblock_size;
1412
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001413 ver.dwOSVersionInfoSize = sizeof(ver);
Minmin Gong8ebc6452019-02-02 20:26:55 -08001414 if (!GetVersionExW((OSVERSIONINFOW*) &ver))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001415 return PyErr_SetFromWindowsErr(0);
Eric Smithf7bb5782010-01-27 00:44:57 +00001416
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001417 version = PyStructSequence_New(&WindowsVersionType);
1418 if (version == NULL)
1419 return NULL;
Eric Smithf7bb5782010-01-27 00:44:57 +00001420
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001421 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMajorVersion));
1422 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMinorVersion));
1423 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwBuildNumber));
1424 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwPlatformId));
Minmin Gong8ebc6452019-02-02 20:26:55 -08001425 PyStructSequence_SET_ITEM(version, pos++, PyUnicode_FromWideChar(ver.szCSDVersion, -1));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001426 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMajor));
1427 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMinor));
1428 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wSuiteMask));
1429 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wProductType));
Eric Smithf7bb5782010-01-27 00:44:57 +00001430
Steve Dower74f4af72016-09-17 17:27:48 -07001431 realMajor = ver.dwMajorVersion;
1432 realMinor = ver.dwMinorVersion;
1433 realBuild = ver.dwBuildNumber;
1434
1435 // GetVersion will lie if we are running in a compatibility mode.
1436 // We need to read the version info from a system file resource
1437 // to accurately identify the OS version. If we fail for any reason,
1438 // just return whatever GetVersion said.
Tony Roberts4860f012019-02-02 18:16:42 +01001439 Py_BEGIN_ALLOW_THREADS
Steve Dower74f4af72016-09-17 17:27:48 -07001440 hKernel32 = GetModuleHandleW(L"kernel32.dll");
Tony Roberts4860f012019-02-02 18:16:42 +01001441 Py_END_ALLOW_THREADS
Steve Dower74f4af72016-09-17 17:27:48 -07001442 if (hKernel32 && GetModuleFileNameW(hKernel32, kernel32_path, MAX_PATH) &&
1443 (verblock_size = GetFileVersionInfoSizeW(kernel32_path, NULL)) &&
1444 (verblock = PyMem_RawMalloc(verblock_size))) {
1445 VS_FIXEDFILEINFO *ffi;
1446 UINT ffi_len;
1447
1448 if (GetFileVersionInfoW(kernel32_path, 0, verblock_size, verblock) &&
1449 VerQueryValueW(verblock, L"", (LPVOID)&ffi, &ffi_len)) {
1450 realMajor = HIWORD(ffi->dwProductVersionMS);
1451 realMinor = LOWORD(ffi->dwProductVersionMS);
1452 realBuild = HIWORD(ffi->dwProductVersionLS);
1453 }
1454 PyMem_RawFree(verblock);
1455 }
Segev Finer48fb7662017-06-04 20:52:27 +03001456 PyStructSequence_SET_ITEM(version, pos++, Py_BuildValue("(kkk)",
1457 realMajor,
1458 realMinor,
1459 realBuild
Steve Dower74f4af72016-09-17 17:27:48 -07001460 ));
1461
Serhiy Storchaka48d761e2013-12-17 15:11:24 +02001462 if (PyErr_Occurred()) {
1463 Py_DECREF(version);
1464 return NULL;
1465 }
Steve Dower74f4af72016-09-17 17:27:48 -07001466
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001467 return version;
Mark Hammond8696ebc2002-10-08 02:44:31 +00001468}
1469
Steve Dower3e96f322015-03-02 08:01:10 -08001470#pragma warning(pop)
1471
Tal Einatede0b6f2018-12-31 17:12:08 +02001472/*[clinic input]
1473sys._enablelegacywindowsfsencoding
1474
1475Changes the default filesystem encoding to mbcs:replace.
1476
1477This is done for consistency with earlier versions of Python. See PEP
1478529 for more information.
1479
1480This is equivalent to defining the PYTHONLEGACYWINDOWSFSENCODING
1481environment variable before launching Python.
1482[clinic start generated code]*/
Steve Dowercc16be82016-09-08 10:35:16 -07001483
1484static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001485sys__enablelegacywindowsfsencoding_impl(PyObject *module)
1486/*[clinic end generated code: output=f5c3855b45e24fe9 input=2bfa931a20704492]*/
Steve Dowercc16be82016-09-08 10:35:16 -07001487{
Victor Stinner709d23d2019-05-02 14:56:30 -04001488 if (_PyUnicode_EnableLegacyWindowsFSEncoding() < 0) {
Victor Stinnerb2457ef2018-08-29 13:25:36 +02001489 return NULL;
1490 }
Steve Dowercc16be82016-09-08 10:35:16 -07001491 Py_RETURN_NONE;
1492}
1493
Mark Hammond8696ebc2002-10-08 02:44:31 +00001494#endif /* MS_WINDOWS */
1495
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001496#ifdef HAVE_DLOPEN
Tal Einatede0b6f2018-12-31 17:12:08 +02001497
1498/*[clinic input]
1499sys.setdlopenflags
1500
1501 flags as new_val: int
1502 /
1503
1504Set the flags used by the interpreter for dlopen calls.
1505
1506This is used, for example, when the interpreter loads extension
1507modules. Among other things, this will enable a lazy resolving of
1508symbols when importing a module, if called as sys.setdlopenflags(0).
1509To share symbols across extension modules, call as
1510sys.setdlopenflags(os.RTLD_GLOBAL). Symbolic names for the flag
1511modules can be found in the os module (RTLD_xxx constants, e.g.
1512os.RTLD_LAZY).
1513[clinic start generated code]*/
1514
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001515static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001516sys_setdlopenflags_impl(PyObject *module, int new_val)
1517/*[clinic end generated code: output=ec918b7fe0a37281 input=4c838211e857a77f]*/
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001518{
Victor Stinnercaba55b2018-08-03 15:33:52 +02001519 PyInterpreterState *interp = _PyInterpreterState_Get();
1520 interp->dlopenflags = new_val;
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001521 Py_RETURN_NONE;
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001522}
1523
Tal Einatede0b6f2018-12-31 17:12:08 +02001524
1525/*[clinic input]
1526sys.getdlopenflags
1527
1528Return the current value of the flags that are used for dlopen calls.
1529
1530The flag constants are defined in the os module.
1531[clinic start generated code]*/
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001532
1533static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001534sys_getdlopenflags_impl(PyObject *module)
1535/*[clinic end generated code: output=e92cd1bc5005da6e input=dc4ea0899c53b4b6]*/
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001536{
Victor Stinnercaba55b2018-08-03 15:33:52 +02001537 PyInterpreterState *interp = _PyInterpreterState_Get();
1538 return PyLong_FromLong(interp->dlopenflags);
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001539}
1540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001541#endif /* HAVE_DLOPEN */
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001542
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001543#ifdef USE_MALLOPT
1544/* Link with -lmalloc (or -lmpc) on an SGI */
1545#include <malloc.h>
1546
Tal Einatede0b6f2018-12-31 17:12:08 +02001547/*[clinic input]
1548sys.mdebug
1549
1550 flag: int
1551 /
1552[clinic start generated code]*/
1553
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001554static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001555sys_mdebug_impl(PyObject *module, int flag)
1556/*[clinic end generated code: output=5431d545847c3637 input=151d150ae1636f8a]*/
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001557{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 int flag;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001559 mallopt(M_DEBUG, flag);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001560 Py_RETURN_NONE;
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001561}
1562#endif /* USE_MALLOPT */
1563
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001564size_t
1565_PySys_GetSizeOf(PyObject *o)
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001566{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 PyObject *res = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001568 PyObject *method;
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001569 Py_ssize_t size;
Benjamin Petersona5758c02009-05-09 18:15:04 +00001570
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001571 /* Make sure the type is initialized. float gets initialized late */
1572 if (PyType_Ready(Py_TYPE(o)) < 0)
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001573 return (size_t)-1;
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +00001574
Benjamin Petersonce798522012-01-22 11:24:29 -05001575 method = _PyObject_LookupSpecial(o, &PyId___sizeof__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001576 if (method == NULL) {
1577 if (!PyErr_Occurred())
1578 PyErr_Format(PyExc_TypeError,
1579 "Type %.100s doesn't define __sizeof__",
1580 Py_TYPE(o)->tp_name);
1581 }
1582 else {
Victor Stinnerf17c3de2016-12-06 18:46:19 +01001583 res = _PyObject_CallNoArg(method);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001584 Py_DECREF(method);
1585 }
1586
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001587 if (res == NULL)
1588 return (size_t)-1;
1589
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001590 size = PyLong_AsSsize_t(res);
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001591 Py_DECREF(res);
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001592 if (size == -1 && PyErr_Occurred())
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001593 return (size_t)-1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001594
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001595 if (size < 0) {
1596 PyErr_SetString(PyExc_ValueError, "__sizeof__() should return >= 0");
1597 return (size_t)-1;
1598 }
1599
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001600 /* add gc_head size */
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001601 if (PyObject_IS_GC(o))
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001602 return ((size_t)size) + sizeof(PyGC_Head);
1603 return (size_t)size;
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001604}
1605
1606static PyObject *
1607sys_getsizeof(PyObject *self, PyObject *args, PyObject *kwds)
1608{
1609 static char *kwlist[] = {"object", "default", 0};
1610 size_t size;
1611 PyObject *o, *dflt = NULL;
1612
1613 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|O:getsizeof",
1614 kwlist, &o, &dflt))
1615 return NULL;
1616
1617 size = _PySys_GetSizeOf(o);
1618
1619 if (size == (size_t)-1 && PyErr_Occurred()) {
1620 /* Has a default value been given */
1621 if (dflt != NULL && PyErr_ExceptionMatches(PyExc_TypeError)) {
1622 PyErr_Clear();
1623 Py_INCREF(dflt);
1624 return dflt;
1625 }
1626 else
1627 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001628 }
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001629
1630 return PyLong_FromSize_t(size);
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001631}
1632
1633PyDoc_STRVAR(getsizeof_doc,
Tal Einatede0b6f2018-12-31 17:12:08 +02001634"getsizeof(object [, default]) -> int\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001635\n\
1636Return the size of object in bytes.");
1637
Tal Einatede0b6f2018-12-31 17:12:08 +02001638/*[clinic input]
1639sys.getrefcount -> Py_ssize_t
1640
1641 object: object
1642 /
1643
1644Return the reference count of object.
1645
1646The count returned is generally one higher than you might expect,
1647because it includes the (temporary) reference as an argument to
1648getrefcount().
1649[clinic start generated code]*/
1650
1651static Py_ssize_t
1652sys_getrefcount_impl(PyObject *module, PyObject *object)
1653/*[clinic end generated code: output=5fd477f2264b85b2 input=bf474efd50a21535]*/
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001654{
Tal Einatede0b6f2018-12-31 17:12:08 +02001655 return object->ob_refcnt;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001656}
1657
Tim Peters4be93d02002-07-07 19:59:50 +00001658#ifdef Py_REF_DEBUG
Tal Einatede0b6f2018-12-31 17:12:08 +02001659/*[clinic input]
1660sys.gettotalrefcount -> Py_ssize_t
1661[clinic start generated code]*/
1662
1663static Py_ssize_t
1664sys_gettotalrefcount_impl(PyObject *module)
1665/*[clinic end generated code: output=4103886cf17c25bc input=53b744faa5d2e4f6]*/
Mark Hammond440d8982000-06-20 08:12:48 +00001666{
Tal Einatede0b6f2018-12-31 17:12:08 +02001667 return _Py_GetRefTotal();
Mark Hammond440d8982000-06-20 08:12:48 +00001668}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001669#endif /* Py_REF_DEBUG */
Mark Hammond440d8982000-06-20 08:12:48 +00001670
Tal Einatede0b6f2018-12-31 17:12:08 +02001671/*[clinic input]
1672sys.getallocatedblocks -> Py_ssize_t
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001673
Tal Einatede0b6f2018-12-31 17:12:08 +02001674Return the number of memory blocks currently allocated.
1675[clinic start generated code]*/
1676
1677static Py_ssize_t
1678sys_getallocatedblocks_impl(PyObject *module)
1679/*[clinic end generated code: output=f0c4e873f0b6dcf7 input=dab13ee346a0673e]*/
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001680{
Tal Einatede0b6f2018-12-31 17:12:08 +02001681 return _Py_GetAllocatedBlocks();
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001682}
1683
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001684#ifdef COUNT_ALLOCS
Tal Einatede0b6f2018-12-31 17:12:08 +02001685/*[clinic input]
1686sys.getcounts
1687[clinic start generated code]*/
1688
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001689static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001690sys_getcounts_impl(PyObject *module)
1691/*[clinic end generated code: output=20df00bc164f43cb input=ad2ec7bda5424953]*/
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001692{
Pablo Galindo49c75a82018-10-28 15:02:17 +00001693 extern PyObject *_Py_get_counts(void);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001694
Pablo Galindo49c75a82018-10-28 15:02:17 +00001695 return _Py_get_counts();
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001696}
1697#endif
1698
Tal Einatede0b6f2018-12-31 17:12:08 +02001699/*[clinic input]
1700sys._getframe
1701
1702 depth: int = 0
1703 /
1704
1705Return a frame object from the call stack.
1706
1707If optional integer depth is given, return the frame object that many
1708calls below the top of the stack. If that is deeper than the call
1709stack, ValueError is raised. The default for depth is zero, returning
1710the frame at the top of the call stack.
1711
1712This function should be used for internal and specialized purposes
1713only.
1714[clinic start generated code]*/
Barry Warsawb6a54d22000-12-06 21:47:46 +00001715
1716static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001717sys__getframe_impl(PyObject *module, int depth)
1718/*[clinic end generated code: output=d438776c04d59804 input=c1be8a6464b11ee5]*/
Barry Warsawb6a54d22000-12-06 21:47:46 +00001719{
Victor Stinner50b48572018-11-01 01:51:40 +01001720 PyFrameObject *f = _PyThreadState_GET()->frame;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001721
Steve Dowerb82e17e2019-05-23 08:45:22 -07001722 if (PySys_Audit("sys._getframe", "O", f) < 0) {
1723 return NULL;
1724 }
1725
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001726 while (depth > 0 && f != NULL) {
1727 f = f->f_back;
1728 --depth;
1729 }
1730 if (f == NULL) {
1731 PyErr_SetString(PyExc_ValueError,
1732 "call stack is not deep enough");
1733 return NULL;
1734 }
1735 Py_INCREF(f);
1736 return (PyObject*)f;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001737}
1738
Tal Einatede0b6f2018-12-31 17:12:08 +02001739/*[clinic input]
1740sys._current_frames
1741
1742Return a dict mapping each thread's thread id to its current stack frame.
1743
1744This function should be used for specialized purposes only.
1745[clinic start generated code]*/
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001746
1747static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001748sys__current_frames_impl(PyObject *module)
1749/*[clinic end generated code: output=d2a41ac0a0a3809a input=2a9049c5f5033691]*/
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001750{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001751 return _PyThread_CurrentFrames();
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001752}
1753
Tal Einatede0b6f2018-12-31 17:12:08 +02001754/*[clinic input]
1755sys.call_tracing
1756
1757 func: object
1758 args as funcargs: object(subclass_of='&PyTuple_Type')
1759 /
1760
1761Call func(*args), while tracing is enabled.
1762
1763The tracing state is saved, and restored afterwards. This is intended
1764to be called from a debugger from a checkpoint, to recursively debug
1765some other code.
1766[clinic start generated code]*/
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001767
1768static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001769sys_call_tracing_impl(PyObject *module, PyObject *func, PyObject *funcargs)
1770/*[clinic end generated code: output=7e4999853cd4e5a6 input=5102e8b11049f92f]*/
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001771{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001772 return _PyEval_CallTracing(func, funcargs);
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001773}
1774
Tal Einatede0b6f2018-12-31 17:12:08 +02001775/*[clinic input]
1776sys.callstats
1777
1778Return a tuple of function call statistics.
1779
1780A tuple is returned only if CALL_PROFILE was defined when Python was
1781built. Otherwise, this returns None.
1782
1783When enabled, this function returns detailed, implementation-specific
1784details about the number of function calls executed. The return value
1785is a 11-tuple where the entries in the tuple are counts of:
17860. all function calls
17871. calls to PyFunction_Type objects
17882. PyFunction calls that do not create an argument tuple
17893. PyFunction calls that do not create an argument tuple
1790 and bypass PyEval_EvalCodeEx()
17914. PyMethod calls
17925. PyMethod calls on bound methods
17936. PyType calls
17947. PyCFunction calls
17958. generator calls
17969. All other calls
179710. Number of stack pops performed by call_function()
1798[clinic start generated code]*/
Barry Warsawb6a54d22000-12-06 21:47:46 +00001799
Victor Stinner048afd92016-11-28 11:59:04 +01001800static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001801sys_callstats_impl(PyObject *module)
1802/*[clinic end generated code: output=edc4a74957fa8def input=d447d8d224d5d175]*/
Victor Stinner048afd92016-11-28 11:59:04 +01001803{
1804 if (PyErr_WarnEx(PyExc_DeprecationWarning,
1805 "sys.callstats() has been deprecated in Python 3.7 "
1806 "and will be removed in the future", 1) < 0) {
1807 return NULL;
1808 }
1809
1810 Py_RETURN_NONE;
1811}
1812
1813
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001814#ifdef __cplusplus
1815extern "C" {
1816#endif
1817
Tal Einatede0b6f2018-12-31 17:12:08 +02001818/*[clinic input]
1819sys._debugmallocstats
1820
1821Print summary info to stderr about the state of pymalloc's structures.
1822
1823In Py_DEBUG mode, also perform some expensive internal consistency
1824checks.
1825[clinic start generated code]*/
1826
David Malcolm49526f42012-06-22 14:55:41 -04001827static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001828sys__debugmallocstats_impl(PyObject *module)
1829/*[clinic end generated code: output=ec3565f8c7cee46a input=33c0c9c416f98424]*/
David Malcolm49526f42012-06-22 14:55:41 -04001830{
1831#ifdef WITH_PYMALLOC
Victor Stinner6bf992a2017-12-06 17:26:10 +01001832 if (_PyObject_DebugMallocStats(stderr)) {
Victor Stinner34be8072016-03-14 12:04:26 +01001833 fputc('\n', stderr);
1834 }
David Malcolm49526f42012-06-22 14:55:41 -04001835#endif
1836 _PyObject_DebugTypeStats(stderr);
1837
1838 Py_RETURN_NONE;
1839}
David Malcolm49526f42012-06-22 14:55:41 -04001840
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001841#ifdef Py_TRACE_REFS
Guido van Rossumded690f1996-05-24 20:48:31 +00001842/* Defined in objects.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001843extern PyObject *_Py_GetObjects(PyObject *, PyObject *);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001844#endif
Guido van Rossumded690f1996-05-24 20:48:31 +00001845
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001846#ifdef DYNAMIC_EXECUTION_PROFILE
1847/* Defined in ceval.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001848extern PyObject *_Py_GetDXProfile(PyObject *, PyObject *);
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001849#endif
1850
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001851#ifdef __cplusplus
1852}
1853#endif
1854
Tal Einatede0b6f2018-12-31 17:12:08 +02001855
1856/*[clinic input]
1857sys._clear_type_cache
1858
1859Clear the internal type lookup cache.
1860[clinic start generated code]*/
1861
Christian Heimes15ebc882008-02-04 18:48:49 +00001862static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001863sys__clear_type_cache_impl(PyObject *module)
1864/*[clinic end generated code: output=20e48ca54a6f6971 input=127f3e04a8d9b555]*/
Christian Heimes15ebc882008-02-04 18:48:49 +00001865{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001866 PyType_ClearCache();
1867 Py_RETURN_NONE;
Christian Heimes15ebc882008-02-04 18:48:49 +00001868}
1869
Tal Einatede0b6f2018-12-31 17:12:08 +02001870/*[clinic input]
1871sys.is_finalizing
1872
1873Return True if Python is exiting.
1874[clinic start generated code]*/
1875
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001876static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001877sys_is_finalizing_impl(PyObject *module)
1878/*[clinic end generated code: output=735b5ff7962ab281 input=f0df747a039948a5]*/
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001879{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001880 return PyBool_FromLong(_Py_IsFinalizing());
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001881}
1882
Victor Stinnerd6958ac2016-12-02 01:13:46 +01001883#ifdef ANDROID_API_LEVEL
Tal Einatede0b6f2018-12-31 17:12:08 +02001884/*[clinic input]
1885sys.getandroidapilevel
1886
1887Return the build time API version of Android as an integer.
1888[clinic start generated code]*/
Victor Stinnerd6958ac2016-12-02 01:13:46 +01001889
1890static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001891sys_getandroidapilevel_impl(PyObject *module)
1892/*[clinic end generated code: output=214abf183a1c70c1 input=3e6d6c9fcdd24ac6]*/
Victor Stinnerd6958ac2016-12-02 01:13:46 +01001893{
1894 return PyLong_FromLong(ANDROID_API_LEVEL);
1895}
1896#endif /* ANDROID_API_LEVEL */
1897
1898
Steve Dowerb82e17e2019-05-23 08:45:22 -07001899
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001900static PyMethodDef sys_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001901 /* Might as well keep this in alphabetic order */
Steve Dowerb82e17e2019-05-23 08:45:22 -07001902 SYS_ADDAUDITHOOK_METHODDEF
1903 {"audit", (PyCFunction)(void(*)(void))sys_audit, METH_FASTCALL, audit_doc },
Serhiy Storchaka62be7422018-11-27 13:27:31 +02001904 {"breakpointhook", (PyCFunction)(void(*)(void))sys_breakpointhook,
Barry Warsaw36c1d1f2017-10-05 12:11:18 -04001905 METH_FASTCALL | METH_KEYWORDS, breakpointhook_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001906 SYS_CALLSTATS_METHODDEF
1907 SYS__CLEAR_TYPE_CACHE_METHODDEF
1908 SYS__CURRENT_FRAMES_METHODDEF
1909 SYS_DISPLAYHOOK_METHODDEF
1910 SYS_EXC_INFO_METHODDEF
1911 SYS_EXCEPTHOOK_METHODDEF
1912 SYS_EXIT_METHODDEF
1913 SYS_GETDEFAULTENCODING_METHODDEF
1914 SYS_GETDLOPENFLAGS_METHODDEF
1915 SYS_GETALLOCATEDBLOCKS_METHODDEF
1916 SYS_GETCOUNTS_METHODDEF
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001917#ifdef DYNAMIC_EXECUTION_PROFILE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001918 {"getdxp", _Py_GetDXProfile, METH_VARARGS},
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001919#endif
Tal Einatede0b6f2018-12-31 17:12:08 +02001920 SYS_GETFILESYSTEMENCODING_METHODDEF
1921 SYS_GETFILESYSTEMENCODEERRORS_METHODDEF
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001922#ifdef Py_TRACE_REFS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001923 {"getobjects", _Py_GetObjects, METH_VARARGS},
Tim Peters4be93d02002-07-07 19:59:50 +00001924#endif
Tal Einatede0b6f2018-12-31 17:12:08 +02001925 SYS_GETTOTALREFCOUNT_METHODDEF
1926 SYS_GETREFCOUNT_METHODDEF
1927 SYS_GETRECURSIONLIMIT_METHODDEF
Serhiy Storchaka62be7422018-11-27 13:27:31 +02001928 {"getsizeof", (PyCFunction)(void(*)(void))sys_getsizeof,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001929 METH_VARARGS | METH_KEYWORDS, getsizeof_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001930 SYS__GETFRAME_METHODDEF
1931 SYS_GETWINDOWSVERSION_METHODDEF
1932 SYS__ENABLELEGACYWINDOWSFSENCODING_METHODDEF
1933 SYS_INTERN_METHODDEF
1934 SYS_IS_FINALIZING_METHODDEF
1935 SYS_MDEBUG_METHODDEF
1936 SYS_SETCHECKINTERVAL_METHODDEF
1937 SYS_GETCHECKINTERVAL_METHODDEF
1938 SYS_SETSWITCHINTERVAL_METHODDEF
1939 SYS_GETSWITCHINTERVAL_METHODDEF
1940 SYS_SETDLOPENFLAGS_METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001941 {"setprofile", sys_setprofile, METH_O, setprofile_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001942 SYS_GETPROFILE_METHODDEF
1943 SYS_SETRECURSIONLIMIT_METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001944 {"settrace", sys_settrace, METH_O, settrace_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001945 SYS_GETTRACE_METHODDEF
1946 SYS_CALL_TRACING_METHODDEF
1947 SYS__DEBUGMALLOCSTATS_METHODDEF
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001948 SYS_SET_COROUTINE_ORIGIN_TRACKING_DEPTH_METHODDEF
1949 SYS_GET_COROUTINE_ORIGIN_TRACKING_DEPTH_METHODDEF
Serhiy Storchaka62be7422018-11-27 13:27:31 +02001950 {"set_asyncgen_hooks", (PyCFunction)(void(*)(void))sys_set_asyncgen_hooks,
Yury Selivanoveb636452016-09-08 22:01:51 -07001951 METH_VARARGS | METH_KEYWORDS, set_asyncgen_hooks_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001952 SYS_GET_ASYNCGEN_HOOKS_METHODDEF
1953 SYS_GETANDROIDAPILEVEL_METHODDEF
Victor Stinneref9d9b62019-05-22 11:28:22 +02001954 SYS_UNRAISABLEHOOK_METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001955 {NULL, NULL} /* sentinel */
Guido van Rossum3f5da241990-12-20 15:06:42 +00001956};
1957
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001958static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001959list_builtin_module_names(void)
Guido van Rossum34679b71993-01-26 13:33:44 +00001960{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001961 PyObject *list = PyList_New(0);
1962 int i;
1963 if (list == NULL)
1964 return NULL;
1965 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1966 PyObject *name = PyUnicode_FromString(
1967 PyImport_Inittab[i].name);
1968 if (name == NULL)
1969 break;
1970 PyList_Append(list, name);
1971 Py_DECREF(name);
1972 }
1973 if (PyList_Sort(list) != 0) {
1974 Py_DECREF(list);
1975 list = NULL;
1976 }
1977 if (list) {
1978 PyObject *v = PyList_AsTuple(list);
1979 Py_DECREF(list);
1980 list = v;
1981 }
1982 return list;
Guido van Rossum34679b71993-01-26 13:33:44 +00001983}
1984
Nick Coghlanbc77eff2018-03-25 20:44:30 +10001985/* Pre-initialization support for sys.warnoptions and sys._xoptions
1986 *
1987 * Modern internal code paths:
1988 * These APIs get called after _Py_InitializeCore and get to use the
1989 * regular CPython list, dict, and unicode APIs.
1990 *
1991 * Legacy embedding code paths:
1992 * The multi-phase initialization API isn't public yet, so embedding
1993 * apps still need to be able configure sys.warnoptions and sys._xoptions
1994 * before they call Py_Initialize. To support this, we stash copies of
1995 * the supplied wchar * sequences in linked lists, and then migrate the
1996 * contents of those lists to the sys module in _PyInitializeCore.
1997 *
1998 */
1999
2000struct _preinit_entry {
2001 wchar_t *value;
2002 struct _preinit_entry *next;
2003};
2004
2005typedef struct _preinit_entry *_Py_PreInitEntry;
2006
2007static _Py_PreInitEntry _preinit_warnoptions = NULL;
2008static _Py_PreInitEntry _preinit_xoptions = NULL;
2009
2010static _Py_PreInitEntry
2011_alloc_preinit_entry(const wchar_t *value)
2012{
2013 /* To get this to work, we have to initialize the runtime implicitly */
2014 _PyRuntime_Initialize();
2015
2016 /* Force default allocator, so we can ensure that it also gets used to
2017 * destroy the linked list in _clear_preinit_entries.
2018 */
2019 PyMemAllocatorEx old_alloc;
2020 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2021
2022 _Py_PreInitEntry node = PyMem_RawCalloc(1, sizeof(*node));
2023 if (node != NULL) {
2024 node->value = _PyMem_RawWcsdup(value);
2025 if (node->value == NULL) {
2026 PyMem_RawFree(node);
2027 node = NULL;
2028 };
2029 };
2030
2031 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2032 return node;
Zackery Spytz1a2252e2019-05-06 10:56:51 -06002033}
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002034
2035static int
2036_append_preinit_entry(_Py_PreInitEntry *optionlist, const wchar_t *value)
2037{
2038 _Py_PreInitEntry new_entry = _alloc_preinit_entry(value);
2039 if (new_entry == NULL) {
2040 return -1;
2041 }
2042 /* We maintain the linked list in this order so it's easy to play back
2043 * the add commands in the same order later on in _Py_InitializeCore
2044 */
2045 _Py_PreInitEntry last_entry = *optionlist;
2046 if (last_entry == NULL) {
2047 *optionlist = new_entry;
2048 } else {
2049 while (last_entry->next != NULL) {
2050 last_entry = last_entry->next;
2051 }
2052 last_entry->next = new_entry;
2053 }
2054 return 0;
Zackery Spytz1a2252e2019-05-06 10:56:51 -06002055}
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002056
2057static void
2058_clear_preinit_entries(_Py_PreInitEntry *optionlist)
2059{
2060 _Py_PreInitEntry current = *optionlist;
2061 *optionlist = NULL;
2062 /* Deallocate the nodes and their contents using the default allocator */
2063 PyMemAllocatorEx old_alloc;
2064 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2065 while (current != NULL) {
2066 _Py_PreInitEntry next = current->next;
2067 PyMem_RawFree(current->value);
2068 PyMem_RawFree(current);
2069 current = next;
2070 }
2071 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
Zackery Spytz1a2252e2019-05-06 10:56:51 -06002072}
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002073
2074static void
2075_clear_all_preinit_options(void)
2076{
2077 _clear_preinit_entries(&_preinit_warnoptions);
2078 _clear_preinit_entries(&_preinit_xoptions);
2079}
2080
2081static int
2082_PySys_ReadPreInitOptions(void)
2083{
2084 /* Rerun the add commands with the actual sys module available */
Victor Stinner50b48572018-11-01 01:51:40 +01002085 PyThreadState *tstate = _PyThreadState_GET();
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002086 if (tstate == NULL) {
2087 /* Still don't have a thread state, so something is wrong! */
2088 return -1;
2089 }
2090 _Py_PreInitEntry entry = _preinit_warnoptions;
2091 while (entry != NULL) {
2092 PySys_AddWarnOption(entry->value);
2093 entry = entry->next;
2094 }
2095 entry = _preinit_xoptions;
2096 while (entry != NULL) {
2097 PySys_AddXOption(entry->value);
2098 entry = entry->next;
2099 }
2100
2101 _clear_all_preinit_options();
2102 return 0;
Zackery Spytz1a2252e2019-05-06 10:56:51 -06002103}
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002104
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002105static PyObject *
2106get_warnoptions(void)
2107{
Eric Snowdae02762017-09-14 00:35:58 -07002108 PyObject *warnoptions = _PySys_GetObjectId(&PyId_warnoptions);
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002109 if (warnoptions == NULL || !PyList_Check(warnoptions)) {
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002110 /* PEP432 TODO: we can reach this if warnoptions is NULL in the main
2111 * interpreter config. When that happens, we need to properly set
2112 * the `warnoptions` reference in the main interpreter config as well.
2113 *
2114 * For Python 3.7, we shouldn't be able to get here due to the
2115 * combination of how _PyMainInterpreter_ReadConfig and _PySys_EndInit
2116 * work, but we expect 3.8+ to make the _PyMainInterpreter_ReadConfig
2117 * call optional for embedding applications, thus making this
2118 * reachable again.
2119 */
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002120 warnoptions = PyList_New(0);
2121 if (warnoptions == NULL)
2122 return NULL;
Eric Snowdae02762017-09-14 00:35:58 -07002123 if (_PySys_SetObjectId(&PyId_warnoptions, warnoptions)) {
2124 Py_DECREF(warnoptions);
2125 return NULL;
2126 }
2127 Py_DECREF(warnoptions);
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002128 }
2129 return warnoptions;
2130}
Guido van Rossum23fff912000-12-15 22:02:05 +00002131
2132void
2133PySys_ResetWarnOptions(void)
2134{
Victor Stinner50b48572018-11-01 01:51:40 +01002135 PyThreadState *tstate = _PyThreadState_GET();
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002136 if (tstate == NULL) {
2137 _clear_preinit_entries(&_preinit_warnoptions);
2138 return;
2139 }
2140
Eric Snowdae02762017-09-14 00:35:58 -07002141 PyObject *warnoptions = _PySys_GetObjectId(&PyId_warnoptions);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002142 if (warnoptions == NULL || !PyList_Check(warnoptions))
2143 return;
2144 PyList_SetSlice(warnoptions, 0, PyList_GET_SIZE(warnoptions), NULL);
Guido van Rossum23fff912000-12-15 22:02:05 +00002145}
2146
Victor Stinnere1b29952018-10-30 14:31:42 +01002147static int
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002148_PySys_AddWarnOptionWithError(PyObject *option)
Guido van Rossum23fff912000-12-15 22:02:05 +00002149{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002150 PyObject *warnoptions = get_warnoptions();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002151 if (warnoptions == NULL) {
2152 return -1;
2153 }
2154 if (PyList_Append(warnoptions, option)) {
2155 return -1;
2156 }
2157 return 0;
2158}
2159
2160void
2161PySys_AddWarnOptionUnicode(PyObject *option)
2162{
Victor Stinnere1b29952018-10-30 14:31:42 +01002163 if (_PySys_AddWarnOptionWithError(option) < 0) {
2164 /* No return value, therefore clear error state if possible */
2165 if (_PyThreadState_UncheckedGet()) {
2166 PyErr_Clear();
2167 }
2168 }
Victor Stinner9ca9c252010-05-19 16:53:30 +00002169}
2170
2171void
2172PySys_AddWarnOption(const wchar_t *s)
2173{
Victor Stinner50b48572018-11-01 01:51:40 +01002174 PyThreadState *tstate = _PyThreadState_GET();
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002175 if (tstate == NULL) {
2176 _append_preinit_entry(&_preinit_warnoptions, s);
2177 return;
2178 }
Victor Stinner9ca9c252010-05-19 16:53:30 +00002179 PyObject *unicode;
2180 unicode = PyUnicode_FromWideChar(s, -1);
2181 if (unicode == NULL)
2182 return;
2183 PySys_AddWarnOptionUnicode(unicode);
2184 Py_DECREF(unicode);
Guido van Rossum23fff912000-12-15 22:02:05 +00002185}
2186
Christian Heimes33fe8092008-04-13 13:53:33 +00002187int
2188PySys_HasWarnOptions(void)
2189{
Eric Snowdae02762017-09-14 00:35:58 -07002190 PyObject *warnoptions = _PySys_GetObjectId(&PyId_warnoptions);
Serhiy Storchakadffccc62018-12-10 13:50:22 +02002191 return (warnoptions != NULL && PyList_Check(warnoptions)
2192 && PyList_GET_SIZE(warnoptions) > 0);
Christian Heimes33fe8092008-04-13 13:53:33 +00002193}
2194
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002195static PyObject *
2196get_xoptions(void)
2197{
Eric Snowdae02762017-09-14 00:35:58 -07002198 PyObject *xoptions = _PySys_GetObjectId(&PyId__xoptions);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002199 if (xoptions == NULL || !PyDict_Check(xoptions)) {
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002200 /* PEP432 TODO: we can reach this if xoptions is NULL in the main
2201 * interpreter config. When that happens, we need to properly set
2202 * the `xoptions` reference in the main interpreter config as well.
2203 *
2204 * For Python 3.7, we shouldn't be able to get here due to the
2205 * combination of how _PyMainInterpreter_ReadConfig and _PySys_EndInit
2206 * work, but we expect 3.8+ to make the _PyMainInterpreter_ReadConfig
2207 * call optional for embedding applications, thus making this
2208 * reachable again.
2209 */
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002210 xoptions = PyDict_New();
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002211 if (xoptions == NULL)
2212 return NULL;
Eric Snowdae02762017-09-14 00:35:58 -07002213 if (_PySys_SetObjectId(&PyId__xoptions, xoptions)) {
2214 Py_DECREF(xoptions);
2215 return NULL;
2216 }
2217 Py_DECREF(xoptions);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002218 }
2219 return xoptions;
2220}
2221
Victor Stinnere1b29952018-10-30 14:31:42 +01002222static int
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002223_PySys_AddXOptionWithError(const wchar_t *s)
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002224{
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002225 PyObject *name = NULL, *value = NULL;
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002226
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002227 PyObject *opts = get_xoptions();
2228 if (opts == NULL) {
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002229 goto error;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002230 }
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002231
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002232 const wchar_t *name_end = wcschr(s, L'=');
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002233 if (!name_end) {
2234 name = PyUnicode_FromWideChar(s, -1);
2235 value = Py_True;
2236 Py_INCREF(value);
2237 }
2238 else {
2239 name = PyUnicode_FromWideChar(s, name_end - s);
2240 value = PyUnicode_FromWideChar(name_end + 1, -1);
2241 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002242 if (name == NULL || value == NULL) {
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002243 goto error;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002244 }
2245 if (PyDict_SetItem(opts, name, value) < 0) {
2246 goto error;
2247 }
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002248 Py_DECREF(name);
2249 Py_DECREF(value);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002250 return 0;
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002251
2252error:
2253 Py_XDECREF(name);
2254 Py_XDECREF(value);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002255 return -1;
2256}
2257
2258void
2259PySys_AddXOption(const wchar_t *s)
2260{
Victor Stinner50b48572018-11-01 01:51:40 +01002261 PyThreadState *tstate = _PyThreadState_GET();
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002262 if (tstate == NULL) {
2263 _append_preinit_entry(&_preinit_xoptions, s);
2264 return;
2265 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002266 if (_PySys_AddXOptionWithError(s) < 0) {
2267 /* No return value, therefore clear error state if possible */
2268 if (_PyThreadState_UncheckedGet()) {
2269 PyErr_Clear();
2270 }
Victor Stinner0cae6092016-11-11 01:43:56 +01002271 }
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002272}
2273
2274PyObject *
2275PySys_GetXOptions(void)
2276{
2277 return get_xoptions();
2278}
2279
Guido van Rossum40552d01998-08-06 03:34:39 +00002280/* XXX This doc string is too long to be a single string literal in VC++ 5.0.
2281 Two literals concatenated works just fine. If you have a K&R compiler
2282 or other abomination that however *does* understand longer strings,
2283 get rid of the !!! comment in the middle and the quotes that surround it. */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002284PyDoc_VAR(sys_doc) =
2285PyDoc_STR(
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002286"This module provides access to some objects used or maintained by the\n\
2287interpreter and to functions that interact strongly with the interpreter.\n\
2288\n\
2289Dynamic objects:\n\
2290\n\
2291argv -- command line arguments; argv[0] is the script pathname if known\n\
2292path -- module search path; path[0] is the script directory, else ''\n\
2293modules -- dictionary of loaded modules\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002294\n\
2295displayhook -- called to show results in an interactive session\n\
2296excepthook -- called to handle any uncaught exception other than SystemExit\n\
2297 To customize printing in an interactive session or to install a custom\n\
2298 top-level exception handler, assign other functions to replace these.\n\
2299\n\
Benjamin Peterson06157a42008-07-15 00:28:36 +00002300stdin -- standard input file object; used by input()\n\
Georg Brandl88fc6642007-02-09 21:28:07 +00002301stdout -- standard output file object; used by print()\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002302stderr -- standard error object; used for error messages\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002303 By assigning other file objects (or objects that behave like files)\n\
2304 to these, it is possible to redirect all of the interpreter's I/O.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002305\n\
2306last_type -- type of last uncaught exception\n\
2307last_value -- value of last uncaught exception\n\
2308last_traceback -- traceback of last uncaught exception\n\
2309 These three are only available in an interactive session after a\n\
2310 traceback has been printed.\n\
Guido van Rossuma71b5f41999-01-14 19:07:00 +00002311"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002312)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002313/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002314PyDoc_STR(
Guido van Rossuma71b5f41999-01-14 19:07:00 +00002315"\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002316Static objects:\n\
2317\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002318builtin_module_names -- tuple of module names built into this interpreter\n\
2319copyright -- copyright notice pertaining to this interpreter\n\
2320exec_prefix -- prefix used to find the machine-specific Python library\n\
Petri Lehtinen4b0eab62012-02-02 21:23:15 +02002321executable -- absolute path of the executable binary of the Python interpreter\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002322float_info -- a struct sequence with information about the float implementation.\n\
2323float_repr_style -- string indicating the style of repr() output for floats\n\
Christian Heimes985ecdc2013-11-20 11:46:18 +01002324hash_info -- a struct sequence with information about the hash algorithm.\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002325hexversion -- version information encoded as a single integer\n\
Barry Warsaw409da152012-06-03 16:18:47 -04002326implementation -- Python implementation information.\n\
Mark Dickinsonbd792642009-03-18 20:06:12 +00002327int_info -- a struct sequence with information about the int implementation.\n\
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00002328maxsize -- the largest supported length of containers.\n\
Serhiy Storchakad3faf432015-01-18 11:28:37 +02002329maxunicode -- the value of the largest Unicode code point\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002330platform -- platform identifier\n\
2331prefix -- prefix used to find the Python library\n\
2332thread_info -- a struct sequence with information about the thread implementation.\n\
Fred Drake801c08d2000-04-13 15:29:10 +00002333version -- the version of this interpreter as a string\n\
Eric Smith0e5b5622009-02-06 01:32:42 +00002334version_info -- version information as a named tuple\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002335"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002336)
Steve Dowercc16be82016-09-08 10:35:16 -07002337#ifdef MS_COREDLL
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002338/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002339PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002340"dllhandle -- [Windows only] integer handle of the Python DLL\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002341winver -- [Windows only] version number of the Python DLL\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002342"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002343)
Steve Dowercc16be82016-09-08 10:35:16 -07002344#endif /* MS_COREDLL */
2345#ifdef MS_WINDOWS
2346/* concatenating string here */
2347PyDoc_STR(
oldkaa0735f2018-02-02 16:52:55 +08002348"_enablelegacywindowsfsencoding -- [Windows only]\n\
Steve Dowercc16be82016-09-08 10:35:16 -07002349"
2350)
2351#endif
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002352PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002353"__stdin__ -- the original stdin; don't touch!\n\
2354__stdout__ -- the original stdout; don't touch!\n\
2355__stderr__ -- the original stderr; don't touch!\n\
2356__displayhook__ -- the original displayhook; don't touch!\n\
2357__excepthook__ -- the original excepthook; don't touch!\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002358\n\
2359Functions:\n\
2360\n\
Georg Brandl1a3284e2007-12-02 09:40:06 +00002361displayhook() -- print an object to the screen, and save it in builtins._\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002362excepthook() -- print an exception and its traceback to sys.stderr\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002363exc_info() -- return thread-safe information about the current exception\n\
2364exit() -- exit the interpreter by raising SystemExit\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00002365getdlopenflags() -- returns flags to be used for dlopen() calls\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00002366getprofile() -- get the global profiling function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002367getrefcount() -- return the reference count for an object (plus one :-)\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00002368getrecursionlimit() -- return the max recursion depth for the interpreter\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00002369getsizeof() -- return the size of an object in bytes\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00002370gettrace() -- get the global debug tracing function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002371setcheckinterval() -- control how often the interpreter checks for events\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00002372setdlopenflags() -- set the flags to be used for dlopen() calls\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002373setprofile() -- set the global profiling function\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00002374setrecursionlimit() -- set the max recursion depth for the interpreter\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002375settrace() -- set the global debug tracing function\n\
Fred Drakeccede592000-08-14 20:59:57 +00002376"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002377)
Fred Drakeccede592000-08-14 20:59:57 +00002378/* end of sys_doc */ ;
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002379
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002380
2381PyDoc_STRVAR(flags__doc__,
2382"sys.flags\n\
2383\n\
2384Flags provided through command line arguments or environment vars.");
2385
2386static PyTypeObject FlagsType;
2387
2388static PyStructSequence_Field flags_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002389 {"debug", "-d"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002390 {"inspect", "-i"},
2391 {"interactive", "-i"},
2392 {"optimize", "-O or -OO"},
2393 {"dont_write_bytecode", "-B"},
2394 {"no_user_site", "-s"},
2395 {"no_site", "-S"},
2396 {"ignore_environment", "-E"},
2397 {"verbose", "-v"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002398 /* {"unbuffered", "-u"}, */
2399 /* {"skip_first", "-x"}, */
Georg Brandl8aa7e992010-12-28 18:30:18 +00002400 {"bytes_warning", "-b"},
2401 {"quiet", "-q"},
Georg Brandl09a7c722012-02-20 21:31:46 +01002402 {"hash_randomization", "-R"},
Christian Heimesad73a9c2013-08-10 16:36:18 +02002403 {"isolated", "-I"},
Victor Stinner5e3806f2017-11-30 11:40:24 +01002404 {"dev_mode", "-X dev"},
Victor Stinner91106cd2017-12-13 12:29:09 +01002405 {"utf8_mode", "-X utf8"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002406 {0}
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002407};
2408
2409static PyStructSequence_Desc flags_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002410 "sys.flags", /* name */
2411 flags__doc__, /* doc */
2412 flags_fields, /* fields */
Victor Stinner91106cd2017-12-13 12:29:09 +01002413 15
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002414};
2415
2416static PyObject*
Victor Stinner0fd2c302019-06-04 03:15:09 +02002417make_flags(_PyRuntimeState *runtime, PyInterpreterState *interp)
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002418{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002419 int pos = 0;
2420 PyObject *seq;
Victor Stinner331a6a52019-05-27 16:39:22 +02002421 const PyPreConfig *preconfig = &runtime->preconfig;
2422 const PyConfig *config = &interp->config;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002423
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002424 seq = PyStructSequence_New(&FlagsType);
2425 if (seq == NULL)
2426 return NULL;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002427
2428#define SetFlag(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002429 PyStructSequence_SET_ITEM(seq, pos++, PyLong_FromLong(flag))
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002430
Victor Stinnerfbca9082018-08-30 00:50:45 +02002431 SetFlag(config->parser_debug);
2432 SetFlag(config->inspect);
2433 SetFlag(config->interactive);
2434 SetFlag(config->optimization_level);
2435 SetFlag(!config->write_bytecode);
2436 SetFlag(!config->user_site_directory);
2437 SetFlag(!config->site_import);
Victor Stinner20004952019-03-26 02:31:11 +01002438 SetFlag(!config->use_environment);
Victor Stinnerfbca9082018-08-30 00:50:45 +02002439 SetFlag(config->verbose);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002440 /* SetFlag(saw_unbuffered_flag); */
2441 /* SetFlag(skipfirstline); */
Victor Stinnerfbca9082018-08-30 00:50:45 +02002442 SetFlag(config->bytes_warning);
2443 SetFlag(config->quiet);
2444 SetFlag(config->use_hash_seed == 0 || config->hash_seed != 0);
Victor Stinner20004952019-03-26 02:31:11 +01002445 SetFlag(config->isolated);
2446 PyStructSequence_SET_ITEM(seq, pos++, PyBool_FromLong(config->dev_mode));
2447 SetFlag(preconfig->utf8_mode);
Victor Stinner91106cd2017-12-13 12:29:09 +01002448#undef SetFlag
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002450 if (PyErr_Occurred()) {
Serhiy Storchaka87a854d2013-12-17 14:59:42 +02002451 Py_DECREF(seq);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002452 return NULL;
2453 }
2454 return seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002455}
2456
Eric Smith0e5b5622009-02-06 01:32:42 +00002457PyDoc_STRVAR(version_info__doc__,
2458"sys.version_info\n\
2459\n\
2460Version information as a named tuple.");
2461
2462static PyTypeObject VersionInfoType;
2463
2464static PyStructSequence_Field version_info_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002465 {"major", "Major release number"},
2466 {"minor", "Minor release number"},
2467 {"micro", "Patch release number"},
Ned Deilyda4887a2016-11-04 17:03:34 -04002468 {"releaselevel", "'alpha', 'beta', 'candidate', or 'final'"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 {"serial", "Serial release number"},
2470 {0}
Eric Smith0e5b5622009-02-06 01:32:42 +00002471};
2472
2473static PyStructSequence_Desc version_info_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002474 "sys.version_info", /* name */
2475 version_info__doc__, /* doc */
2476 version_info_fields, /* fields */
2477 5
Eric Smith0e5b5622009-02-06 01:32:42 +00002478};
2479
2480static PyObject *
2481make_version_info(void)
2482{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002483 PyObject *version_info;
2484 char *s;
2485 int pos = 0;
Eric Smith0e5b5622009-02-06 01:32:42 +00002486
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002487 version_info = PyStructSequence_New(&VersionInfoType);
2488 if (version_info == NULL) {
2489 return NULL;
2490 }
Eric Smith0e5b5622009-02-06 01:32:42 +00002491
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002492 /*
2493 * These release level checks are mutually exclusive and cover
2494 * the field, so don't get too fancy with the pre-processor!
2495 */
Eric Smith0e5b5622009-02-06 01:32:42 +00002496#if PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_ALPHA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002497 s = "alpha";
Eric Smith0e5b5622009-02-06 01:32:42 +00002498#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_BETA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002499 s = "beta";
Eric Smith0e5b5622009-02-06 01:32:42 +00002500#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_GAMMA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002501 s = "candidate";
Eric Smith0e5b5622009-02-06 01:32:42 +00002502#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_FINAL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002503 s = "final";
Eric Smith0e5b5622009-02-06 01:32:42 +00002504#endif
2505
2506#define SetIntItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002507 PyStructSequence_SET_ITEM(version_info, pos++, PyLong_FromLong(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00002508#define SetStrItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002509 PyStructSequence_SET_ITEM(version_info, pos++, PyUnicode_FromString(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00002510
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002511 SetIntItem(PY_MAJOR_VERSION);
2512 SetIntItem(PY_MINOR_VERSION);
2513 SetIntItem(PY_MICRO_VERSION);
2514 SetStrItem(s);
2515 SetIntItem(PY_RELEASE_SERIAL);
Eric Smith0e5b5622009-02-06 01:32:42 +00002516#undef SetIntItem
2517#undef SetStrItem
2518
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002519 if (PyErr_Occurred()) {
2520 Py_CLEAR(version_info);
2521 return NULL;
2522 }
2523 return version_info;
Eric Smith0e5b5622009-02-06 01:32:42 +00002524}
2525
Brett Cannon3adc7b72012-07-09 14:22:12 -04002526/* sys.implementation values */
2527#define NAME "cpython"
2528const char *_PySys_ImplName = NAME;
Victor Stinnercf01b682015-11-05 11:21:38 +01002529#define MAJOR Py_STRINGIFY(PY_MAJOR_VERSION)
2530#define MINOR Py_STRINGIFY(PY_MINOR_VERSION)
Ned Deily529ea5d2014-06-30 23:31:14 -07002531#define TAG NAME "-" MAJOR MINOR
Brett Cannon3adc7b72012-07-09 14:22:12 -04002532const char *_PySys_ImplCacheTag = TAG;
2533#undef NAME
Brett Cannon3adc7b72012-07-09 14:22:12 -04002534#undef MAJOR
2535#undef MINOR
2536#undef TAG
2537
Barry Warsaw409da152012-06-03 16:18:47 -04002538static PyObject *
2539make_impl_info(PyObject *version_info)
2540{
2541 int res;
2542 PyObject *impl_info, *value, *ns;
2543
2544 impl_info = PyDict_New();
2545 if (impl_info == NULL)
2546 return NULL;
2547
2548 /* populate the dict */
2549
Brett Cannon3adc7b72012-07-09 14:22:12 -04002550 value = PyUnicode_FromString(_PySys_ImplName);
Barry Warsaw409da152012-06-03 16:18:47 -04002551 if (value == NULL)
2552 goto error;
2553 res = PyDict_SetItemString(impl_info, "name", value);
2554 Py_DECREF(value);
2555 if (res < 0)
2556 goto error;
2557
Brett Cannon3adc7b72012-07-09 14:22:12 -04002558 value = PyUnicode_FromString(_PySys_ImplCacheTag);
Barry Warsaw409da152012-06-03 16:18:47 -04002559 if (value == NULL)
2560 goto error;
2561 res = PyDict_SetItemString(impl_info, "cache_tag", value);
2562 Py_DECREF(value);
2563 if (res < 0)
2564 goto error;
Barry Warsaw409da152012-06-03 16:18:47 -04002565
2566 res = PyDict_SetItemString(impl_info, "version", version_info);
2567 if (res < 0)
2568 goto error;
2569
2570 value = PyLong_FromLong(PY_VERSION_HEX);
2571 if (value == NULL)
2572 goto error;
2573 res = PyDict_SetItemString(impl_info, "hexversion", value);
2574 Py_DECREF(value);
2575 if (res < 0)
2576 goto error;
2577
doko@ubuntu.com55532312016-06-14 08:55:19 +02002578#ifdef MULTIARCH
2579 value = PyUnicode_FromString(MULTIARCH);
2580 if (value == NULL)
2581 goto error;
2582 res = PyDict_SetItemString(impl_info, "_multiarch", value);
2583 Py_DECREF(value);
2584 if (res < 0)
2585 goto error;
2586#endif
2587
Barry Warsaw409da152012-06-03 16:18:47 -04002588 /* dict ready */
2589
2590 ns = _PyNamespace_New(impl_info);
2591 Py_DECREF(impl_info);
2592 return ns;
2593
2594error:
2595 Py_CLEAR(impl_info);
2596 return NULL;
2597}
2598
Martin v. Löwis1a214512008-06-11 05:26:20 +00002599static struct PyModuleDef sysmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002600 PyModuleDef_HEAD_INIT,
2601 "sys",
2602 sys_doc,
2603 -1, /* multiple "initialization" just copies the module dict. */
2604 sys_methods,
2605 NULL,
2606 NULL,
2607 NULL,
2608 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00002609};
2610
Eric Snow6b4be192017-05-22 21:36:03 -07002611/* Updating the sys namespace, returning NULL pointer on error */
Victor Stinner8fea2522013-10-27 17:15:42 +01002612#define SET_SYS_FROM_STRING_BORROW(key, value) \
Victor Stinner58049602013-07-22 22:40:00 +02002613 do { \
Victor Stinner58049602013-07-22 22:40:00 +02002614 PyObject *v = (value); \
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002615 if (v == NULL) { \
2616 goto err_occurred; \
2617 } \
Victor Stinner58049602013-07-22 22:40:00 +02002618 res = PyDict_SetItemString(sysdict, key, v); \
2619 if (res < 0) { \
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002620 goto err_occurred; \
Victor Stinner8fea2522013-10-27 17:15:42 +01002621 } \
2622 } while (0)
2623#define SET_SYS_FROM_STRING(key, value) \
2624 do { \
Victor Stinner8fea2522013-10-27 17:15:42 +01002625 PyObject *v = (value); \
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002626 if (v == NULL) { \
2627 goto err_occurred; \
2628 } \
Victor Stinner8fea2522013-10-27 17:15:42 +01002629 res = PyDict_SetItemString(sysdict, key, v); \
2630 Py_DECREF(v); \
2631 if (res < 0) { \
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002632 goto err_occurred; \
Victor Stinner58049602013-07-22 22:40:00 +02002633 } \
2634 } while (0)
Guido van Rossum25ce5661997-08-02 03:10:38 +00002635
Victor Stinner331a6a52019-05-27 16:39:22 +02002636static PyStatus
Victor Stinner0fd2c302019-06-04 03:15:09 +02002637_PySys_InitCore(_PyRuntimeState *runtime, PyInterpreterState *interp,
2638 PyObject *sysdict)
Eric Snow6b4be192017-05-22 21:36:03 -07002639{
Victor Stinnerab672812019-01-23 15:04:40 +01002640 PyObject *version_info;
Eric Snow6b4be192017-05-22 21:36:03 -07002641 int res;
2642
Nick Coghland6009512014-11-20 21:39:37 +10002643 /* stdin/stdout/stderr are set in pylifecycle.c */
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002644
Victor Stinner8fea2522013-10-27 17:15:42 +01002645 SET_SYS_FROM_STRING_BORROW("__displayhook__",
2646 PyDict_GetItemString(sysdict, "displayhook"));
2647 SET_SYS_FROM_STRING_BORROW("__excepthook__",
2648 PyDict_GetItemString(sysdict, "excepthook"));
Barry Warsaw36c1d1f2017-10-05 12:11:18 -04002649 SET_SYS_FROM_STRING_BORROW(
2650 "__breakpointhook__",
2651 PyDict_GetItemString(sysdict, "breakpointhook"));
Victor Stinneref9d9b62019-05-22 11:28:22 +02002652 SET_SYS_FROM_STRING_BORROW("__unraisablehook__",
2653 PyDict_GetItemString(sysdict, "unraisablehook"));
2654
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002655 SET_SYS_FROM_STRING("version",
2656 PyUnicode_FromString(Py_GetVersion()));
2657 SET_SYS_FROM_STRING("hexversion",
2658 PyLong_FromLong(PY_VERSION_HEX));
Ned Deily5c4b0d02017-03-04 00:19:55 -05002659 SET_SYS_FROM_STRING("_git",
2660 Py_BuildValue("(szz)", "CPython", _Py_gitidentifier(),
2661 _Py_gitversion()));
INADA Naoki6b42eb12017-06-29 15:31:38 +09002662 SET_SYS_FROM_STRING("_framework", PyUnicode_FromString(_PYTHONFRAMEWORK));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002663 SET_SYS_FROM_STRING("api_version",
2664 PyLong_FromLong(PYTHON_API_VERSION));
2665 SET_SYS_FROM_STRING("copyright",
2666 PyUnicode_FromString(Py_GetCopyright()));
2667 SET_SYS_FROM_STRING("platform",
2668 PyUnicode_FromString(Py_GetPlatform()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002669 SET_SYS_FROM_STRING("maxsize",
2670 PyLong_FromSsize_t(PY_SSIZE_T_MAX));
2671 SET_SYS_FROM_STRING("float_info",
2672 PyFloat_GetInfo());
2673 SET_SYS_FROM_STRING("int_info",
2674 PyLong_GetInfo());
Mark Dickinsondc787d22010-05-23 13:33:13 +00002675 /* initialize hash_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002676 if (Hash_InfoType.tp_name == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002677 if (PyStructSequence_InitType2(&Hash_InfoType, &hash_info_desc) < 0) {
2678 goto type_init_failed;
2679 }
Victor Stinner1c8f0592013-07-22 22:24:54 +02002680 }
Mark Dickinsondc787d22010-05-23 13:33:13 +00002681 SET_SYS_FROM_STRING("hash_info",
2682 get_hash_info());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002683 SET_SYS_FROM_STRING("maxunicode",
Ezio Melotti48a2f8f2011-09-29 00:18:19 +03002684 PyLong_FromLong(0x10FFFF));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002685 SET_SYS_FROM_STRING("builtin_module_names",
2686 list_builtin_module_names());
Christian Heimes743e0cd2012-10-17 23:52:17 +02002687#if PY_BIG_ENDIAN
2688 SET_SYS_FROM_STRING("byteorder",
2689 PyUnicode_FromString("big"));
2690#else
2691 SET_SYS_FROM_STRING("byteorder",
2692 PyUnicode_FromString("little"));
2693#endif
Fred Drake099325e2000-08-14 15:47:03 +00002694
Guido van Rossum8b9ea871996-08-23 18:14:47 +00002695#ifdef MS_COREDLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002696 SET_SYS_FROM_STRING("dllhandle",
2697 PyLong_FromVoidPtr(PyWin_DLLhModule));
2698 SET_SYS_FROM_STRING("winver",
2699 PyUnicode_FromString(PyWin_DLLVersionString));
Guido van Rossumc606fe11996-04-09 02:37:57 +00002700#endif
Barry Warsaw8cf4eae2010-10-16 01:04:07 +00002701#ifdef ABIFLAGS
2702 SET_SYS_FROM_STRING("abiflags",
2703 PyUnicode_FromString(ABIFLAGS));
2704#endif
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002705
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002706 /* version_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002707 if (VersionInfoType.tp_name == NULL) {
2708 if (PyStructSequence_InitType2(&VersionInfoType,
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002709 &version_info_desc) < 0) {
2710 goto type_init_failed;
2711 }
Victor Stinner1c8f0592013-07-22 22:24:54 +02002712 }
Barry Warsaw409da152012-06-03 16:18:47 -04002713 version_info = make_version_info();
2714 SET_SYS_FROM_STRING("version_info", version_info);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002715 /* prevent user from creating new instances */
2716 VersionInfoType.tp_init = NULL;
2717 VersionInfoType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02002718 res = PyDict_DelItemString(VersionInfoType.tp_dict, "__new__");
2719 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError))
2720 PyErr_Clear();
Eric Smith0e5b5622009-02-06 01:32:42 +00002721
Barry Warsaw409da152012-06-03 16:18:47 -04002722 /* implementation */
2723 SET_SYS_FROM_STRING("implementation", make_impl_info(version_info));
2724
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002725 /* flags */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002726 if (FlagsType.tp_name == 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002727 if (PyStructSequence_InitType2(&FlagsType, &flags_desc) < 0) {
2728 goto type_init_failed;
2729 }
Victor Stinner1c8f0592013-07-22 22:24:54 +02002730 }
Victor Stinner43125222019-04-24 18:23:53 +02002731 /* Set flags to their default values (updated by _PySys_InitMain()) */
Victor Stinner0fd2c302019-06-04 03:15:09 +02002732 SET_SYS_FROM_STRING("flags", make_flags(runtime, interp));
Eric Smithf7bb5782010-01-27 00:44:57 +00002733
2734#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002735 /* getwindowsversion */
2736 if (WindowsVersionType.tp_name == 0)
Victor Stinner1c8f0592013-07-22 22:24:54 +02002737 if (PyStructSequence_InitType2(&WindowsVersionType,
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002738 &windows_version_desc) < 0) {
2739 goto type_init_failed;
2740 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002741 /* prevent user from creating new instances */
2742 WindowsVersionType.tp_init = NULL;
2743 WindowsVersionType.tp_new = NULL;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002744 assert(!PyErr_Occurred());
Antoine Pitrou871dfc42014-04-28 13:07:06 +02002745 res = PyDict_DelItemString(WindowsVersionType.tp_dict, "__new__");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002746 if (res < 0 && PyErr_ExceptionMatches(PyExc_KeyError)) {
Antoine Pitrou871dfc42014-04-28 13:07:06 +02002747 PyErr_Clear();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002748 }
Eric Smithf7bb5782010-01-27 00:44:57 +00002749#endif
2750
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002751 /* float repr style: 0.03 (short) vs 0.029999999999999999 (legacy) */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002752#ifndef PY_NO_SHORT_FLOAT_REPR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002753 SET_SYS_FROM_STRING("float_repr_style",
2754 PyUnicode_FromString("short"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002755#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002756 SET_SYS_FROM_STRING("float_repr_style",
2757 PyUnicode_FromString("legacy"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002758#endif
2759
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002760 SET_SYS_FROM_STRING("thread_info", PyThread_GetInfo());
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002761
Yury Selivanoveb636452016-09-08 22:01:51 -07002762 /* initialize asyncgen_hooks */
2763 if (AsyncGenHooksType.tp_name == NULL) {
2764 if (PyStructSequence_InitType2(
2765 &AsyncGenHooksType, &asyncgen_hooks_desc) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002766 goto type_init_failed;
Yury Selivanoveb636452016-09-08 22:01:51 -07002767 }
2768 }
2769
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002770 if (PyErr_Occurred()) {
2771 goto err_occurred;
2772 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002773 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002774
2775type_init_failed:
Victor Stinner331a6a52019-05-27 16:39:22 +02002776 return _PyStatus_ERR("failed to initialize a type");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002777
2778err_occurred:
Victor Stinner331a6a52019-05-27 16:39:22 +02002779 return _PyStatus_ERR("can't initialize sys module");
Guido van Rossum5b3138b1990-11-18 17:41:40 +00002780}
2781
Eric Snow6b4be192017-05-22 21:36:03 -07002782#undef SET_SYS_FROM_STRING
Eric Snow6b4be192017-05-22 21:36:03 -07002783
2784/* Updating the sys namespace, returning integer error codes */
Eric Snow6b4be192017-05-22 21:36:03 -07002785#define SET_SYS_FROM_STRING_INT_RESULT(key, value) \
2786 do { \
2787 PyObject *v = (value); \
2788 if (v == NULL) \
2789 return -1; \
2790 res = PyDict_SetItemString(sysdict, key, v); \
2791 Py_DECREF(v); \
2792 if (res < 0) { \
2793 return res; \
2794 } \
2795 } while (0)
2796
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002797
2798static int
2799sys_add_xoption(PyObject *opts, const wchar_t *s)
2800{
2801 PyObject *name, *value;
2802
2803 const wchar_t *name_end = wcschr(s, L'=');
2804 if (!name_end) {
2805 name = PyUnicode_FromWideChar(s, -1);
2806 value = Py_True;
2807 Py_INCREF(value);
2808 }
2809 else {
2810 name = PyUnicode_FromWideChar(s, name_end - s);
2811 value = PyUnicode_FromWideChar(name_end + 1, -1);
2812 }
2813 if (name == NULL || value == NULL) {
2814 goto error;
2815 }
2816 if (PyDict_SetItem(opts, name, value) < 0) {
2817 goto error;
2818 }
2819 Py_DECREF(name);
2820 Py_DECREF(value);
2821 return 0;
2822
2823error:
2824 Py_XDECREF(name);
2825 Py_XDECREF(value);
2826 return -1;
2827}
2828
2829
2830static PyObject*
Victor Stinner331a6a52019-05-27 16:39:22 +02002831sys_create_xoptions_dict(const PyConfig *config)
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002832{
2833 Py_ssize_t nxoption = config->xoptions.length;
2834 wchar_t * const * xoptions = config->xoptions.items;
2835 PyObject *dict = PyDict_New();
2836 if (dict == NULL) {
2837 return NULL;
2838 }
2839
2840 for (Py_ssize_t i=0; i < nxoption; i++) {
2841 const wchar_t *option = xoptions[i];
2842 if (sys_add_xoption(dict, option) < 0) {
2843 Py_DECREF(dict);
2844 return NULL;
2845 }
2846 }
2847
2848 return dict;
2849}
2850
2851
Eric Snow6b4be192017-05-22 21:36:03 -07002852int
Victor Stinner0fd2c302019-06-04 03:15:09 +02002853_PySys_InitMain(_PyRuntimeState *runtime, PyInterpreterState *interp)
Eric Snow6b4be192017-05-22 21:36:03 -07002854{
Victor Stinnerab672812019-01-23 15:04:40 +01002855 PyObject *sysdict = interp->sysdict;
Victor Stinner331a6a52019-05-27 16:39:22 +02002856 const PyConfig *config = &interp->config;
Eric Snow6b4be192017-05-22 21:36:03 -07002857 int res;
2858
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002859#define COPY_LIST(KEY, VALUE) \
Victor Stinner37cd9822018-11-16 11:55:35 +01002860 do { \
Victor Stinner331a6a52019-05-27 16:39:22 +02002861 PyObject *list = _PyWideStringList_AsList(&(VALUE)); \
Victor Stinner37cd9822018-11-16 11:55:35 +01002862 if (list == NULL) { \
2863 return -1; \
2864 } \
2865 SET_SYS_FROM_STRING_BORROW(KEY, list); \
2866 Py_DECREF(list); \
2867 } while (0)
2868
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002869#define SET_SYS_FROM_WSTR(KEY, VALUE) \
2870 do { \
2871 PyObject *str = PyUnicode_FromWideChar(VALUE, -1); \
2872 if (str == NULL) { \
2873 return -1; \
2874 } \
2875 SET_SYS_FROM_STRING_BORROW(KEY, str); \
2876 Py_DECREF(str); \
2877 } while (0)
Victor Stinner37cd9822018-11-16 11:55:35 +01002878
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002879 COPY_LIST("path", config->module_search_paths);
2880
2881 SET_SYS_FROM_WSTR("executable", config->executable);
Steve Dower323e7432019-06-29 14:28:59 -07002882 SET_SYS_FROM_WSTR("_base_executable", config->base_executable);
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002883 SET_SYS_FROM_WSTR("prefix", config->prefix);
2884 SET_SYS_FROM_WSTR("base_prefix", config->base_prefix);
2885 SET_SYS_FROM_WSTR("exec_prefix", config->exec_prefix);
2886 SET_SYS_FROM_WSTR("base_exec_prefix", config->base_exec_prefix);
Victor Stinner41264f12017-12-15 02:05:29 +01002887
Carl Meyerb193fa92018-06-15 22:40:56 -06002888 if (config->pycache_prefix != NULL) {
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002889 SET_SYS_FROM_WSTR("pycache_prefix", config->pycache_prefix);
Carl Meyerb193fa92018-06-15 22:40:56 -06002890 } else {
2891 PyDict_SetItemString(sysdict, "pycache_prefix", Py_None);
2892 }
2893
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002894 COPY_LIST("argv", config->argv);
2895 COPY_LIST("warnoptions", config->warnoptions);
2896
2897 PyObject *xoptions = sys_create_xoptions_dict(config);
2898 if (xoptions == NULL) {
2899 return -1;
Victor Stinner41264f12017-12-15 02:05:29 +01002900 }
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002901 SET_SYS_FROM_STRING_BORROW("_xoptions", xoptions);
Pablo Galindo34ef64f2019-03-27 12:43:47 +00002902 Py_DECREF(xoptions);
Victor Stinner41264f12017-12-15 02:05:29 +01002903
Victor Stinner37cd9822018-11-16 11:55:35 +01002904#undef COPY_LIST
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002905#undef SET_SYS_FROM_WSTR
Victor Stinner37cd9822018-11-16 11:55:35 +01002906
Eric Snow6b4be192017-05-22 21:36:03 -07002907 /* Set flags to their final values */
Victor Stinner0fd2c302019-06-04 03:15:09 +02002908 SET_SYS_FROM_STRING_INT_RESULT("flags", make_flags(runtime, interp));
Eric Snow6b4be192017-05-22 21:36:03 -07002909 /* prevent user from creating new instances */
2910 FlagsType.tp_init = NULL;
2911 FlagsType.tp_new = NULL;
2912 res = PyDict_DelItemString(FlagsType.tp_dict, "__new__");
2913 if (res < 0) {
2914 if (!PyErr_ExceptionMatches(PyExc_KeyError)) {
2915 return res;
2916 }
2917 PyErr_Clear();
2918 }
2919
2920 SET_SYS_FROM_STRING_INT_RESULT("dont_write_bytecode",
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002921 PyBool_FromLong(!config->write_bytecode));
Eric Snow6b4be192017-05-22 21:36:03 -07002922
Eric Snowdae02762017-09-14 00:35:58 -07002923 if (get_warnoptions() == NULL)
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002924 return -1;
Victor Stinner865de272017-06-08 13:27:47 +02002925
Eric Snowdae02762017-09-14 00:35:58 -07002926 if (get_xoptions() == NULL)
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002927 return -1;
Eric Snow6b4be192017-05-22 21:36:03 -07002928
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002929 /* Transfer any sys.warnoptions and sys._xoptions set directly
2930 * by an embedding application from the linked list to the module. */
2931 if (_PySys_ReadPreInitOptions() != 0)
2932 return -1;
2933
Eric Snow6b4be192017-05-22 21:36:03 -07002934 if (PyErr_Occurred())
2935 return -1;
2936 return 0;
Victor Stinner41264f12017-12-15 02:05:29 +01002937
2938err_occurred:
2939 return -1;
Eric Snow6b4be192017-05-22 21:36:03 -07002940}
2941
Victor Stinner41264f12017-12-15 02:05:29 +01002942#undef SET_SYS_FROM_STRING_BORROW
Eric Snow6b4be192017-05-22 21:36:03 -07002943#undef SET_SYS_FROM_STRING_INT_RESULT
Eric Snow6b4be192017-05-22 21:36:03 -07002944
Victor Stinnerab672812019-01-23 15:04:40 +01002945
2946/* Set up a preliminary stderr printer until we have enough
2947 infrastructure for the io module in place.
2948
2949 Use UTF-8/surrogateescape and ignore EAGAIN errors. */
Victor Stinner331a6a52019-05-27 16:39:22 +02002950PyStatus
Victor Stinnerab672812019-01-23 15:04:40 +01002951_PySys_SetPreliminaryStderr(PyObject *sysdict)
2952{
2953 PyObject *pstderr = PyFile_NewStdPrinter(fileno(stderr));
2954 if (pstderr == NULL) {
2955 goto error;
2956 }
2957 if (_PyDict_SetItemId(sysdict, &PyId_stderr, pstderr) < 0) {
2958 goto error;
2959 }
2960 if (PyDict_SetItemString(sysdict, "__stderr__", pstderr) < 0) {
2961 goto error;
2962 }
2963 Py_DECREF(pstderr);
Victor Stinner331a6a52019-05-27 16:39:22 +02002964 return _PyStatus_OK();
Victor Stinnerab672812019-01-23 15:04:40 +01002965
2966error:
2967 Py_XDECREF(pstderr);
Victor Stinner331a6a52019-05-27 16:39:22 +02002968 return _PyStatus_ERR("can't set preliminary stderr");
Victor Stinnerab672812019-01-23 15:04:40 +01002969}
2970
2971
2972/* Create sys module without all attributes: _PySys_InitMain() should be called
2973 later to add remaining attributes. */
Victor Stinner331a6a52019-05-27 16:39:22 +02002974PyStatus
Victor Stinner0fd2c302019-06-04 03:15:09 +02002975_PySys_Create(_PyRuntimeState *runtime, PyInterpreterState *interp,
2976 PyObject **sysmod_p)
Victor Stinnerab672812019-01-23 15:04:40 +01002977{
2978 PyObject *modules = PyDict_New();
2979 if (modules == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002980 return _PyStatus_ERR("can't make modules dictionary");
Victor Stinnerab672812019-01-23 15:04:40 +01002981 }
2982 interp->modules = modules;
2983
2984 PyObject *sysmod = _PyModule_CreateInitialized(&sysmodule, PYTHON_API_VERSION);
2985 if (sysmod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002986 return _PyStatus_ERR("failed to create a module object");
Victor Stinnerab672812019-01-23 15:04:40 +01002987 }
2988
2989 PyObject *sysdict = PyModule_GetDict(sysmod);
2990 if (sysdict == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002991 return _PyStatus_ERR("can't initialize sys dict");
Victor Stinnerab672812019-01-23 15:04:40 +01002992 }
2993 Py_INCREF(sysdict);
2994 interp->sysdict = sysdict;
2995
2996 if (PyDict_SetItemString(sysdict, "modules", interp->modules) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002997 return _PyStatus_ERR("can't initialize sys module");
Victor Stinnerab672812019-01-23 15:04:40 +01002998 }
2999
Victor Stinner331a6a52019-05-27 16:39:22 +02003000 PyStatus status = _PySys_SetPreliminaryStderr(sysdict);
3001 if (_PyStatus_EXCEPTION(status)) {
3002 return status;
Victor Stinnerab672812019-01-23 15:04:40 +01003003 }
3004
Victor Stinner0fd2c302019-06-04 03:15:09 +02003005 status = _PySys_InitCore(runtime, interp, sysdict);
Victor Stinner331a6a52019-05-27 16:39:22 +02003006 if (_PyStatus_EXCEPTION(status)) {
3007 return status;
Victor Stinnerab672812019-01-23 15:04:40 +01003008 }
3009
3010 _PyImport_FixupBuiltin(sysmod, "sys", interp->modules);
3011
3012 *sysmod_p = sysmod;
Victor Stinner331a6a52019-05-27 16:39:22 +02003013 return _PyStatus_OK();
Victor Stinnerab672812019-01-23 15:04:40 +01003014}
3015
3016
Guido van Rossum65bf9f21997-04-29 18:33:38 +00003017static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00003018makepathobject(const wchar_t *path, wchar_t delim)
Guido van Rossum5b3138b1990-11-18 17:41:40 +00003019{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003020 int i, n;
3021 const wchar_t *p;
3022 PyObject *v, *w;
Tim Peters216b78b2006-01-06 02:40:53 +00003023
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003024 n = 1;
3025 p = path;
3026 while ((p = wcschr(p, delim)) != NULL) {
3027 n++;
3028 p++;
3029 }
3030 v = PyList_New(n);
3031 if (v == NULL)
3032 return NULL;
3033 for (i = 0; ; i++) {
3034 p = wcschr(path, delim);
3035 if (p == NULL)
3036 p = path + wcslen(path); /* End of string */
3037 w = PyUnicode_FromWideChar(path, (Py_ssize_t)(p - path));
3038 if (w == NULL) {
3039 Py_DECREF(v);
3040 return NULL;
3041 }
Zackery Spytz99d56b52018-12-08 07:16:55 -07003042 PyList_SET_ITEM(v, i, w);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003043 if (*p == '\0')
3044 break;
3045 path = p+1;
3046 }
3047 return v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003048}
3049
3050void
Martin v. Löwis790465f2008-04-05 20:41:37 +00003051PySys_SetPath(const wchar_t *path)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003052{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003053 PyObject *v;
3054 if ((v = makepathobject(path, DELIM)) == NULL)
3055 Py_FatalError("can't create sys.path");
Victor Stinnerbd303c12013-11-07 23:07:29 +01003056 if (_PySys_SetObjectId(&PyId_path, v) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003057 Py_FatalError("can't assign sys.path");
3058 Py_DECREF(v);
Guido van Rossum3f5da241990-12-20 15:06:42 +00003059}
3060
Guido van Rossum65bf9f21997-04-29 18:33:38 +00003061static PyObject *
Victor Stinner74f65682019-03-15 15:08:05 +01003062make_sys_argv(int argc, wchar_t * const * argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00003063{
Victor Stinner74f65682019-03-15 15:08:05 +01003064 PyObject *list = PyList_New(argc);
3065 if (list == NULL) {
3066 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003067 }
Victor Stinner74f65682019-03-15 15:08:05 +01003068
3069 for (Py_ssize_t i = 0; i < argc; i++) {
3070 PyObject *v = PyUnicode_FromWideChar(argv[i], -1);
3071 if (v == NULL) {
3072 Py_DECREF(list);
3073 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003074 }
Victor Stinner74f65682019-03-15 15:08:05 +01003075 PyList_SET_ITEM(list, i, v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003076 }
Victor Stinner74f65682019-03-15 15:08:05 +01003077 return list;
Guido van Rossum3f5da241990-12-20 15:06:42 +00003078}
3079
Victor Stinner11a247d2017-12-13 21:05:57 +01003080void
3081PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)
Victor Stinnerd5dda982017-12-13 17:31:16 +01003082{
Victor Stinner74f65682019-03-15 15:08:05 +01003083 if (argc < 1 || argv == NULL) {
3084 /* Ensure at least one (empty) argument is seen */
3085 wchar_t* empty_argv[1] = {L""};
3086 argv = empty_argv;
3087 argc = 1;
3088 }
3089
3090 PyObject *av = make_sys_argv(argc, argv);
Victor Stinnerd5dda982017-12-13 17:31:16 +01003091 if (av == NULL) {
Victor Stinner11a247d2017-12-13 21:05:57 +01003092 Py_FatalError("no mem for sys.argv");
Victor Stinnerd5dda982017-12-13 17:31:16 +01003093 }
3094 if (PySys_SetObject("argv", av) != 0) {
3095 Py_DECREF(av);
Victor Stinner11a247d2017-12-13 21:05:57 +01003096 Py_FatalError("can't assign sys.argv");
Victor Stinnerd5dda982017-12-13 17:31:16 +01003097 }
3098 Py_DECREF(av);
3099
3100 if (updatepath) {
3101 /* If argv[0] is not '-c' nor '-m', prepend argv[0] to sys.path.
3102 If argv[0] is a symlink, use the real path. */
Victor Stinner331a6a52019-05-27 16:39:22 +02003103 const PyWideStringList argv_list = {.length = argc, .items = argv};
Victor Stinnerdcf61712019-03-19 16:09:27 +01003104 PyObject *path0 = NULL;
3105 if (_PyPathConfig_ComputeSysPath0(&argv_list, &path0)) {
3106 if (path0 == NULL) {
3107 Py_FatalError("can't compute path0 from argv");
Victor Stinner11a247d2017-12-13 21:05:57 +01003108 }
Victor Stinnerdcf61712019-03-19 16:09:27 +01003109
3110 PyObject *sys_path = _PySys_GetObjectId(&PyId_path);
3111 if (sys_path != NULL) {
3112 if (PyList_Insert(sys_path, 0, path0) < 0) {
3113 Py_DECREF(path0);
3114 Py_FatalError("can't prepend path0 to sys.path");
3115 }
3116 }
3117 Py_DECREF(path0);
Victor Stinner11a247d2017-12-13 21:05:57 +01003118 }
Victor Stinnerd5dda982017-12-13 17:31:16 +01003119 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003120}
Guido van Rossuma890e681998-05-12 14:59:24 +00003121
Antoine Pitrouf978fac2010-05-21 17:25:34 +00003122void
3123PySys_SetArgv(int argc, wchar_t **argv)
3124{
Christian Heimesad73a9c2013-08-10 16:36:18 +02003125 PySys_SetArgvEx(argc, argv, Py_IsolatedFlag == 0);
Antoine Pitrouf978fac2010-05-21 17:25:34 +00003126}
3127
Victor Stinner14284c22010-04-23 12:02:30 +00003128/* Reimplementation of PyFile_WriteString() no calling indirectly
3129 PyErr_CheckSignals(): avoid the call to PyObject_Str(). */
3130
3131static int
Victor Stinner79766632010-08-16 17:36:42 +00003132sys_pyfile_write_unicode(PyObject *unicode, PyObject *file)
Victor Stinner14284c22010-04-23 12:02:30 +00003133{
Victor Stinnerc3ccaae2016-08-20 01:24:22 +02003134 PyObject *writer = NULL, *result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003135 int err;
Victor Stinner14284c22010-04-23 12:02:30 +00003136
Victor Stinnerecccc4f2010-06-08 20:46:00 +00003137 if (file == NULL)
3138 return -1;
3139
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003140 writer = _PyObject_GetAttrId(file, &PyId_write);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003141 if (writer == NULL)
3142 goto error;
Victor Stinner14284c22010-04-23 12:02:30 +00003143
Victor Stinner7bfb42d2016-12-05 17:04:32 +01003144 result = PyObject_CallFunctionObjArgs(writer, unicode, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003145 if (result == NULL) {
3146 goto error;
3147 } else {
3148 err = 0;
3149 goto finally;
3150 }
Victor Stinner14284c22010-04-23 12:02:30 +00003151
3152error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003153 err = -1;
Victor Stinner14284c22010-04-23 12:02:30 +00003154finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003155 Py_XDECREF(writer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003156 Py_XDECREF(result);
3157 return err;
Victor Stinner14284c22010-04-23 12:02:30 +00003158}
3159
Victor Stinner79766632010-08-16 17:36:42 +00003160static int
3161sys_pyfile_write(const char *text, PyObject *file)
3162{
3163 PyObject *unicode = NULL;
3164 int err;
3165
3166 if (file == NULL)
3167 return -1;
3168
3169 unicode = PyUnicode_FromString(text);
3170 if (unicode == NULL)
3171 return -1;
3172
3173 err = sys_pyfile_write_unicode(unicode, file);
3174 Py_DECREF(unicode);
3175 return err;
3176}
Guido van Rossuma890e681998-05-12 14:59:24 +00003177
3178/* APIs to write to sys.stdout or sys.stderr using a printf-like interface.
3179 Adapted from code submitted by Just van Rossum.
3180
3181 PySys_WriteStdout(format, ...)
3182 PySys_WriteStderr(format, ...)
3183
3184 The first function writes to sys.stdout; the second to sys.stderr. When
3185 there is a problem, they write to the real (C level) stdout or stderr;
Guido van Rossum8442af31998-10-12 18:22:10 +00003186 no exceptions are raised.
Guido van Rossuma890e681998-05-12 14:59:24 +00003187
Victor Stinner14284c22010-04-23 12:02:30 +00003188 PyErr_CheckSignals() is not called to avoid the execution of the Python
Victor Stinner79766632010-08-16 17:36:42 +00003189 signal handlers: they may raise a new exception whereas sys_write()
3190 ignores all exceptions.
Victor Stinner14284c22010-04-23 12:02:30 +00003191
Guido van Rossuma890e681998-05-12 14:59:24 +00003192 Both take a printf-style format string as their first argument followed
3193 by a variable length argument list determined by the format string.
3194
3195 *** WARNING ***
3196
3197 The format should limit the total size of the formatted output string to
3198 1000 bytes. In particular, this means that no unrestricted "%s" formats
3199 should occur; these should be limited using "%.<N>s where <N> is a
3200 decimal number calculated so that <N> plus the maximum size of other
3201 formatted text does not exceed 1000 bytes. Also watch out for "%f",
3202 which can print hundreds of digits for very large numbers.
3203
3204 */
3205
3206static void
Victor Stinner09054372013-11-06 22:41:44 +01003207sys_write(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Guido van Rossuma890e681998-05-12 14:59:24 +00003208{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003209 PyObject *file;
3210 PyObject *error_type, *error_value, *error_traceback;
3211 char buffer[1001];
3212 int written;
Guido van Rossuma890e681998-05-12 14:59:24 +00003213
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003214 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Victor Stinner09054372013-11-06 22:41:44 +01003215 file = _PySys_GetObjectId(key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003216 written = PyOS_vsnprintf(buffer, sizeof(buffer), format, va);
3217 if (sys_pyfile_write(buffer, file) != 0) {
3218 PyErr_Clear();
3219 fputs(buffer, fp);
3220 }
3221 if (written < 0 || (size_t)written >= sizeof(buffer)) {
3222 const char *truncated = "... truncated";
Victor Stinner79766632010-08-16 17:36:42 +00003223 if (sys_pyfile_write(truncated, file) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003224 fputs(truncated, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003225 }
3226 PyErr_Restore(error_type, error_value, error_traceback);
Guido van Rossuma890e681998-05-12 14:59:24 +00003227}
3228
3229void
Guido van Rossuma890e681998-05-12 14:59:24 +00003230PySys_WriteStdout(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00003231{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003232 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00003233
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003234 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01003235 sys_write(&PyId_stdout, stdout, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003236 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00003237}
3238
3239void
Guido van Rossuma890e681998-05-12 14:59:24 +00003240PySys_WriteStderr(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00003241{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003242 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00003243
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003244 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01003245 sys_write(&PyId_stderr, stderr, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00003246 va_end(va);
3247}
3248
3249static void
Victor Stinner09054372013-11-06 22:41:44 +01003250sys_format(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Victor Stinner79766632010-08-16 17:36:42 +00003251{
3252 PyObject *file, *message;
3253 PyObject *error_type, *error_value, *error_traceback;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02003254 const char *utf8;
Victor Stinner79766632010-08-16 17:36:42 +00003255
3256 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Victor Stinner09054372013-11-06 22:41:44 +01003257 file = _PySys_GetObjectId(key);
Victor Stinner79766632010-08-16 17:36:42 +00003258 message = PyUnicode_FromFormatV(format, va);
3259 if (message != NULL) {
3260 if (sys_pyfile_write_unicode(message, file) != 0) {
3261 PyErr_Clear();
Serhiy Storchaka06515832016-11-20 09:13:07 +02003262 utf8 = PyUnicode_AsUTF8(message);
Victor Stinner79766632010-08-16 17:36:42 +00003263 if (utf8 != NULL)
3264 fputs(utf8, fp);
3265 }
3266 Py_DECREF(message);
3267 }
3268 PyErr_Restore(error_type, error_value, error_traceback);
3269}
3270
3271void
3272PySys_FormatStdout(const char *format, ...)
3273{
3274 va_list va;
3275
3276 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01003277 sys_format(&PyId_stdout, stdout, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00003278 va_end(va);
3279}
3280
3281void
3282PySys_FormatStderr(const char *format, ...)
3283{
3284 va_list va;
3285
3286 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01003287 sys_format(&PyId_stderr, stderr, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003288 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00003289}