blob: fd0a9c0bf576c0f039967ad1f6abd0a57b0b220d [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 Stinner838f2642019-06-13 22:41:23 +020020#include "pycore_ceval.h"
Victor Stinner331a6a52019-05-27 16:39:22 +020021#include "pycore_initconfig.h"
Victor Stinner838f2642019-06-13 22:41:23 +020022#include "pycore_pathconfig.h"
23#include "pycore_pyerrors.h"
Victor Stinner621cebe2018-11-12 16:53:38 +010024#include "pycore_pylifecycle.h"
25#include "pycore_pymem.h"
Steve Dowerb82e17e2019-05-23 08:45:22 -070026#include "pycore_tupleobject.h"
Victor Stinnerd5c355c2011-04-30 14:53:09 +020027#include "pythread.h"
Steve Dowerb82e17e2019-05-23 08:45:22 -070028#include "pydtrace.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000029
Guido van Rossume2437a11992-03-23 18:20:18 +000030#include "osdefs.h"
Stefan Krah1845d142016-04-25 21:38:53 +020031#include <locale.h>
Guido van Rossum3f5da241990-12-20 15:06:42 +000032
Mark Hammond8696ebc2002-10-08 02:44:31 +000033#ifdef MS_WINDOWS
34#define WIN32_LEAN_AND_MEAN
Amaury Forgeot d'Arc06cfe952007-11-10 13:55:44 +000035#include <windows.h>
Mark Hammond8696ebc2002-10-08 02:44:31 +000036#endif /* MS_WINDOWS */
37
Guido van Rossum9b38a141996-09-11 23:12:24 +000038#ifdef MS_COREDLL
Guido van Rossumc606fe11996-04-09 02:37:57 +000039extern void *PyWin_DLLhModule;
Guido van Rossum6c1e5f21997-09-29 23:34:23 +000040/* A string loaded from the DLL at startup: */
41extern const char *PyWin_DLLVersionString;
Guido van Rossumc606fe11996-04-09 02:37:57 +000042#endif
43
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -080044/*[clinic input]
45module sys
46[clinic start generated code]*/
47/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3726b388feee8cea]*/
48
49#include "clinic/sysmodule.c.h"
50
Victor Stinnerbd303c12013-11-07 23:07:29 +010051_Py_IDENTIFIER(_);
52_Py_IDENTIFIER(__sizeof__);
Eric Snowdae02762017-09-14 00:35:58 -070053_Py_IDENTIFIER(_xoptions);
Victor Stinnerbd303c12013-11-07 23:07:29 +010054_Py_IDENTIFIER(buffer);
55_Py_IDENTIFIER(builtins);
56_Py_IDENTIFIER(encoding);
57_Py_IDENTIFIER(path);
58_Py_IDENTIFIER(stdout);
59_Py_IDENTIFIER(stderr);
Eric Snowdae02762017-09-14 00:35:58 -070060_Py_IDENTIFIER(warnoptions);
Victor Stinnerbd303c12013-11-07 23:07:29 +010061_Py_IDENTIFIER(write);
62
Victor Stinner838f2642019-06-13 22:41:23 +020063static PyObject *
64sys_get_object_id(PyThreadState *tstate, _Py_Identifier *key)
Victor Stinnerd67bd452013-11-06 22:36:40 +010065{
Victor Stinner838f2642019-06-13 22:41:23 +020066 PyObject *sd = tstate->interp->sysdict;
Victor Stinnercaba55b2018-08-03 15:33:52 +020067 if (sd == NULL) {
Victor Stinnerd67bd452013-11-06 22:36:40 +010068 return NULL;
Victor Stinnercaba55b2018-08-03 15:33:52 +020069 }
Victor Stinnerd67bd452013-11-06 22:36:40 +010070 return _PyDict_GetItemId(sd, key);
71}
72
73PyObject *
Victor Stinner838f2642019-06-13 22:41:23 +020074_PySys_GetObjectId(_Py_Identifier *key)
75{
76 PyThreadState *tstate = _PyThreadState_GET();
77 return sys_get_object_id(tstate, key);
78}
79
80PyObject *
Neal Norwitzf3081322007-08-25 00:32:45 +000081PySys_GetObject(const char *name)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000082{
Victor Stinner838f2642019-06-13 22:41:23 +020083 PyThreadState *tstate = _PyThreadState_GET();
84 PyObject *sd = tstate->interp->sysdict;
Victor Stinnercaba55b2018-08-03 15:33:52 +020085 if (sd == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000086 return NULL;
Victor Stinnercaba55b2018-08-03 15:33:52 +020087 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000088 return PyDict_GetItemString(sd, name);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000089}
90
Victor Stinner838f2642019-06-13 22:41:23 +020091static int
92sys_set_object_id(PyThreadState *tstate, _Py_Identifier *key, PyObject *v)
Victor Stinnerd67bd452013-11-06 22:36:40 +010093{
Victor Stinner838f2642019-06-13 22:41:23 +020094 PyObject *sd = tstate->interp->sysdict;
Victor Stinnerd67bd452013-11-06 22:36:40 +010095 if (v == NULL) {
Victor Stinnercaba55b2018-08-03 15:33:52 +020096 if (_PyDict_GetItemId(sd, key) == NULL) {
Victor Stinnerd67bd452013-11-06 22:36:40 +010097 return 0;
Victor Stinnercaba55b2018-08-03 15:33:52 +020098 }
99 else {
Victor Stinnerd67bd452013-11-06 22:36:40 +0100100 return _PyDict_DelItemId(sd, key);
Victor Stinnercaba55b2018-08-03 15:33:52 +0200101 }
Victor Stinnerd67bd452013-11-06 22:36:40 +0100102 }
Victor Stinnercaba55b2018-08-03 15:33:52 +0200103 else {
Victor Stinnerd67bd452013-11-06 22:36:40 +0100104 return _PyDict_SetItemId(sd, key, v);
Victor Stinnercaba55b2018-08-03 15:33:52 +0200105 }
Victor Stinnerd67bd452013-11-06 22:36:40 +0100106}
107
108int
Victor Stinner838f2642019-06-13 22:41:23 +0200109_PySys_SetObjectId(_Py_Identifier *key, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000110{
Victor Stinner838f2642019-06-13 22:41:23 +0200111 PyThreadState *tstate = _PyThreadState_GET();
112 return sys_set_object_id(tstate, key, v);
113}
114
115static int
116sys_set_object(PyThreadState *tstate, const char *name, PyObject *v)
117{
118 PyObject *sd = tstate->interp->sysdict;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000119 if (v == NULL) {
Victor Stinnercaba55b2018-08-03 15:33:52 +0200120 if (PyDict_GetItemString(sd, name) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000121 return 0;
Victor Stinnercaba55b2018-08-03 15:33:52 +0200122 }
123 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000124 return PyDict_DelItemString(sd, name);
Victor Stinnercaba55b2018-08-03 15:33:52 +0200125 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000126 }
Victor Stinnercaba55b2018-08-03 15:33:52 +0200127 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000128 return PyDict_SetItemString(sd, name, v);
Victor Stinnercaba55b2018-08-03 15:33:52 +0200129 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000130}
131
Victor Stinner838f2642019-06-13 22:41:23 +0200132int
133PySys_SetObject(const char *name, PyObject *v)
Steve Dowerb82e17e2019-05-23 08:45:22 -0700134{
Victor Stinner838f2642019-06-13 22:41:23 +0200135 PyThreadState *tstate = _PyThreadState_GET();
136 return sys_set_object(tstate, name, v);
137}
138
Victor Stinner08faf002020-03-26 18:57:32 +0100139
Victor Stinner838f2642019-06-13 22:41:23 +0200140static int
Victor Stinner08faf002020-03-26 18:57:32 +0100141should_audit(PyInterpreterState *is)
Victor Stinner838f2642019-06-13 22:41:23 +0200142{
Victor Stinner08faf002020-03-26 18:57:32 +0100143 /* tstate->interp cannot be NULL, but test it just in case
144 for extra safety */
145 assert(is != NULL);
146 if (!is) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700147 return 0;
148 }
Victor Stinner08faf002020-03-26 18:57:32 +0100149 return (is->runtime->audit_hook_head
150 || is->audit_hooks
151 || PyDTrace_AUDIT_ENABLED());
Steve Dowerb82e17e2019-05-23 08:45:22 -0700152}
153
Steve Dowerb82e17e2019-05-23 08:45:22 -0700154
Victor Stinner08faf002020-03-26 18:57:32 +0100155static int
156sys_audit_tstate(PyThreadState *ts, const char *event,
157 const char *argFormat, va_list vargs)
158{
Steve Dowerb82e17e2019-05-23 08:45:22 -0700159 /* N format is inappropriate, because you do not know
160 whether the reference is consumed by the call.
161 Assert rather than exception for perf reasons */
162 assert(!argFormat || !strchr(argFormat, 'N'));
163
Victor Stinner08faf002020-03-26 18:57:32 +0100164 if (!ts) {
165 /* Audit hooks cannot be called with a NULL thread state */
Steve Dowerb82e17e2019-05-23 08:45:22 -0700166 return 0;
167 }
168
Victor Stinner08faf002020-03-26 18:57:32 +0100169 /* The current implementation cannot be called if tstate is not
170 the current Python thread state. */
171 assert(ts == _PyThreadState_GET());
172
173 /* Early exit when no hooks are registered */
174 PyInterpreterState *is = ts->interp;
175 if (!should_audit(is)) {
176 return 0;
177 }
178
179 PyObject *eventName = NULL;
180 PyObject *eventArgs = NULL;
181 PyObject *hooks = NULL;
182 PyObject *hook = NULL;
183 int res = -1;
184
Steve Dowerb82e17e2019-05-23 08:45:22 -0700185 int dtrace = PyDTrace_AUDIT_ENABLED();
186
187 PyObject *exc_type, *exc_value, *exc_tb;
Victor Stinner08faf002020-03-26 18:57:32 +0100188 _PyErr_Fetch(ts, &exc_type, &exc_value, &exc_tb);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700189
190 /* Initialize event args now */
191 if (argFormat && argFormat[0]) {
Victor Stinner08faf002020-03-26 18:57:32 +0100192 eventArgs = _Py_VaBuildValue_SizeT(argFormat, vargs);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700193 if (eventArgs && !PyTuple_Check(eventArgs)) {
194 PyObject *argTuple = PyTuple_Pack(1, eventArgs);
195 Py_DECREF(eventArgs);
196 eventArgs = argTuple;
197 }
Victor Stinner08faf002020-03-26 18:57:32 +0100198 }
199 else {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700200 eventArgs = PyTuple_New(0);
201 }
202 if (!eventArgs) {
203 goto exit;
204 }
205
206 /* Call global hooks */
Victor Stinner08faf002020-03-26 18:57:32 +0100207 _Py_AuditHookEntry *e = is->runtime->audit_hook_head;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700208 for (; e; e = e->next) {
209 if (e->hookCFunction(event, eventArgs, e->userData) < 0) {
210 goto exit;
211 }
212 }
213
214 /* Dtrace USDT point */
215 if (dtrace) {
Andy Lestere6be9b52020-02-11 20:28:35 -0600216 PyDTrace_AUDIT(event, (void *)eventArgs);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700217 }
218
219 /* Call interpreter hooks */
Victor Stinner08faf002020-03-26 18:57:32 +0100220 if (is->audit_hooks) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700221 eventName = PyUnicode_FromString(event);
222 if (!eventName) {
223 goto exit;
224 }
225
226 hooks = PyObject_GetIter(is->audit_hooks);
227 if (!hooks) {
228 goto exit;
229 }
230
231 /* Disallow tracing in hooks unless explicitly enabled */
232 ts->tracing++;
233 ts->use_tracing = 0;
234 while ((hook = PyIter_Next(hooks)) != NULL) {
Serhiy Storchaka41c57b32019-09-01 12:03:39 +0300235 _Py_IDENTIFIER(__cantrace__);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700236 PyObject *o;
Serhiy Storchaka41c57b32019-09-01 12:03:39 +0300237 int canTrace = _PyObject_LookupAttrId(hook, &PyId___cantrace__, &o);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700238 if (o) {
239 canTrace = PyObject_IsTrue(o);
240 Py_DECREF(o);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700241 }
242 if (canTrace < 0) {
243 break;
244 }
245 if (canTrace) {
246 ts->use_tracing = (ts->c_tracefunc || ts->c_profilefunc);
247 ts->tracing--;
248 }
Victor Stinner08faf002020-03-26 18:57:32 +0100249 PyObject* args[2] = {eventName, eventArgs};
250 o = _PyObject_FastCallTstate(ts, hook, args, 2);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700251 if (canTrace) {
252 ts->tracing++;
253 ts->use_tracing = 0;
254 }
255 if (!o) {
256 break;
257 }
258 Py_DECREF(o);
259 Py_CLEAR(hook);
260 }
261 ts->use_tracing = (ts->c_tracefunc || ts->c_profilefunc);
262 ts->tracing--;
Victor Stinner838f2642019-06-13 22:41:23 +0200263 if (_PyErr_Occurred(ts)) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700264 goto exit;
265 }
266 }
267
268 res = 0;
269
270exit:
271 Py_XDECREF(hook);
272 Py_XDECREF(hooks);
273 Py_XDECREF(eventName);
274 Py_XDECREF(eventArgs);
275
Victor Stinner08faf002020-03-26 18:57:32 +0100276 if (!res) {
277 _PyErr_Restore(ts, exc_type, exc_value, exc_tb);
278 }
279 else {
280 assert(_PyErr_Occurred(ts));
281 Py_XDECREF(exc_type);
282 Py_XDECREF(exc_value);
283 Py_XDECREF(exc_tb);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700284 }
285
286 return res;
287}
288
Victor Stinner08faf002020-03-26 18:57:32 +0100289int
290_PySys_Audit(PyThreadState *tstate, const char *event,
291 const char *argFormat, ...)
292{
293 va_list vargs;
294#ifdef HAVE_STDARG_PROTOTYPES
295 va_start(vargs, argFormat);
296#else
297 va_start(vargs);
298#endif
299 int res = sys_audit_tstate(tstate, event, argFormat, vargs);
300 va_end(vargs);
301 return res;
302}
303
304int
305PySys_Audit(const char *event, const char *argFormat, ...)
306{
307 PyThreadState *tstate = _PyThreadState_GET();
308 va_list vargs;
309#ifdef HAVE_STDARG_PROTOTYPES
310 va_start(vargs, argFormat);
311#else
312 va_start(vargs);
313#endif
314 int res = sys_audit_tstate(tstate, event, argFormat, vargs);
315 va_end(vargs);
316 return res;
317}
318
Steve Dowerb82e17e2019-05-23 08:45:22 -0700319/* We expose this function primarily for our own cleanup during
320 * finalization. In general, it should not need to be called,
Victor Stinner08faf002020-03-26 18:57:32 +0100321 * and as such the function is not exported.
322 *
323 * Must be finalizing to clear hooks */
Victor Stinner838f2642019-06-13 22:41:23 +0200324void
Victor Stinner08faf002020-03-26 18:57:32 +0100325_PySys_ClearAuditHooks(PyThreadState *ts)
Victor Stinner838f2642019-06-13 22:41:23 +0200326{
Victor Stinner08faf002020-03-26 18:57:32 +0100327 assert(ts != NULL);
328 if (!ts) {
329 return;
330 }
331
332 _PyRuntimeState *runtime = ts->interp->runtime;
Victor Stinner7b3c2522020-03-07 00:24:23 +0100333 PyThreadState *finalizing = _PyRuntimeState_GetFinalizing(runtime);
Victor Stinner08faf002020-03-26 18:57:32 +0100334 assert(finalizing == ts);
335 if (finalizing != ts) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700336 return;
Victor Stinner838f2642019-06-13 22:41:23 +0200337 }
Steve Dowerb82e17e2019-05-23 08:45:22 -0700338
Victor Stinnerda7933e2020-04-13 03:04:28 +0200339 const PyConfig *config = _PyInterpreterState_GetConfig(ts->interp);
Victor Stinner838f2642019-06-13 22:41:23 +0200340 if (config->verbose) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700341 PySys_WriteStderr("# clear sys.audit hooks\n");
342 }
343
344 /* Hooks can abort later hooks for this event, but cannot
345 abort the clear operation itself. */
Victor Stinner08faf002020-03-26 18:57:32 +0100346 _PySys_Audit(ts, "cpython._PySys_ClearAuditHooks", NULL);
Victor Stinner838f2642019-06-13 22:41:23 +0200347 _PyErr_Clear(ts);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700348
Victor Stinner08faf002020-03-26 18:57:32 +0100349 _Py_AuditHookEntry *e = runtime->audit_hook_head, *n;
350 runtime->audit_hook_head = NULL;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700351 while (e) {
352 n = e->next;
353 PyMem_RawFree(e);
354 e = n;
355 }
356}
357
358int
359PySys_AddAuditHook(Py_AuditHookFunction hook, void *userData)
360{
Victor Stinner08faf002020-03-26 18:57:32 +0100361 /* tstate can be NULL, so access directly _PyRuntime:
362 PySys_AddAuditHook() can be called before Python is initialized. */
Victor Stinner838f2642019-06-13 22:41:23 +0200363 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinner08faf002020-03-26 18:57:32 +0100364 PyThreadState *tstate;
365 if (runtime->initialized) {
366 tstate = _PyRuntimeState_GetThreadState(runtime);
367 }
368 else {
369 tstate = NULL;
370 }
Victor Stinner838f2642019-06-13 22:41:23 +0200371
Steve Dowerb82e17e2019-05-23 08:45:22 -0700372 /* Invoke existing audit hooks to allow them an opportunity to abort. */
373 /* Cannot invoke hooks until we are initialized */
Victor Stinner08faf002020-03-26 18:57:32 +0100374 if (tstate != NULL) {
375 if (_PySys_Audit(tstate, "sys.addaudithook", NULL) < 0) {
Steve Dowerbea33f52019-11-28 08:46:11 -0800376 if (_PyErr_ExceptionMatches(tstate, PyExc_RuntimeError)) {
377 /* We do not report errors derived from RuntimeError */
Victor Stinner838f2642019-06-13 22:41:23 +0200378 _PyErr_Clear(tstate);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700379 return 0;
380 }
381 return -1;
382 }
383 }
384
Victor Stinner08faf002020-03-26 18:57:32 +0100385 _Py_AuditHookEntry *e = runtime->audit_hook_head;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700386 if (!e) {
387 e = (_Py_AuditHookEntry*)PyMem_RawMalloc(sizeof(_Py_AuditHookEntry));
Victor Stinner08faf002020-03-26 18:57:32 +0100388 runtime->audit_hook_head = e;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700389 } else {
Victor Stinner838f2642019-06-13 22:41:23 +0200390 while (e->next) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700391 e = e->next;
Victor Stinner838f2642019-06-13 22:41:23 +0200392 }
Steve Dowerb82e17e2019-05-23 08:45:22 -0700393 e = e->next = (_Py_AuditHookEntry*)PyMem_RawMalloc(
394 sizeof(_Py_AuditHookEntry));
395 }
396
397 if (!e) {
Victor Stinner08faf002020-03-26 18:57:32 +0100398 if (tstate != NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +0200399 _PyErr_NoMemory(tstate);
400 }
Steve Dowerb82e17e2019-05-23 08:45:22 -0700401 return -1;
402 }
403
404 e->next = NULL;
405 e->hookCFunction = (Py_AuditHookFunction)hook;
406 e->userData = userData;
407
408 return 0;
409}
410
411/*[clinic input]
412sys.addaudithook
413
414 hook: object
415
416Adds a new audit hook callback.
417[clinic start generated code]*/
418
419static PyObject *
420sys_addaudithook_impl(PyObject *module, PyObject *hook)
421/*[clinic end generated code: output=4f9c17aaeb02f44e input=0f3e191217a45e34]*/
422{
Victor Stinner838f2642019-06-13 22:41:23 +0200423 PyThreadState *tstate = _PyThreadState_GET();
424
Steve Dowerb82e17e2019-05-23 08:45:22 -0700425 /* Invoke existing audit hooks to allow them an opportunity to abort. */
Victor Stinner08faf002020-03-26 18:57:32 +0100426 if (_PySys_Audit(tstate, "sys.addaudithook", NULL) < 0) {
Victor Stinner838f2642019-06-13 22:41:23 +0200427 if (_PyErr_ExceptionMatches(tstate, PyExc_Exception)) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700428 /* We do not report errors derived from Exception */
Victor Stinner838f2642019-06-13 22:41:23 +0200429 _PyErr_Clear(tstate);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700430 Py_RETURN_NONE;
431 }
432 return NULL;
433 }
434
Victor Stinner838f2642019-06-13 22:41:23 +0200435 PyInterpreterState *is = tstate->interp;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700436 if (is->audit_hooks == NULL) {
437 is->audit_hooks = PyList_New(0);
438 if (is->audit_hooks == NULL) {
439 return NULL;
440 }
441 }
442
443 if (PyList_Append(is->audit_hooks, hook) < 0) {
444 return NULL;
445 }
446
447 Py_RETURN_NONE;
448}
449
450PyDoc_STRVAR(audit_doc,
451"audit(event, *args)\n\
452\n\
453Passes the event to any audit hooks that are attached.");
454
455static PyObject *
456sys_audit(PyObject *self, PyObject *const *args, Py_ssize_t argc)
457{
Victor Stinner838f2642019-06-13 22:41:23 +0200458 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner08faf002020-03-26 18:57:32 +0100459 assert(tstate != NULL);
Victor Stinner838f2642019-06-13 22:41:23 +0200460
Steve Dowerb82e17e2019-05-23 08:45:22 -0700461 if (argc == 0) {
Victor Stinner838f2642019-06-13 22:41:23 +0200462 _PyErr_SetString(tstate, PyExc_TypeError,
463 "audit() missing 1 required positional argument: "
464 "'event'");
Steve Dowerb82e17e2019-05-23 08:45:22 -0700465 return NULL;
466 }
467
Victor Stinner08faf002020-03-26 18:57:32 +0100468 if (!should_audit(tstate->interp)) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700469 Py_RETURN_NONE;
470 }
471
472 PyObject *auditEvent = args[0];
473 if (!auditEvent) {
Victor Stinner838f2642019-06-13 22:41:23 +0200474 _PyErr_SetString(tstate, PyExc_TypeError,
475 "expected str for argument 'event'");
Steve Dowerb82e17e2019-05-23 08:45:22 -0700476 return NULL;
477 }
478 if (!PyUnicode_Check(auditEvent)) {
Victor Stinner838f2642019-06-13 22:41:23 +0200479 _PyErr_Format(tstate, PyExc_TypeError,
480 "expected str for argument 'event', not %.200s",
481 Py_TYPE(auditEvent)->tp_name);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700482 return NULL;
483 }
484 const char *event = PyUnicode_AsUTF8(auditEvent);
485 if (!event) {
486 return NULL;
487 }
488
489 PyObject *auditArgs = _PyTuple_FromArray(args + 1, argc - 1);
490 if (!auditArgs) {
491 return NULL;
492 }
493
Victor Stinner08faf002020-03-26 18:57:32 +0100494 int res = _PySys_Audit(tstate, event, "O", auditArgs);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700495 Py_DECREF(auditArgs);
496
497 if (res < 0) {
498 return NULL;
499 }
500
501 Py_RETURN_NONE;
502}
503
504
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400505static PyObject *
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200506sys_breakpointhook(PyObject *self, PyObject *const *args, Py_ssize_t nargs, PyObject *keywords)
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400507{
Victor Stinner838f2642019-06-13 22:41:23 +0200508 PyThreadState *tstate = _PyThreadState_GET();
509 assert(!_PyErr_Occurred(tstate));
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300510 char *envar = Py_GETENV("PYTHONBREAKPOINT");
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400511
512 if (envar == NULL || strlen(envar) == 0) {
513 envar = "pdb.set_trace";
514 }
515 else if (!strcmp(envar, "0")) {
516 /* The breakpoint is explicitly no-op'd. */
517 Py_RETURN_NONE;
518 }
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300519 /* According to POSIX the string returned by getenv() might be invalidated
520 * or the string content might be overwritten by a subsequent call to
521 * getenv(). Since importing a module can performs the getenv() calls,
522 * we need to save a copy of envar. */
523 envar = _PyMem_RawStrdup(envar);
524 if (envar == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +0200525 _PyErr_NoMemory(tstate);
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300526 return NULL;
527 }
Serhiy Storchaka4ae06c52017-12-12 13:55:04 +0200528 const char *last_dot = strrchr(envar, '.');
529 const char *attrname = NULL;
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400530 PyObject *modulepath = NULL;
531
532 if (last_dot == NULL) {
533 /* The breakpoint is a built-in, e.g. PYTHONBREAKPOINT=int */
534 modulepath = PyUnicode_FromString("builtins");
535 attrname = envar;
536 }
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200537 else if (last_dot != envar) {
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400538 /* Split on the last dot; */
539 modulepath = PyUnicode_FromStringAndSize(envar, last_dot - envar);
540 attrname = last_dot + 1;
541 }
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200542 else {
543 goto warn;
544 }
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400545 if (modulepath == NULL) {
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300546 PyMem_RawFree(envar);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400547 return NULL;
548 }
549
Anthony Sottiledce345c2018-11-01 10:25:05 -0700550 PyObject *module = PyImport_Import(modulepath);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400551 Py_DECREF(modulepath);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400552
553 if (module == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +0200554 if (_PyErr_ExceptionMatches(tstate, PyExc_ImportError)) {
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200555 goto warn;
556 }
557 PyMem_RawFree(envar);
558 return NULL;
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400559 }
560
561 PyObject *hook = PyObject_GetAttrString(module, attrname);
562 Py_DECREF(module);
563
564 if (hook == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +0200565 if (_PyErr_ExceptionMatches(tstate, PyExc_AttributeError)) {
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200566 goto warn;
567 }
568 PyMem_RawFree(envar);
569 return NULL;
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400570 }
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300571 PyMem_RawFree(envar);
Petr Viktorinffd97532020-02-11 17:46:57 +0100572 PyObject *retval = PyObject_Vectorcall(hook, args, nargs, keywords);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400573 Py_DECREF(hook);
574 return retval;
575
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200576 warn:
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400577 /* If any of the imports went wrong, then warn and ignore. */
Victor Stinner838f2642019-06-13 22:41:23 +0200578 _PyErr_Clear(tstate);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400579 int status = PyErr_WarnFormat(
580 PyExc_RuntimeWarning, 0,
581 "Ignoring unimportable $PYTHONBREAKPOINT: \"%s\"", envar);
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300582 PyMem_RawFree(envar);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400583 if (status < 0) {
584 /* Printing the warning raised an exception. */
585 return NULL;
586 }
587 /* The warning was (probably) issued. */
588 Py_RETURN_NONE;
589}
590
591PyDoc_STRVAR(breakpointhook_doc,
592"breakpointhook(*args, **kws)\n"
593"\n"
594"This hook function is called by built-in breakpoint().\n"
595);
596
Victor Stinner13d49ee2010-12-04 17:24:33 +0000597/* Write repr(o) to sys.stdout using sys.stdout.encoding and 'backslashreplace'
598 error handler. If sys.stdout has a buffer attribute, use
599 sys.stdout.buffer.write(encoded), otherwise redecode the string and use
600 sys.stdout.write(redecoded).
601
602 Helper function for sys_displayhook(). */
603static int
Andy Lesterda4d6562020-03-05 22:34:36 -0600604sys_displayhook_unencodable(PyObject *outf, PyObject *o)
Victor Stinner13d49ee2010-12-04 17:24:33 +0000605{
606 PyObject *stdout_encoding = NULL;
607 PyObject *encoded, *escaped_str, *repr_str, *buffer, *result;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200608 const char *stdout_encoding_str;
Victor Stinner13d49ee2010-12-04 17:24:33 +0000609 int ret;
610
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200611 stdout_encoding = _PyObject_GetAttrId(outf, &PyId_encoding);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000612 if (stdout_encoding == NULL)
613 goto error;
Serhiy Storchaka06515832016-11-20 09:13:07 +0200614 stdout_encoding_str = PyUnicode_AsUTF8(stdout_encoding);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000615 if (stdout_encoding_str == NULL)
616 goto error;
617
618 repr_str = PyObject_Repr(o);
619 if (repr_str == NULL)
620 goto error;
621 encoded = PyUnicode_AsEncodedString(repr_str,
622 stdout_encoding_str,
623 "backslashreplace");
624 Py_DECREF(repr_str);
625 if (encoded == NULL)
626 goto error;
627
Serhiy Storchaka41c57b32019-09-01 12:03:39 +0300628 if (_PyObject_LookupAttrId(outf, &PyId_buffer, &buffer) < 0) {
629 Py_DECREF(encoded);
630 goto error;
631 }
Victor Stinner13d49ee2010-12-04 17:24:33 +0000632 if (buffer) {
Jeroen Demeyer59ad1102019-07-11 10:59:05 +0200633 result = _PyObject_CallMethodIdOneArg(buffer, &PyId_write, encoded);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000634 Py_DECREF(buffer);
635 Py_DECREF(encoded);
636 if (result == NULL)
637 goto error;
638 Py_DECREF(result);
639 }
640 else {
Victor Stinner13d49ee2010-12-04 17:24:33 +0000641 escaped_str = PyUnicode_FromEncodedObject(encoded,
642 stdout_encoding_str,
643 "strict");
644 Py_DECREF(encoded);
645 if (PyFile_WriteObject(escaped_str, outf, Py_PRINT_RAW) != 0) {
646 Py_DECREF(escaped_str);
647 goto error;
648 }
649 Py_DECREF(escaped_str);
650 }
651 ret = 0;
652 goto finally;
653
654error:
655 ret = -1;
656finally:
657 Py_XDECREF(stdout_encoding);
658 return ret;
659}
660
Tal Einatede0b6f2018-12-31 17:12:08 +0200661/*[clinic input]
662sys.displayhook
663
664 object as o: object
665 /
666
667Print an object to sys.stdout and also save it in builtins._
668[clinic start generated code]*/
669
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000670static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200671sys_displayhook(PyObject *module, PyObject *o)
672/*[clinic end generated code: output=347477d006df92ed input=08ba730166d7ef72]*/
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000673{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000674 PyObject *outf;
Victor Stinnerd02fbb82013-11-06 18:27:13 +0100675 PyObject *builtins;
676 static PyObject *newline = NULL;
Victor Stinner838f2642019-06-13 22:41:23 +0200677 PyThreadState *tstate = _PyThreadState_GET();
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000678
Eric Snow3f9eee62017-09-15 16:35:20 -0600679 builtins = _PyImport_GetModuleId(&PyId_builtins);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000680 if (builtins == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +0200681 if (!_PyErr_Occurred(tstate)) {
682 _PyErr_SetString(tstate, PyExc_RuntimeError,
683 "lost builtins module");
Stefan Krah027b09c2019-03-25 21:50:58 +0100684 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000685 return NULL;
686 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600687 Py_DECREF(builtins);
Moshe Zadka03897ea2001-07-23 13:32:43 +0000688
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000689 /* Print value except if None */
690 /* After printing, also assign to '_' */
691 /* Before, set '_' to None to avoid recursion */
692 if (o == Py_None) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200693 Py_RETURN_NONE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000694 }
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200695 if (_PyObject_SetAttrId(builtins, &PyId__, Py_None) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000696 return NULL;
Victor Stinner838f2642019-06-13 22:41:23 +0200697 outf = sys_get_object_id(tstate, &PyId_stdout);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000698 if (outf == NULL || outf == Py_None) {
Victor Stinner838f2642019-06-13 22:41:23 +0200699 _PyErr_SetString(tstate, PyExc_RuntimeError, "lost sys.stdout");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000700 return NULL;
701 }
Victor Stinner13d49ee2010-12-04 17:24:33 +0000702 if (PyFile_WriteObject(o, outf, 0) != 0) {
Victor Stinner838f2642019-06-13 22:41:23 +0200703 if (_PyErr_ExceptionMatches(tstate, PyExc_UnicodeEncodeError)) {
Andy Lesterda4d6562020-03-05 22:34:36 -0600704 int err;
Victor Stinner13d49ee2010-12-04 17:24:33 +0000705 /* repr(o) is not encodable to sys.stdout.encoding with
706 * sys.stdout.errors error handler (which is probably 'strict') */
Victor Stinner838f2642019-06-13 22:41:23 +0200707 _PyErr_Clear(tstate);
Andy Lesterda4d6562020-03-05 22:34:36 -0600708 err = sys_displayhook_unencodable(outf, o);
Victor Stinner838f2642019-06-13 22:41:23 +0200709 if (err) {
Victor Stinner13d49ee2010-12-04 17:24:33 +0000710 return NULL;
Victor Stinner838f2642019-06-13 22:41:23 +0200711 }
Victor Stinner13d49ee2010-12-04 17:24:33 +0000712 }
713 else {
714 return NULL;
715 }
716 }
Victor Stinnerd02fbb82013-11-06 18:27:13 +0100717 if (newline == NULL) {
718 newline = PyUnicode_FromString("\n");
719 if (newline == NULL)
720 return NULL;
721 }
722 if (PyFile_WriteObject(newline, outf, Py_PRINT_RAW) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000723 return NULL;
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200724 if (_PyObject_SetAttrId(builtins, &PyId__, o) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000725 return NULL;
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200726 Py_RETURN_NONE;
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000727}
728
Tal Einatede0b6f2018-12-31 17:12:08 +0200729
730/*[clinic input]
731sys.excepthook
732
733 exctype: object
734 value: object
735 traceback: object
736 /
737
738Handle an exception by displaying it with a traceback on sys.stderr.
739[clinic start generated code]*/
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000740
741static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200742sys_excepthook_impl(PyObject *module, PyObject *exctype, PyObject *value,
743 PyObject *traceback)
744/*[clinic end generated code: output=18d99fdda21b6b5e input=ecf606fa826f19d9]*/
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000745{
Tal Einatede0b6f2018-12-31 17:12:08 +0200746 PyErr_Display(exctype, value, traceback);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200747 Py_RETURN_NONE;
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000748}
749
Tal Einatede0b6f2018-12-31 17:12:08 +0200750
751/*[clinic input]
752sys.exc_info
753
754Return current exception information: (type, value, traceback).
755
756Return information about the most recent exception caught by an except
757clause in the current stack frame or in an older stack frame.
758[clinic start generated code]*/
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000759
760static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200761sys_exc_info_impl(PyObject *module)
762/*[clinic end generated code: output=3afd0940cf3a4d30 input=b5c5bf077788a3e5]*/
Guido van Rossuma027efa1997-05-05 20:56:21 +0000763{
Victor Stinner50b48572018-11-01 01:51:40 +0100764 _PyErr_StackItem *err_info = _PyErr_GetTopmostException(_PyThreadState_GET());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000765 return Py_BuildValue(
766 "(OOO)",
Mark Shannonae3087c2017-10-22 22:41:51 +0100767 err_info->exc_type != NULL ? err_info->exc_type : Py_None,
768 err_info->exc_value != NULL ? err_info->exc_value : Py_None,
769 err_info->exc_traceback != NULL ?
770 err_info->exc_traceback : Py_None);
Guido van Rossuma027efa1997-05-05 20:56:21 +0000771}
772
Tal Einatede0b6f2018-12-31 17:12:08 +0200773
774/*[clinic input]
Victor Stinneref9d9b62019-05-22 11:28:22 +0200775sys.unraisablehook
776
777 unraisable: object
778 /
779
780Handle an unraisable exception.
781
782The unraisable argument has the following attributes:
783
784* exc_type: Exception type.
Victor Stinner71c52e32019-05-27 08:57:14 +0200785* exc_value: Exception value, can be None.
786* exc_traceback: Exception traceback, can be None.
787* err_msg: Error message, can be None.
788* object: Object causing the exception, can be None.
Victor Stinneref9d9b62019-05-22 11:28:22 +0200789[clinic start generated code]*/
790
791static PyObject *
792sys_unraisablehook(PyObject *module, PyObject *unraisable)
Victor Stinner71c52e32019-05-27 08:57:14 +0200793/*[clinic end generated code: output=bb92838b32abaa14 input=ec3af148294af8d3]*/
Victor Stinneref9d9b62019-05-22 11:28:22 +0200794{
795 return _PyErr_WriteUnraisableDefaultHook(unraisable);
796}
797
798
799/*[clinic input]
Tal Einatede0b6f2018-12-31 17:12:08 +0200800sys.exit
801
Serhiy Storchaka279f4462019-09-14 12:24:05 +0300802 status: object = None
Tal Einatede0b6f2018-12-31 17:12:08 +0200803 /
804
805Exit the interpreter by raising SystemExit(status).
806
807If the status is omitted or None, it defaults to zero (i.e., success).
808If the status is an integer, it will be used as the system exit status.
809If it is another kind of object, it will be printed and the system
810exit status will be one (i.e., failure).
811[clinic start generated code]*/
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000812
813static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200814sys_exit_impl(PyObject *module, PyObject *status)
Serhiy Storchaka279f4462019-09-14 12:24:05 +0300815/*[clinic end generated code: output=13870986c1ab2ec0 input=b86ca9497baa94f2]*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000816{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000817 /* Raise SystemExit so callers may catch it or clean up. */
Victor Stinner838f2642019-06-13 22:41:23 +0200818 PyThreadState *tstate = _PyThreadState_GET();
819 _PyErr_SetObject(tstate, PyExc_SystemExit, status);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000820 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000821}
822
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000823
Martin v. Löwis107b7da2001-11-09 20:59:39 +0000824
Tal Einatede0b6f2018-12-31 17:12:08 +0200825/*[clinic input]
826sys.getdefaultencoding
827
828Return the current default encoding used by the Unicode implementation.
829[clinic start generated code]*/
830
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000831static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200832sys_getdefaultencoding_impl(PyObject *module)
833/*[clinic end generated code: output=256d19dfcc0711e6 input=d416856ddbef6909]*/
Fred Drake8b4d01d2000-05-09 19:57:01 +0000834{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000835 return PyUnicode_FromString(PyUnicode_GetDefaultEncoding());
Fred Drake8b4d01d2000-05-09 19:57:01 +0000836}
837
Tal Einatede0b6f2018-12-31 17:12:08 +0200838/*[clinic input]
839sys.getfilesystemencoding
840
841Return the encoding used to convert Unicode filenames to OS filenames.
842[clinic start generated code]*/
Fred Drake8b4d01d2000-05-09 19:57:01 +0000843
844static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200845sys_getfilesystemencoding_impl(PyObject *module)
846/*[clinic end generated code: output=1dc4bdbe9be44aa7 input=8475f8649b8c7d8c]*/
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000847{
Victor Stinnerda7933e2020-04-13 03:04:28 +0200848 PyInterpreterState *interp = _PyInterpreterState_GET_UNSAFE();
849 const PyConfig *config = _PyInterpreterState_GetConfig(interp);
Victor Stinner709d23d2019-05-02 14:56:30 -0400850 return PyUnicode_FromWideChar(config->filesystem_encoding, -1);
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000851}
852
Tal Einatede0b6f2018-12-31 17:12:08 +0200853/*[clinic input]
854sys.getfilesystemencodeerrors
855
856Return the error mode used Unicode to OS filename conversion.
857[clinic start generated code]*/
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000858
Martin v. Löwis04dc25c2008-10-03 16:09:28 +0000859static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200860sys_getfilesystemencodeerrors_impl(PyObject *module)
861/*[clinic end generated code: output=ba77b36bbf7c96f5 input=22a1e8365566f1e5]*/
Steve Dowercc16be82016-09-08 10:35:16 -0700862{
Victor Stinnerda7933e2020-04-13 03:04:28 +0200863 PyInterpreterState *interp = _PyInterpreterState_GET_UNSAFE();
864 const PyConfig *config = _PyInterpreterState_GetConfig(interp);
Victor Stinner709d23d2019-05-02 14:56:30 -0400865 return PyUnicode_FromWideChar(config->filesystem_errors, -1);
Steve Dowercc16be82016-09-08 10:35:16 -0700866}
867
Tal Einatede0b6f2018-12-31 17:12:08 +0200868/*[clinic input]
869sys.intern
870
871 string as s: unicode
872 /
873
874``Intern'' the given string.
875
876This enters the string in the (global) table of interned strings whose
877purpose is to speed up dictionary lookups. Return the string itself or
878the previously interned string object with the same value.
879[clinic start generated code]*/
Steve Dowercc16be82016-09-08 10:35:16 -0700880
881static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200882sys_intern_impl(PyObject *module, PyObject *s)
883/*[clinic end generated code: output=be680c24f5c9e5d6 input=849483c006924e2f]*/
Georg Brandl66a796e2006-12-19 20:50:34 +0000884{
Victor Stinner838f2642019-06-13 22:41:23 +0200885 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000886 if (PyUnicode_CheckExact(s)) {
887 Py_INCREF(s);
888 PyUnicode_InternInPlace(&s);
889 return s;
890 }
891 else {
Victor Stinner838f2642019-06-13 22:41:23 +0200892 _PyErr_Format(tstate, PyExc_TypeError,
Victor Stinnera102ed72020-02-07 02:24:48 +0100893 "can't intern %.400s", Py_TYPE(s)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000894 return NULL;
895 }
Georg Brandl66a796e2006-12-19 20:50:34 +0000896}
897
Georg Brandl66a796e2006-12-19 20:50:34 +0000898
Fred Drake5755ce62001-06-27 19:19:46 +0000899/*
900 * Cached interned string objects used for calling the profile and
901 * trace functions. Initialized by trace_init().
902 */
Nick Coghlan5a851672017-09-08 10:14:16 +1000903static PyObject *whatstrings[8] = {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL};
Fred Drake5755ce62001-06-27 19:19:46 +0000904
905static int
906trace_init(void)
907{
Nick Coghlan5a851672017-09-08 10:14:16 +1000908 static const char * const whatnames[8] = {
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200909 "call", "exception", "line", "return",
Nick Coghlan5a851672017-09-08 10:14:16 +1000910 "c_call", "c_exception", "c_return",
911 "opcode"
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200912 };
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000913 PyObject *name;
914 int i;
Nick Coghlan5a851672017-09-08 10:14:16 +1000915 for (i = 0; i < 8; ++i) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000916 if (whatstrings[i] == NULL) {
917 name = PyUnicode_InternFromString(whatnames[i]);
918 if (name == NULL)
919 return -1;
920 whatstrings[i] = name;
921 }
922 }
923 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000924}
925
926
927static PyObject *
Victor Stinner309d7cc2020-03-13 16:39:12 +0100928call_trampoline(PyThreadState *tstate, PyObject* callback,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000929 PyFrameObject *frame, int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000930{
Victor Stinner78da82b2016-08-20 01:22:57 +0200931 if (PyFrame_FastToLocalsWithError(frame) < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000932 return NULL;
Victor Stinner78da82b2016-08-20 01:22:57 +0200933 }
Victor Stinner41bb43a2013-10-29 01:19:37 +0100934
Victor Stinner838f2642019-06-13 22:41:23 +0200935 PyObject *stack[3];
Victor Stinner78da82b2016-08-20 01:22:57 +0200936 stack[0] = (PyObject *)frame;
937 stack[1] = whatstrings[what];
938 stack[2] = (arg != NULL) ? arg : Py_None;
Fred Drake5755ce62001-06-27 19:19:46 +0000939
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000940 /* call the Python-level function */
Victor Stinner309d7cc2020-03-13 16:39:12 +0100941 PyObject *result = _PyObject_FastCallTstate(tstate, callback, stack, 3);
Fred Drake5755ce62001-06-27 19:19:46 +0000942
Victor Stinner78da82b2016-08-20 01:22:57 +0200943 PyFrame_LocalsToFast(frame, 1);
944 if (result == NULL) {
945 PyTraceBack_Here(frame);
946 }
947
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000948 return result;
Fred Drake5755ce62001-06-27 19:19:46 +0000949}
950
951static int
952profile_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000953 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000954{
Victor Stinner309d7cc2020-03-13 16:39:12 +0100955 if (arg == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 arg = Py_None;
Victor Stinner309d7cc2020-03-13 16:39:12 +0100957 }
958
959 PyThreadState *tstate = _PyThreadState_GET();
960 PyObject *result = call_trampoline(tstate, self, frame, what, arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000961 if (result == NULL) {
Victor Stinner309d7cc2020-03-13 16:39:12 +0100962 _PyEval_SetProfile(tstate, NULL, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000963 return -1;
964 }
Victor Stinner309d7cc2020-03-13 16:39:12 +0100965
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000966 Py_DECREF(result);
967 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000968}
969
970static int
971trace_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000972 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000973{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000974 PyObject *callback;
Victor Stinner309d7cc2020-03-13 16:39:12 +0100975 if (what == PyTrace_CALL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000976 callback = self;
Victor Stinner309d7cc2020-03-13 16:39:12 +0100977 }
978 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000979 callback = frame->f_trace;
Victor Stinner309d7cc2020-03-13 16:39:12 +0100980 }
981 if (callback == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 return 0;
Victor Stinner309d7cc2020-03-13 16:39:12 +0100983 }
984
985 PyThreadState *tstate = _PyThreadState_GET();
986 PyObject *result = call_trampoline(tstate, callback, frame, what, arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000987 if (result == NULL) {
Victor Stinner309d7cc2020-03-13 16:39:12 +0100988 _PyEval_SetTrace(tstate, NULL, NULL);
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200989 Py_CLEAR(frame->f_trace);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000990 return -1;
991 }
Victor Stinner309d7cc2020-03-13 16:39:12 +0100992
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000993 if (result != Py_None) {
Serhiy Storchakaec397562016-04-06 09:50:03 +0300994 Py_XSETREF(frame->f_trace, result);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000995 }
996 else {
997 Py_DECREF(result);
998 }
999 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +00001000}
Fred Draked0838392001-06-16 21:02:31 +00001001
Fred Drake8b4d01d2000-05-09 19:57:01 +00001002static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001003sys_settrace(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +00001004{
Victor Stinner309d7cc2020-03-13 16:39:12 +01001005 if (trace_init() == -1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001006 return NULL;
Victor Stinner309d7cc2020-03-13 16:39:12 +01001007 }
1008
1009 PyThreadState *tstate = _PyThreadState_GET();
1010 if (args == Py_None) {
1011 if (_PyEval_SetTrace(tstate, NULL, NULL) < 0) {
1012 return NULL;
1013 }
1014 }
1015 else {
1016 if (_PyEval_SetTrace(tstate, trace_trampoline, args) < 0) {
1017 return NULL;
1018 }
1019 }
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001020 Py_RETURN_NONE;
Guido van Rossume2437a11992-03-23 18:20:18 +00001021}
1022
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001023PyDoc_STRVAR(settrace_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001024"settrace(function)\n\
1025\n\
1026Set the global debug tracing function. It will be called on each\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001027function call. See the debugger chapter in the library manual."
1028);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001029
Tal Einatede0b6f2018-12-31 17:12:08 +02001030/*[clinic input]
1031sys.gettrace
1032
1033Return the global debug tracing function set with sys.settrace.
1034
1035See the debugger chapter in the library manual.
1036[clinic start generated code]*/
1037
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001038static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001039sys_gettrace_impl(PyObject *module)
1040/*[clinic end generated code: output=e97e3a4d8c971b6e input=373b51bb2147f4d8]*/
Christian Heimes9bd667a2008-01-20 15:14:11 +00001041{
Victor Stinner50b48572018-11-01 01:51:40 +01001042 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001043 PyObject *temp = tstate->c_traceobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +00001044
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001045 if (temp == NULL)
1046 temp = Py_None;
1047 Py_INCREF(temp);
1048 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +00001049}
1050
Christian Heimes9bd667a2008-01-20 15:14:11 +00001051static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001052sys_setprofile(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +00001053{
Victor Stinner309d7cc2020-03-13 16:39:12 +01001054 if (trace_init() == -1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 return NULL;
Victor Stinner309d7cc2020-03-13 16:39:12 +01001056 }
1057
1058 PyThreadState *tstate = _PyThreadState_GET();
1059 if (args == Py_None) {
1060 if (_PyEval_SetProfile(tstate, NULL, NULL) < 0) {
1061 return NULL;
1062 }
1063 }
1064 else {
1065 if (_PyEval_SetProfile(tstate, profile_trampoline, args) < 0) {
1066 return NULL;
1067 }
1068 }
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001069 Py_RETURN_NONE;
Guido van Rossume2437a11992-03-23 18:20:18 +00001070}
1071
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001072PyDoc_STRVAR(setprofile_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001073"setprofile(function)\n\
1074\n\
1075Set the profiling function. It will be called on each function call\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001076and return. See the profiler chapter in the library manual."
1077);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001078
Tal Einatede0b6f2018-12-31 17:12:08 +02001079/*[clinic input]
1080sys.getprofile
1081
1082Return the profiling function set with sys.setprofile.
1083
1084See the profiler chapter in the library manual.
1085[clinic start generated code]*/
1086
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001087static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001088sys_getprofile_impl(PyObject *module)
1089/*[clinic end generated code: output=579b96b373448188 input=1b3209d89a32965d]*/
Christian Heimes9bd667a2008-01-20 15:14:11 +00001090{
Victor Stinner50b48572018-11-01 01:51:40 +01001091 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001092 PyObject *temp = tstate->c_profileobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +00001093
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001094 if (temp == NULL)
1095 temp = Py_None;
1096 Py_INCREF(temp);
1097 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +00001098}
1099
Tim Peterse5e065b2003-07-06 18:36:54 +00001100
Tal Einatede0b6f2018-12-31 17:12:08 +02001101/*[clinic input]
1102sys.setswitchinterval
1103
1104 interval: double
1105 /
1106
1107Set the ideal thread switching delay inside the Python interpreter.
1108
1109The actual frequency of switching threads can be lower if the
1110interpreter executes long sequences of uninterruptible code
1111(this is implementation-specific and workload-dependent).
1112
1113The parameter must represent the desired switching delay in seconds
1114A typical value is 0.005 (5 milliseconds).
1115[clinic start generated code]*/
Tim Peterse5e065b2003-07-06 18:36:54 +00001116
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001117static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001118sys_setswitchinterval_impl(PyObject *module, double interval)
1119/*[clinic end generated code: output=65a19629e5153983 input=561b477134df91d9]*/
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001120{
Victor Stinner838f2642019-06-13 22:41:23 +02001121 PyThreadState *tstate = _PyThreadState_GET();
Tal Einatede0b6f2018-12-31 17:12:08 +02001122 if (interval <= 0.0) {
Victor Stinner838f2642019-06-13 22:41:23 +02001123 _PyErr_SetString(tstate, PyExc_ValueError,
1124 "switch interval must be strictly positive");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001125 return NULL;
1126 }
Tal Einatede0b6f2018-12-31 17:12:08 +02001127 _PyEval_SetSwitchInterval((unsigned long) (1e6 * interval));
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001128 Py_RETURN_NONE;
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001129}
1130
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001131
Tal Einatede0b6f2018-12-31 17:12:08 +02001132/*[clinic input]
1133sys.getswitchinterval -> double
1134
1135Return the current thread switch interval; see sys.setswitchinterval().
1136[clinic start generated code]*/
1137
1138static double
1139sys_getswitchinterval_impl(PyObject *module)
1140/*[clinic end generated code: output=a38c277c85b5096d input=bdf9d39c0ebbbb6f]*/
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001141{
Tal Einatede0b6f2018-12-31 17:12:08 +02001142 return 1e-6 * _PyEval_GetSwitchInterval();
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001143}
1144
Tal Einatede0b6f2018-12-31 17:12:08 +02001145/*[clinic input]
1146sys.setrecursionlimit
1147
1148 limit as new_limit: int
1149 /
1150
1151Set the maximum depth of the Python interpreter stack to n.
1152
1153This limit prevents infinite recursion from causing an overflow of the C
1154stack and crashing Python. The highest possible limit is platform-
1155dependent.
1156[clinic start generated code]*/
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001157
Tim Peterse5e065b2003-07-06 18:36:54 +00001158static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001159sys_setrecursionlimit_impl(PyObject *module, int new_limit)
1160/*[clinic end generated code: output=35e1c64754800ace input=b0f7a23393924af3]*/
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001161{
Tal Einatede0b6f2018-12-31 17:12:08 +02001162 int mark;
Victor Stinner838f2642019-06-13 22:41:23 +02001163 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner50856d52015-10-13 00:11:21 +02001164
Victor Stinner50856d52015-10-13 00:11:21 +02001165 if (new_limit < 1) {
Victor Stinner838f2642019-06-13 22:41:23 +02001166 _PyErr_SetString(tstate, PyExc_ValueError,
1167 "recursion limit must be greater or equal than 1");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001168 return NULL;
1169 }
Victor Stinner50856d52015-10-13 00:11:21 +02001170
1171 /* Issue #25274: When the recursion depth hits the recursion limit in
1172 _Py_CheckRecursiveCall(), the overflowed flag of the thread state is
1173 set to 1 and a RecursionError is raised. The overflowed flag is reset
1174 to 0 when the recursion depth goes below the low-water mark: see
1175 Py_LeaveRecursiveCall().
1176
1177 Reject too low new limit if the current recursion depth is higher than
1178 the new low-water mark. Otherwise it may not be possible anymore to
1179 reset the overflowed flag to 0. */
1180 mark = _Py_RecursionLimitLowerWaterMark(new_limit);
Victor Stinner50856d52015-10-13 00:11:21 +02001181 if (tstate->recursion_depth >= mark) {
Victor Stinner838f2642019-06-13 22:41:23 +02001182 _PyErr_Format(tstate, PyExc_RecursionError,
1183 "cannot set the recursion limit to %i at "
1184 "the recursion depth %i: the limit is too low",
1185 new_limit, tstate->recursion_depth);
Victor Stinner50856d52015-10-13 00:11:21 +02001186 return NULL;
1187 }
1188
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 Py_SetRecursionLimit(new_limit);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001190 Py_RETURN_NONE;
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001191}
1192
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001193/*[clinic input]
1194sys.set_coroutine_origin_tracking_depth
1195
1196 depth: int
1197
1198Enable or disable origin tracking for coroutine objects in this thread.
1199
Tal Einatede0b6f2018-12-31 17:12:08 +02001200Coroutine objects will track 'depth' frames of traceback information
1201about where they came from, available in their cr_origin attribute.
1202
1203Set a depth of 0 to disable.
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001204[clinic start generated code]*/
1205
1206static PyObject *
1207sys_set_coroutine_origin_tracking_depth_impl(PyObject *module, int depth)
Tal Einatede0b6f2018-12-31 17:12:08 +02001208/*[clinic end generated code: output=0a2123c1cc6759c5 input=a1d0a05f89d2c426]*/
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001209{
Victor Stinner838f2642019-06-13 22:41:23 +02001210 PyThreadState *tstate = _PyThreadState_GET();
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001211 if (depth < 0) {
Victor Stinner838f2642019-06-13 22:41:23 +02001212 _PyErr_SetString(tstate, PyExc_ValueError, "depth must be >= 0");
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001213 return NULL;
1214 }
Victor Stinner838f2642019-06-13 22:41:23 +02001215 _PyEval_SetCoroutineOriginTrackingDepth(tstate, depth);
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001216 Py_RETURN_NONE;
1217}
1218
1219/*[clinic input]
1220sys.get_coroutine_origin_tracking_depth -> int
1221
1222Check status of origin tracking for coroutine objects in this thread.
1223[clinic start generated code]*/
1224
1225static int
1226sys_get_coroutine_origin_tracking_depth_impl(PyObject *module)
1227/*[clinic end generated code: output=3699f7be95a3afb8 input=335266a71205b61a]*/
1228{
1229 return _PyEval_GetCoroutineOriginTrackingDepth();
1230}
1231
Yury Selivanoveb636452016-09-08 22:01:51 -07001232static PyTypeObject AsyncGenHooksType;
1233
1234PyDoc_STRVAR(asyncgen_hooks_doc,
1235"asyncgen_hooks\n\
1236\n\
Raymond Hettinger71170742019-09-11 07:17:32 -07001237A named tuple providing information about asynchronous\n\
Yury Selivanoveb636452016-09-08 22:01:51 -07001238generators hooks. The attributes are read only.");
1239
1240static PyStructSequence_Field asyncgen_hooks_fields[] = {
1241 {"firstiter", "Hook to intercept first iteration"},
1242 {"finalizer", "Hook to intercept finalization"},
1243 {0}
1244};
1245
1246static PyStructSequence_Desc asyncgen_hooks_desc = {
1247 "asyncgen_hooks", /* name */
1248 asyncgen_hooks_doc, /* doc */
1249 asyncgen_hooks_fields , /* fields */
1250 2
1251};
1252
Yury Selivanoveb636452016-09-08 22:01:51 -07001253static PyObject *
1254sys_set_asyncgen_hooks(PyObject *self, PyObject *args, PyObject *kw)
1255{
1256 static char *keywords[] = {"firstiter", "finalizer", NULL};
1257 PyObject *firstiter = NULL;
1258 PyObject *finalizer = NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02001259 PyThreadState *tstate = _PyThreadState_GET();
Yury Selivanoveb636452016-09-08 22:01:51 -07001260
1261 if (!PyArg_ParseTupleAndKeywords(
1262 args, kw, "|OO", keywords,
1263 &firstiter, &finalizer)) {
1264 return NULL;
1265 }
1266
1267 if (finalizer && finalizer != Py_None) {
1268 if (!PyCallable_Check(finalizer)) {
Victor Stinner838f2642019-06-13 22:41:23 +02001269 _PyErr_Format(tstate, PyExc_TypeError,
1270 "callable finalizer expected, got %.50s",
1271 Py_TYPE(finalizer)->tp_name);
Yury Selivanoveb636452016-09-08 22:01:51 -07001272 return NULL;
1273 }
Zackery Spytz79ceccd2020-03-26 06:11:13 -06001274 if (_PyEval_SetAsyncGenFinalizer(finalizer) < 0) {
1275 return NULL;
1276 }
Yury Selivanoveb636452016-09-08 22:01:51 -07001277 }
Zackery Spytz79ceccd2020-03-26 06:11:13 -06001278 else if (finalizer == Py_None && _PyEval_SetAsyncGenFinalizer(NULL) < 0) {
1279 return NULL;
Yury Selivanoveb636452016-09-08 22:01:51 -07001280 }
1281
1282 if (firstiter && firstiter != Py_None) {
1283 if (!PyCallable_Check(firstiter)) {
Victor Stinner838f2642019-06-13 22:41:23 +02001284 _PyErr_Format(tstate, PyExc_TypeError,
1285 "callable firstiter expected, got %.50s",
1286 Py_TYPE(firstiter)->tp_name);
Yury Selivanoveb636452016-09-08 22:01:51 -07001287 return NULL;
1288 }
Zackery Spytz79ceccd2020-03-26 06:11:13 -06001289 if (_PyEval_SetAsyncGenFirstiter(firstiter) < 0) {
1290 return NULL;
1291 }
Yury Selivanoveb636452016-09-08 22:01:51 -07001292 }
Zackery Spytz79ceccd2020-03-26 06:11:13 -06001293 else if (firstiter == Py_None && _PyEval_SetAsyncGenFirstiter(NULL) < 0) {
1294 return NULL;
Yury Selivanoveb636452016-09-08 22:01:51 -07001295 }
1296
1297 Py_RETURN_NONE;
1298}
1299
1300PyDoc_STRVAR(set_asyncgen_hooks_doc,
Tal Einatede0b6f2018-12-31 17:12:08 +02001301"set_asyncgen_hooks(* [, firstiter] [, finalizer])\n\
Yury Selivanoveb636452016-09-08 22:01:51 -07001302\n\
1303Set a finalizer for async generators objects."
1304);
1305
Tal Einatede0b6f2018-12-31 17:12:08 +02001306/*[clinic input]
1307sys.get_asyncgen_hooks
1308
1309Return the installed asynchronous generators hooks.
1310
1311This returns a namedtuple of the form (firstiter, finalizer).
1312[clinic start generated code]*/
1313
Yury Selivanoveb636452016-09-08 22:01:51 -07001314static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001315sys_get_asyncgen_hooks_impl(PyObject *module)
1316/*[clinic end generated code: output=53a253707146f6cf input=3676b9ea62b14625]*/
Yury Selivanoveb636452016-09-08 22:01:51 -07001317{
1318 PyObject *res;
1319 PyObject *firstiter = _PyEval_GetAsyncGenFirstiter();
1320 PyObject *finalizer = _PyEval_GetAsyncGenFinalizer();
1321
1322 res = PyStructSequence_New(&AsyncGenHooksType);
1323 if (res == NULL) {
1324 return NULL;
1325 }
1326
1327 if (firstiter == NULL) {
1328 firstiter = Py_None;
1329 }
1330
1331 if (finalizer == NULL) {
1332 finalizer = Py_None;
1333 }
1334
1335 Py_INCREF(firstiter);
1336 PyStructSequence_SET_ITEM(res, 0, firstiter);
1337
1338 Py_INCREF(finalizer);
1339 PyStructSequence_SET_ITEM(res, 1, finalizer);
1340
1341 return res;
1342}
1343
Yury Selivanoveb636452016-09-08 22:01:51 -07001344
Mark Dickinsondc787d22010-05-23 13:33:13 +00001345static PyTypeObject Hash_InfoType;
1346
1347PyDoc_STRVAR(hash_info_doc,
1348"hash_info\n\
1349\n\
Raymond Hettinger71170742019-09-11 07:17:32 -07001350A named tuple providing parameters used for computing\n\
Christian Heimes985ecdc2013-11-20 11:46:18 +01001351hashes. The attributes are read only.");
Mark Dickinsondc787d22010-05-23 13:33:13 +00001352
1353static PyStructSequence_Field hash_info_fields[] = {
1354 {"width", "width of the type used for hashing, in bits"},
1355 {"modulus", "prime number giving the modulus on which the hash "
1356 "function is based"},
1357 {"inf", "value to be used for hash of a positive infinity"},
1358 {"nan", "value to be used for hash of a nan"},
1359 {"imag", "multiplier used for the imaginary part of a complex number"},
Christian Heimes985ecdc2013-11-20 11:46:18 +01001360 {"algorithm", "name of the algorithm for hashing of str, bytes and "
1361 "memoryviews"},
1362 {"hash_bits", "internal output size of hash algorithm"},
1363 {"seed_bits", "seed size of hash algorithm"},
1364 {"cutoff", "small string optimization cutoff"},
Mark Dickinsondc787d22010-05-23 13:33:13 +00001365 {NULL, NULL}
1366};
1367
1368static PyStructSequence_Desc hash_info_desc = {
1369 "sys.hash_info",
1370 hash_info_doc,
1371 hash_info_fields,
Christian Heimes985ecdc2013-11-20 11:46:18 +01001372 9,
Mark Dickinsondc787d22010-05-23 13:33:13 +00001373};
1374
Matthias Klosed885e952010-07-06 10:53:30 +00001375static PyObject *
Victor Stinner838f2642019-06-13 22:41:23 +02001376get_hash_info(PyThreadState *tstate)
Mark Dickinsondc787d22010-05-23 13:33:13 +00001377{
1378 PyObject *hash_info;
1379 int field = 0;
Christian Heimes985ecdc2013-11-20 11:46:18 +01001380 PyHash_FuncDef *hashfunc;
Mark Dickinsondc787d22010-05-23 13:33:13 +00001381 hash_info = PyStructSequence_New(&Hash_InfoType);
1382 if (hash_info == NULL)
1383 return NULL;
Christian Heimes985ecdc2013-11-20 11:46:18 +01001384 hashfunc = PyHash_GetFuncDef();
Mark Dickinsondc787d22010-05-23 13:33:13 +00001385 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001386 PyLong_FromLong(8*sizeof(Py_hash_t)));
Mark Dickinsondc787d22010-05-23 13:33:13 +00001387 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8035bc52010-10-23 16:20:50 +00001388 PyLong_FromSsize_t(_PyHASH_MODULUS));
Mark Dickinsondc787d22010-05-23 13:33:13 +00001389 PyStructSequence_SET_ITEM(hash_info, field++,
1390 PyLong_FromLong(_PyHASH_INF));
1391 PyStructSequence_SET_ITEM(hash_info, field++,
1392 PyLong_FromLong(_PyHASH_NAN));
1393 PyStructSequence_SET_ITEM(hash_info, field++,
1394 PyLong_FromLong(_PyHASH_IMAG));
Christian Heimes985ecdc2013-11-20 11:46:18 +01001395 PyStructSequence_SET_ITEM(hash_info, field++,
1396 PyUnicode_FromString(hashfunc->name));
1397 PyStructSequence_SET_ITEM(hash_info, field++,
1398 PyLong_FromLong(hashfunc->hash_bits));
1399 PyStructSequence_SET_ITEM(hash_info, field++,
1400 PyLong_FromLong(hashfunc->seed_bits));
1401 PyStructSequence_SET_ITEM(hash_info, field++,
1402 PyLong_FromLong(Py_HASH_CUTOFF));
Victor Stinner838f2642019-06-13 22:41:23 +02001403 if (_PyErr_Occurred(tstate)) {
Mark Dickinsondc787d22010-05-23 13:33:13 +00001404 Py_CLEAR(hash_info);
1405 return NULL;
1406 }
1407 return hash_info;
1408}
Tal Einatede0b6f2018-12-31 17:12:08 +02001409/*[clinic input]
1410sys.getrecursionlimit
Mark Dickinsondc787d22010-05-23 13:33:13 +00001411
Tal Einatede0b6f2018-12-31 17:12:08 +02001412Return the current value of the recursion limit.
Mark Dickinsondc787d22010-05-23 13:33:13 +00001413
Tal Einatede0b6f2018-12-31 17:12:08 +02001414The recursion limit is the maximum depth of the Python interpreter
1415stack. This limit prevents infinite recursion from causing an overflow
1416of the C stack and crashing Python.
1417[clinic start generated code]*/
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001418
1419static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001420sys_getrecursionlimit_impl(PyObject *module)
1421/*[clinic end generated code: output=d571fb6b4549ef2e input=1c6129fd2efaeea8]*/
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001422{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001423 return PyLong_FromLong(Py_GetRecursionLimit());
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001424}
1425
Mark Hammond8696ebc2002-10-08 02:44:31 +00001426#ifdef MS_WINDOWS
Mark Hammond8696ebc2002-10-08 02:44:31 +00001427
Eric Smithf7bb5782010-01-27 00:44:57 +00001428static PyTypeObject WindowsVersionType = {0, 0, 0, 0, 0, 0};
1429
1430static PyStructSequence_Field windows_version_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001431 {"major", "Major version number"},
1432 {"minor", "Minor version number"},
1433 {"build", "Build number"},
1434 {"platform", "Operating system platform"},
1435 {"service_pack", "Latest Service Pack installed on the system"},
1436 {"service_pack_major", "Service Pack major version number"},
1437 {"service_pack_minor", "Service Pack minor version number"},
1438 {"suite_mask", "Bit mask identifying available product suites"},
1439 {"product_type", "System product type"},
Steve Dower74f4af72016-09-17 17:27:48 -07001440 {"platform_version", "Diagnostic version number"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001441 {0}
Eric Smithf7bb5782010-01-27 00:44:57 +00001442};
1443
1444static PyStructSequence_Desc windows_version_desc = {
Tal Einatede0b6f2018-12-31 17:12:08 +02001445 "sys.getwindowsversion", /* name */
1446 sys_getwindowsversion__doc__, /* doc */
1447 windows_version_fields, /* fields */
1448 5 /* For backward compatibility,
1449 only the first 5 items are accessible
1450 via indexing, the rest are name only */
Eric Smithf7bb5782010-01-27 00:44:57 +00001451};
1452
Steve Dower3e96f322015-03-02 08:01:10 -08001453/* Disable deprecation warnings about GetVersionEx as the result is
1454 being passed straight through to the caller, who is responsible for
1455 using it correctly. */
1456#pragma warning(push)
1457#pragma warning(disable:4996)
1458
Tal Einatede0b6f2018-12-31 17:12:08 +02001459/*[clinic input]
1460sys.getwindowsversion
1461
1462Return info about the running version of Windows as a named tuple.
1463
1464The members are named: major, minor, build, platform, service_pack,
1465service_pack_major, service_pack_minor, suite_mask, product_type and
1466platform_version. For backward compatibility, only the first 5 items
1467are available by indexing. All elements are numbers, except
1468service_pack and platform_type which are strings, and platform_version
1469which is a 3-tuple. Platform is always 2. Product_type may be 1 for a
1470workstation, 2 for a domain controller, 3 for a server.
1471Platform_version is a 3-tuple containing a version number that is
1472intended for identifying the OS rather than feature detection.
1473[clinic start generated code]*/
1474
Mark Hammond8696ebc2002-10-08 02:44:31 +00001475static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001476sys_getwindowsversion_impl(PyObject *module)
1477/*[clinic end generated code: output=1ec063280b932857 input=73a228a328fee63a]*/
Mark Hammond8696ebc2002-10-08 02:44:31 +00001478{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001479 PyObject *version;
1480 int pos = 0;
Minmin Gong8ebc6452019-02-02 20:26:55 -08001481 OSVERSIONINFOEXW ver;
Steve Dower74f4af72016-09-17 17:27:48 -07001482 DWORD realMajor, realMinor, realBuild;
1483 HANDLE hKernel32;
1484 wchar_t kernel32_path[MAX_PATH];
1485 LPVOID verblock;
1486 DWORD verblock_size;
Victor Stinner838f2642019-06-13 22:41:23 +02001487 PyThreadState *tstate = _PyThreadState_GET();
Steve Dower74f4af72016-09-17 17:27:48 -07001488
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001489 ver.dwOSVersionInfoSize = sizeof(ver);
Minmin Gong8ebc6452019-02-02 20:26:55 -08001490 if (!GetVersionExW((OSVERSIONINFOW*) &ver))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001491 return PyErr_SetFromWindowsErr(0);
Eric Smithf7bb5782010-01-27 00:44:57 +00001492
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 version = PyStructSequence_New(&WindowsVersionType);
1494 if (version == NULL)
1495 return NULL;
Eric Smithf7bb5782010-01-27 00:44:57 +00001496
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMajorVersion));
1498 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMinorVersion));
1499 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwBuildNumber));
1500 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwPlatformId));
Minmin Gong8ebc6452019-02-02 20:26:55 -08001501 PyStructSequence_SET_ITEM(version, pos++, PyUnicode_FromWideChar(ver.szCSDVersion, -1));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001502 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMajor));
1503 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMinor));
1504 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wSuiteMask));
1505 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wProductType));
Eric Smithf7bb5782010-01-27 00:44:57 +00001506
Steve Dower74f4af72016-09-17 17:27:48 -07001507 realMajor = ver.dwMajorVersion;
1508 realMinor = ver.dwMinorVersion;
1509 realBuild = ver.dwBuildNumber;
1510
1511 // GetVersion will lie if we are running in a compatibility mode.
1512 // We need to read the version info from a system file resource
1513 // to accurately identify the OS version. If we fail for any reason,
1514 // just return whatever GetVersion said.
Tony Roberts4860f012019-02-02 18:16:42 +01001515 Py_BEGIN_ALLOW_THREADS
Steve Dower74f4af72016-09-17 17:27:48 -07001516 hKernel32 = GetModuleHandleW(L"kernel32.dll");
Tony Roberts4860f012019-02-02 18:16:42 +01001517 Py_END_ALLOW_THREADS
Steve Dower74f4af72016-09-17 17:27:48 -07001518 if (hKernel32 && GetModuleFileNameW(hKernel32, kernel32_path, MAX_PATH) &&
1519 (verblock_size = GetFileVersionInfoSizeW(kernel32_path, NULL)) &&
1520 (verblock = PyMem_RawMalloc(verblock_size))) {
1521 VS_FIXEDFILEINFO *ffi;
1522 UINT ffi_len;
1523
1524 if (GetFileVersionInfoW(kernel32_path, 0, verblock_size, verblock) &&
1525 VerQueryValueW(verblock, L"", (LPVOID)&ffi, &ffi_len)) {
1526 realMajor = HIWORD(ffi->dwProductVersionMS);
1527 realMinor = LOWORD(ffi->dwProductVersionMS);
1528 realBuild = HIWORD(ffi->dwProductVersionLS);
1529 }
1530 PyMem_RawFree(verblock);
1531 }
Segev Finer48fb7662017-06-04 20:52:27 +03001532 PyStructSequence_SET_ITEM(version, pos++, Py_BuildValue("(kkk)",
1533 realMajor,
1534 realMinor,
1535 realBuild
Steve Dower74f4af72016-09-17 17:27:48 -07001536 ));
1537
Victor Stinner838f2642019-06-13 22:41:23 +02001538 if (_PyErr_Occurred(tstate)) {
Serhiy Storchaka48d761e2013-12-17 15:11:24 +02001539 Py_DECREF(version);
1540 return NULL;
1541 }
Steve Dower74f4af72016-09-17 17:27:48 -07001542
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001543 return version;
Mark Hammond8696ebc2002-10-08 02:44:31 +00001544}
1545
Steve Dower3e96f322015-03-02 08:01:10 -08001546#pragma warning(pop)
1547
Tal Einatede0b6f2018-12-31 17:12:08 +02001548/*[clinic input]
1549sys._enablelegacywindowsfsencoding
1550
1551Changes the default filesystem encoding to mbcs:replace.
1552
1553This is done for consistency with earlier versions of Python. See PEP
1554529 for more information.
1555
1556This is equivalent to defining the PYTHONLEGACYWINDOWSFSENCODING
1557environment variable before launching Python.
1558[clinic start generated code]*/
Steve Dowercc16be82016-09-08 10:35:16 -07001559
1560static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001561sys__enablelegacywindowsfsencoding_impl(PyObject *module)
1562/*[clinic end generated code: output=f5c3855b45e24fe9 input=2bfa931a20704492]*/
Steve Dowercc16be82016-09-08 10:35:16 -07001563{
Victor Stinner709d23d2019-05-02 14:56:30 -04001564 if (_PyUnicode_EnableLegacyWindowsFSEncoding() < 0) {
Victor Stinnerb2457ef2018-08-29 13:25:36 +02001565 return NULL;
1566 }
Steve Dowercc16be82016-09-08 10:35:16 -07001567 Py_RETURN_NONE;
1568}
1569
Mark Hammond8696ebc2002-10-08 02:44:31 +00001570#endif /* MS_WINDOWS */
1571
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001572#ifdef HAVE_DLOPEN
Tal Einatede0b6f2018-12-31 17:12:08 +02001573
1574/*[clinic input]
1575sys.setdlopenflags
1576
1577 flags as new_val: int
1578 /
1579
1580Set the flags used by the interpreter for dlopen calls.
1581
1582This is used, for example, when the interpreter loads extension
1583modules. Among other things, this will enable a lazy resolving of
1584symbols when importing a module, if called as sys.setdlopenflags(0).
1585To share symbols across extension modules, call as
1586sys.setdlopenflags(os.RTLD_GLOBAL). Symbolic names for the flag
1587modules can be found in the os module (RTLD_xxx constants, e.g.
1588os.RTLD_LAZY).
1589[clinic start generated code]*/
1590
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001591static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001592sys_setdlopenflags_impl(PyObject *module, int new_val)
1593/*[clinic end generated code: output=ec918b7fe0a37281 input=4c838211e857a77f]*/
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001594{
Victor Stinner838f2642019-06-13 22:41:23 +02001595 PyThreadState *tstate = _PyThreadState_GET();
1596 tstate->interp->dlopenflags = new_val;
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001597 Py_RETURN_NONE;
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001598}
1599
Tal Einatede0b6f2018-12-31 17:12:08 +02001600
1601/*[clinic input]
1602sys.getdlopenflags
1603
1604Return the current value of the flags that are used for dlopen calls.
1605
1606The flag constants are defined in the os module.
1607[clinic start generated code]*/
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001608
1609static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001610sys_getdlopenflags_impl(PyObject *module)
1611/*[clinic end generated code: output=e92cd1bc5005da6e input=dc4ea0899c53b4b6]*/
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001612{
Victor Stinner838f2642019-06-13 22:41:23 +02001613 PyThreadState *tstate = _PyThreadState_GET();
1614 return PyLong_FromLong(tstate->interp->dlopenflags);
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001615}
1616
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001617#endif /* HAVE_DLOPEN */
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001618
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001619#ifdef USE_MALLOPT
1620/* Link with -lmalloc (or -lmpc) on an SGI */
1621#include <malloc.h>
1622
Tal Einatede0b6f2018-12-31 17:12:08 +02001623/*[clinic input]
1624sys.mdebug
1625
1626 flag: int
1627 /
1628[clinic start generated code]*/
1629
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001630static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001631sys_mdebug_impl(PyObject *module, int flag)
1632/*[clinic end generated code: output=5431d545847c3637 input=151d150ae1636f8a]*/
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001633{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001634 int flag;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001635 mallopt(M_DEBUG, flag);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001636 Py_RETURN_NONE;
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001637}
1638#endif /* USE_MALLOPT */
1639
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001640size_t
1641_PySys_GetSizeOf(PyObject *o)
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001642{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 PyObject *res = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001644 PyObject *method;
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001645 Py_ssize_t size;
Victor Stinner838f2642019-06-13 22:41:23 +02001646 PyThreadState *tstate = _PyThreadState_GET();
Benjamin Petersona5758c02009-05-09 18:15:04 +00001647
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 /* Make sure the type is initialized. float gets initialized late */
Victor Stinner838f2642019-06-13 22:41:23 +02001649 if (PyType_Ready(Py_TYPE(o)) < 0) {
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001650 return (size_t)-1;
Victor Stinner838f2642019-06-13 22:41:23 +02001651 }
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +00001652
Benjamin Petersonce798522012-01-22 11:24:29 -05001653 method = _PyObject_LookupSpecial(o, &PyId___sizeof__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001654 if (method == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +02001655 if (!_PyErr_Occurred(tstate)) {
1656 _PyErr_Format(tstate, PyExc_TypeError,
1657 "Type %.100s doesn't define __sizeof__",
1658 Py_TYPE(o)->tp_name);
1659 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001660 }
1661 else {
Victor Stinnerf17c3de2016-12-06 18:46:19 +01001662 res = _PyObject_CallNoArg(method);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001663 Py_DECREF(method);
1664 }
1665
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001666 if (res == NULL)
1667 return (size_t)-1;
1668
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001669 size = PyLong_AsSsize_t(res);
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001670 Py_DECREF(res);
Victor Stinner838f2642019-06-13 22:41:23 +02001671 if (size == -1 && _PyErr_Occurred(tstate))
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001672 return (size_t)-1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001673
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001674 if (size < 0) {
Victor Stinner838f2642019-06-13 22:41:23 +02001675 _PyErr_SetString(tstate, PyExc_ValueError,
1676 "__sizeof__() should return >= 0");
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001677 return (size_t)-1;
1678 }
1679
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 /* add gc_head size */
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001681 if (PyObject_IS_GC(o))
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001682 return ((size_t)size) + sizeof(PyGC_Head);
1683 return (size_t)size;
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001684}
1685
1686static PyObject *
1687sys_getsizeof(PyObject *self, PyObject *args, PyObject *kwds)
1688{
1689 static char *kwlist[] = {"object", "default", 0};
1690 size_t size;
1691 PyObject *o, *dflt = NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02001692 PyThreadState *tstate = _PyThreadState_GET();
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001693
1694 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|O:getsizeof",
Victor Stinner838f2642019-06-13 22:41:23 +02001695 kwlist, &o, &dflt)) {
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001696 return NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02001697 }
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001698
1699 size = _PySys_GetSizeOf(o);
1700
Victor Stinner838f2642019-06-13 22:41:23 +02001701 if (size == (size_t)-1 && _PyErr_Occurred(tstate)) {
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001702 /* Has a default value been given */
Victor Stinner838f2642019-06-13 22:41:23 +02001703 if (dflt != NULL && _PyErr_ExceptionMatches(tstate, PyExc_TypeError)) {
1704 _PyErr_Clear(tstate);
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001705 Py_INCREF(dflt);
1706 return dflt;
1707 }
1708 else
1709 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001710 }
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001711
1712 return PyLong_FromSize_t(size);
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001713}
1714
1715PyDoc_STRVAR(getsizeof_doc,
Tal Einatede0b6f2018-12-31 17:12:08 +02001716"getsizeof(object [, default]) -> int\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001717\n\
1718Return the size of object in bytes.");
1719
Tal Einatede0b6f2018-12-31 17:12:08 +02001720/*[clinic input]
1721sys.getrefcount -> Py_ssize_t
1722
1723 object: object
1724 /
1725
1726Return the reference count of object.
1727
1728The count returned is generally one higher than you might expect,
1729because it includes the (temporary) reference as an argument to
1730getrefcount().
1731[clinic start generated code]*/
1732
1733static Py_ssize_t
1734sys_getrefcount_impl(PyObject *module, PyObject *object)
1735/*[clinic end generated code: output=5fd477f2264b85b2 input=bf474efd50a21535]*/
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001736{
Victor Stinnera93c51e2020-02-07 00:38:59 +01001737 return Py_REFCNT(object);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001738}
1739
Tim Peters4be93d02002-07-07 19:59:50 +00001740#ifdef Py_REF_DEBUG
Tal Einatede0b6f2018-12-31 17:12:08 +02001741/*[clinic input]
1742sys.gettotalrefcount -> Py_ssize_t
1743[clinic start generated code]*/
1744
1745static Py_ssize_t
1746sys_gettotalrefcount_impl(PyObject *module)
1747/*[clinic end generated code: output=4103886cf17c25bc input=53b744faa5d2e4f6]*/
Mark Hammond440d8982000-06-20 08:12:48 +00001748{
Tal Einatede0b6f2018-12-31 17:12:08 +02001749 return _Py_GetRefTotal();
Mark Hammond440d8982000-06-20 08:12:48 +00001750}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001751#endif /* Py_REF_DEBUG */
Mark Hammond440d8982000-06-20 08:12:48 +00001752
Tal Einatede0b6f2018-12-31 17:12:08 +02001753/*[clinic input]
1754sys.getallocatedblocks -> Py_ssize_t
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001755
Tal Einatede0b6f2018-12-31 17:12:08 +02001756Return the number of memory blocks currently allocated.
1757[clinic start generated code]*/
1758
1759static Py_ssize_t
1760sys_getallocatedblocks_impl(PyObject *module)
1761/*[clinic end generated code: output=f0c4e873f0b6dcf7 input=dab13ee346a0673e]*/
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001762{
Tal Einatede0b6f2018-12-31 17:12:08 +02001763 return _Py_GetAllocatedBlocks();
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001764}
1765
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001766
Tal Einatede0b6f2018-12-31 17:12:08 +02001767/*[clinic input]
1768sys._getframe
1769
1770 depth: int = 0
1771 /
1772
1773Return a frame object from the call stack.
1774
1775If optional integer depth is given, return the frame object that many
1776calls below the top of the stack. If that is deeper than the call
1777stack, ValueError is raised. The default for depth is zero, returning
1778the frame at the top of the call stack.
1779
1780This function should be used for internal and specialized purposes
1781only.
1782[clinic start generated code]*/
Barry Warsawb6a54d22000-12-06 21:47:46 +00001783
1784static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001785sys__getframe_impl(PyObject *module, int depth)
1786/*[clinic end generated code: output=d438776c04d59804 input=c1be8a6464b11ee5]*/
Barry Warsawb6a54d22000-12-06 21:47:46 +00001787{
Victor Stinner838f2642019-06-13 22:41:23 +02001788 PyThreadState *tstate = _PyThreadState_GET();
1789 PyFrameObject *f = tstate->frame;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001790
Victor Stinner08faf002020-03-26 18:57:32 +01001791 if (_PySys_Audit(tstate, "sys._getframe", "O", f) < 0) {
Steve Dowerb82e17e2019-05-23 08:45:22 -07001792 return NULL;
1793 }
1794
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001795 while (depth > 0 && f != NULL) {
1796 f = f->f_back;
1797 --depth;
1798 }
1799 if (f == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +02001800 _PyErr_SetString(tstate, PyExc_ValueError,
1801 "call stack is not deep enough");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001802 return NULL;
1803 }
1804 Py_INCREF(f);
1805 return (PyObject*)f;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001806}
1807
Tal Einatede0b6f2018-12-31 17:12:08 +02001808/*[clinic input]
1809sys._current_frames
1810
1811Return a dict mapping each thread's thread id to its current stack frame.
1812
1813This function should be used for specialized purposes only.
1814[clinic start generated code]*/
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001815
1816static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001817sys__current_frames_impl(PyObject *module)
1818/*[clinic end generated code: output=d2a41ac0a0a3809a input=2a9049c5f5033691]*/
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001819{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001820 return _PyThread_CurrentFrames();
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001821}
1822
Tal Einatede0b6f2018-12-31 17:12:08 +02001823/*[clinic input]
1824sys.call_tracing
1825
1826 func: object
1827 args as funcargs: object(subclass_of='&PyTuple_Type')
1828 /
1829
1830Call func(*args), while tracing is enabled.
1831
1832The tracing state is saved, and restored afterwards. This is intended
1833to be called from a debugger from a checkpoint, to recursively debug
1834some other code.
1835[clinic start generated code]*/
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001836
1837static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001838sys_call_tracing_impl(PyObject *module, PyObject *func, PyObject *funcargs)
1839/*[clinic end generated code: output=7e4999853cd4e5a6 input=5102e8b11049f92f]*/
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001840{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001841 return _PyEval_CallTracing(func, funcargs);
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001842}
1843
Victor Stinner048afd92016-11-28 11:59:04 +01001844
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001845#ifdef __cplusplus
1846extern "C" {
1847#endif
1848
Tal Einatede0b6f2018-12-31 17:12:08 +02001849/*[clinic input]
1850sys._debugmallocstats
1851
1852Print summary info to stderr about the state of pymalloc's structures.
1853
1854In Py_DEBUG mode, also perform some expensive internal consistency
1855checks.
1856[clinic start generated code]*/
1857
David Malcolm49526f42012-06-22 14:55:41 -04001858static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001859sys__debugmallocstats_impl(PyObject *module)
1860/*[clinic end generated code: output=ec3565f8c7cee46a input=33c0c9c416f98424]*/
David Malcolm49526f42012-06-22 14:55:41 -04001861{
1862#ifdef WITH_PYMALLOC
Victor Stinner6bf992a2017-12-06 17:26:10 +01001863 if (_PyObject_DebugMallocStats(stderr)) {
Victor Stinner34be8072016-03-14 12:04:26 +01001864 fputc('\n', stderr);
1865 }
David Malcolm49526f42012-06-22 14:55:41 -04001866#endif
1867 _PyObject_DebugTypeStats(stderr);
1868
1869 Py_RETURN_NONE;
1870}
David Malcolm49526f42012-06-22 14:55:41 -04001871
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001872#ifdef Py_TRACE_REFS
Guido van Rossumded690f1996-05-24 20:48:31 +00001873/* Defined in objects.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001874extern PyObject *_Py_GetObjects(PyObject *, PyObject *);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001875#endif
Guido van Rossumded690f1996-05-24 20:48:31 +00001876
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001877#ifdef DYNAMIC_EXECUTION_PROFILE
1878/* Defined in ceval.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001879extern PyObject *_Py_GetDXProfile(PyObject *, PyObject *);
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001880#endif
1881
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001882#ifdef __cplusplus
1883}
1884#endif
1885
Tal Einatede0b6f2018-12-31 17:12:08 +02001886
1887/*[clinic input]
1888sys._clear_type_cache
1889
1890Clear the internal type lookup cache.
1891[clinic start generated code]*/
1892
Christian Heimes15ebc882008-02-04 18:48:49 +00001893static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001894sys__clear_type_cache_impl(PyObject *module)
1895/*[clinic end generated code: output=20e48ca54a6f6971 input=127f3e04a8d9b555]*/
Christian Heimes15ebc882008-02-04 18:48:49 +00001896{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001897 PyType_ClearCache();
1898 Py_RETURN_NONE;
Christian Heimes15ebc882008-02-04 18:48:49 +00001899}
1900
Tal Einatede0b6f2018-12-31 17:12:08 +02001901/*[clinic input]
1902sys.is_finalizing
1903
1904Return True if Python is exiting.
1905[clinic start generated code]*/
1906
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001907static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001908sys_is_finalizing_impl(PyObject *module)
1909/*[clinic end generated code: output=735b5ff7962ab281 input=f0df747a039948a5]*/
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001910{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001911 return PyBool_FromLong(_Py_IsFinalizing());
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001912}
1913
Victor Stinnerd6958ac2016-12-02 01:13:46 +01001914#ifdef ANDROID_API_LEVEL
Tal Einatede0b6f2018-12-31 17:12:08 +02001915/*[clinic input]
1916sys.getandroidapilevel
1917
1918Return the build time API version of Android as an integer.
1919[clinic start generated code]*/
Victor Stinnerd6958ac2016-12-02 01:13:46 +01001920
1921static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001922sys_getandroidapilevel_impl(PyObject *module)
1923/*[clinic end generated code: output=214abf183a1c70c1 input=3e6d6c9fcdd24ac6]*/
Victor Stinnerd6958ac2016-12-02 01:13:46 +01001924{
1925 return PyLong_FromLong(ANDROID_API_LEVEL);
1926}
1927#endif /* ANDROID_API_LEVEL */
1928
1929
Steve Dowerb82e17e2019-05-23 08:45:22 -07001930
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001931static PyMethodDef sys_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001932 /* Might as well keep this in alphabetic order */
Steve Dowerb82e17e2019-05-23 08:45:22 -07001933 SYS_ADDAUDITHOOK_METHODDEF
1934 {"audit", (PyCFunction)(void(*)(void))sys_audit, METH_FASTCALL, audit_doc },
Serhiy Storchaka62be7422018-11-27 13:27:31 +02001935 {"breakpointhook", (PyCFunction)(void(*)(void))sys_breakpointhook,
Barry Warsaw36c1d1f2017-10-05 12:11:18 -04001936 METH_FASTCALL | METH_KEYWORDS, breakpointhook_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001937 SYS__CLEAR_TYPE_CACHE_METHODDEF
1938 SYS__CURRENT_FRAMES_METHODDEF
1939 SYS_DISPLAYHOOK_METHODDEF
1940 SYS_EXC_INFO_METHODDEF
1941 SYS_EXCEPTHOOK_METHODDEF
1942 SYS_EXIT_METHODDEF
1943 SYS_GETDEFAULTENCODING_METHODDEF
1944 SYS_GETDLOPENFLAGS_METHODDEF
1945 SYS_GETALLOCATEDBLOCKS_METHODDEF
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001946#ifdef DYNAMIC_EXECUTION_PROFILE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001947 {"getdxp", _Py_GetDXProfile, METH_VARARGS},
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001948#endif
Tal Einatede0b6f2018-12-31 17:12:08 +02001949 SYS_GETFILESYSTEMENCODING_METHODDEF
1950 SYS_GETFILESYSTEMENCODEERRORS_METHODDEF
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001951#ifdef Py_TRACE_REFS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001952 {"getobjects", _Py_GetObjects, METH_VARARGS},
Tim Peters4be93d02002-07-07 19:59:50 +00001953#endif
Tal Einatede0b6f2018-12-31 17:12:08 +02001954 SYS_GETTOTALREFCOUNT_METHODDEF
1955 SYS_GETREFCOUNT_METHODDEF
1956 SYS_GETRECURSIONLIMIT_METHODDEF
Serhiy Storchaka62be7422018-11-27 13:27:31 +02001957 {"getsizeof", (PyCFunction)(void(*)(void))sys_getsizeof,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001958 METH_VARARGS | METH_KEYWORDS, getsizeof_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001959 SYS__GETFRAME_METHODDEF
1960 SYS_GETWINDOWSVERSION_METHODDEF
1961 SYS__ENABLELEGACYWINDOWSFSENCODING_METHODDEF
1962 SYS_INTERN_METHODDEF
1963 SYS_IS_FINALIZING_METHODDEF
1964 SYS_MDEBUG_METHODDEF
Tal Einatede0b6f2018-12-31 17:12:08 +02001965 SYS_SETSWITCHINTERVAL_METHODDEF
1966 SYS_GETSWITCHINTERVAL_METHODDEF
1967 SYS_SETDLOPENFLAGS_METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001968 {"setprofile", sys_setprofile, METH_O, setprofile_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001969 SYS_GETPROFILE_METHODDEF
1970 SYS_SETRECURSIONLIMIT_METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001971 {"settrace", sys_settrace, METH_O, settrace_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001972 SYS_GETTRACE_METHODDEF
1973 SYS_CALL_TRACING_METHODDEF
1974 SYS__DEBUGMALLOCSTATS_METHODDEF
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001975 SYS_SET_COROUTINE_ORIGIN_TRACKING_DEPTH_METHODDEF
1976 SYS_GET_COROUTINE_ORIGIN_TRACKING_DEPTH_METHODDEF
Serhiy Storchaka62be7422018-11-27 13:27:31 +02001977 {"set_asyncgen_hooks", (PyCFunction)(void(*)(void))sys_set_asyncgen_hooks,
Yury Selivanoveb636452016-09-08 22:01:51 -07001978 METH_VARARGS | METH_KEYWORDS, set_asyncgen_hooks_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001979 SYS_GET_ASYNCGEN_HOOKS_METHODDEF
1980 SYS_GETANDROIDAPILEVEL_METHODDEF
Victor Stinneref9d9b62019-05-22 11:28:22 +02001981 SYS_UNRAISABLEHOOK_METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001982 {NULL, NULL} /* sentinel */
Guido van Rossum3f5da241990-12-20 15:06:42 +00001983};
1984
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001985static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001986list_builtin_module_names(void)
Guido van Rossum34679b71993-01-26 13:33:44 +00001987{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001988 PyObject *list = PyList_New(0);
1989 int i;
1990 if (list == NULL)
1991 return NULL;
1992 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1993 PyObject *name = PyUnicode_FromString(
1994 PyImport_Inittab[i].name);
1995 if (name == NULL)
1996 break;
1997 PyList_Append(list, name);
1998 Py_DECREF(name);
1999 }
2000 if (PyList_Sort(list) != 0) {
2001 Py_DECREF(list);
2002 list = NULL;
2003 }
2004 if (list) {
2005 PyObject *v = PyList_AsTuple(list);
2006 Py_DECREF(list);
2007 list = v;
2008 }
2009 return list;
Guido van Rossum34679b71993-01-26 13:33:44 +00002010}
2011
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002012/* Pre-initialization support for sys.warnoptions and sys._xoptions
2013 *
2014 * Modern internal code paths:
2015 * These APIs get called after _Py_InitializeCore and get to use the
2016 * regular CPython list, dict, and unicode APIs.
2017 *
2018 * Legacy embedding code paths:
2019 * The multi-phase initialization API isn't public yet, so embedding
2020 * apps still need to be able configure sys.warnoptions and sys._xoptions
2021 * before they call Py_Initialize. To support this, we stash copies of
2022 * the supplied wchar * sequences in linked lists, and then migrate the
2023 * contents of those lists to the sys module in _PyInitializeCore.
2024 *
2025 */
2026
2027struct _preinit_entry {
2028 wchar_t *value;
2029 struct _preinit_entry *next;
2030};
2031
2032typedef struct _preinit_entry *_Py_PreInitEntry;
2033
2034static _Py_PreInitEntry _preinit_warnoptions = NULL;
2035static _Py_PreInitEntry _preinit_xoptions = NULL;
2036
2037static _Py_PreInitEntry
2038_alloc_preinit_entry(const wchar_t *value)
2039{
2040 /* To get this to work, we have to initialize the runtime implicitly */
2041 _PyRuntime_Initialize();
2042
2043 /* Force default allocator, so we can ensure that it also gets used to
2044 * destroy the linked list in _clear_preinit_entries.
2045 */
2046 PyMemAllocatorEx old_alloc;
2047 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2048
2049 _Py_PreInitEntry node = PyMem_RawCalloc(1, sizeof(*node));
2050 if (node != NULL) {
2051 node->value = _PyMem_RawWcsdup(value);
2052 if (node->value == NULL) {
2053 PyMem_RawFree(node);
2054 node = NULL;
2055 };
2056 };
2057
2058 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2059 return node;
Zackery Spytz1a2252e2019-05-06 10:56:51 -06002060}
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002061
2062static int
2063_append_preinit_entry(_Py_PreInitEntry *optionlist, const wchar_t *value)
2064{
2065 _Py_PreInitEntry new_entry = _alloc_preinit_entry(value);
2066 if (new_entry == NULL) {
2067 return -1;
2068 }
2069 /* We maintain the linked list in this order so it's easy to play back
2070 * the add commands in the same order later on in _Py_InitializeCore
2071 */
2072 _Py_PreInitEntry last_entry = *optionlist;
2073 if (last_entry == NULL) {
2074 *optionlist = new_entry;
2075 } else {
2076 while (last_entry->next != NULL) {
2077 last_entry = last_entry->next;
2078 }
2079 last_entry->next = new_entry;
2080 }
2081 return 0;
Zackery Spytz1a2252e2019-05-06 10:56:51 -06002082}
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002083
2084static void
2085_clear_preinit_entries(_Py_PreInitEntry *optionlist)
2086{
2087 _Py_PreInitEntry current = *optionlist;
2088 *optionlist = NULL;
2089 /* Deallocate the nodes and their contents using the default allocator */
2090 PyMemAllocatorEx old_alloc;
2091 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2092 while (current != NULL) {
2093 _Py_PreInitEntry next = current->next;
2094 PyMem_RawFree(current->value);
2095 PyMem_RawFree(current);
2096 current = next;
2097 }
2098 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
Zackery Spytz1a2252e2019-05-06 10:56:51 -06002099}
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002100
Victor Stinner120b7072019-08-23 18:03:08 +01002101
2102PyStatus
Victor Stinnerfb4ae152019-09-30 01:40:17 +02002103_PySys_ReadPreinitWarnOptions(PyWideStringList *options)
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002104{
Victor Stinner120b7072019-08-23 18:03:08 +01002105 PyStatus status;
2106 _Py_PreInitEntry entry;
2107
2108 for (entry = _preinit_warnoptions; entry != NULL; entry = entry->next) {
Victor Stinnerfb4ae152019-09-30 01:40:17 +02002109 status = PyWideStringList_Append(options, entry->value);
Victor Stinner120b7072019-08-23 18:03:08 +01002110 if (_PyStatus_EXCEPTION(status)) {
2111 return status;
2112 }
2113 }
2114
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002115 _clear_preinit_entries(&_preinit_warnoptions);
Victor Stinner120b7072019-08-23 18:03:08 +01002116 return _PyStatus_OK();
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002117}
2118
Victor Stinner120b7072019-08-23 18:03:08 +01002119
2120PyStatus
2121_PySys_ReadPreinitXOptions(PyConfig *config)
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002122{
Victor Stinner120b7072019-08-23 18:03:08 +01002123 PyStatus status;
2124 _Py_PreInitEntry entry;
2125
2126 for (entry = _preinit_xoptions; entry != NULL; entry = entry->next) {
2127 status = PyWideStringList_Append(&config->xoptions, entry->value);
2128 if (_PyStatus_EXCEPTION(status)) {
2129 return status;
2130 }
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002131 }
2132
Victor Stinner120b7072019-08-23 18:03:08 +01002133 _clear_preinit_entries(&_preinit_xoptions);
2134 return _PyStatus_OK();
Zackery Spytz1a2252e2019-05-06 10:56:51 -06002135}
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002136
Victor Stinner120b7072019-08-23 18:03:08 +01002137
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002138static PyObject *
Victor Stinner838f2642019-06-13 22:41:23 +02002139get_warnoptions(PyThreadState *tstate)
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002140{
Victor Stinner838f2642019-06-13 22:41:23 +02002141 PyObject *warnoptions = sys_get_object_id(tstate, &PyId_warnoptions);
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002142 if (warnoptions == NULL || !PyList_Check(warnoptions)) {
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002143 /* PEP432 TODO: we can reach this if warnoptions is NULL in the main
2144 * interpreter config. When that happens, we need to properly set
2145 * the `warnoptions` reference in the main interpreter config as well.
2146 *
2147 * For Python 3.7, we shouldn't be able to get here due to the
2148 * combination of how _PyMainInterpreter_ReadConfig and _PySys_EndInit
2149 * work, but we expect 3.8+ to make the _PyMainInterpreter_ReadConfig
2150 * call optional for embedding applications, thus making this
2151 * reachable again.
2152 */
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002153 warnoptions = PyList_New(0);
Victor Stinner838f2642019-06-13 22:41:23 +02002154 if (warnoptions == NULL) {
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002155 return NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02002156 }
2157 if (sys_set_object_id(tstate, &PyId_warnoptions, warnoptions)) {
Eric Snowdae02762017-09-14 00:35:58 -07002158 Py_DECREF(warnoptions);
2159 return NULL;
2160 }
2161 Py_DECREF(warnoptions);
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002162 }
2163 return warnoptions;
2164}
Guido van Rossum23fff912000-12-15 22:02:05 +00002165
2166void
2167PySys_ResetWarnOptions(void)
2168{
Victor Stinner50b48572018-11-01 01:51:40 +01002169 PyThreadState *tstate = _PyThreadState_GET();
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002170 if (tstate == NULL) {
2171 _clear_preinit_entries(&_preinit_warnoptions);
2172 return;
2173 }
2174
Victor Stinner838f2642019-06-13 22:41:23 +02002175 PyObject *warnoptions = sys_get_object_id(tstate, &PyId_warnoptions);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002176 if (warnoptions == NULL || !PyList_Check(warnoptions))
2177 return;
2178 PyList_SetSlice(warnoptions, 0, PyList_GET_SIZE(warnoptions), NULL);
Guido van Rossum23fff912000-12-15 22:02:05 +00002179}
2180
Victor Stinnere1b29952018-10-30 14:31:42 +01002181static int
Victor Stinner838f2642019-06-13 22:41:23 +02002182_PySys_AddWarnOptionWithError(PyThreadState *tstate, PyObject *option)
Guido van Rossum23fff912000-12-15 22:02:05 +00002183{
Victor Stinner838f2642019-06-13 22:41:23 +02002184 PyObject *warnoptions = get_warnoptions(tstate);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002185 if (warnoptions == NULL) {
2186 return -1;
2187 }
2188 if (PyList_Append(warnoptions, option)) {
2189 return -1;
2190 }
2191 return 0;
2192}
2193
2194void
2195PySys_AddWarnOptionUnicode(PyObject *option)
2196{
Victor Stinner838f2642019-06-13 22:41:23 +02002197 PyThreadState *tstate = _PyThreadState_GET();
2198 if (_PySys_AddWarnOptionWithError(tstate, option) < 0) {
Victor Stinnere1b29952018-10-30 14:31:42 +01002199 /* No return value, therefore clear error state if possible */
Victor Stinner838f2642019-06-13 22:41:23 +02002200 if (tstate) {
2201 _PyErr_Clear(tstate);
Victor Stinnere1b29952018-10-30 14:31:42 +01002202 }
2203 }
Victor Stinner9ca9c252010-05-19 16:53:30 +00002204}
2205
2206void
2207PySys_AddWarnOption(const wchar_t *s)
2208{
Victor Stinner50b48572018-11-01 01:51:40 +01002209 PyThreadState *tstate = _PyThreadState_GET();
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002210 if (tstate == NULL) {
2211 _append_preinit_entry(&_preinit_warnoptions, s);
2212 return;
2213 }
Victor Stinner9ca9c252010-05-19 16:53:30 +00002214 PyObject *unicode;
2215 unicode = PyUnicode_FromWideChar(s, -1);
2216 if (unicode == NULL)
2217 return;
2218 PySys_AddWarnOptionUnicode(unicode);
2219 Py_DECREF(unicode);
Guido van Rossum23fff912000-12-15 22:02:05 +00002220}
2221
Christian Heimes33fe8092008-04-13 13:53:33 +00002222int
2223PySys_HasWarnOptions(void)
2224{
Victor Stinner838f2642019-06-13 22:41:23 +02002225 PyThreadState *tstate = _PyThreadState_GET();
2226 PyObject *warnoptions = sys_get_object_id(tstate, &PyId_warnoptions);
Serhiy Storchakadffccc62018-12-10 13:50:22 +02002227 return (warnoptions != NULL && PyList_Check(warnoptions)
2228 && PyList_GET_SIZE(warnoptions) > 0);
Christian Heimes33fe8092008-04-13 13:53:33 +00002229}
2230
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002231static PyObject *
Victor Stinner838f2642019-06-13 22:41:23 +02002232get_xoptions(PyThreadState *tstate)
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002233{
Victor Stinner838f2642019-06-13 22:41:23 +02002234 PyObject *xoptions = sys_get_object_id(tstate, &PyId__xoptions);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002235 if (xoptions == NULL || !PyDict_Check(xoptions)) {
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002236 /* PEP432 TODO: we can reach this if xoptions is NULL in the main
2237 * interpreter config. When that happens, we need to properly set
2238 * the `xoptions` reference in the main interpreter config as well.
2239 *
2240 * For Python 3.7, we shouldn't be able to get here due to the
2241 * combination of how _PyMainInterpreter_ReadConfig and _PySys_EndInit
2242 * work, but we expect 3.8+ to make the _PyMainInterpreter_ReadConfig
2243 * call optional for embedding applications, thus making this
2244 * reachable again.
2245 */
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002246 xoptions = PyDict_New();
Victor Stinner838f2642019-06-13 22:41:23 +02002247 if (xoptions == NULL) {
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002248 return NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02002249 }
2250 if (sys_set_object_id(tstate, &PyId__xoptions, xoptions)) {
Eric Snowdae02762017-09-14 00:35:58 -07002251 Py_DECREF(xoptions);
2252 return NULL;
2253 }
2254 Py_DECREF(xoptions);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002255 }
2256 return xoptions;
2257}
2258
Victor Stinnere1b29952018-10-30 14:31:42 +01002259static int
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002260_PySys_AddXOptionWithError(const wchar_t *s)
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002261{
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002262 PyObject *name = NULL, *value = NULL;
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002263
Victor Stinner838f2642019-06-13 22:41:23 +02002264 PyThreadState *tstate = _PyThreadState_GET();
2265 PyObject *opts = get_xoptions(tstate);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002266 if (opts == NULL) {
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002267 goto error;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002268 }
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002269
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002270 const wchar_t *name_end = wcschr(s, L'=');
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002271 if (!name_end) {
2272 name = PyUnicode_FromWideChar(s, -1);
2273 value = Py_True;
2274 Py_INCREF(value);
2275 }
2276 else {
2277 name = PyUnicode_FromWideChar(s, name_end - s);
2278 value = PyUnicode_FromWideChar(name_end + 1, -1);
2279 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002280 if (name == NULL || value == NULL) {
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002281 goto error;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002282 }
2283 if (PyDict_SetItem(opts, name, value) < 0) {
2284 goto error;
2285 }
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002286 Py_DECREF(name);
2287 Py_DECREF(value);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002288 return 0;
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002289
2290error:
2291 Py_XDECREF(name);
2292 Py_XDECREF(value);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002293 return -1;
2294}
2295
2296void
2297PySys_AddXOption(const wchar_t *s)
2298{
Victor Stinner50b48572018-11-01 01:51:40 +01002299 PyThreadState *tstate = _PyThreadState_GET();
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002300 if (tstate == NULL) {
2301 _append_preinit_entry(&_preinit_xoptions, s);
2302 return;
2303 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002304 if (_PySys_AddXOptionWithError(s) < 0) {
2305 /* No return value, therefore clear error state if possible */
Victor Stinner120b7072019-08-23 18:03:08 +01002306 _PyErr_Clear(tstate);
Victor Stinner0cae6092016-11-11 01:43:56 +01002307 }
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002308}
2309
2310PyObject *
2311PySys_GetXOptions(void)
2312{
Victor Stinner838f2642019-06-13 22:41:23 +02002313 PyThreadState *tstate = _PyThreadState_GET();
2314 return get_xoptions(tstate);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002315}
2316
Guido van Rossum40552d01998-08-06 03:34:39 +00002317/* XXX This doc string is too long to be a single string literal in VC++ 5.0.
2318 Two literals concatenated works just fine. If you have a K&R compiler
2319 or other abomination that however *does* understand longer strings,
2320 get rid of the !!! comment in the middle and the quotes that surround it. */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002321PyDoc_VAR(sys_doc) =
2322PyDoc_STR(
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002323"This module provides access to some objects used or maintained by the\n\
2324interpreter and to functions that interact strongly with the interpreter.\n\
2325\n\
2326Dynamic objects:\n\
2327\n\
2328argv -- command line arguments; argv[0] is the script pathname if known\n\
2329path -- module search path; path[0] is the script directory, else ''\n\
2330modules -- dictionary of loaded modules\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002331\n\
2332displayhook -- called to show results in an interactive session\n\
2333excepthook -- called to handle any uncaught exception other than SystemExit\n\
2334 To customize printing in an interactive session or to install a custom\n\
2335 top-level exception handler, assign other functions to replace these.\n\
2336\n\
Benjamin Peterson06157a42008-07-15 00:28:36 +00002337stdin -- standard input file object; used by input()\n\
Georg Brandl88fc6642007-02-09 21:28:07 +00002338stdout -- standard output file object; used by print()\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002339stderr -- standard error object; used for error messages\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002340 By assigning other file objects (or objects that behave like files)\n\
2341 to these, it is possible to redirect all of the interpreter's I/O.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002342\n\
2343last_type -- type of last uncaught exception\n\
2344last_value -- value of last uncaught exception\n\
2345last_traceback -- traceback of last uncaught exception\n\
2346 These three are only available in an interactive session after a\n\
2347 traceback has been printed.\n\
Guido van Rossuma71b5f41999-01-14 19:07:00 +00002348"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002349)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002350/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002351PyDoc_STR(
Guido van Rossuma71b5f41999-01-14 19:07:00 +00002352"\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002353Static objects:\n\
2354\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002355builtin_module_names -- tuple of module names built into this interpreter\n\
2356copyright -- copyright notice pertaining to this interpreter\n\
2357exec_prefix -- prefix used to find the machine-specific Python library\n\
Petri Lehtinen4b0eab62012-02-02 21:23:15 +02002358executable -- absolute path of the executable binary of the Python interpreter\n\
Raymond Hettinger71170742019-09-11 07:17:32 -07002359float_info -- a named tuple with information about the float implementation.\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002360float_repr_style -- string indicating the style of repr() output for floats\n\
Raymond Hettinger71170742019-09-11 07:17:32 -07002361hash_info -- a named tuple with information about the hash algorithm.\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002362hexversion -- version information encoded as a single integer\n\
Barry Warsaw409da152012-06-03 16:18:47 -04002363implementation -- Python implementation information.\n\
Raymond Hettinger71170742019-09-11 07:17:32 -07002364int_info -- a named tuple with information about the int implementation.\n\
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00002365maxsize -- the largest supported length of containers.\n\
Serhiy Storchakad3faf432015-01-18 11:28:37 +02002366maxunicode -- the value of the largest Unicode code point\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002367platform -- platform identifier\n\
2368prefix -- prefix used to find the Python library\n\
Raymond Hettinger71170742019-09-11 07:17:32 -07002369thread_info -- a named tuple with information about the thread implementation.\n\
Fred Drake801c08d2000-04-13 15:29:10 +00002370version -- the version of this interpreter as a string\n\
Eric Smith0e5b5622009-02-06 01:32:42 +00002371version_info -- version information as a named tuple\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002372"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002373)
Steve Dowercc16be82016-09-08 10:35:16 -07002374#ifdef MS_COREDLL
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002375/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002376PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002377"dllhandle -- [Windows only] integer handle of the Python DLL\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002378winver -- [Windows only] version number of the Python DLL\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002379"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002380)
Steve Dowercc16be82016-09-08 10:35:16 -07002381#endif /* MS_COREDLL */
2382#ifdef MS_WINDOWS
2383/* concatenating string here */
2384PyDoc_STR(
oldkaa0735f2018-02-02 16:52:55 +08002385"_enablelegacywindowsfsencoding -- [Windows only]\n\
Steve Dowercc16be82016-09-08 10:35:16 -07002386"
2387)
2388#endif
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002389PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002390"__stdin__ -- the original stdin; don't touch!\n\
2391__stdout__ -- the original stdout; don't touch!\n\
2392__stderr__ -- the original stderr; don't touch!\n\
2393__displayhook__ -- the original displayhook; don't touch!\n\
2394__excepthook__ -- the original excepthook; don't touch!\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002395\n\
2396Functions:\n\
2397\n\
Georg Brandl1a3284e2007-12-02 09:40:06 +00002398displayhook() -- print an object to the screen, and save it in builtins._\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002399excepthook() -- print an exception and its traceback to sys.stderr\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002400exc_info() -- return thread-safe information about the current exception\n\
2401exit() -- exit the interpreter by raising SystemExit\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00002402getdlopenflags() -- returns flags to be used for dlopen() calls\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00002403getprofile() -- get the global profiling function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002404getrefcount() -- return the reference count for an object (plus one :-)\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00002405getrecursionlimit() -- return the max recursion depth for the interpreter\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00002406getsizeof() -- return the size of an object in bytes\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00002407gettrace() -- get the global debug tracing function\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00002408setdlopenflags() -- set the flags to be used for dlopen() calls\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002409setprofile() -- set the global profiling function\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00002410setrecursionlimit() -- set the max recursion depth for the interpreter\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002411settrace() -- set the global debug tracing function\n\
Fred Drakeccede592000-08-14 20:59:57 +00002412"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002413)
Fred Drakeccede592000-08-14 20:59:57 +00002414/* end of sys_doc */ ;
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002415
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002416
2417PyDoc_STRVAR(flags__doc__,
2418"sys.flags\n\
2419\n\
2420Flags provided through command line arguments or environment vars.");
2421
2422static PyTypeObject FlagsType;
2423
2424static PyStructSequence_Field flags_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002425 {"debug", "-d"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002426 {"inspect", "-i"},
2427 {"interactive", "-i"},
2428 {"optimize", "-O or -OO"},
2429 {"dont_write_bytecode", "-B"},
2430 {"no_user_site", "-s"},
2431 {"no_site", "-S"},
2432 {"ignore_environment", "-E"},
2433 {"verbose", "-v"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002434 /* {"unbuffered", "-u"}, */
2435 /* {"skip_first", "-x"}, */
Georg Brandl8aa7e992010-12-28 18:30:18 +00002436 {"bytes_warning", "-b"},
2437 {"quiet", "-q"},
Georg Brandl09a7c722012-02-20 21:31:46 +01002438 {"hash_randomization", "-R"},
Christian Heimesad73a9c2013-08-10 16:36:18 +02002439 {"isolated", "-I"},
Victor Stinner5e3806f2017-11-30 11:40:24 +01002440 {"dev_mode", "-X dev"},
Victor Stinner91106cd2017-12-13 12:29:09 +01002441 {"utf8_mode", "-X utf8"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002442 {0}
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002443};
2444
2445static PyStructSequence_Desc flags_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002446 "sys.flags", /* name */
2447 flags__doc__, /* doc */
2448 flags_fields, /* fields */
Victor Stinner91106cd2017-12-13 12:29:09 +01002449 15
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002450};
2451
2452static PyObject*
Victor Stinner01b1cc12019-11-20 02:27:56 +01002453make_flags(PyThreadState *tstate)
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002454{
Victor Stinner01b1cc12019-11-20 02:27:56 +01002455 PyInterpreterState *interp = tstate->interp;
2456 const PyPreConfig *preconfig = &interp->runtime->preconfig;
Victor Stinnerda7933e2020-04-13 03:04:28 +02002457 const PyConfig *config = _PyInterpreterState_GetConfig(interp);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002458
Victor Stinner01b1cc12019-11-20 02:27:56 +01002459 PyObject *seq = PyStructSequence_New(&FlagsType);
2460 if (seq == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002461 return NULL;
Victor Stinner01b1cc12019-11-20 02:27:56 +01002462 }
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002463
Victor Stinner01b1cc12019-11-20 02:27:56 +01002464 int pos = 0;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002465#define SetFlag(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 PyStructSequence_SET_ITEM(seq, pos++, PyLong_FromLong(flag))
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002467
Victor Stinnerfbca9082018-08-30 00:50:45 +02002468 SetFlag(config->parser_debug);
2469 SetFlag(config->inspect);
2470 SetFlag(config->interactive);
2471 SetFlag(config->optimization_level);
2472 SetFlag(!config->write_bytecode);
2473 SetFlag(!config->user_site_directory);
2474 SetFlag(!config->site_import);
Victor Stinner20004952019-03-26 02:31:11 +01002475 SetFlag(!config->use_environment);
Victor Stinnerfbca9082018-08-30 00:50:45 +02002476 SetFlag(config->verbose);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002477 /* SetFlag(saw_unbuffered_flag); */
2478 /* SetFlag(skipfirstline); */
Victor Stinnerfbca9082018-08-30 00:50:45 +02002479 SetFlag(config->bytes_warning);
2480 SetFlag(config->quiet);
2481 SetFlag(config->use_hash_seed == 0 || config->hash_seed != 0);
Victor Stinner20004952019-03-26 02:31:11 +01002482 SetFlag(config->isolated);
2483 PyStructSequence_SET_ITEM(seq, pos++, PyBool_FromLong(config->dev_mode));
2484 SetFlag(preconfig->utf8_mode);
Victor Stinner91106cd2017-12-13 12:29:09 +01002485#undef SetFlag
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002486
Victor Stinner838f2642019-06-13 22:41:23 +02002487 if (_PyErr_Occurred(tstate)) {
Serhiy Storchaka87a854d2013-12-17 14:59:42 +02002488 Py_DECREF(seq);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002489 return NULL;
2490 }
2491 return seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002492}
2493
Eric Smith0e5b5622009-02-06 01:32:42 +00002494PyDoc_STRVAR(version_info__doc__,
2495"sys.version_info\n\
2496\n\
2497Version information as a named tuple.");
2498
2499static PyTypeObject VersionInfoType;
2500
2501static PyStructSequence_Field version_info_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002502 {"major", "Major release number"},
2503 {"minor", "Minor release number"},
2504 {"micro", "Patch release number"},
Ned Deilyda4887a2016-11-04 17:03:34 -04002505 {"releaselevel", "'alpha', 'beta', 'candidate', or 'final'"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002506 {"serial", "Serial release number"},
2507 {0}
Eric Smith0e5b5622009-02-06 01:32:42 +00002508};
2509
2510static PyStructSequence_Desc version_info_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002511 "sys.version_info", /* name */
2512 version_info__doc__, /* doc */
2513 version_info_fields, /* fields */
2514 5
Eric Smith0e5b5622009-02-06 01:32:42 +00002515};
2516
2517static PyObject *
Victor Stinner838f2642019-06-13 22:41:23 +02002518make_version_info(PyThreadState *tstate)
Eric Smith0e5b5622009-02-06 01:32:42 +00002519{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002520 PyObject *version_info;
2521 char *s;
2522 int pos = 0;
Eric Smith0e5b5622009-02-06 01:32:42 +00002523
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002524 version_info = PyStructSequence_New(&VersionInfoType);
2525 if (version_info == NULL) {
2526 return NULL;
2527 }
Eric Smith0e5b5622009-02-06 01:32:42 +00002528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002529 /*
2530 * These release level checks are mutually exclusive and cover
2531 * the field, so don't get too fancy with the pre-processor!
2532 */
Eric Smith0e5b5622009-02-06 01:32:42 +00002533#if PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_ALPHA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002534 s = "alpha";
Eric Smith0e5b5622009-02-06 01:32:42 +00002535#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_BETA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002536 s = "beta";
Eric Smith0e5b5622009-02-06 01:32:42 +00002537#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_GAMMA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002538 s = "candidate";
Eric Smith0e5b5622009-02-06 01:32:42 +00002539#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_FINAL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002540 s = "final";
Eric Smith0e5b5622009-02-06 01:32:42 +00002541#endif
2542
2543#define SetIntItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002544 PyStructSequence_SET_ITEM(version_info, pos++, PyLong_FromLong(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00002545#define SetStrItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002546 PyStructSequence_SET_ITEM(version_info, pos++, PyUnicode_FromString(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00002547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002548 SetIntItem(PY_MAJOR_VERSION);
2549 SetIntItem(PY_MINOR_VERSION);
2550 SetIntItem(PY_MICRO_VERSION);
2551 SetStrItem(s);
2552 SetIntItem(PY_RELEASE_SERIAL);
Eric Smith0e5b5622009-02-06 01:32:42 +00002553#undef SetIntItem
2554#undef SetStrItem
2555
Victor Stinner838f2642019-06-13 22:41:23 +02002556 if (_PyErr_Occurred(tstate)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002557 Py_CLEAR(version_info);
2558 return NULL;
2559 }
2560 return version_info;
Eric Smith0e5b5622009-02-06 01:32:42 +00002561}
2562
Brett Cannon3adc7b72012-07-09 14:22:12 -04002563/* sys.implementation values */
2564#define NAME "cpython"
2565const char *_PySys_ImplName = NAME;
Victor Stinnercf01b682015-11-05 11:21:38 +01002566#define MAJOR Py_STRINGIFY(PY_MAJOR_VERSION)
2567#define MINOR Py_STRINGIFY(PY_MINOR_VERSION)
Ned Deily529ea5d2014-06-30 23:31:14 -07002568#define TAG NAME "-" MAJOR MINOR
Brett Cannon3adc7b72012-07-09 14:22:12 -04002569const char *_PySys_ImplCacheTag = TAG;
2570#undef NAME
Brett Cannon3adc7b72012-07-09 14:22:12 -04002571#undef MAJOR
2572#undef MINOR
2573#undef TAG
2574
Barry Warsaw409da152012-06-03 16:18:47 -04002575static PyObject *
2576make_impl_info(PyObject *version_info)
2577{
2578 int res;
2579 PyObject *impl_info, *value, *ns;
2580
2581 impl_info = PyDict_New();
2582 if (impl_info == NULL)
2583 return NULL;
2584
2585 /* populate the dict */
2586
Brett Cannon3adc7b72012-07-09 14:22:12 -04002587 value = PyUnicode_FromString(_PySys_ImplName);
Barry Warsaw409da152012-06-03 16:18:47 -04002588 if (value == NULL)
2589 goto error;
2590 res = PyDict_SetItemString(impl_info, "name", value);
2591 Py_DECREF(value);
2592 if (res < 0)
2593 goto error;
2594
Brett Cannon3adc7b72012-07-09 14:22:12 -04002595 value = PyUnicode_FromString(_PySys_ImplCacheTag);
Barry Warsaw409da152012-06-03 16:18:47 -04002596 if (value == NULL)
2597 goto error;
2598 res = PyDict_SetItemString(impl_info, "cache_tag", value);
2599 Py_DECREF(value);
2600 if (res < 0)
2601 goto error;
Barry Warsaw409da152012-06-03 16:18:47 -04002602
2603 res = PyDict_SetItemString(impl_info, "version", version_info);
2604 if (res < 0)
2605 goto error;
2606
2607 value = PyLong_FromLong(PY_VERSION_HEX);
2608 if (value == NULL)
2609 goto error;
2610 res = PyDict_SetItemString(impl_info, "hexversion", value);
2611 Py_DECREF(value);
2612 if (res < 0)
2613 goto error;
2614
doko@ubuntu.com55532312016-06-14 08:55:19 +02002615#ifdef MULTIARCH
2616 value = PyUnicode_FromString(MULTIARCH);
2617 if (value == NULL)
2618 goto error;
2619 res = PyDict_SetItemString(impl_info, "_multiarch", value);
2620 Py_DECREF(value);
2621 if (res < 0)
2622 goto error;
2623#endif
2624
Barry Warsaw409da152012-06-03 16:18:47 -04002625 /* dict ready */
2626
2627 ns = _PyNamespace_New(impl_info);
2628 Py_DECREF(impl_info);
2629 return ns;
2630
2631error:
2632 Py_CLEAR(impl_info);
2633 return NULL;
2634}
2635
Martin v. Löwis1a214512008-06-11 05:26:20 +00002636static struct PyModuleDef sysmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002637 PyModuleDef_HEAD_INIT,
2638 "sys",
2639 sys_doc,
2640 -1, /* multiple "initialization" just copies the module dict. */
2641 sys_methods,
2642 NULL,
2643 NULL,
2644 NULL,
2645 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00002646};
2647
Eric Snow6b4be192017-05-22 21:36:03 -07002648/* Updating the sys namespace, returning NULL pointer on error */
Victor Stinner8fea2522013-10-27 17:15:42 +01002649#define SET_SYS_FROM_STRING_BORROW(key, value) \
Victor Stinner58049602013-07-22 22:40:00 +02002650 do { \
Victor Stinner58049602013-07-22 22:40:00 +02002651 PyObject *v = (value); \
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002652 if (v == NULL) { \
2653 goto err_occurred; \
2654 } \
Victor Stinner58049602013-07-22 22:40:00 +02002655 res = PyDict_SetItemString(sysdict, key, v); \
2656 if (res < 0) { \
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002657 goto err_occurred; \
Victor Stinner8fea2522013-10-27 17:15:42 +01002658 } \
2659 } while (0)
2660#define SET_SYS_FROM_STRING(key, value) \
2661 do { \
Victor Stinner8fea2522013-10-27 17:15:42 +01002662 PyObject *v = (value); \
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002663 if (v == NULL) { \
2664 goto err_occurred; \
2665 } \
Victor Stinner8fea2522013-10-27 17:15:42 +01002666 res = PyDict_SetItemString(sysdict, key, v); \
2667 Py_DECREF(v); \
2668 if (res < 0) { \
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002669 goto err_occurred; \
Victor Stinner58049602013-07-22 22:40:00 +02002670 } \
2671 } while (0)
Guido van Rossum25ce5661997-08-02 03:10:38 +00002672
Victor Stinner331a6a52019-05-27 16:39:22 +02002673static PyStatus
Victor Stinner01b1cc12019-11-20 02:27:56 +01002674_PySys_InitCore(PyThreadState *tstate, PyObject *sysdict)
Eric Snow6b4be192017-05-22 21:36:03 -07002675{
Victor Stinnerab672812019-01-23 15:04:40 +01002676 PyObject *version_info;
Eric Snow6b4be192017-05-22 21:36:03 -07002677 int res;
2678
Nick Coghland6009512014-11-20 21:39:37 +10002679 /* stdin/stdout/stderr are set in pylifecycle.c */
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002680
Victor Stinner8fea2522013-10-27 17:15:42 +01002681 SET_SYS_FROM_STRING_BORROW("__displayhook__",
2682 PyDict_GetItemString(sysdict, "displayhook"));
2683 SET_SYS_FROM_STRING_BORROW("__excepthook__",
2684 PyDict_GetItemString(sysdict, "excepthook"));
Barry Warsaw36c1d1f2017-10-05 12:11:18 -04002685 SET_SYS_FROM_STRING_BORROW(
2686 "__breakpointhook__",
2687 PyDict_GetItemString(sysdict, "breakpointhook"));
Victor Stinneref9d9b62019-05-22 11:28:22 +02002688 SET_SYS_FROM_STRING_BORROW("__unraisablehook__",
2689 PyDict_GetItemString(sysdict, "unraisablehook"));
2690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002691 SET_SYS_FROM_STRING("version",
2692 PyUnicode_FromString(Py_GetVersion()));
2693 SET_SYS_FROM_STRING("hexversion",
2694 PyLong_FromLong(PY_VERSION_HEX));
Ned Deily5c4b0d02017-03-04 00:19:55 -05002695 SET_SYS_FROM_STRING("_git",
2696 Py_BuildValue("(szz)", "CPython", _Py_gitidentifier(),
2697 _Py_gitversion()));
INADA Naoki6b42eb12017-06-29 15:31:38 +09002698 SET_SYS_FROM_STRING("_framework", PyUnicode_FromString(_PYTHONFRAMEWORK));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002699 SET_SYS_FROM_STRING("api_version",
2700 PyLong_FromLong(PYTHON_API_VERSION));
2701 SET_SYS_FROM_STRING("copyright",
2702 PyUnicode_FromString(Py_GetCopyright()));
2703 SET_SYS_FROM_STRING("platform",
2704 PyUnicode_FromString(Py_GetPlatform()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002705 SET_SYS_FROM_STRING("maxsize",
2706 PyLong_FromSsize_t(PY_SSIZE_T_MAX));
2707 SET_SYS_FROM_STRING("float_info",
2708 PyFloat_GetInfo());
2709 SET_SYS_FROM_STRING("int_info",
2710 PyLong_GetInfo());
Mark Dickinsondc787d22010-05-23 13:33:13 +00002711 /* initialize hash_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002712 if (Hash_InfoType.tp_name == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002713 if (PyStructSequence_InitType2(&Hash_InfoType, &hash_info_desc) < 0) {
2714 goto type_init_failed;
2715 }
Victor Stinner1c8f0592013-07-22 22:24:54 +02002716 }
Mark Dickinsondc787d22010-05-23 13:33:13 +00002717 SET_SYS_FROM_STRING("hash_info",
Victor Stinner838f2642019-06-13 22:41:23 +02002718 get_hash_info(tstate));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002719 SET_SYS_FROM_STRING("maxunicode",
Ezio Melotti48a2f8f2011-09-29 00:18:19 +03002720 PyLong_FromLong(0x10FFFF));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002721 SET_SYS_FROM_STRING("builtin_module_names",
2722 list_builtin_module_names());
Christian Heimes743e0cd2012-10-17 23:52:17 +02002723#if PY_BIG_ENDIAN
2724 SET_SYS_FROM_STRING("byteorder",
2725 PyUnicode_FromString("big"));
2726#else
2727 SET_SYS_FROM_STRING("byteorder",
2728 PyUnicode_FromString("little"));
2729#endif
Fred Drake099325e2000-08-14 15:47:03 +00002730
Guido van Rossum8b9ea871996-08-23 18:14:47 +00002731#ifdef MS_COREDLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002732 SET_SYS_FROM_STRING("dllhandle",
2733 PyLong_FromVoidPtr(PyWin_DLLhModule));
2734 SET_SYS_FROM_STRING("winver",
2735 PyUnicode_FromString(PyWin_DLLVersionString));
Guido van Rossumc606fe11996-04-09 02:37:57 +00002736#endif
Barry Warsaw8cf4eae2010-10-16 01:04:07 +00002737#ifdef ABIFLAGS
2738 SET_SYS_FROM_STRING("abiflags",
2739 PyUnicode_FromString(ABIFLAGS));
2740#endif
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002741
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002742 /* version_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002743 if (VersionInfoType.tp_name == NULL) {
2744 if (PyStructSequence_InitType2(&VersionInfoType,
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002745 &version_info_desc) < 0) {
2746 goto type_init_failed;
2747 }
Victor Stinner1c8f0592013-07-22 22:24:54 +02002748 }
Victor Stinner838f2642019-06-13 22:41:23 +02002749 version_info = make_version_info(tstate);
Barry Warsaw409da152012-06-03 16:18:47 -04002750 SET_SYS_FROM_STRING("version_info", version_info);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002751 /* prevent user from creating new instances */
2752 VersionInfoType.tp_init = NULL;
2753 VersionInfoType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02002754 res = PyDict_DelItemString(VersionInfoType.tp_dict, "__new__");
Victor Stinner838f2642019-06-13 22:41:23 +02002755 if (res < 0 && _PyErr_ExceptionMatches(tstate, PyExc_KeyError)) {
2756 _PyErr_Clear(tstate);
2757 }
Eric Smith0e5b5622009-02-06 01:32:42 +00002758
Barry Warsaw409da152012-06-03 16:18:47 -04002759 /* implementation */
2760 SET_SYS_FROM_STRING("implementation", make_impl_info(version_info));
2761
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002762 /* flags */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002763 if (FlagsType.tp_name == 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002764 if (PyStructSequence_InitType2(&FlagsType, &flags_desc) < 0) {
2765 goto type_init_failed;
2766 }
Victor Stinner1c8f0592013-07-22 22:24:54 +02002767 }
Victor Stinner43125222019-04-24 18:23:53 +02002768 /* Set flags to their default values (updated by _PySys_InitMain()) */
Victor Stinner01b1cc12019-11-20 02:27:56 +01002769 SET_SYS_FROM_STRING("flags", make_flags(tstate));
Eric Smithf7bb5782010-01-27 00:44:57 +00002770
2771#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002772 /* getwindowsversion */
2773 if (WindowsVersionType.tp_name == 0)
Victor Stinner1c8f0592013-07-22 22:24:54 +02002774 if (PyStructSequence_InitType2(&WindowsVersionType,
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002775 &windows_version_desc) < 0) {
2776 goto type_init_failed;
2777 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002778 /* prevent user from creating new instances */
2779 WindowsVersionType.tp_init = NULL;
2780 WindowsVersionType.tp_new = NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02002781 assert(!_PyErr_Occurred(tstate));
Antoine Pitrou871dfc42014-04-28 13:07:06 +02002782 res = PyDict_DelItemString(WindowsVersionType.tp_dict, "__new__");
Victor Stinner838f2642019-06-13 22:41:23 +02002783 if (res < 0 && _PyErr_ExceptionMatches(tstate, PyExc_KeyError)) {
2784 _PyErr_Clear(tstate);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002785 }
Eric Smithf7bb5782010-01-27 00:44:57 +00002786#endif
2787
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002788 /* float repr style: 0.03 (short) vs 0.029999999999999999 (legacy) */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002789#ifndef PY_NO_SHORT_FLOAT_REPR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002790 SET_SYS_FROM_STRING("float_repr_style",
2791 PyUnicode_FromString("short"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002792#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002793 SET_SYS_FROM_STRING("float_repr_style",
2794 PyUnicode_FromString("legacy"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002795#endif
2796
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002797 SET_SYS_FROM_STRING("thread_info", PyThread_GetInfo());
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002798
Yury Selivanoveb636452016-09-08 22:01:51 -07002799 /* initialize asyncgen_hooks */
2800 if (AsyncGenHooksType.tp_name == NULL) {
2801 if (PyStructSequence_InitType2(
2802 &AsyncGenHooksType, &asyncgen_hooks_desc) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002803 goto type_init_failed;
Yury Selivanoveb636452016-09-08 22:01:51 -07002804 }
2805 }
2806
Victor Stinner838f2642019-06-13 22:41:23 +02002807 if (_PyErr_Occurred(tstate)) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002808 goto err_occurred;
2809 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002810 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002811
2812type_init_failed:
Victor Stinner331a6a52019-05-27 16:39:22 +02002813 return _PyStatus_ERR("failed to initialize a type");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002814
2815err_occurred:
Victor Stinner331a6a52019-05-27 16:39:22 +02002816 return _PyStatus_ERR("can't initialize sys module");
Guido van Rossum5b3138b1990-11-18 17:41:40 +00002817}
2818
Eric Snow6b4be192017-05-22 21:36:03 -07002819/* Updating the sys namespace, returning integer error codes */
Eric Snow6b4be192017-05-22 21:36:03 -07002820#define SET_SYS_FROM_STRING_INT_RESULT(key, value) \
2821 do { \
2822 PyObject *v = (value); \
2823 if (v == NULL) \
2824 return -1; \
2825 res = PyDict_SetItemString(sysdict, key, v); \
2826 Py_DECREF(v); \
2827 if (res < 0) { \
2828 return res; \
2829 } \
2830 } while (0)
2831
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002832
2833static int
2834sys_add_xoption(PyObject *opts, const wchar_t *s)
2835{
2836 PyObject *name, *value;
2837
2838 const wchar_t *name_end = wcschr(s, L'=');
2839 if (!name_end) {
2840 name = PyUnicode_FromWideChar(s, -1);
2841 value = Py_True;
2842 Py_INCREF(value);
2843 }
2844 else {
2845 name = PyUnicode_FromWideChar(s, name_end - s);
2846 value = PyUnicode_FromWideChar(name_end + 1, -1);
2847 }
2848 if (name == NULL || value == NULL) {
2849 goto error;
2850 }
2851 if (PyDict_SetItem(opts, name, value) < 0) {
2852 goto error;
2853 }
2854 Py_DECREF(name);
2855 Py_DECREF(value);
2856 return 0;
2857
2858error:
2859 Py_XDECREF(name);
2860 Py_XDECREF(value);
2861 return -1;
2862}
2863
2864
2865static PyObject*
Victor Stinner331a6a52019-05-27 16:39:22 +02002866sys_create_xoptions_dict(const PyConfig *config)
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002867{
2868 Py_ssize_t nxoption = config->xoptions.length;
2869 wchar_t * const * xoptions = config->xoptions.items;
2870 PyObject *dict = PyDict_New();
2871 if (dict == NULL) {
2872 return NULL;
2873 }
2874
2875 for (Py_ssize_t i=0; i < nxoption; i++) {
2876 const wchar_t *option = xoptions[i];
2877 if (sys_add_xoption(dict, option) < 0) {
2878 Py_DECREF(dict);
2879 return NULL;
2880 }
2881 }
2882
2883 return dict;
2884}
2885
2886
Eric Snow6b4be192017-05-22 21:36:03 -07002887int
Victor Stinner01b1cc12019-11-20 02:27:56 +01002888_PySys_InitMain(PyThreadState *tstate)
Eric Snow6b4be192017-05-22 21:36:03 -07002889{
Victor Stinner838f2642019-06-13 22:41:23 +02002890 PyObject *sysdict = tstate->interp->sysdict;
Victor Stinnerda7933e2020-04-13 03:04:28 +02002891 const PyConfig *config = _PyInterpreterState_GetConfig(tstate->interp);
Eric Snow6b4be192017-05-22 21:36:03 -07002892 int res;
2893
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002894#define COPY_LIST(KEY, VALUE) \
Victor Stinner37cd9822018-11-16 11:55:35 +01002895 do { \
Victor Stinner331a6a52019-05-27 16:39:22 +02002896 PyObject *list = _PyWideStringList_AsList(&(VALUE)); \
Victor Stinner37cd9822018-11-16 11:55:35 +01002897 if (list == NULL) { \
2898 return -1; \
2899 } \
2900 SET_SYS_FROM_STRING_BORROW(KEY, list); \
2901 Py_DECREF(list); \
2902 } while (0)
2903
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002904#define SET_SYS_FROM_WSTR(KEY, VALUE) \
2905 do { \
2906 PyObject *str = PyUnicode_FromWideChar(VALUE, -1); \
2907 if (str == NULL) { \
2908 return -1; \
2909 } \
2910 SET_SYS_FROM_STRING_BORROW(KEY, str); \
2911 Py_DECREF(str); \
2912 } while (0)
Victor Stinner37cd9822018-11-16 11:55:35 +01002913
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002914 COPY_LIST("path", config->module_search_paths);
2915
2916 SET_SYS_FROM_WSTR("executable", config->executable);
Steve Dower9048c492019-06-29 10:34:11 -07002917 SET_SYS_FROM_WSTR("_base_executable", config->base_executable);
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002918 SET_SYS_FROM_WSTR("prefix", config->prefix);
2919 SET_SYS_FROM_WSTR("base_prefix", config->base_prefix);
2920 SET_SYS_FROM_WSTR("exec_prefix", config->exec_prefix);
2921 SET_SYS_FROM_WSTR("base_exec_prefix", config->base_exec_prefix);
Victor Stinner8510f432020-03-10 09:53:09 +01002922 {
2923 PyObject *str = PyUnicode_FromString(PLATLIBDIR);
2924 if (str == NULL) {
2925 return -1;
2926 }
2927 SET_SYS_FROM_STRING("platlibdir", str);
2928 }
Victor Stinner41264f12017-12-15 02:05:29 +01002929
Carl Meyerb193fa92018-06-15 22:40:56 -06002930 if (config->pycache_prefix != NULL) {
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002931 SET_SYS_FROM_WSTR("pycache_prefix", config->pycache_prefix);
Carl Meyerb193fa92018-06-15 22:40:56 -06002932 } else {
2933 PyDict_SetItemString(sysdict, "pycache_prefix", Py_None);
2934 }
2935
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002936 COPY_LIST("argv", config->argv);
2937 COPY_LIST("warnoptions", config->warnoptions);
2938
2939 PyObject *xoptions = sys_create_xoptions_dict(config);
2940 if (xoptions == NULL) {
2941 return -1;
Victor Stinner41264f12017-12-15 02:05:29 +01002942 }
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002943 SET_SYS_FROM_STRING_BORROW("_xoptions", xoptions);
Pablo Galindo34ef64f2019-03-27 12:43:47 +00002944 Py_DECREF(xoptions);
Victor Stinner41264f12017-12-15 02:05:29 +01002945
Victor Stinner37cd9822018-11-16 11:55:35 +01002946#undef COPY_LIST
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002947#undef SET_SYS_FROM_WSTR
Victor Stinner37cd9822018-11-16 11:55:35 +01002948
Victor Stinner8510f432020-03-10 09:53:09 +01002949
Eric Snow6b4be192017-05-22 21:36:03 -07002950 /* Set flags to their final values */
Victor Stinner01b1cc12019-11-20 02:27:56 +01002951 SET_SYS_FROM_STRING_INT_RESULT("flags", make_flags(tstate));
Eric Snow6b4be192017-05-22 21:36:03 -07002952 /* prevent user from creating new instances */
2953 FlagsType.tp_init = NULL;
2954 FlagsType.tp_new = NULL;
2955 res = PyDict_DelItemString(FlagsType.tp_dict, "__new__");
2956 if (res < 0) {
Victor Stinner838f2642019-06-13 22:41:23 +02002957 if (!_PyErr_ExceptionMatches(tstate, PyExc_KeyError)) {
Eric Snow6b4be192017-05-22 21:36:03 -07002958 return res;
2959 }
Victor Stinner838f2642019-06-13 22:41:23 +02002960 _PyErr_Clear(tstate);
Eric Snow6b4be192017-05-22 21:36:03 -07002961 }
2962
2963 SET_SYS_FROM_STRING_INT_RESULT("dont_write_bytecode",
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002964 PyBool_FromLong(!config->write_bytecode));
Eric Snow6b4be192017-05-22 21:36:03 -07002965
Victor Stinner838f2642019-06-13 22:41:23 +02002966 if (get_warnoptions(tstate) == NULL) {
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002967 return -1;
Victor Stinner838f2642019-06-13 22:41:23 +02002968 }
Victor Stinner865de272017-06-08 13:27:47 +02002969
Victor Stinner838f2642019-06-13 22:41:23 +02002970 if (get_xoptions(tstate) == NULL)
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002971 return -1;
Eric Snow6b4be192017-05-22 21:36:03 -07002972
Victor Stinner838f2642019-06-13 22:41:23 +02002973 if (_PyErr_Occurred(tstate)) {
2974 goto err_occurred;
2975 }
2976
Eric Snow6b4be192017-05-22 21:36:03 -07002977 return 0;
Victor Stinner41264f12017-12-15 02:05:29 +01002978
2979err_occurred:
2980 return -1;
Eric Snow6b4be192017-05-22 21:36:03 -07002981}
2982
Victor Stinner8510f432020-03-10 09:53:09 +01002983#undef SET_SYS_FROM_STRING
Victor Stinner41264f12017-12-15 02:05:29 +01002984#undef SET_SYS_FROM_STRING_BORROW
Eric Snow6b4be192017-05-22 21:36:03 -07002985#undef SET_SYS_FROM_STRING_INT_RESULT
Eric Snow6b4be192017-05-22 21:36:03 -07002986
Victor Stinnerab672812019-01-23 15:04:40 +01002987
2988/* Set up a preliminary stderr printer until we have enough
2989 infrastructure for the io module in place.
2990
2991 Use UTF-8/surrogateescape and ignore EAGAIN errors. */
Victor Stinner81fe5bd2019-12-06 02:43:30 +01002992static PyStatus
Victor Stinnerab672812019-01-23 15:04:40 +01002993_PySys_SetPreliminaryStderr(PyObject *sysdict)
2994{
2995 PyObject *pstderr = PyFile_NewStdPrinter(fileno(stderr));
2996 if (pstderr == NULL) {
2997 goto error;
2998 }
2999 if (_PyDict_SetItemId(sysdict, &PyId_stderr, pstderr) < 0) {
3000 goto error;
3001 }
3002 if (PyDict_SetItemString(sysdict, "__stderr__", pstderr) < 0) {
3003 goto error;
3004 }
3005 Py_DECREF(pstderr);
Victor Stinner331a6a52019-05-27 16:39:22 +02003006 return _PyStatus_OK();
Victor Stinnerab672812019-01-23 15:04:40 +01003007
3008error:
3009 Py_XDECREF(pstderr);
Victor Stinner331a6a52019-05-27 16:39:22 +02003010 return _PyStatus_ERR("can't set preliminary stderr");
Victor Stinnerab672812019-01-23 15:04:40 +01003011}
3012
3013
3014/* Create sys module without all attributes: _PySys_InitMain() should be called
3015 later to add remaining attributes. */
Victor Stinner331a6a52019-05-27 16:39:22 +02003016PyStatus
Victor Stinner01b1cc12019-11-20 02:27:56 +01003017_PySys_Create(PyThreadState *tstate, PyObject **sysmod_p)
Victor Stinnerab672812019-01-23 15:04:40 +01003018{
Victor Stinner81fe5bd2019-12-06 02:43:30 +01003019 assert(!_PyErr_Occurred(tstate));
3020
Victor Stinnerb45d2592019-06-20 00:05:23 +02003021 PyInterpreterState *interp = tstate->interp;
Victor Stinner838f2642019-06-13 22:41:23 +02003022
Victor Stinnerab672812019-01-23 15:04:40 +01003023 PyObject *modules = PyDict_New();
3024 if (modules == NULL) {
Victor Stinner81fe5bd2019-12-06 02:43:30 +01003025 goto error;
Victor Stinnerab672812019-01-23 15:04:40 +01003026 }
3027 interp->modules = modules;
3028
3029 PyObject *sysmod = _PyModule_CreateInitialized(&sysmodule, PYTHON_API_VERSION);
3030 if (sysmod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02003031 return _PyStatus_ERR("failed to create a module object");
Victor Stinnerab672812019-01-23 15:04:40 +01003032 }
3033
3034 PyObject *sysdict = PyModule_GetDict(sysmod);
3035 if (sysdict == NULL) {
Victor Stinner81fe5bd2019-12-06 02:43:30 +01003036 goto error;
Victor Stinnerab672812019-01-23 15:04:40 +01003037 }
3038 Py_INCREF(sysdict);
3039 interp->sysdict = sysdict;
3040
3041 if (PyDict_SetItemString(sysdict, "modules", interp->modules) < 0) {
Victor Stinner81fe5bd2019-12-06 02:43:30 +01003042 goto error;
Victor Stinnerab672812019-01-23 15:04:40 +01003043 }
3044
Victor Stinner331a6a52019-05-27 16:39:22 +02003045 PyStatus status = _PySys_SetPreliminaryStderr(sysdict);
3046 if (_PyStatus_EXCEPTION(status)) {
3047 return status;
Victor Stinnerab672812019-01-23 15:04:40 +01003048 }
3049
Victor Stinner01b1cc12019-11-20 02:27:56 +01003050 status = _PySys_InitCore(tstate, sysdict);
Victor Stinner331a6a52019-05-27 16:39:22 +02003051 if (_PyStatus_EXCEPTION(status)) {
3052 return status;
Victor Stinnerab672812019-01-23 15:04:40 +01003053 }
3054
Victor Stinner81fe5bd2019-12-06 02:43:30 +01003055 if (_PyImport_FixupBuiltin(sysmod, "sys", interp->modules) < 0) {
3056 goto error;
3057 }
3058
3059 assert(!_PyErr_Occurred(tstate));
Victor Stinnerab672812019-01-23 15:04:40 +01003060
3061 *sysmod_p = sysmod;
Victor Stinner331a6a52019-05-27 16:39:22 +02003062 return _PyStatus_OK();
Victor Stinner81fe5bd2019-12-06 02:43:30 +01003063
3064error:
3065 return _PyStatus_ERR("can't initialize sys module");
Victor Stinnerab672812019-01-23 15:04:40 +01003066}
3067
3068
Guido van Rossum65bf9f21997-04-29 18:33:38 +00003069static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00003070makepathobject(const wchar_t *path, wchar_t delim)
Guido van Rossum5b3138b1990-11-18 17:41:40 +00003071{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003072 int i, n;
3073 const wchar_t *p;
3074 PyObject *v, *w;
Tim Peters216b78b2006-01-06 02:40:53 +00003075
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003076 n = 1;
3077 p = path;
3078 while ((p = wcschr(p, delim)) != NULL) {
3079 n++;
3080 p++;
3081 }
3082 v = PyList_New(n);
3083 if (v == NULL)
3084 return NULL;
3085 for (i = 0; ; i++) {
3086 p = wcschr(path, delim);
3087 if (p == NULL)
3088 p = path + wcslen(path); /* End of string */
3089 w = PyUnicode_FromWideChar(path, (Py_ssize_t)(p - path));
3090 if (w == NULL) {
3091 Py_DECREF(v);
3092 return NULL;
3093 }
Zackery Spytz99d56b52018-12-08 07:16:55 -07003094 PyList_SET_ITEM(v, i, w);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003095 if (*p == '\0')
3096 break;
3097 path = p+1;
3098 }
3099 return v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003100}
3101
3102void
Martin v. Löwis790465f2008-04-05 20:41:37 +00003103PySys_SetPath(const wchar_t *path)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003104{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003105 PyObject *v;
3106 if ((v = makepathobject(path, DELIM)) == NULL)
3107 Py_FatalError("can't create sys.path");
Victor Stinner838f2642019-06-13 22:41:23 +02003108 PyThreadState *tstate = _PyThreadState_GET();
3109 if (sys_set_object_id(tstate, &PyId_path, v) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003110 Py_FatalError("can't assign sys.path");
Victor Stinner838f2642019-06-13 22:41:23 +02003111 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003112 Py_DECREF(v);
Guido van Rossum3f5da241990-12-20 15:06:42 +00003113}
3114
Guido van Rossum65bf9f21997-04-29 18:33:38 +00003115static PyObject *
Victor Stinner74f65682019-03-15 15:08:05 +01003116make_sys_argv(int argc, wchar_t * const * argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00003117{
Victor Stinner74f65682019-03-15 15:08:05 +01003118 PyObject *list = PyList_New(argc);
3119 if (list == NULL) {
3120 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003121 }
Victor Stinner74f65682019-03-15 15:08:05 +01003122
3123 for (Py_ssize_t i = 0; i < argc; i++) {
3124 PyObject *v = PyUnicode_FromWideChar(argv[i], -1);
3125 if (v == NULL) {
3126 Py_DECREF(list);
3127 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003128 }
Victor Stinner74f65682019-03-15 15:08:05 +01003129 PyList_SET_ITEM(list, i, v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003130 }
Victor Stinner74f65682019-03-15 15:08:05 +01003131 return list;
Guido van Rossum3f5da241990-12-20 15:06:42 +00003132}
3133
Victor Stinner11a247d2017-12-13 21:05:57 +01003134void
3135PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)
Victor Stinnerd5dda982017-12-13 17:31:16 +01003136{
Victor Stinnerc4868252019-08-23 11:04:16 +01003137 wchar_t* empty_argv[1] = {L""};
Victor Stinner838f2642019-06-13 22:41:23 +02003138 PyThreadState *tstate = _PyThreadState_GET();
3139
Victor Stinner74f65682019-03-15 15:08:05 +01003140 if (argc < 1 || argv == NULL) {
3141 /* Ensure at least one (empty) argument is seen */
Victor Stinner74f65682019-03-15 15:08:05 +01003142 argv = empty_argv;
3143 argc = 1;
3144 }
3145
3146 PyObject *av = make_sys_argv(argc, argv);
Victor Stinnerd5dda982017-12-13 17:31:16 +01003147 if (av == NULL) {
Victor Stinner11a247d2017-12-13 21:05:57 +01003148 Py_FatalError("no mem for sys.argv");
Victor Stinnerd5dda982017-12-13 17:31:16 +01003149 }
Victor Stinner838f2642019-06-13 22:41:23 +02003150 if (sys_set_object(tstate, "argv", av) != 0) {
Victor Stinnerd5dda982017-12-13 17:31:16 +01003151 Py_DECREF(av);
Victor Stinner11a247d2017-12-13 21:05:57 +01003152 Py_FatalError("can't assign sys.argv");
Victor Stinnerd5dda982017-12-13 17:31:16 +01003153 }
3154 Py_DECREF(av);
3155
3156 if (updatepath) {
3157 /* If argv[0] is not '-c' nor '-m', prepend argv[0] to sys.path.
3158 If argv[0] is a symlink, use the real path. */
Victor Stinner331a6a52019-05-27 16:39:22 +02003159 const PyWideStringList argv_list = {.length = argc, .items = argv};
Victor Stinnerdcf61712019-03-19 16:09:27 +01003160 PyObject *path0 = NULL;
3161 if (_PyPathConfig_ComputeSysPath0(&argv_list, &path0)) {
3162 if (path0 == NULL) {
3163 Py_FatalError("can't compute path0 from argv");
Victor Stinner11a247d2017-12-13 21:05:57 +01003164 }
Victor Stinnerdcf61712019-03-19 16:09:27 +01003165
Victor Stinner838f2642019-06-13 22:41:23 +02003166 PyObject *sys_path = sys_get_object_id(tstate, &PyId_path);
Victor Stinnerdcf61712019-03-19 16:09:27 +01003167 if (sys_path != NULL) {
3168 if (PyList_Insert(sys_path, 0, path0) < 0) {
3169 Py_DECREF(path0);
3170 Py_FatalError("can't prepend path0 to sys.path");
3171 }
3172 }
3173 Py_DECREF(path0);
Victor Stinner11a247d2017-12-13 21:05:57 +01003174 }
Victor Stinnerd5dda982017-12-13 17:31:16 +01003175 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003176}
Guido van Rossuma890e681998-05-12 14:59:24 +00003177
Antoine Pitrouf978fac2010-05-21 17:25:34 +00003178void
3179PySys_SetArgv(int argc, wchar_t **argv)
3180{
Christian Heimesad73a9c2013-08-10 16:36:18 +02003181 PySys_SetArgvEx(argc, argv, Py_IsolatedFlag == 0);
Antoine Pitrouf978fac2010-05-21 17:25:34 +00003182}
3183
Victor Stinner14284c22010-04-23 12:02:30 +00003184/* Reimplementation of PyFile_WriteString() no calling indirectly
3185 PyErr_CheckSignals(): avoid the call to PyObject_Str(). */
3186
3187static int
Victor Stinner79766632010-08-16 17:36:42 +00003188sys_pyfile_write_unicode(PyObject *unicode, PyObject *file)
Victor Stinner14284c22010-04-23 12:02:30 +00003189{
Victor Stinnerecccc4f2010-06-08 20:46:00 +00003190 if (file == NULL)
3191 return -1;
Jeroen Demeyerb1263d52019-06-28 11:49:00 +02003192 assert(unicode != NULL);
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02003193 PyObject *result = _PyObject_CallMethodIdOneArg(file, &PyId_write, unicode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003194 if (result == NULL) {
Jeroen Demeyerb1263d52019-06-28 11:49:00 +02003195 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003196 }
Jeroen Demeyerb1263d52019-06-28 11:49:00 +02003197 Py_DECREF(result);
3198 return 0;
Victor Stinner14284c22010-04-23 12:02:30 +00003199}
3200
Victor Stinner79766632010-08-16 17:36:42 +00003201static int
3202sys_pyfile_write(const char *text, PyObject *file)
3203{
3204 PyObject *unicode = NULL;
3205 int err;
3206
3207 if (file == NULL)
3208 return -1;
3209
3210 unicode = PyUnicode_FromString(text);
3211 if (unicode == NULL)
3212 return -1;
3213
3214 err = sys_pyfile_write_unicode(unicode, file);
3215 Py_DECREF(unicode);
3216 return err;
3217}
Guido van Rossuma890e681998-05-12 14:59:24 +00003218
3219/* APIs to write to sys.stdout or sys.stderr using a printf-like interface.
3220 Adapted from code submitted by Just van Rossum.
3221
3222 PySys_WriteStdout(format, ...)
3223 PySys_WriteStderr(format, ...)
3224
3225 The first function writes to sys.stdout; the second to sys.stderr. When
3226 there is a problem, they write to the real (C level) stdout or stderr;
Guido van Rossum8442af31998-10-12 18:22:10 +00003227 no exceptions are raised.
Guido van Rossuma890e681998-05-12 14:59:24 +00003228
Victor Stinner14284c22010-04-23 12:02:30 +00003229 PyErr_CheckSignals() is not called to avoid the execution of the Python
Victor Stinner79766632010-08-16 17:36:42 +00003230 signal handlers: they may raise a new exception whereas sys_write()
3231 ignores all exceptions.
Victor Stinner14284c22010-04-23 12:02:30 +00003232
Guido van Rossuma890e681998-05-12 14:59:24 +00003233 Both take a printf-style format string as their first argument followed
3234 by a variable length argument list determined by the format string.
3235
3236 *** WARNING ***
3237
3238 The format should limit the total size of the formatted output string to
3239 1000 bytes. In particular, this means that no unrestricted "%s" formats
3240 should occur; these should be limited using "%.<N>s where <N> is a
3241 decimal number calculated so that <N> plus the maximum size of other
3242 formatted text does not exceed 1000 bytes. Also watch out for "%f",
3243 which can print hundreds of digits for very large numbers.
3244
3245 */
3246
3247static void
Victor Stinner09054372013-11-06 22:41:44 +01003248sys_write(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Guido van Rossuma890e681998-05-12 14:59:24 +00003249{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003250 PyObject *file;
3251 PyObject *error_type, *error_value, *error_traceback;
3252 char buffer[1001];
3253 int written;
Victor Stinner838f2642019-06-13 22:41:23 +02003254 PyThreadState *tstate = _PyThreadState_GET();
Guido van Rossuma890e681998-05-12 14:59:24 +00003255
Victor Stinner838f2642019-06-13 22:41:23 +02003256 _PyErr_Fetch(tstate, &error_type, &error_value, &error_traceback);
3257 file = sys_get_object_id(tstate, key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003258 written = PyOS_vsnprintf(buffer, sizeof(buffer), format, va);
3259 if (sys_pyfile_write(buffer, file) != 0) {
Victor Stinner838f2642019-06-13 22:41:23 +02003260 _PyErr_Clear(tstate);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003261 fputs(buffer, fp);
3262 }
3263 if (written < 0 || (size_t)written >= sizeof(buffer)) {
3264 const char *truncated = "... truncated";
Victor Stinner79766632010-08-16 17:36:42 +00003265 if (sys_pyfile_write(truncated, file) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003266 fputs(truncated, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003267 }
Victor Stinner838f2642019-06-13 22:41:23 +02003268 _PyErr_Restore(tstate, error_type, error_value, error_traceback);
Guido van Rossuma890e681998-05-12 14:59:24 +00003269}
3270
3271void
Guido van Rossuma890e681998-05-12 14:59:24 +00003272PySys_WriteStdout(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00003273{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003274 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00003275
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003276 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01003277 sys_write(&PyId_stdout, stdout, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003278 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00003279}
3280
3281void
Guido van Rossuma890e681998-05-12 14:59:24 +00003282PySys_WriteStderr(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00003283{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003284 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00003285
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003286 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01003287 sys_write(&PyId_stderr, stderr, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00003288 va_end(va);
3289}
3290
3291static void
Victor Stinner09054372013-11-06 22:41:44 +01003292sys_format(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Victor Stinner79766632010-08-16 17:36:42 +00003293{
3294 PyObject *file, *message;
3295 PyObject *error_type, *error_value, *error_traceback;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02003296 const char *utf8;
Victor Stinner838f2642019-06-13 22:41:23 +02003297 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner79766632010-08-16 17:36:42 +00003298
Victor Stinner838f2642019-06-13 22:41:23 +02003299 _PyErr_Fetch(tstate, &error_type, &error_value, &error_traceback);
3300 file = sys_get_object_id(tstate, key);
Victor Stinner79766632010-08-16 17:36:42 +00003301 message = PyUnicode_FromFormatV(format, va);
3302 if (message != NULL) {
3303 if (sys_pyfile_write_unicode(message, file) != 0) {
Victor Stinner838f2642019-06-13 22:41:23 +02003304 _PyErr_Clear(tstate);
Serhiy Storchaka06515832016-11-20 09:13:07 +02003305 utf8 = PyUnicode_AsUTF8(message);
Victor Stinner79766632010-08-16 17:36:42 +00003306 if (utf8 != NULL)
3307 fputs(utf8, fp);
3308 }
3309 Py_DECREF(message);
3310 }
Victor Stinner838f2642019-06-13 22:41:23 +02003311 _PyErr_Restore(tstate, error_type, error_value, error_traceback);
Victor Stinner79766632010-08-16 17:36:42 +00003312}
3313
3314void
3315PySys_FormatStdout(const char *format, ...)
3316{
3317 va_list va;
3318
3319 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01003320 sys_format(&PyId_stdout, stdout, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00003321 va_end(va);
3322}
3323
3324void
3325PySys_FormatStderr(const char *format, ...)
3326{
3327 va_list va;
3328
3329 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01003330 sys_format(&PyId_stderr, stderr, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003331 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00003332}