blob: 9fcdb5dbc49b1446252676dd8fd8dfc53a7988b8 [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"
Victor Stinnerd9ea5ca2020-04-15 02:57:50 +020018#include "pycore_ceval.h" // _Py_RecursionLimitLowerWaterMark()
Victor Stinner384621c2020-06-22 17:27:35 +020019#include "pycore_initconfig.h" // _PyStatus_EXCEPTION()
20#include "pycore_object.h" // _PyObject_IS_GC()
21#include "pycore_pathconfig.h" // _PyPathConfig_ComputeSysPath0()
22#include "pycore_pyerrors.h" // _PyErr_Fetch()
23#include "pycore_pylifecycle.h" // _PyErr_WriteUnraisableDefaultHook()
Victor Stinnerd9ea5ca2020-04-15 02:57:50 +020024#include "pycore_pymem.h" // _PyMem_SetDefaultAllocator()
25#include "pycore_pystate.h" // _PyThreadState_GET()
Victor Stinner384621c2020-06-22 17:27:35 +020026#include "pycore_tuple.h" // _PyTuple_FromArray()
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000027
Victor Stinner384621c2020-06-22 17:27:35 +020028#include "code.h"
29#include "frameobject.h" // PyFrame_GetBack()
Victor Stinner361dcdc2020-04-15 03:24:57 +020030#include "pydtrace.h"
31#include "osdefs.h" // DELIM
Stefan Krah1845d142016-04-25 21:38:53 +020032#include <locale.h>
Guido van Rossum3f5da241990-12-20 15:06:42 +000033
Mark Hammond8696ebc2002-10-08 02:44:31 +000034#ifdef MS_WINDOWS
35#define WIN32_LEAN_AND_MEAN
Amaury Forgeot d'Arc06cfe952007-11-10 13:55:44 +000036#include <windows.h>
Mark Hammond8696ebc2002-10-08 02:44:31 +000037#endif /* MS_WINDOWS */
38
Guido van Rossum9b38a141996-09-11 23:12:24 +000039#ifdef MS_COREDLL
Guido van Rossumc606fe11996-04-09 02:37:57 +000040extern void *PyWin_DLLhModule;
Guido van Rossum6c1e5f21997-09-29 23:34:23 +000041/* A string loaded from the DLL at startup: */
42extern const char *PyWin_DLLVersionString;
Guido van Rossumc606fe11996-04-09 02:37:57 +000043#endif
44
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -080045/*[clinic input]
46module sys
47[clinic start generated code]*/
48/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3726b388feee8cea]*/
49
50#include "clinic/sysmodule.c.h"
51
Victor Stinnerbd303c12013-11-07 23:07:29 +010052_Py_IDENTIFIER(_);
53_Py_IDENTIFIER(__sizeof__);
Eric Snowdae02762017-09-14 00:35:58 -070054_Py_IDENTIFIER(_xoptions);
Victor Stinnerbd303c12013-11-07 23:07:29 +010055_Py_IDENTIFIER(buffer);
56_Py_IDENTIFIER(builtins);
57_Py_IDENTIFIER(encoding);
58_Py_IDENTIFIER(path);
59_Py_IDENTIFIER(stdout);
60_Py_IDENTIFIER(stderr);
Eric Snowdae02762017-09-14 00:35:58 -070061_Py_IDENTIFIER(warnoptions);
Victor Stinnerbd303c12013-11-07 23:07:29 +010062_Py_IDENTIFIER(write);
63
Victor Stinner838f2642019-06-13 22:41:23 +020064static PyObject *
65sys_get_object_id(PyThreadState *tstate, _Py_Identifier *key)
Victor Stinnerd67bd452013-11-06 22:36:40 +010066{
Victor Stinner838f2642019-06-13 22:41:23 +020067 PyObject *sd = tstate->interp->sysdict;
Victor Stinnercaba55b2018-08-03 15:33:52 +020068 if (sd == NULL) {
Victor Stinnerd67bd452013-11-06 22:36:40 +010069 return NULL;
Victor Stinnercaba55b2018-08-03 15:33:52 +020070 }
Victor Stinnerd67bd452013-11-06 22:36:40 +010071 return _PyDict_GetItemId(sd, key);
72}
73
74PyObject *
Victor Stinner838f2642019-06-13 22:41:23 +020075_PySys_GetObjectId(_Py_Identifier *key)
76{
77 PyThreadState *tstate = _PyThreadState_GET();
78 return sys_get_object_id(tstate, key);
79}
80
81PyObject *
Neal Norwitzf3081322007-08-25 00:32:45 +000082PySys_GetObject(const char *name)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000083{
Victor Stinner838f2642019-06-13 22:41:23 +020084 PyThreadState *tstate = _PyThreadState_GET();
85 PyObject *sd = tstate->interp->sysdict;
Victor Stinnercaba55b2018-08-03 15:33:52 +020086 if (sd == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000087 return NULL;
Victor Stinnercaba55b2018-08-03 15:33:52 +020088 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000089 return PyDict_GetItemString(sd, name);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000090}
91
Victor Stinner838f2642019-06-13 22:41:23 +020092static int
93sys_set_object_id(PyThreadState *tstate, _Py_Identifier *key, PyObject *v)
Victor Stinnerd67bd452013-11-06 22:36:40 +010094{
Victor Stinner838f2642019-06-13 22:41:23 +020095 PyObject *sd = tstate->interp->sysdict;
Victor Stinnerd67bd452013-11-06 22:36:40 +010096 if (v == NULL) {
Victor Stinnercaba55b2018-08-03 15:33:52 +020097 if (_PyDict_GetItemId(sd, key) == NULL) {
Victor Stinnerd67bd452013-11-06 22:36:40 +010098 return 0;
Victor Stinnercaba55b2018-08-03 15:33:52 +020099 }
100 else {
Victor Stinnerd67bd452013-11-06 22:36:40 +0100101 return _PyDict_DelItemId(sd, key);
Victor Stinnercaba55b2018-08-03 15:33:52 +0200102 }
Victor Stinnerd67bd452013-11-06 22:36:40 +0100103 }
Victor Stinnercaba55b2018-08-03 15:33:52 +0200104 else {
Victor Stinnerd67bd452013-11-06 22:36:40 +0100105 return _PyDict_SetItemId(sd, key, v);
Victor Stinnercaba55b2018-08-03 15:33:52 +0200106 }
Victor Stinnerd67bd452013-11-06 22:36:40 +0100107}
108
109int
Victor Stinner838f2642019-06-13 22:41:23 +0200110_PySys_SetObjectId(_Py_Identifier *key, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000111{
Victor Stinner838f2642019-06-13 22:41:23 +0200112 PyThreadState *tstate = _PyThreadState_GET();
113 return sys_set_object_id(tstate, key, v);
114}
115
116static int
117sys_set_object(PyThreadState *tstate, const char *name, PyObject *v)
118{
119 PyObject *sd = tstate->interp->sysdict;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000120 if (v == NULL) {
Victor Stinnercaba55b2018-08-03 15:33:52 +0200121 if (PyDict_GetItemString(sd, name) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000122 return 0;
Victor Stinnercaba55b2018-08-03 15:33:52 +0200123 }
124 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000125 return PyDict_DelItemString(sd, name);
Victor Stinnercaba55b2018-08-03 15:33:52 +0200126 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000127 }
Victor Stinnercaba55b2018-08-03 15:33:52 +0200128 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000129 return PyDict_SetItemString(sd, name, v);
Victor Stinnercaba55b2018-08-03 15:33:52 +0200130 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000131}
132
Victor Stinner838f2642019-06-13 22:41:23 +0200133int
134PySys_SetObject(const char *name, PyObject *v)
Steve Dowerb82e17e2019-05-23 08:45:22 -0700135{
Victor Stinner838f2642019-06-13 22:41:23 +0200136 PyThreadState *tstate = _PyThreadState_GET();
137 return sys_set_object(tstate, name, v);
138}
139
Victor Stinner08faf002020-03-26 18:57:32 +0100140
Victor Stinner838f2642019-06-13 22:41:23 +0200141static int
Victor Stinner08faf002020-03-26 18:57:32 +0100142should_audit(PyInterpreterState *is)
Victor Stinner838f2642019-06-13 22:41:23 +0200143{
Victor Stinner08faf002020-03-26 18:57:32 +0100144 /* tstate->interp cannot be NULL, but test it just in case
145 for extra safety */
146 assert(is != NULL);
147 if (!is) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700148 return 0;
149 }
Victor Stinner08faf002020-03-26 18:57:32 +0100150 return (is->runtime->audit_hook_head
151 || is->audit_hooks
152 || PyDTrace_AUDIT_ENABLED());
Steve Dowerb82e17e2019-05-23 08:45:22 -0700153}
154
Steve Dowerb82e17e2019-05-23 08:45:22 -0700155
Victor Stinner08faf002020-03-26 18:57:32 +0100156static int
157sys_audit_tstate(PyThreadState *ts, const char *event,
158 const char *argFormat, va_list vargs)
159{
Steve Dowerb82e17e2019-05-23 08:45:22 -0700160 /* N format is inappropriate, because you do not know
161 whether the reference is consumed by the call.
162 Assert rather than exception for perf reasons */
163 assert(!argFormat || !strchr(argFormat, 'N'));
164
Victor Stinner08faf002020-03-26 18:57:32 +0100165 if (!ts) {
166 /* Audit hooks cannot be called with a NULL thread state */
Steve Dowerb82e17e2019-05-23 08:45:22 -0700167 return 0;
168 }
169
Victor Stinner08faf002020-03-26 18:57:32 +0100170 /* The current implementation cannot be called if tstate is not
171 the current Python thread state. */
172 assert(ts == _PyThreadState_GET());
173
174 /* Early exit when no hooks are registered */
175 PyInterpreterState *is = ts->interp;
176 if (!should_audit(is)) {
177 return 0;
178 }
179
180 PyObject *eventName = NULL;
181 PyObject *eventArgs = NULL;
182 PyObject *hooks = NULL;
183 PyObject *hook = NULL;
184 int res = -1;
185
Steve Dowerb82e17e2019-05-23 08:45:22 -0700186 int dtrace = PyDTrace_AUDIT_ENABLED();
187
188 PyObject *exc_type, *exc_value, *exc_tb;
Victor Stinner08faf002020-03-26 18:57:32 +0100189 _PyErr_Fetch(ts, &exc_type, &exc_value, &exc_tb);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700190
191 /* Initialize event args now */
192 if (argFormat && argFormat[0]) {
Victor Stinner08faf002020-03-26 18:57:32 +0100193 eventArgs = _Py_VaBuildValue_SizeT(argFormat, vargs);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700194 if (eventArgs && !PyTuple_Check(eventArgs)) {
195 PyObject *argTuple = PyTuple_Pack(1, eventArgs);
196 Py_DECREF(eventArgs);
197 eventArgs = argTuple;
198 }
Victor Stinner08faf002020-03-26 18:57:32 +0100199 }
200 else {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700201 eventArgs = PyTuple_New(0);
202 }
203 if (!eventArgs) {
204 goto exit;
205 }
206
207 /* Call global hooks */
Victor Stinner08faf002020-03-26 18:57:32 +0100208 _Py_AuditHookEntry *e = is->runtime->audit_hook_head;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700209 for (; e; e = e->next) {
210 if (e->hookCFunction(event, eventArgs, e->userData) < 0) {
211 goto exit;
212 }
213 }
214
215 /* Dtrace USDT point */
216 if (dtrace) {
Andy Lestere6be9b52020-02-11 20:28:35 -0600217 PyDTrace_AUDIT(event, (void *)eventArgs);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700218 }
219
220 /* Call interpreter hooks */
Victor Stinner08faf002020-03-26 18:57:32 +0100221 if (is->audit_hooks) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700222 eventName = PyUnicode_FromString(event);
223 if (!eventName) {
224 goto exit;
225 }
226
227 hooks = PyObject_GetIter(is->audit_hooks);
228 if (!hooks) {
229 goto exit;
230 }
231
232 /* Disallow tracing in hooks unless explicitly enabled */
233 ts->tracing++;
234 ts->use_tracing = 0;
235 while ((hook = PyIter_Next(hooks)) != NULL) {
Serhiy Storchaka41c57b32019-09-01 12:03:39 +0300236 _Py_IDENTIFIER(__cantrace__);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700237 PyObject *o;
Serhiy Storchaka41c57b32019-09-01 12:03:39 +0300238 int canTrace = _PyObject_LookupAttrId(hook, &PyId___cantrace__, &o);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700239 if (o) {
240 canTrace = PyObject_IsTrue(o);
241 Py_DECREF(o);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700242 }
243 if (canTrace < 0) {
244 break;
245 }
246 if (canTrace) {
247 ts->use_tracing = (ts->c_tracefunc || ts->c_profilefunc);
248 ts->tracing--;
249 }
Victor Stinner08faf002020-03-26 18:57:32 +0100250 PyObject* args[2] = {eventName, eventArgs};
251 o = _PyObject_FastCallTstate(ts, hook, args, 2);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700252 if (canTrace) {
253 ts->tracing++;
254 ts->use_tracing = 0;
255 }
256 if (!o) {
257 break;
258 }
259 Py_DECREF(o);
260 Py_CLEAR(hook);
261 }
262 ts->use_tracing = (ts->c_tracefunc || ts->c_profilefunc);
263 ts->tracing--;
Victor Stinner838f2642019-06-13 22:41:23 +0200264 if (_PyErr_Occurred(ts)) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700265 goto exit;
266 }
267 }
268
269 res = 0;
270
271exit:
272 Py_XDECREF(hook);
273 Py_XDECREF(hooks);
274 Py_XDECREF(eventName);
275 Py_XDECREF(eventArgs);
276
Victor Stinner08faf002020-03-26 18:57:32 +0100277 if (!res) {
278 _PyErr_Restore(ts, exc_type, exc_value, exc_tb);
279 }
280 else {
281 assert(_PyErr_Occurred(ts));
282 Py_XDECREF(exc_type);
283 Py_XDECREF(exc_value);
284 Py_XDECREF(exc_tb);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700285 }
286
287 return res;
288}
289
Victor Stinner08faf002020-03-26 18:57:32 +0100290int
291_PySys_Audit(PyThreadState *tstate, const char *event,
292 const char *argFormat, ...)
293{
294 va_list vargs;
295#ifdef HAVE_STDARG_PROTOTYPES
296 va_start(vargs, argFormat);
297#else
298 va_start(vargs);
299#endif
300 int res = sys_audit_tstate(tstate, event, argFormat, vargs);
301 va_end(vargs);
302 return res;
303}
304
305int
306PySys_Audit(const char *event, const char *argFormat, ...)
307{
308 PyThreadState *tstate = _PyThreadState_GET();
309 va_list vargs;
310#ifdef HAVE_STDARG_PROTOTYPES
311 va_start(vargs, argFormat);
312#else
313 va_start(vargs);
314#endif
315 int res = sys_audit_tstate(tstate, event, argFormat, vargs);
316 va_end(vargs);
317 return res;
318}
319
Steve Dowerb82e17e2019-05-23 08:45:22 -0700320/* We expose this function primarily for our own cleanup during
321 * finalization. In general, it should not need to be called,
Victor Stinner08faf002020-03-26 18:57:32 +0100322 * and as such the function is not exported.
323 *
324 * Must be finalizing to clear hooks */
Victor Stinner838f2642019-06-13 22:41:23 +0200325void
Victor Stinner08faf002020-03-26 18:57:32 +0100326_PySys_ClearAuditHooks(PyThreadState *ts)
Victor Stinner838f2642019-06-13 22:41:23 +0200327{
Victor Stinner08faf002020-03-26 18:57:32 +0100328 assert(ts != NULL);
329 if (!ts) {
330 return;
331 }
332
333 _PyRuntimeState *runtime = ts->interp->runtime;
Victor Stinner7b3c2522020-03-07 00:24:23 +0100334 PyThreadState *finalizing = _PyRuntimeState_GetFinalizing(runtime);
Victor Stinner08faf002020-03-26 18:57:32 +0100335 assert(finalizing == ts);
336 if (finalizing != ts) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700337 return;
Victor Stinner838f2642019-06-13 22:41:23 +0200338 }
Steve Dowerb82e17e2019-05-23 08:45:22 -0700339
Victor Stinnerda7933e2020-04-13 03:04:28 +0200340 const PyConfig *config = _PyInterpreterState_GetConfig(ts->interp);
Victor Stinner838f2642019-06-13 22:41:23 +0200341 if (config->verbose) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700342 PySys_WriteStderr("# clear sys.audit hooks\n");
343 }
344
345 /* Hooks can abort later hooks for this event, but cannot
346 abort the clear operation itself. */
Victor Stinner08faf002020-03-26 18:57:32 +0100347 _PySys_Audit(ts, "cpython._PySys_ClearAuditHooks", NULL);
Victor Stinner838f2642019-06-13 22:41:23 +0200348 _PyErr_Clear(ts);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700349
Victor Stinner08faf002020-03-26 18:57:32 +0100350 _Py_AuditHookEntry *e = runtime->audit_hook_head, *n;
351 runtime->audit_hook_head = NULL;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700352 while (e) {
353 n = e->next;
354 PyMem_RawFree(e);
355 e = n;
356 }
357}
358
359int
360PySys_AddAuditHook(Py_AuditHookFunction hook, void *userData)
361{
Victor Stinner08faf002020-03-26 18:57:32 +0100362 /* tstate can be NULL, so access directly _PyRuntime:
363 PySys_AddAuditHook() can be called before Python is initialized. */
Victor Stinner838f2642019-06-13 22:41:23 +0200364 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinner08faf002020-03-26 18:57:32 +0100365 PyThreadState *tstate;
366 if (runtime->initialized) {
367 tstate = _PyRuntimeState_GetThreadState(runtime);
368 }
369 else {
370 tstate = NULL;
371 }
Victor Stinner838f2642019-06-13 22:41:23 +0200372
Steve Dowerb82e17e2019-05-23 08:45:22 -0700373 /* Invoke existing audit hooks to allow them an opportunity to abort. */
374 /* Cannot invoke hooks until we are initialized */
Victor Stinner08faf002020-03-26 18:57:32 +0100375 if (tstate != NULL) {
376 if (_PySys_Audit(tstate, "sys.addaudithook", NULL) < 0) {
Steve Dowerbea33f52019-11-28 08:46:11 -0800377 if (_PyErr_ExceptionMatches(tstate, PyExc_RuntimeError)) {
378 /* We do not report errors derived from RuntimeError */
Victor Stinner838f2642019-06-13 22:41:23 +0200379 _PyErr_Clear(tstate);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700380 return 0;
381 }
382 return -1;
383 }
384 }
385
Victor Stinner08faf002020-03-26 18:57:32 +0100386 _Py_AuditHookEntry *e = runtime->audit_hook_head;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700387 if (!e) {
388 e = (_Py_AuditHookEntry*)PyMem_RawMalloc(sizeof(_Py_AuditHookEntry));
Victor Stinner08faf002020-03-26 18:57:32 +0100389 runtime->audit_hook_head = e;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700390 } else {
Victor Stinner838f2642019-06-13 22:41:23 +0200391 while (e->next) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700392 e = e->next;
Victor Stinner838f2642019-06-13 22:41:23 +0200393 }
Steve Dowerb82e17e2019-05-23 08:45:22 -0700394 e = e->next = (_Py_AuditHookEntry*)PyMem_RawMalloc(
395 sizeof(_Py_AuditHookEntry));
396 }
397
398 if (!e) {
Victor Stinner08faf002020-03-26 18:57:32 +0100399 if (tstate != NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +0200400 _PyErr_NoMemory(tstate);
401 }
Steve Dowerb82e17e2019-05-23 08:45:22 -0700402 return -1;
403 }
404
405 e->next = NULL;
406 e->hookCFunction = (Py_AuditHookFunction)hook;
407 e->userData = userData;
408
409 return 0;
410}
411
412/*[clinic input]
413sys.addaudithook
414
415 hook: object
416
417Adds a new audit hook callback.
418[clinic start generated code]*/
419
420static PyObject *
421sys_addaudithook_impl(PyObject *module, PyObject *hook)
422/*[clinic end generated code: output=4f9c17aaeb02f44e input=0f3e191217a45e34]*/
423{
Victor Stinner838f2642019-06-13 22:41:23 +0200424 PyThreadState *tstate = _PyThreadState_GET();
425
Steve Dowerb82e17e2019-05-23 08:45:22 -0700426 /* Invoke existing audit hooks to allow them an opportunity to abort. */
Victor Stinner08faf002020-03-26 18:57:32 +0100427 if (_PySys_Audit(tstate, "sys.addaudithook", NULL) < 0) {
Victor Stinner838f2642019-06-13 22:41:23 +0200428 if (_PyErr_ExceptionMatches(tstate, PyExc_Exception)) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700429 /* We do not report errors derived from Exception */
Victor Stinner838f2642019-06-13 22:41:23 +0200430 _PyErr_Clear(tstate);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700431 Py_RETURN_NONE;
432 }
433 return NULL;
434 }
435
Victor Stinner838f2642019-06-13 22:41:23 +0200436 PyInterpreterState *is = tstate->interp;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700437 if (is->audit_hooks == NULL) {
438 is->audit_hooks = PyList_New(0);
439 if (is->audit_hooks == NULL) {
440 return NULL;
441 }
442 }
443
444 if (PyList_Append(is->audit_hooks, hook) < 0) {
445 return NULL;
446 }
447
448 Py_RETURN_NONE;
449}
450
451PyDoc_STRVAR(audit_doc,
452"audit(event, *args)\n\
453\n\
454Passes the event to any audit hooks that are attached.");
455
456static PyObject *
457sys_audit(PyObject *self, PyObject *const *args, Py_ssize_t argc)
458{
Victor Stinner838f2642019-06-13 22:41:23 +0200459 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner3026cad2020-06-01 16:02:40 +0200460 _Py_EnsureTstateNotNULL(tstate);
Victor Stinner838f2642019-06-13 22:41:23 +0200461
Steve Dowerb82e17e2019-05-23 08:45:22 -0700462 if (argc == 0) {
Victor Stinner838f2642019-06-13 22:41:23 +0200463 _PyErr_SetString(tstate, PyExc_TypeError,
464 "audit() missing 1 required positional argument: "
465 "'event'");
Steve Dowerb82e17e2019-05-23 08:45:22 -0700466 return NULL;
467 }
468
Victor Stinner08faf002020-03-26 18:57:32 +0100469 if (!should_audit(tstate->interp)) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700470 Py_RETURN_NONE;
471 }
472
473 PyObject *auditEvent = args[0];
474 if (!auditEvent) {
Victor Stinner838f2642019-06-13 22:41:23 +0200475 _PyErr_SetString(tstate, PyExc_TypeError,
476 "expected str for argument 'event'");
Steve Dowerb82e17e2019-05-23 08:45:22 -0700477 return NULL;
478 }
479 if (!PyUnicode_Check(auditEvent)) {
Victor Stinner838f2642019-06-13 22:41:23 +0200480 _PyErr_Format(tstate, PyExc_TypeError,
481 "expected str for argument 'event', not %.200s",
482 Py_TYPE(auditEvent)->tp_name);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700483 return NULL;
484 }
485 const char *event = PyUnicode_AsUTF8(auditEvent);
486 if (!event) {
487 return NULL;
488 }
489
490 PyObject *auditArgs = _PyTuple_FromArray(args + 1, argc - 1);
491 if (!auditArgs) {
492 return NULL;
493 }
494
Victor Stinner08faf002020-03-26 18:57:32 +0100495 int res = _PySys_Audit(tstate, event, "O", auditArgs);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700496 Py_DECREF(auditArgs);
497
498 if (res < 0) {
499 return NULL;
500 }
501
502 Py_RETURN_NONE;
503}
504
505
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400506static PyObject *
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200507sys_breakpointhook(PyObject *self, PyObject *const *args, Py_ssize_t nargs, PyObject *keywords)
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400508{
Victor Stinner838f2642019-06-13 22:41:23 +0200509 PyThreadState *tstate = _PyThreadState_GET();
510 assert(!_PyErr_Occurred(tstate));
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300511 char *envar = Py_GETENV("PYTHONBREAKPOINT");
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400512
513 if (envar == NULL || strlen(envar) == 0) {
514 envar = "pdb.set_trace";
515 }
516 else if (!strcmp(envar, "0")) {
517 /* The breakpoint is explicitly no-op'd. */
518 Py_RETURN_NONE;
519 }
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300520 /* According to POSIX the string returned by getenv() might be invalidated
521 * or the string content might be overwritten by a subsequent call to
522 * getenv(). Since importing a module can performs the getenv() calls,
523 * we need to save a copy of envar. */
524 envar = _PyMem_RawStrdup(envar);
525 if (envar == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +0200526 _PyErr_NoMemory(tstate);
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300527 return NULL;
528 }
Serhiy Storchaka4ae06c52017-12-12 13:55:04 +0200529 const char *last_dot = strrchr(envar, '.');
530 const char *attrname = NULL;
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400531 PyObject *modulepath = NULL;
532
533 if (last_dot == NULL) {
534 /* The breakpoint is a built-in, e.g. PYTHONBREAKPOINT=int */
535 modulepath = PyUnicode_FromString("builtins");
536 attrname = envar;
537 }
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200538 else if (last_dot != envar) {
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400539 /* Split on the last dot; */
540 modulepath = PyUnicode_FromStringAndSize(envar, last_dot - envar);
541 attrname = last_dot + 1;
542 }
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200543 else {
544 goto warn;
545 }
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400546 if (modulepath == NULL) {
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300547 PyMem_RawFree(envar);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400548 return NULL;
549 }
550
Anthony Sottiledce345c2018-11-01 10:25:05 -0700551 PyObject *module = PyImport_Import(modulepath);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400552 Py_DECREF(modulepath);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400553
554 if (module == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +0200555 if (_PyErr_ExceptionMatches(tstate, PyExc_ImportError)) {
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200556 goto warn;
557 }
558 PyMem_RawFree(envar);
559 return NULL;
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400560 }
561
562 PyObject *hook = PyObject_GetAttrString(module, attrname);
563 Py_DECREF(module);
564
565 if (hook == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +0200566 if (_PyErr_ExceptionMatches(tstate, PyExc_AttributeError)) {
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200567 goto warn;
568 }
569 PyMem_RawFree(envar);
570 return NULL;
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400571 }
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300572 PyMem_RawFree(envar);
Petr Viktorinffd97532020-02-11 17:46:57 +0100573 PyObject *retval = PyObject_Vectorcall(hook, args, nargs, keywords);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400574 Py_DECREF(hook);
575 return retval;
576
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200577 warn:
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400578 /* If any of the imports went wrong, then warn and ignore. */
Victor Stinner838f2642019-06-13 22:41:23 +0200579 _PyErr_Clear(tstate);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400580 int status = PyErr_WarnFormat(
581 PyExc_RuntimeWarning, 0,
582 "Ignoring unimportable $PYTHONBREAKPOINT: \"%s\"", envar);
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300583 PyMem_RawFree(envar);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400584 if (status < 0) {
585 /* Printing the warning raised an exception. */
586 return NULL;
587 }
588 /* The warning was (probably) issued. */
589 Py_RETURN_NONE;
590}
591
592PyDoc_STRVAR(breakpointhook_doc,
593"breakpointhook(*args, **kws)\n"
594"\n"
595"This hook function is called by built-in breakpoint().\n"
596);
597
Victor Stinner13d49ee2010-12-04 17:24:33 +0000598/* Write repr(o) to sys.stdout using sys.stdout.encoding and 'backslashreplace'
599 error handler. If sys.stdout has a buffer attribute, use
600 sys.stdout.buffer.write(encoded), otherwise redecode the string and use
601 sys.stdout.write(redecoded).
602
603 Helper function for sys_displayhook(). */
604static int
Andy Lesterda4d6562020-03-05 22:34:36 -0600605sys_displayhook_unencodable(PyObject *outf, PyObject *o)
Victor Stinner13d49ee2010-12-04 17:24:33 +0000606{
607 PyObject *stdout_encoding = NULL;
608 PyObject *encoded, *escaped_str, *repr_str, *buffer, *result;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200609 const char *stdout_encoding_str;
Victor Stinner13d49ee2010-12-04 17:24:33 +0000610 int ret;
611
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200612 stdout_encoding = _PyObject_GetAttrId(outf, &PyId_encoding);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000613 if (stdout_encoding == NULL)
614 goto error;
Serhiy Storchaka06515832016-11-20 09:13:07 +0200615 stdout_encoding_str = PyUnicode_AsUTF8(stdout_encoding);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000616 if (stdout_encoding_str == NULL)
617 goto error;
618
619 repr_str = PyObject_Repr(o);
620 if (repr_str == NULL)
621 goto error;
622 encoded = PyUnicode_AsEncodedString(repr_str,
623 stdout_encoding_str,
624 "backslashreplace");
625 Py_DECREF(repr_str);
626 if (encoded == NULL)
627 goto error;
628
Serhiy Storchaka41c57b32019-09-01 12:03:39 +0300629 if (_PyObject_LookupAttrId(outf, &PyId_buffer, &buffer) < 0) {
630 Py_DECREF(encoded);
631 goto error;
632 }
Victor Stinner13d49ee2010-12-04 17:24:33 +0000633 if (buffer) {
Jeroen Demeyer59ad1102019-07-11 10:59:05 +0200634 result = _PyObject_CallMethodIdOneArg(buffer, &PyId_write, encoded);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000635 Py_DECREF(buffer);
636 Py_DECREF(encoded);
637 if (result == NULL)
638 goto error;
639 Py_DECREF(result);
640 }
641 else {
Victor Stinner13d49ee2010-12-04 17:24:33 +0000642 escaped_str = PyUnicode_FromEncodedObject(encoded,
643 stdout_encoding_str,
644 "strict");
645 Py_DECREF(encoded);
646 if (PyFile_WriteObject(escaped_str, outf, Py_PRINT_RAW) != 0) {
647 Py_DECREF(escaped_str);
648 goto error;
649 }
650 Py_DECREF(escaped_str);
651 }
652 ret = 0;
653 goto finally;
654
655error:
656 ret = -1;
657finally:
658 Py_XDECREF(stdout_encoding);
659 return ret;
660}
661
Tal Einatede0b6f2018-12-31 17:12:08 +0200662/*[clinic input]
663sys.displayhook
664
665 object as o: object
666 /
667
668Print an object to sys.stdout and also save it in builtins._
669[clinic start generated code]*/
670
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000671static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200672sys_displayhook(PyObject *module, PyObject *o)
673/*[clinic end generated code: output=347477d006df92ed input=08ba730166d7ef72]*/
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000674{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000675 PyObject *outf;
Victor Stinnerd02fbb82013-11-06 18:27:13 +0100676 PyObject *builtins;
677 static PyObject *newline = NULL;
Victor Stinner838f2642019-06-13 22:41:23 +0200678 PyThreadState *tstate = _PyThreadState_GET();
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000679
Eric Snow3f9eee62017-09-15 16:35:20 -0600680 builtins = _PyImport_GetModuleId(&PyId_builtins);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000681 if (builtins == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +0200682 if (!_PyErr_Occurred(tstate)) {
683 _PyErr_SetString(tstate, PyExc_RuntimeError,
684 "lost builtins module");
Stefan Krah027b09c2019-03-25 21:50:58 +0100685 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000686 return NULL;
687 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600688 Py_DECREF(builtins);
Moshe Zadka03897ea2001-07-23 13:32:43 +0000689
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000690 /* Print value except if None */
691 /* After printing, also assign to '_' */
692 /* Before, set '_' to None to avoid recursion */
693 if (o == Py_None) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200694 Py_RETURN_NONE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000695 }
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200696 if (_PyObject_SetAttrId(builtins, &PyId__, Py_None) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000697 return NULL;
Victor Stinner838f2642019-06-13 22:41:23 +0200698 outf = sys_get_object_id(tstate, &PyId_stdout);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000699 if (outf == NULL || outf == Py_None) {
Victor Stinner838f2642019-06-13 22:41:23 +0200700 _PyErr_SetString(tstate, PyExc_RuntimeError, "lost sys.stdout");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000701 return NULL;
702 }
Victor Stinner13d49ee2010-12-04 17:24:33 +0000703 if (PyFile_WriteObject(o, outf, 0) != 0) {
Victor Stinner838f2642019-06-13 22:41:23 +0200704 if (_PyErr_ExceptionMatches(tstate, PyExc_UnicodeEncodeError)) {
Andy Lesterda4d6562020-03-05 22:34:36 -0600705 int err;
Victor Stinner13d49ee2010-12-04 17:24:33 +0000706 /* repr(o) is not encodable to sys.stdout.encoding with
707 * sys.stdout.errors error handler (which is probably 'strict') */
Victor Stinner838f2642019-06-13 22:41:23 +0200708 _PyErr_Clear(tstate);
Andy Lesterda4d6562020-03-05 22:34:36 -0600709 err = sys_displayhook_unencodable(outf, o);
Victor Stinner838f2642019-06-13 22:41:23 +0200710 if (err) {
Victor Stinner13d49ee2010-12-04 17:24:33 +0000711 return NULL;
Victor Stinner838f2642019-06-13 22:41:23 +0200712 }
Victor Stinner13d49ee2010-12-04 17:24:33 +0000713 }
714 else {
715 return NULL;
716 }
717 }
Victor Stinnerd02fbb82013-11-06 18:27:13 +0100718 if (newline == NULL) {
719 newline = PyUnicode_FromString("\n");
720 if (newline == NULL)
721 return NULL;
722 }
723 if (PyFile_WriteObject(newline, outf, Py_PRINT_RAW) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000724 return NULL;
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200725 if (_PyObject_SetAttrId(builtins, &PyId__, o) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000726 return NULL;
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200727 Py_RETURN_NONE;
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000728}
729
Tal Einatede0b6f2018-12-31 17:12:08 +0200730
731/*[clinic input]
732sys.excepthook
733
734 exctype: object
735 value: object
736 traceback: object
737 /
738
739Handle an exception by displaying it with a traceback on sys.stderr.
740[clinic start generated code]*/
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000741
742static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200743sys_excepthook_impl(PyObject *module, PyObject *exctype, PyObject *value,
744 PyObject *traceback)
745/*[clinic end generated code: output=18d99fdda21b6b5e input=ecf606fa826f19d9]*/
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000746{
Tal Einatede0b6f2018-12-31 17:12:08 +0200747 PyErr_Display(exctype, value, traceback);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200748 Py_RETURN_NONE;
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000749}
750
Tal Einatede0b6f2018-12-31 17:12:08 +0200751
752/*[clinic input]
753sys.exc_info
754
755Return current exception information: (type, value, traceback).
756
757Return information about the most recent exception caught by an except
758clause in the current stack frame or in an older stack frame.
759[clinic start generated code]*/
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000760
761static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200762sys_exc_info_impl(PyObject *module)
763/*[clinic end generated code: output=3afd0940cf3a4d30 input=b5c5bf077788a3e5]*/
Guido van Rossuma027efa1997-05-05 20:56:21 +0000764{
Victor Stinner50b48572018-11-01 01:51:40 +0100765 _PyErr_StackItem *err_info = _PyErr_GetTopmostException(_PyThreadState_GET());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000766 return Py_BuildValue(
767 "(OOO)",
Mark Shannonae3087c2017-10-22 22:41:51 +0100768 err_info->exc_type != NULL ? err_info->exc_type : Py_None,
769 err_info->exc_value != NULL ? err_info->exc_value : Py_None,
770 err_info->exc_traceback != NULL ?
771 err_info->exc_traceback : Py_None);
Guido van Rossuma027efa1997-05-05 20:56:21 +0000772}
773
Tal Einatede0b6f2018-12-31 17:12:08 +0200774
775/*[clinic input]
Victor Stinneref9d9b62019-05-22 11:28:22 +0200776sys.unraisablehook
777
778 unraisable: object
779 /
780
781Handle an unraisable exception.
782
783The unraisable argument has the following attributes:
784
785* exc_type: Exception type.
Victor Stinner71c52e32019-05-27 08:57:14 +0200786* exc_value: Exception value, can be None.
787* exc_traceback: Exception traceback, can be None.
788* err_msg: Error message, can be None.
789* object: Object causing the exception, can be None.
Victor Stinneref9d9b62019-05-22 11:28:22 +0200790[clinic start generated code]*/
791
792static PyObject *
793sys_unraisablehook(PyObject *module, PyObject *unraisable)
Victor Stinner71c52e32019-05-27 08:57:14 +0200794/*[clinic end generated code: output=bb92838b32abaa14 input=ec3af148294af8d3]*/
Victor Stinneref9d9b62019-05-22 11:28:22 +0200795{
796 return _PyErr_WriteUnraisableDefaultHook(unraisable);
797}
798
799
800/*[clinic input]
Tal Einatede0b6f2018-12-31 17:12:08 +0200801sys.exit
802
Serhiy Storchaka279f4462019-09-14 12:24:05 +0300803 status: object = None
Tal Einatede0b6f2018-12-31 17:12:08 +0200804 /
805
806Exit the interpreter by raising SystemExit(status).
807
808If the status is omitted or None, it defaults to zero (i.e., success).
809If the status is an integer, it will be used as the system exit status.
810If it is another kind of object, it will be printed and the system
811exit status will be one (i.e., failure).
812[clinic start generated code]*/
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000813
814static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200815sys_exit_impl(PyObject *module, PyObject *status)
Serhiy Storchaka279f4462019-09-14 12:24:05 +0300816/*[clinic end generated code: output=13870986c1ab2ec0 input=b86ca9497baa94f2]*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000817{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000818 /* Raise SystemExit so callers may catch it or clean up. */
Victor Stinner838f2642019-06-13 22:41:23 +0200819 PyThreadState *tstate = _PyThreadState_GET();
820 _PyErr_SetObject(tstate, PyExc_SystemExit, status);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000821 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000822}
823
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000824
Martin v. Löwis107b7da2001-11-09 20:59:39 +0000825
Tal Einatede0b6f2018-12-31 17:12:08 +0200826/*[clinic input]
827sys.getdefaultencoding
828
829Return the current default encoding used by the Unicode implementation.
830[clinic start generated code]*/
831
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000832static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200833sys_getdefaultencoding_impl(PyObject *module)
834/*[clinic end generated code: output=256d19dfcc0711e6 input=d416856ddbef6909]*/
Fred Drake8b4d01d2000-05-09 19:57:01 +0000835{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000836 return PyUnicode_FromString(PyUnicode_GetDefaultEncoding());
Fred Drake8b4d01d2000-05-09 19:57:01 +0000837}
838
Tal Einatede0b6f2018-12-31 17:12:08 +0200839/*[clinic input]
840sys.getfilesystemencoding
841
842Return the encoding used to convert Unicode filenames to OS filenames.
843[clinic start generated code]*/
Fred Drake8b4d01d2000-05-09 19:57:01 +0000844
845static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200846sys_getfilesystemencoding_impl(PyObject *module)
847/*[clinic end generated code: output=1dc4bdbe9be44aa7 input=8475f8649b8c7d8c]*/
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000848{
Victor Stinner81a7be32020-04-14 15:14:01 +0200849 PyInterpreterState *interp = _PyInterpreterState_GET();
Victor Stinnerda7933e2020-04-13 03:04:28 +0200850 const PyConfig *config = _PyInterpreterState_GetConfig(interp);
Victor Stinner709d23d2019-05-02 14:56:30 -0400851 return PyUnicode_FromWideChar(config->filesystem_encoding, -1);
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000852}
853
Tal Einatede0b6f2018-12-31 17:12:08 +0200854/*[clinic input]
855sys.getfilesystemencodeerrors
856
857Return the error mode used Unicode to OS filename conversion.
858[clinic start generated code]*/
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000859
Martin v. Löwis04dc25c2008-10-03 16:09:28 +0000860static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200861sys_getfilesystemencodeerrors_impl(PyObject *module)
862/*[clinic end generated code: output=ba77b36bbf7c96f5 input=22a1e8365566f1e5]*/
Steve Dowercc16be82016-09-08 10:35:16 -0700863{
Victor Stinner81a7be32020-04-14 15:14:01 +0200864 PyInterpreterState *interp = _PyInterpreterState_GET();
Victor Stinnerda7933e2020-04-13 03:04:28 +0200865 const PyConfig *config = _PyInterpreterState_GetConfig(interp);
Victor Stinner709d23d2019-05-02 14:56:30 -0400866 return PyUnicode_FromWideChar(config->filesystem_errors, -1);
Steve Dowercc16be82016-09-08 10:35:16 -0700867}
868
Tal Einatede0b6f2018-12-31 17:12:08 +0200869/*[clinic input]
870sys.intern
871
872 string as s: unicode
873 /
874
875``Intern'' the given string.
876
877This enters the string in the (global) table of interned strings whose
878purpose is to speed up dictionary lookups. Return the string itself or
879the previously interned string object with the same value.
880[clinic start generated code]*/
Steve Dowercc16be82016-09-08 10:35:16 -0700881
882static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200883sys_intern_impl(PyObject *module, PyObject *s)
884/*[clinic end generated code: output=be680c24f5c9e5d6 input=849483c006924e2f]*/
Georg Brandl66a796e2006-12-19 20:50:34 +0000885{
Victor Stinner838f2642019-06-13 22:41:23 +0200886 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000887 if (PyUnicode_CheckExact(s)) {
888 Py_INCREF(s);
889 PyUnicode_InternInPlace(&s);
890 return s;
891 }
892 else {
Victor Stinner838f2642019-06-13 22:41:23 +0200893 _PyErr_Format(tstate, PyExc_TypeError,
Victor Stinnera102ed72020-02-07 02:24:48 +0100894 "can't intern %.400s", Py_TYPE(s)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000895 return NULL;
896 }
Georg Brandl66a796e2006-12-19 20:50:34 +0000897}
898
Georg Brandl66a796e2006-12-19 20:50:34 +0000899
Fred Drake5755ce62001-06-27 19:19:46 +0000900/*
901 * Cached interned string objects used for calling the profile and
902 * trace functions. Initialized by trace_init().
903 */
Nick Coghlan5a851672017-09-08 10:14:16 +1000904static PyObject *whatstrings[8] = {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL};
Fred Drake5755ce62001-06-27 19:19:46 +0000905
906static int
907trace_init(void)
908{
Nick Coghlan5a851672017-09-08 10:14:16 +1000909 static const char * const whatnames[8] = {
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200910 "call", "exception", "line", "return",
Nick Coghlan5a851672017-09-08 10:14:16 +1000911 "c_call", "c_exception", "c_return",
912 "opcode"
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200913 };
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000914 PyObject *name;
915 int i;
Nick Coghlan5a851672017-09-08 10:14:16 +1000916 for (i = 0; i < 8; ++i) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000917 if (whatstrings[i] == NULL) {
918 name = PyUnicode_InternFromString(whatnames[i]);
919 if (name == NULL)
920 return -1;
921 whatstrings[i] = name;
922 }
923 }
924 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000925}
926
927
928static PyObject *
Victor Stinner309d7cc2020-03-13 16:39:12 +0100929call_trampoline(PyThreadState *tstate, PyObject* callback,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000930 PyFrameObject *frame, int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000931{
Victor Stinner78da82b2016-08-20 01:22:57 +0200932 if (PyFrame_FastToLocalsWithError(frame) < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000933 return NULL;
Victor Stinner78da82b2016-08-20 01:22:57 +0200934 }
Victor Stinner41bb43a2013-10-29 01:19:37 +0100935
Victor Stinner838f2642019-06-13 22:41:23 +0200936 PyObject *stack[3];
Victor Stinner78da82b2016-08-20 01:22:57 +0200937 stack[0] = (PyObject *)frame;
938 stack[1] = whatstrings[what];
939 stack[2] = (arg != NULL) ? arg : Py_None;
Fred Drake5755ce62001-06-27 19:19:46 +0000940
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000941 /* call the Python-level function */
Victor Stinner309d7cc2020-03-13 16:39:12 +0100942 PyObject *result = _PyObject_FastCallTstate(tstate, callback, stack, 3);
Fred Drake5755ce62001-06-27 19:19:46 +0000943
Victor Stinner78da82b2016-08-20 01:22:57 +0200944 PyFrame_LocalsToFast(frame, 1);
945 if (result == NULL) {
946 PyTraceBack_Here(frame);
947 }
948
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000949 return result;
Fred Drake5755ce62001-06-27 19:19:46 +0000950}
951
952static int
953profile_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000954 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000955{
Victor Stinner309d7cc2020-03-13 16:39:12 +0100956 if (arg == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000957 arg = Py_None;
Victor Stinner309d7cc2020-03-13 16:39:12 +0100958 }
959
960 PyThreadState *tstate = _PyThreadState_GET();
961 PyObject *result = call_trampoline(tstate, self, frame, what, arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000962 if (result == NULL) {
Victor Stinner309d7cc2020-03-13 16:39:12 +0100963 _PyEval_SetProfile(tstate, NULL, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000964 return -1;
965 }
Victor Stinner309d7cc2020-03-13 16:39:12 +0100966
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000967 Py_DECREF(result);
968 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000969}
970
971static int
972trace_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000973 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000974{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000975 PyObject *callback;
Victor Stinner309d7cc2020-03-13 16:39:12 +0100976 if (what == PyTrace_CALL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000977 callback = self;
Victor Stinner309d7cc2020-03-13 16:39:12 +0100978 }
979 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 callback = frame->f_trace;
Victor Stinner309d7cc2020-03-13 16:39:12 +0100981 }
982 if (callback == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000983 return 0;
Victor Stinner309d7cc2020-03-13 16:39:12 +0100984 }
985
986 PyThreadState *tstate = _PyThreadState_GET();
987 PyObject *result = call_trampoline(tstate, callback, frame, what, arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000988 if (result == NULL) {
Victor Stinner309d7cc2020-03-13 16:39:12 +0100989 _PyEval_SetTrace(tstate, NULL, NULL);
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200990 Py_CLEAR(frame->f_trace);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000991 return -1;
992 }
Victor Stinner309d7cc2020-03-13 16:39:12 +0100993
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000994 if (result != Py_None) {
Serhiy Storchakaec397562016-04-06 09:50:03 +0300995 Py_XSETREF(frame->f_trace, result);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000996 }
997 else {
998 Py_DECREF(result);
999 }
1000 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +00001001}
Fred Draked0838392001-06-16 21:02:31 +00001002
Fred Drake8b4d01d2000-05-09 19:57:01 +00001003static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001004sys_settrace(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +00001005{
Victor Stinner309d7cc2020-03-13 16:39:12 +01001006 if (trace_init() == -1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001007 return NULL;
Victor Stinner309d7cc2020-03-13 16:39:12 +01001008 }
1009
1010 PyThreadState *tstate = _PyThreadState_GET();
1011 if (args == Py_None) {
1012 if (_PyEval_SetTrace(tstate, NULL, NULL) < 0) {
1013 return NULL;
1014 }
1015 }
1016 else {
1017 if (_PyEval_SetTrace(tstate, trace_trampoline, args) < 0) {
1018 return NULL;
1019 }
1020 }
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001021 Py_RETURN_NONE;
Guido van Rossume2437a11992-03-23 18:20:18 +00001022}
1023
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001024PyDoc_STRVAR(settrace_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001025"settrace(function)\n\
1026\n\
1027Set the global debug tracing function. It will be called on each\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001028function call. See the debugger chapter in the library manual."
1029);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001030
Tal Einatede0b6f2018-12-31 17:12:08 +02001031/*[clinic input]
1032sys.gettrace
1033
1034Return the global debug tracing function set with sys.settrace.
1035
1036See the debugger chapter in the library manual.
1037[clinic start generated code]*/
1038
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001039static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001040sys_gettrace_impl(PyObject *module)
1041/*[clinic end generated code: output=e97e3a4d8c971b6e input=373b51bb2147f4d8]*/
Christian Heimes9bd667a2008-01-20 15:14:11 +00001042{
Victor Stinner50b48572018-11-01 01:51:40 +01001043 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001044 PyObject *temp = tstate->c_traceobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +00001045
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 if (temp == NULL)
1047 temp = Py_None;
1048 Py_INCREF(temp);
1049 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +00001050}
1051
Christian Heimes9bd667a2008-01-20 15:14:11 +00001052static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001053sys_setprofile(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +00001054{
Victor Stinner309d7cc2020-03-13 16:39:12 +01001055 if (trace_init() == -1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001056 return NULL;
Victor Stinner309d7cc2020-03-13 16:39:12 +01001057 }
1058
1059 PyThreadState *tstate = _PyThreadState_GET();
1060 if (args == Py_None) {
1061 if (_PyEval_SetProfile(tstate, NULL, NULL) < 0) {
1062 return NULL;
1063 }
1064 }
1065 else {
1066 if (_PyEval_SetProfile(tstate, profile_trampoline, args) < 0) {
1067 return NULL;
1068 }
1069 }
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001070 Py_RETURN_NONE;
Guido van Rossume2437a11992-03-23 18:20:18 +00001071}
1072
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001073PyDoc_STRVAR(setprofile_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001074"setprofile(function)\n\
1075\n\
1076Set the profiling function. It will be called on each function call\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001077and return. See the profiler chapter in the library manual."
1078);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001079
Tal Einatede0b6f2018-12-31 17:12:08 +02001080/*[clinic input]
1081sys.getprofile
1082
1083Return the profiling function set with sys.setprofile.
1084
1085See the profiler chapter in the library manual.
1086[clinic start generated code]*/
1087
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001088static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001089sys_getprofile_impl(PyObject *module)
1090/*[clinic end generated code: output=579b96b373448188 input=1b3209d89a32965d]*/
Christian Heimes9bd667a2008-01-20 15:14:11 +00001091{
Victor Stinner50b48572018-11-01 01:51:40 +01001092 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 PyObject *temp = tstate->c_profileobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +00001094
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001095 if (temp == NULL)
1096 temp = Py_None;
1097 Py_INCREF(temp);
1098 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +00001099}
1100
Tim Peterse5e065b2003-07-06 18:36:54 +00001101
Tal Einatede0b6f2018-12-31 17:12:08 +02001102/*[clinic input]
1103sys.setswitchinterval
1104
1105 interval: double
1106 /
1107
1108Set the ideal thread switching delay inside the Python interpreter.
1109
1110The actual frequency of switching threads can be lower if the
1111interpreter executes long sequences of uninterruptible code
1112(this is implementation-specific and workload-dependent).
1113
1114The parameter must represent the desired switching delay in seconds
1115A typical value is 0.005 (5 milliseconds).
1116[clinic start generated code]*/
Tim Peterse5e065b2003-07-06 18:36:54 +00001117
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001118static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001119sys_setswitchinterval_impl(PyObject *module, double interval)
1120/*[clinic end generated code: output=65a19629e5153983 input=561b477134df91d9]*/
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001121{
Victor Stinner838f2642019-06-13 22:41:23 +02001122 PyThreadState *tstate = _PyThreadState_GET();
Tal Einatede0b6f2018-12-31 17:12:08 +02001123 if (interval <= 0.0) {
Victor Stinner838f2642019-06-13 22:41:23 +02001124 _PyErr_SetString(tstate, PyExc_ValueError,
1125 "switch interval must be strictly positive");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001126 return NULL;
1127 }
Tal Einatede0b6f2018-12-31 17:12:08 +02001128 _PyEval_SetSwitchInterval((unsigned long) (1e6 * interval));
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001129 Py_RETURN_NONE;
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001130}
1131
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001132
Tal Einatede0b6f2018-12-31 17:12:08 +02001133/*[clinic input]
1134sys.getswitchinterval -> double
1135
1136Return the current thread switch interval; see sys.setswitchinterval().
1137[clinic start generated code]*/
1138
1139static double
1140sys_getswitchinterval_impl(PyObject *module)
1141/*[clinic end generated code: output=a38c277c85b5096d input=bdf9d39c0ebbbb6f]*/
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001142{
Tal Einatede0b6f2018-12-31 17:12:08 +02001143 return 1e-6 * _PyEval_GetSwitchInterval();
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001144}
1145
Tal Einatede0b6f2018-12-31 17:12:08 +02001146/*[clinic input]
1147sys.setrecursionlimit
1148
1149 limit as new_limit: int
1150 /
1151
1152Set the maximum depth of the Python interpreter stack to n.
1153
1154This limit prevents infinite recursion from causing an overflow of the C
1155stack and crashing Python. The highest possible limit is platform-
1156dependent.
1157[clinic start generated code]*/
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001158
Tim Peterse5e065b2003-07-06 18:36:54 +00001159static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001160sys_setrecursionlimit_impl(PyObject *module, int new_limit)
1161/*[clinic end generated code: output=35e1c64754800ace input=b0f7a23393924af3]*/
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001162{
Tal Einatede0b6f2018-12-31 17:12:08 +02001163 int mark;
Victor Stinner838f2642019-06-13 22:41:23 +02001164 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner50856d52015-10-13 00:11:21 +02001165
Victor Stinner50856d52015-10-13 00:11:21 +02001166 if (new_limit < 1) {
Victor Stinner838f2642019-06-13 22:41:23 +02001167 _PyErr_SetString(tstate, PyExc_ValueError,
1168 "recursion limit must be greater or equal than 1");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001169 return NULL;
1170 }
Victor Stinner50856d52015-10-13 00:11:21 +02001171
1172 /* Issue #25274: When the recursion depth hits the recursion limit in
1173 _Py_CheckRecursiveCall(), the overflowed flag of the thread state is
1174 set to 1 and a RecursionError is raised. The overflowed flag is reset
1175 to 0 when the recursion depth goes below the low-water mark: see
1176 Py_LeaveRecursiveCall().
1177
1178 Reject too low new limit if the current recursion depth is higher than
1179 the new low-water mark. Otherwise it may not be possible anymore to
1180 reset the overflowed flag to 0. */
1181 mark = _Py_RecursionLimitLowerWaterMark(new_limit);
Victor Stinner50856d52015-10-13 00:11:21 +02001182 if (tstate->recursion_depth >= mark) {
Victor Stinner838f2642019-06-13 22:41:23 +02001183 _PyErr_Format(tstate, PyExc_RecursionError,
1184 "cannot set the recursion limit to %i at "
1185 "the recursion depth %i: the limit is too low",
1186 new_limit, tstate->recursion_depth);
Victor Stinner50856d52015-10-13 00:11:21 +02001187 return NULL;
1188 }
1189
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001190 Py_SetRecursionLimit(new_limit);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001191 Py_RETURN_NONE;
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001192}
1193
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001194/*[clinic input]
1195sys.set_coroutine_origin_tracking_depth
1196
1197 depth: int
1198
1199Enable or disable origin tracking for coroutine objects in this thread.
1200
Tal Einatede0b6f2018-12-31 17:12:08 +02001201Coroutine objects will track 'depth' frames of traceback information
1202about where they came from, available in their cr_origin attribute.
1203
1204Set a depth of 0 to disable.
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001205[clinic start generated code]*/
1206
1207static PyObject *
1208sys_set_coroutine_origin_tracking_depth_impl(PyObject *module, int depth)
Tal Einatede0b6f2018-12-31 17:12:08 +02001209/*[clinic end generated code: output=0a2123c1cc6759c5 input=a1d0a05f89d2c426]*/
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001210{
Victor Stinner838f2642019-06-13 22:41:23 +02001211 PyThreadState *tstate = _PyThreadState_GET();
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001212 if (depth < 0) {
Victor Stinner838f2642019-06-13 22:41:23 +02001213 _PyErr_SetString(tstate, PyExc_ValueError, "depth must be >= 0");
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001214 return NULL;
1215 }
Victor Stinner838f2642019-06-13 22:41:23 +02001216 _PyEval_SetCoroutineOriginTrackingDepth(tstate, depth);
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001217 Py_RETURN_NONE;
1218}
1219
1220/*[clinic input]
1221sys.get_coroutine_origin_tracking_depth -> int
1222
1223Check status of origin tracking for coroutine objects in this thread.
1224[clinic start generated code]*/
1225
1226static int
1227sys_get_coroutine_origin_tracking_depth_impl(PyObject *module)
1228/*[clinic end generated code: output=3699f7be95a3afb8 input=335266a71205b61a]*/
1229{
1230 return _PyEval_GetCoroutineOriginTrackingDepth();
1231}
1232
Yury Selivanoveb636452016-09-08 22:01:51 -07001233static PyTypeObject AsyncGenHooksType;
1234
1235PyDoc_STRVAR(asyncgen_hooks_doc,
1236"asyncgen_hooks\n\
1237\n\
Raymond Hettinger71170742019-09-11 07:17:32 -07001238A named tuple providing information about asynchronous\n\
Yury Selivanoveb636452016-09-08 22:01:51 -07001239generators hooks. The attributes are read only.");
1240
1241static PyStructSequence_Field asyncgen_hooks_fields[] = {
1242 {"firstiter", "Hook to intercept first iteration"},
1243 {"finalizer", "Hook to intercept finalization"},
1244 {0}
1245};
1246
1247static PyStructSequence_Desc asyncgen_hooks_desc = {
1248 "asyncgen_hooks", /* name */
1249 asyncgen_hooks_doc, /* doc */
1250 asyncgen_hooks_fields , /* fields */
1251 2
1252};
1253
Yury Selivanoveb636452016-09-08 22:01:51 -07001254static PyObject *
1255sys_set_asyncgen_hooks(PyObject *self, PyObject *args, PyObject *kw)
1256{
1257 static char *keywords[] = {"firstiter", "finalizer", NULL};
1258 PyObject *firstiter = NULL;
1259 PyObject *finalizer = NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02001260 PyThreadState *tstate = _PyThreadState_GET();
Yury Selivanoveb636452016-09-08 22:01:51 -07001261
1262 if (!PyArg_ParseTupleAndKeywords(
1263 args, kw, "|OO", keywords,
1264 &firstiter, &finalizer)) {
1265 return NULL;
1266 }
1267
1268 if (finalizer && finalizer != Py_None) {
1269 if (!PyCallable_Check(finalizer)) {
Victor Stinner838f2642019-06-13 22:41:23 +02001270 _PyErr_Format(tstate, PyExc_TypeError,
1271 "callable finalizer expected, got %.50s",
1272 Py_TYPE(finalizer)->tp_name);
Yury Selivanoveb636452016-09-08 22:01:51 -07001273 return NULL;
1274 }
Zackery Spytz79ceccd2020-03-26 06:11:13 -06001275 if (_PyEval_SetAsyncGenFinalizer(finalizer) < 0) {
1276 return NULL;
1277 }
Yury Selivanoveb636452016-09-08 22:01:51 -07001278 }
Zackery Spytz79ceccd2020-03-26 06:11:13 -06001279 else if (finalizer == Py_None && _PyEval_SetAsyncGenFinalizer(NULL) < 0) {
1280 return NULL;
Yury Selivanoveb636452016-09-08 22:01:51 -07001281 }
1282
1283 if (firstiter && firstiter != Py_None) {
1284 if (!PyCallable_Check(firstiter)) {
Victor Stinner838f2642019-06-13 22:41:23 +02001285 _PyErr_Format(tstate, PyExc_TypeError,
1286 "callable firstiter expected, got %.50s",
1287 Py_TYPE(firstiter)->tp_name);
Yury Selivanoveb636452016-09-08 22:01:51 -07001288 return NULL;
1289 }
Zackery Spytz79ceccd2020-03-26 06:11:13 -06001290 if (_PyEval_SetAsyncGenFirstiter(firstiter) < 0) {
1291 return NULL;
1292 }
Yury Selivanoveb636452016-09-08 22:01:51 -07001293 }
Zackery Spytz79ceccd2020-03-26 06:11:13 -06001294 else if (firstiter == Py_None && _PyEval_SetAsyncGenFirstiter(NULL) < 0) {
1295 return NULL;
Yury Selivanoveb636452016-09-08 22:01:51 -07001296 }
1297
1298 Py_RETURN_NONE;
1299}
1300
1301PyDoc_STRVAR(set_asyncgen_hooks_doc,
Tal Einatede0b6f2018-12-31 17:12:08 +02001302"set_asyncgen_hooks(* [, firstiter] [, finalizer])\n\
Yury Selivanoveb636452016-09-08 22:01:51 -07001303\n\
1304Set a finalizer for async generators objects."
1305);
1306
Tal Einatede0b6f2018-12-31 17:12:08 +02001307/*[clinic input]
1308sys.get_asyncgen_hooks
1309
1310Return the installed asynchronous generators hooks.
1311
1312This returns a namedtuple of the form (firstiter, finalizer).
1313[clinic start generated code]*/
1314
Yury Selivanoveb636452016-09-08 22:01:51 -07001315static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001316sys_get_asyncgen_hooks_impl(PyObject *module)
1317/*[clinic end generated code: output=53a253707146f6cf input=3676b9ea62b14625]*/
Yury Selivanoveb636452016-09-08 22:01:51 -07001318{
1319 PyObject *res;
1320 PyObject *firstiter = _PyEval_GetAsyncGenFirstiter();
1321 PyObject *finalizer = _PyEval_GetAsyncGenFinalizer();
1322
1323 res = PyStructSequence_New(&AsyncGenHooksType);
1324 if (res == NULL) {
1325 return NULL;
1326 }
1327
1328 if (firstiter == NULL) {
1329 firstiter = Py_None;
1330 }
1331
1332 if (finalizer == NULL) {
1333 finalizer = Py_None;
1334 }
1335
1336 Py_INCREF(firstiter);
1337 PyStructSequence_SET_ITEM(res, 0, firstiter);
1338
1339 Py_INCREF(finalizer);
1340 PyStructSequence_SET_ITEM(res, 1, finalizer);
1341
1342 return res;
1343}
1344
Yury Selivanoveb636452016-09-08 22:01:51 -07001345
Mark Dickinsondc787d22010-05-23 13:33:13 +00001346static PyTypeObject Hash_InfoType;
1347
1348PyDoc_STRVAR(hash_info_doc,
1349"hash_info\n\
1350\n\
Raymond Hettinger71170742019-09-11 07:17:32 -07001351A named tuple providing parameters used for computing\n\
Christian Heimes985ecdc2013-11-20 11:46:18 +01001352hashes. The attributes are read only.");
Mark Dickinsondc787d22010-05-23 13:33:13 +00001353
1354static PyStructSequence_Field hash_info_fields[] = {
1355 {"width", "width of the type used for hashing, in bits"},
1356 {"modulus", "prime number giving the modulus on which the hash "
1357 "function is based"},
1358 {"inf", "value to be used for hash of a positive infinity"},
1359 {"nan", "value to be used for hash of a nan"},
1360 {"imag", "multiplier used for the imaginary part of a complex number"},
Christian Heimes985ecdc2013-11-20 11:46:18 +01001361 {"algorithm", "name of the algorithm for hashing of str, bytes and "
1362 "memoryviews"},
1363 {"hash_bits", "internal output size of hash algorithm"},
1364 {"seed_bits", "seed size of hash algorithm"},
1365 {"cutoff", "small string optimization cutoff"},
Mark Dickinsondc787d22010-05-23 13:33:13 +00001366 {NULL, NULL}
1367};
1368
1369static PyStructSequence_Desc hash_info_desc = {
1370 "sys.hash_info",
1371 hash_info_doc,
1372 hash_info_fields,
Christian Heimes985ecdc2013-11-20 11:46:18 +01001373 9,
Mark Dickinsondc787d22010-05-23 13:33:13 +00001374};
1375
Matthias Klosed885e952010-07-06 10:53:30 +00001376static PyObject *
Victor Stinner838f2642019-06-13 22:41:23 +02001377get_hash_info(PyThreadState *tstate)
Mark Dickinsondc787d22010-05-23 13:33:13 +00001378{
1379 PyObject *hash_info;
1380 int field = 0;
Christian Heimes985ecdc2013-11-20 11:46:18 +01001381 PyHash_FuncDef *hashfunc;
Mark Dickinsondc787d22010-05-23 13:33:13 +00001382 hash_info = PyStructSequence_New(&Hash_InfoType);
1383 if (hash_info == NULL)
1384 return NULL;
Christian Heimes985ecdc2013-11-20 11:46:18 +01001385 hashfunc = PyHash_GetFuncDef();
Mark Dickinsondc787d22010-05-23 13:33:13 +00001386 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001387 PyLong_FromLong(8*sizeof(Py_hash_t)));
Mark Dickinsondc787d22010-05-23 13:33:13 +00001388 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8035bc52010-10-23 16:20:50 +00001389 PyLong_FromSsize_t(_PyHASH_MODULUS));
Mark Dickinsondc787d22010-05-23 13:33:13 +00001390 PyStructSequence_SET_ITEM(hash_info, field++,
1391 PyLong_FromLong(_PyHASH_INF));
1392 PyStructSequence_SET_ITEM(hash_info, field++,
1393 PyLong_FromLong(_PyHASH_NAN));
1394 PyStructSequence_SET_ITEM(hash_info, field++,
1395 PyLong_FromLong(_PyHASH_IMAG));
Christian Heimes985ecdc2013-11-20 11:46:18 +01001396 PyStructSequence_SET_ITEM(hash_info, field++,
1397 PyUnicode_FromString(hashfunc->name));
1398 PyStructSequence_SET_ITEM(hash_info, field++,
1399 PyLong_FromLong(hashfunc->hash_bits));
1400 PyStructSequence_SET_ITEM(hash_info, field++,
1401 PyLong_FromLong(hashfunc->seed_bits));
1402 PyStructSequence_SET_ITEM(hash_info, field++,
1403 PyLong_FromLong(Py_HASH_CUTOFF));
Victor Stinner838f2642019-06-13 22:41:23 +02001404 if (_PyErr_Occurred(tstate)) {
Mark Dickinsondc787d22010-05-23 13:33:13 +00001405 Py_CLEAR(hash_info);
1406 return NULL;
1407 }
1408 return hash_info;
1409}
Tal Einatede0b6f2018-12-31 17:12:08 +02001410/*[clinic input]
1411sys.getrecursionlimit
Mark Dickinsondc787d22010-05-23 13:33:13 +00001412
Tal Einatede0b6f2018-12-31 17:12:08 +02001413Return the current value of the recursion limit.
Mark Dickinsondc787d22010-05-23 13:33:13 +00001414
Tal Einatede0b6f2018-12-31 17:12:08 +02001415The recursion limit is the maximum depth of the Python interpreter
1416stack. This limit prevents infinite recursion from causing an overflow
1417of the C stack and crashing Python.
1418[clinic start generated code]*/
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001419
1420static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001421sys_getrecursionlimit_impl(PyObject *module)
1422/*[clinic end generated code: output=d571fb6b4549ef2e input=1c6129fd2efaeea8]*/
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001423{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001424 return PyLong_FromLong(Py_GetRecursionLimit());
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001425}
1426
Mark Hammond8696ebc2002-10-08 02:44:31 +00001427#ifdef MS_WINDOWS
Mark Hammond8696ebc2002-10-08 02:44:31 +00001428
Eric Smithf7bb5782010-01-27 00:44:57 +00001429static PyTypeObject WindowsVersionType = {0, 0, 0, 0, 0, 0};
1430
1431static PyStructSequence_Field windows_version_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 {"major", "Major version number"},
1433 {"minor", "Minor version number"},
1434 {"build", "Build number"},
1435 {"platform", "Operating system platform"},
1436 {"service_pack", "Latest Service Pack installed on the system"},
1437 {"service_pack_major", "Service Pack major version number"},
1438 {"service_pack_minor", "Service Pack minor version number"},
1439 {"suite_mask", "Bit mask identifying available product suites"},
1440 {"product_type", "System product type"},
Steve Dower74f4af72016-09-17 17:27:48 -07001441 {"platform_version", "Diagnostic version number"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001442 {0}
Eric Smithf7bb5782010-01-27 00:44:57 +00001443};
1444
1445static PyStructSequence_Desc windows_version_desc = {
Tal Einatede0b6f2018-12-31 17:12:08 +02001446 "sys.getwindowsversion", /* name */
1447 sys_getwindowsversion__doc__, /* doc */
1448 windows_version_fields, /* fields */
1449 5 /* For backward compatibility,
1450 only the first 5 items are accessible
1451 via indexing, the rest are name only */
Eric Smithf7bb5782010-01-27 00:44:57 +00001452};
1453
Steve Dower3e96f322015-03-02 08:01:10 -08001454/* Disable deprecation warnings about GetVersionEx as the result is
1455 being passed straight through to the caller, who is responsible for
1456 using it correctly. */
1457#pragma warning(push)
1458#pragma warning(disable:4996)
1459
Tal Einatede0b6f2018-12-31 17:12:08 +02001460/*[clinic input]
1461sys.getwindowsversion
1462
1463Return info about the running version of Windows as a named tuple.
1464
1465The members are named: major, minor, build, platform, service_pack,
1466service_pack_major, service_pack_minor, suite_mask, product_type and
1467platform_version. For backward compatibility, only the first 5 items
1468are available by indexing. All elements are numbers, except
1469service_pack and platform_type which are strings, and platform_version
1470which is a 3-tuple. Platform is always 2. Product_type may be 1 for a
1471workstation, 2 for a domain controller, 3 for a server.
1472Platform_version is a 3-tuple containing a version number that is
1473intended for identifying the OS rather than feature detection.
1474[clinic start generated code]*/
1475
Mark Hammond8696ebc2002-10-08 02:44:31 +00001476static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001477sys_getwindowsversion_impl(PyObject *module)
1478/*[clinic end generated code: output=1ec063280b932857 input=73a228a328fee63a]*/
Mark Hammond8696ebc2002-10-08 02:44:31 +00001479{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001480 PyObject *version;
1481 int pos = 0;
Minmin Gong8ebc6452019-02-02 20:26:55 -08001482 OSVERSIONINFOEXW ver;
Steve Dower74f4af72016-09-17 17:27:48 -07001483 DWORD realMajor, realMinor, realBuild;
1484 HANDLE hKernel32;
1485 wchar_t kernel32_path[MAX_PATH];
1486 LPVOID verblock;
1487 DWORD verblock_size;
Victor Stinner838f2642019-06-13 22:41:23 +02001488 PyThreadState *tstate = _PyThreadState_GET();
Steve Dower74f4af72016-09-17 17:27:48 -07001489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001490 ver.dwOSVersionInfoSize = sizeof(ver);
Minmin Gong8ebc6452019-02-02 20:26:55 -08001491 if (!GetVersionExW((OSVERSIONINFOW*) &ver))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001492 return PyErr_SetFromWindowsErr(0);
Eric Smithf7bb5782010-01-27 00:44:57 +00001493
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001494 version = PyStructSequence_New(&WindowsVersionType);
1495 if (version == NULL)
1496 return NULL;
Eric Smithf7bb5782010-01-27 00:44:57 +00001497
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001498 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMajorVersion));
1499 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMinorVersion));
1500 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwBuildNumber));
1501 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwPlatformId));
Minmin Gong8ebc6452019-02-02 20:26:55 -08001502 PyStructSequence_SET_ITEM(version, pos++, PyUnicode_FromWideChar(ver.szCSDVersion, -1));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001503 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMajor));
1504 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMinor));
1505 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wSuiteMask));
1506 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wProductType));
Eric Smithf7bb5782010-01-27 00:44:57 +00001507
Steve Dower74f4af72016-09-17 17:27:48 -07001508 realMajor = ver.dwMajorVersion;
1509 realMinor = ver.dwMinorVersion;
1510 realBuild = ver.dwBuildNumber;
1511
1512 // GetVersion will lie if we are running in a compatibility mode.
1513 // We need to read the version info from a system file resource
1514 // to accurately identify the OS version. If we fail for any reason,
1515 // just return whatever GetVersion said.
Tony Roberts4860f012019-02-02 18:16:42 +01001516 Py_BEGIN_ALLOW_THREADS
Steve Dower74f4af72016-09-17 17:27:48 -07001517 hKernel32 = GetModuleHandleW(L"kernel32.dll");
Tony Roberts4860f012019-02-02 18:16:42 +01001518 Py_END_ALLOW_THREADS
Steve Dower74f4af72016-09-17 17:27:48 -07001519 if (hKernel32 && GetModuleFileNameW(hKernel32, kernel32_path, MAX_PATH) &&
1520 (verblock_size = GetFileVersionInfoSizeW(kernel32_path, NULL)) &&
1521 (verblock = PyMem_RawMalloc(verblock_size))) {
1522 VS_FIXEDFILEINFO *ffi;
1523 UINT ffi_len;
1524
1525 if (GetFileVersionInfoW(kernel32_path, 0, verblock_size, verblock) &&
1526 VerQueryValueW(verblock, L"", (LPVOID)&ffi, &ffi_len)) {
1527 realMajor = HIWORD(ffi->dwProductVersionMS);
1528 realMinor = LOWORD(ffi->dwProductVersionMS);
1529 realBuild = HIWORD(ffi->dwProductVersionLS);
1530 }
1531 PyMem_RawFree(verblock);
1532 }
Segev Finer48fb7662017-06-04 20:52:27 +03001533 PyStructSequence_SET_ITEM(version, pos++, Py_BuildValue("(kkk)",
1534 realMajor,
1535 realMinor,
1536 realBuild
Steve Dower74f4af72016-09-17 17:27:48 -07001537 ));
1538
Victor Stinner838f2642019-06-13 22:41:23 +02001539 if (_PyErr_Occurred(tstate)) {
Serhiy Storchaka48d761e2013-12-17 15:11:24 +02001540 Py_DECREF(version);
1541 return NULL;
1542 }
Steve Dower74f4af72016-09-17 17:27:48 -07001543
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001544 return version;
Mark Hammond8696ebc2002-10-08 02:44:31 +00001545}
1546
Steve Dower3e96f322015-03-02 08:01:10 -08001547#pragma warning(pop)
1548
Tal Einatede0b6f2018-12-31 17:12:08 +02001549/*[clinic input]
1550sys._enablelegacywindowsfsencoding
1551
1552Changes the default filesystem encoding to mbcs:replace.
1553
1554This is done for consistency with earlier versions of Python. See PEP
1555529 for more information.
1556
1557This is equivalent to defining the PYTHONLEGACYWINDOWSFSENCODING
1558environment variable before launching Python.
1559[clinic start generated code]*/
Steve Dowercc16be82016-09-08 10:35:16 -07001560
1561static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001562sys__enablelegacywindowsfsencoding_impl(PyObject *module)
1563/*[clinic end generated code: output=f5c3855b45e24fe9 input=2bfa931a20704492]*/
Steve Dowercc16be82016-09-08 10:35:16 -07001564{
Victor Stinner709d23d2019-05-02 14:56:30 -04001565 if (_PyUnicode_EnableLegacyWindowsFSEncoding() < 0) {
Victor Stinnerb2457ef2018-08-29 13:25:36 +02001566 return NULL;
1567 }
Steve Dowercc16be82016-09-08 10:35:16 -07001568 Py_RETURN_NONE;
1569}
1570
Mark Hammond8696ebc2002-10-08 02:44:31 +00001571#endif /* MS_WINDOWS */
1572
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001573#ifdef HAVE_DLOPEN
Tal Einatede0b6f2018-12-31 17:12:08 +02001574
1575/*[clinic input]
1576sys.setdlopenflags
1577
1578 flags as new_val: int
1579 /
1580
1581Set the flags used by the interpreter for dlopen calls.
1582
1583This is used, for example, when the interpreter loads extension
1584modules. Among other things, this will enable a lazy resolving of
1585symbols when importing a module, if called as sys.setdlopenflags(0).
1586To share symbols across extension modules, call as
1587sys.setdlopenflags(os.RTLD_GLOBAL). Symbolic names for the flag
1588modules can be found in the os module (RTLD_xxx constants, e.g.
1589os.RTLD_LAZY).
1590[clinic start generated code]*/
1591
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001592static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001593sys_setdlopenflags_impl(PyObject *module, int new_val)
1594/*[clinic end generated code: output=ec918b7fe0a37281 input=4c838211e857a77f]*/
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001595{
Victor Stinner838f2642019-06-13 22:41:23 +02001596 PyThreadState *tstate = _PyThreadState_GET();
1597 tstate->interp->dlopenflags = new_val;
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001598 Py_RETURN_NONE;
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001599}
1600
Tal Einatede0b6f2018-12-31 17:12:08 +02001601
1602/*[clinic input]
1603sys.getdlopenflags
1604
1605Return the current value of the flags that are used for dlopen calls.
1606
1607The flag constants are defined in the os module.
1608[clinic start generated code]*/
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001609
1610static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001611sys_getdlopenflags_impl(PyObject *module)
1612/*[clinic end generated code: output=e92cd1bc5005da6e input=dc4ea0899c53b4b6]*/
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001613{
Victor Stinner838f2642019-06-13 22:41:23 +02001614 PyThreadState *tstate = _PyThreadState_GET();
1615 return PyLong_FromLong(tstate->interp->dlopenflags);
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001616}
1617
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001618#endif /* HAVE_DLOPEN */
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001619
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001620#ifdef USE_MALLOPT
1621/* Link with -lmalloc (or -lmpc) on an SGI */
1622#include <malloc.h>
1623
Tal Einatede0b6f2018-12-31 17:12:08 +02001624/*[clinic input]
1625sys.mdebug
1626
1627 flag: int
1628 /
1629[clinic start generated code]*/
1630
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001631static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001632sys_mdebug_impl(PyObject *module, int flag)
1633/*[clinic end generated code: output=5431d545847c3637 input=151d150ae1636f8a]*/
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001634{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001635 int flag;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001636 mallopt(M_DEBUG, flag);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001637 Py_RETURN_NONE;
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001638}
1639#endif /* USE_MALLOPT */
1640
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001641size_t
1642_PySys_GetSizeOf(PyObject *o)
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001643{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001644 PyObject *res = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001645 PyObject *method;
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001646 Py_ssize_t size;
Victor Stinner838f2642019-06-13 22:41:23 +02001647 PyThreadState *tstate = _PyThreadState_GET();
Benjamin Petersona5758c02009-05-09 18:15:04 +00001648
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001649 /* Make sure the type is initialized. float gets initialized late */
Victor Stinner838f2642019-06-13 22:41:23 +02001650 if (PyType_Ready(Py_TYPE(o)) < 0) {
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001651 return (size_t)-1;
Victor Stinner838f2642019-06-13 22:41:23 +02001652 }
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +00001653
Benjamin Petersonce798522012-01-22 11:24:29 -05001654 method = _PyObject_LookupSpecial(o, &PyId___sizeof__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001655 if (method == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +02001656 if (!_PyErr_Occurred(tstate)) {
1657 _PyErr_Format(tstate, PyExc_TypeError,
1658 "Type %.100s doesn't define __sizeof__",
1659 Py_TYPE(o)->tp_name);
1660 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001661 }
1662 else {
Victor Stinnerf17c3de2016-12-06 18:46:19 +01001663 res = _PyObject_CallNoArg(method);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001664 Py_DECREF(method);
1665 }
1666
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001667 if (res == NULL)
1668 return (size_t)-1;
1669
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001670 size = PyLong_AsSsize_t(res);
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001671 Py_DECREF(res);
Victor Stinner838f2642019-06-13 22:41:23 +02001672 if (size == -1 && _PyErr_Occurred(tstate))
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001673 return (size_t)-1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001674
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001675 if (size < 0) {
Victor Stinner838f2642019-06-13 22:41:23 +02001676 _PyErr_SetString(tstate, PyExc_ValueError,
1677 "__sizeof__() should return >= 0");
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001678 return (size_t)-1;
1679 }
1680
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001681 /* add gc_head size */
Hai Shi675d9a32020-04-15 02:11:20 +08001682 if (_PyObject_IS_GC(o))
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001683 return ((size_t)size) + sizeof(PyGC_Head);
1684 return (size_t)size;
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001685}
1686
1687static PyObject *
1688sys_getsizeof(PyObject *self, PyObject *args, PyObject *kwds)
1689{
1690 static char *kwlist[] = {"object", "default", 0};
1691 size_t size;
1692 PyObject *o, *dflt = NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02001693 PyThreadState *tstate = _PyThreadState_GET();
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001694
1695 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|O:getsizeof",
Victor Stinner838f2642019-06-13 22:41:23 +02001696 kwlist, &o, &dflt)) {
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001697 return NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02001698 }
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001699
1700 size = _PySys_GetSizeOf(o);
1701
Victor Stinner838f2642019-06-13 22:41:23 +02001702 if (size == (size_t)-1 && _PyErr_Occurred(tstate)) {
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001703 /* Has a default value been given */
Victor Stinner838f2642019-06-13 22:41:23 +02001704 if (dflt != NULL && _PyErr_ExceptionMatches(tstate, PyExc_TypeError)) {
1705 _PyErr_Clear(tstate);
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001706 Py_INCREF(dflt);
1707 return dflt;
1708 }
1709 else
1710 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001711 }
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001712
1713 return PyLong_FromSize_t(size);
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001714}
1715
1716PyDoc_STRVAR(getsizeof_doc,
Tal Einatede0b6f2018-12-31 17:12:08 +02001717"getsizeof(object [, default]) -> int\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001718\n\
1719Return the size of object in bytes.");
1720
Tal Einatede0b6f2018-12-31 17:12:08 +02001721/*[clinic input]
1722sys.getrefcount -> Py_ssize_t
1723
1724 object: object
1725 /
1726
1727Return the reference count of object.
1728
1729The count returned is generally one higher than you might expect,
1730because it includes the (temporary) reference as an argument to
1731getrefcount().
1732[clinic start generated code]*/
1733
1734static Py_ssize_t
1735sys_getrefcount_impl(PyObject *module, PyObject *object)
1736/*[clinic end generated code: output=5fd477f2264b85b2 input=bf474efd50a21535]*/
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001737{
Victor Stinnera93c51e2020-02-07 00:38:59 +01001738 return Py_REFCNT(object);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001739}
1740
Tim Peters4be93d02002-07-07 19:59:50 +00001741#ifdef Py_REF_DEBUG
Tal Einatede0b6f2018-12-31 17:12:08 +02001742/*[clinic input]
1743sys.gettotalrefcount -> Py_ssize_t
1744[clinic start generated code]*/
1745
1746static Py_ssize_t
1747sys_gettotalrefcount_impl(PyObject *module)
1748/*[clinic end generated code: output=4103886cf17c25bc input=53b744faa5d2e4f6]*/
Mark Hammond440d8982000-06-20 08:12:48 +00001749{
Tal Einatede0b6f2018-12-31 17:12:08 +02001750 return _Py_GetRefTotal();
Mark Hammond440d8982000-06-20 08:12:48 +00001751}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001752#endif /* Py_REF_DEBUG */
Mark Hammond440d8982000-06-20 08:12:48 +00001753
Tal Einatede0b6f2018-12-31 17:12:08 +02001754/*[clinic input]
1755sys.getallocatedblocks -> Py_ssize_t
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001756
Tal Einatede0b6f2018-12-31 17:12:08 +02001757Return the number of memory blocks currently allocated.
1758[clinic start generated code]*/
1759
1760static Py_ssize_t
1761sys_getallocatedblocks_impl(PyObject *module)
1762/*[clinic end generated code: output=f0c4e873f0b6dcf7 input=dab13ee346a0673e]*/
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001763{
Tal Einatede0b6f2018-12-31 17:12:08 +02001764 return _Py_GetAllocatedBlocks();
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001765}
1766
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001767
Tal Einatede0b6f2018-12-31 17:12:08 +02001768/*[clinic input]
1769sys._getframe
1770
1771 depth: int = 0
1772 /
1773
1774Return a frame object from the call stack.
1775
1776If optional integer depth is given, return the frame object that many
1777calls below the top of the stack. If that is deeper than the call
1778stack, ValueError is raised. The default for depth is zero, returning
1779the frame at the top of the call stack.
1780
1781This function should be used for internal and specialized purposes
1782only.
1783[clinic start generated code]*/
Barry Warsawb6a54d22000-12-06 21:47:46 +00001784
1785static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001786sys__getframe_impl(PyObject *module, int depth)
1787/*[clinic end generated code: output=d438776c04d59804 input=c1be8a6464b11ee5]*/
Barry Warsawb6a54d22000-12-06 21:47:46 +00001788{
Victor Stinner838f2642019-06-13 22:41:23 +02001789 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner70364772020-04-29 03:28:46 +02001790 PyFrameObject *f = PyThreadState_GetFrame(tstate);
Barry Warsawb6a54d22000-12-06 21:47:46 +00001791
Victor Stinner08faf002020-03-26 18:57:32 +01001792 if (_PySys_Audit(tstate, "sys._getframe", "O", f) < 0) {
Victor Stinner70364772020-04-29 03:28:46 +02001793 Py_DECREF(f);
Steve Dowerb82e17e2019-05-23 08:45:22 -07001794 return NULL;
1795 }
1796
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001797 while (depth > 0 && f != NULL) {
Victor Stinner70364772020-04-29 03:28:46 +02001798 PyFrameObject *back = PyFrame_GetBack(f);
1799 Py_DECREF(f);
1800 f = back;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001801 --depth;
1802 }
1803 if (f == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +02001804 _PyErr_SetString(tstate, PyExc_ValueError,
1805 "call stack is not deep enough");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001806 return NULL;
1807 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001808 return (PyObject*)f;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001809}
1810
Tal Einatede0b6f2018-12-31 17:12:08 +02001811/*[clinic input]
1812sys._current_frames
1813
1814Return a dict mapping each thread's thread id to its current stack frame.
1815
1816This function should be used for specialized purposes only.
1817[clinic start generated code]*/
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001818
1819static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001820sys__current_frames_impl(PyObject *module)
1821/*[clinic end generated code: output=d2a41ac0a0a3809a input=2a9049c5f5033691]*/
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001822{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001823 return _PyThread_CurrentFrames();
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001824}
1825
Tal Einatede0b6f2018-12-31 17:12:08 +02001826/*[clinic input]
1827sys.call_tracing
1828
1829 func: object
1830 args as funcargs: object(subclass_of='&PyTuple_Type')
1831 /
1832
1833Call func(*args), while tracing is enabled.
1834
1835The tracing state is saved, and restored afterwards. This is intended
1836to be called from a debugger from a checkpoint, to recursively debug
1837some other code.
1838[clinic start generated code]*/
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001839
1840static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001841sys_call_tracing_impl(PyObject *module, PyObject *func, PyObject *funcargs)
1842/*[clinic end generated code: output=7e4999853cd4e5a6 input=5102e8b11049f92f]*/
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001843{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001844 return _PyEval_CallTracing(func, funcargs);
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001845}
1846
Victor Stinner048afd92016-11-28 11:59:04 +01001847
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001848#ifdef __cplusplus
1849extern "C" {
1850#endif
1851
Tal Einatede0b6f2018-12-31 17:12:08 +02001852/*[clinic input]
1853sys._debugmallocstats
1854
1855Print summary info to stderr about the state of pymalloc's structures.
1856
1857In Py_DEBUG mode, also perform some expensive internal consistency
1858checks.
1859[clinic start generated code]*/
1860
David Malcolm49526f42012-06-22 14:55:41 -04001861static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001862sys__debugmallocstats_impl(PyObject *module)
1863/*[clinic end generated code: output=ec3565f8c7cee46a input=33c0c9c416f98424]*/
David Malcolm49526f42012-06-22 14:55:41 -04001864{
1865#ifdef WITH_PYMALLOC
Victor Stinner6bf992a2017-12-06 17:26:10 +01001866 if (_PyObject_DebugMallocStats(stderr)) {
Victor Stinner34be8072016-03-14 12:04:26 +01001867 fputc('\n', stderr);
1868 }
David Malcolm49526f42012-06-22 14:55:41 -04001869#endif
1870 _PyObject_DebugTypeStats(stderr);
1871
1872 Py_RETURN_NONE;
1873}
David Malcolm49526f42012-06-22 14:55:41 -04001874
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001875#ifdef Py_TRACE_REFS
Guido van Rossumded690f1996-05-24 20:48:31 +00001876/* Defined in objects.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001877extern PyObject *_Py_GetObjects(PyObject *, PyObject *);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001878#endif
Guido van Rossumded690f1996-05-24 20:48:31 +00001879
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001880#ifdef DYNAMIC_EXECUTION_PROFILE
1881/* Defined in ceval.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001882extern PyObject *_Py_GetDXProfile(PyObject *, PyObject *);
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001883#endif
1884
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001885#ifdef __cplusplus
1886}
1887#endif
1888
Tal Einatede0b6f2018-12-31 17:12:08 +02001889
1890/*[clinic input]
1891sys._clear_type_cache
1892
1893Clear the internal type lookup cache.
1894[clinic start generated code]*/
1895
Christian Heimes15ebc882008-02-04 18:48:49 +00001896static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001897sys__clear_type_cache_impl(PyObject *module)
1898/*[clinic end generated code: output=20e48ca54a6f6971 input=127f3e04a8d9b555]*/
Christian Heimes15ebc882008-02-04 18:48:49 +00001899{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001900 PyType_ClearCache();
1901 Py_RETURN_NONE;
Christian Heimes15ebc882008-02-04 18:48:49 +00001902}
1903
Tal Einatede0b6f2018-12-31 17:12:08 +02001904/*[clinic input]
1905sys.is_finalizing
1906
1907Return True if Python is exiting.
1908[clinic start generated code]*/
1909
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001910static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001911sys_is_finalizing_impl(PyObject *module)
1912/*[clinic end generated code: output=735b5ff7962ab281 input=f0df747a039948a5]*/
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001913{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001914 return PyBool_FromLong(_Py_IsFinalizing());
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001915}
1916
Victor Stinnerd6958ac2016-12-02 01:13:46 +01001917#ifdef ANDROID_API_LEVEL
Tal Einatede0b6f2018-12-31 17:12:08 +02001918/*[clinic input]
1919sys.getandroidapilevel
1920
1921Return the build time API version of Android as an integer.
1922[clinic start generated code]*/
Victor Stinnerd6958ac2016-12-02 01:13:46 +01001923
1924static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001925sys_getandroidapilevel_impl(PyObject *module)
1926/*[clinic end generated code: output=214abf183a1c70c1 input=3e6d6c9fcdd24ac6]*/
Victor Stinnerd6958ac2016-12-02 01:13:46 +01001927{
1928 return PyLong_FromLong(ANDROID_API_LEVEL);
1929}
1930#endif /* ANDROID_API_LEVEL */
1931
1932
Steve Dowerb82e17e2019-05-23 08:45:22 -07001933
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001934static PyMethodDef sys_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001935 /* Might as well keep this in alphabetic order */
Steve Dowerb82e17e2019-05-23 08:45:22 -07001936 SYS_ADDAUDITHOOK_METHODDEF
1937 {"audit", (PyCFunction)(void(*)(void))sys_audit, METH_FASTCALL, audit_doc },
Serhiy Storchaka62be7422018-11-27 13:27:31 +02001938 {"breakpointhook", (PyCFunction)(void(*)(void))sys_breakpointhook,
Barry Warsaw36c1d1f2017-10-05 12:11:18 -04001939 METH_FASTCALL | METH_KEYWORDS, breakpointhook_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001940 SYS__CLEAR_TYPE_CACHE_METHODDEF
1941 SYS__CURRENT_FRAMES_METHODDEF
1942 SYS_DISPLAYHOOK_METHODDEF
1943 SYS_EXC_INFO_METHODDEF
1944 SYS_EXCEPTHOOK_METHODDEF
1945 SYS_EXIT_METHODDEF
1946 SYS_GETDEFAULTENCODING_METHODDEF
1947 SYS_GETDLOPENFLAGS_METHODDEF
1948 SYS_GETALLOCATEDBLOCKS_METHODDEF
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001949#ifdef DYNAMIC_EXECUTION_PROFILE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001950 {"getdxp", _Py_GetDXProfile, METH_VARARGS},
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001951#endif
Tal Einatede0b6f2018-12-31 17:12:08 +02001952 SYS_GETFILESYSTEMENCODING_METHODDEF
1953 SYS_GETFILESYSTEMENCODEERRORS_METHODDEF
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001954#ifdef Py_TRACE_REFS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001955 {"getobjects", _Py_GetObjects, METH_VARARGS},
Tim Peters4be93d02002-07-07 19:59:50 +00001956#endif
Tal Einatede0b6f2018-12-31 17:12:08 +02001957 SYS_GETTOTALREFCOUNT_METHODDEF
1958 SYS_GETREFCOUNT_METHODDEF
1959 SYS_GETRECURSIONLIMIT_METHODDEF
Serhiy Storchaka62be7422018-11-27 13:27:31 +02001960 {"getsizeof", (PyCFunction)(void(*)(void))sys_getsizeof,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001961 METH_VARARGS | METH_KEYWORDS, getsizeof_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001962 SYS__GETFRAME_METHODDEF
1963 SYS_GETWINDOWSVERSION_METHODDEF
1964 SYS__ENABLELEGACYWINDOWSFSENCODING_METHODDEF
1965 SYS_INTERN_METHODDEF
1966 SYS_IS_FINALIZING_METHODDEF
1967 SYS_MDEBUG_METHODDEF
Tal Einatede0b6f2018-12-31 17:12:08 +02001968 SYS_SETSWITCHINTERVAL_METHODDEF
1969 SYS_GETSWITCHINTERVAL_METHODDEF
1970 SYS_SETDLOPENFLAGS_METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001971 {"setprofile", sys_setprofile, METH_O, setprofile_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001972 SYS_GETPROFILE_METHODDEF
1973 SYS_SETRECURSIONLIMIT_METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001974 {"settrace", sys_settrace, METH_O, settrace_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001975 SYS_GETTRACE_METHODDEF
1976 SYS_CALL_TRACING_METHODDEF
1977 SYS__DEBUGMALLOCSTATS_METHODDEF
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001978 SYS_SET_COROUTINE_ORIGIN_TRACKING_DEPTH_METHODDEF
1979 SYS_GET_COROUTINE_ORIGIN_TRACKING_DEPTH_METHODDEF
Serhiy Storchaka62be7422018-11-27 13:27:31 +02001980 {"set_asyncgen_hooks", (PyCFunction)(void(*)(void))sys_set_asyncgen_hooks,
Yury Selivanoveb636452016-09-08 22:01:51 -07001981 METH_VARARGS | METH_KEYWORDS, set_asyncgen_hooks_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001982 SYS_GET_ASYNCGEN_HOOKS_METHODDEF
1983 SYS_GETANDROIDAPILEVEL_METHODDEF
Victor Stinneref9d9b62019-05-22 11:28:22 +02001984 SYS_UNRAISABLEHOOK_METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001985 {NULL, NULL} /* sentinel */
Guido van Rossum3f5da241990-12-20 15:06:42 +00001986};
1987
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001988static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001989list_builtin_module_names(void)
Guido van Rossum34679b71993-01-26 13:33:44 +00001990{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001991 PyObject *list = PyList_New(0);
1992 int i;
1993 if (list == NULL)
1994 return NULL;
1995 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1996 PyObject *name = PyUnicode_FromString(
1997 PyImport_Inittab[i].name);
1998 if (name == NULL)
1999 break;
2000 PyList_Append(list, name);
2001 Py_DECREF(name);
2002 }
2003 if (PyList_Sort(list) != 0) {
2004 Py_DECREF(list);
2005 list = NULL;
2006 }
2007 if (list) {
2008 PyObject *v = PyList_AsTuple(list);
2009 Py_DECREF(list);
2010 list = v;
2011 }
2012 return list;
Guido van Rossum34679b71993-01-26 13:33:44 +00002013}
2014
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002015/* Pre-initialization support for sys.warnoptions and sys._xoptions
2016 *
2017 * Modern internal code paths:
2018 * These APIs get called after _Py_InitializeCore and get to use the
2019 * regular CPython list, dict, and unicode APIs.
2020 *
2021 * Legacy embedding code paths:
2022 * The multi-phase initialization API isn't public yet, so embedding
2023 * apps still need to be able configure sys.warnoptions and sys._xoptions
2024 * before they call Py_Initialize. To support this, we stash copies of
2025 * the supplied wchar * sequences in linked lists, and then migrate the
2026 * contents of those lists to the sys module in _PyInitializeCore.
2027 *
2028 */
2029
2030struct _preinit_entry {
2031 wchar_t *value;
2032 struct _preinit_entry *next;
2033};
2034
2035typedef struct _preinit_entry *_Py_PreInitEntry;
2036
2037static _Py_PreInitEntry _preinit_warnoptions = NULL;
2038static _Py_PreInitEntry _preinit_xoptions = NULL;
2039
2040static _Py_PreInitEntry
2041_alloc_preinit_entry(const wchar_t *value)
2042{
2043 /* To get this to work, we have to initialize the runtime implicitly */
2044 _PyRuntime_Initialize();
2045
2046 /* Force default allocator, so we can ensure that it also gets used to
2047 * destroy the linked list in _clear_preinit_entries.
2048 */
2049 PyMemAllocatorEx old_alloc;
2050 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2051
2052 _Py_PreInitEntry node = PyMem_RawCalloc(1, sizeof(*node));
2053 if (node != NULL) {
2054 node->value = _PyMem_RawWcsdup(value);
2055 if (node->value == NULL) {
2056 PyMem_RawFree(node);
2057 node = NULL;
2058 };
2059 };
2060
2061 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2062 return node;
Zackery Spytz1a2252e2019-05-06 10:56:51 -06002063}
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002064
2065static int
2066_append_preinit_entry(_Py_PreInitEntry *optionlist, const wchar_t *value)
2067{
2068 _Py_PreInitEntry new_entry = _alloc_preinit_entry(value);
2069 if (new_entry == NULL) {
2070 return -1;
2071 }
2072 /* We maintain the linked list in this order so it's easy to play back
2073 * the add commands in the same order later on in _Py_InitializeCore
2074 */
2075 _Py_PreInitEntry last_entry = *optionlist;
2076 if (last_entry == NULL) {
2077 *optionlist = new_entry;
2078 } else {
2079 while (last_entry->next != NULL) {
2080 last_entry = last_entry->next;
2081 }
2082 last_entry->next = new_entry;
2083 }
2084 return 0;
Zackery Spytz1a2252e2019-05-06 10:56:51 -06002085}
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002086
2087static void
2088_clear_preinit_entries(_Py_PreInitEntry *optionlist)
2089{
2090 _Py_PreInitEntry current = *optionlist;
2091 *optionlist = NULL;
2092 /* Deallocate the nodes and their contents using the default allocator */
2093 PyMemAllocatorEx old_alloc;
2094 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2095 while (current != NULL) {
2096 _Py_PreInitEntry next = current->next;
2097 PyMem_RawFree(current->value);
2098 PyMem_RawFree(current);
2099 current = next;
2100 }
2101 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
Zackery Spytz1a2252e2019-05-06 10:56:51 -06002102}
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002103
Victor Stinner120b7072019-08-23 18:03:08 +01002104
2105PyStatus
Victor Stinnerfb4ae152019-09-30 01:40:17 +02002106_PySys_ReadPreinitWarnOptions(PyWideStringList *options)
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002107{
Victor Stinner120b7072019-08-23 18:03:08 +01002108 PyStatus status;
2109 _Py_PreInitEntry entry;
2110
2111 for (entry = _preinit_warnoptions; entry != NULL; entry = entry->next) {
Victor Stinnerfb4ae152019-09-30 01:40:17 +02002112 status = PyWideStringList_Append(options, entry->value);
Victor Stinner120b7072019-08-23 18:03:08 +01002113 if (_PyStatus_EXCEPTION(status)) {
2114 return status;
2115 }
2116 }
2117
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002118 _clear_preinit_entries(&_preinit_warnoptions);
Victor Stinner120b7072019-08-23 18:03:08 +01002119 return _PyStatus_OK();
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002120}
2121
Victor Stinner120b7072019-08-23 18:03:08 +01002122
2123PyStatus
2124_PySys_ReadPreinitXOptions(PyConfig *config)
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002125{
Victor Stinner120b7072019-08-23 18:03:08 +01002126 PyStatus status;
2127 _Py_PreInitEntry entry;
2128
2129 for (entry = _preinit_xoptions; entry != NULL; entry = entry->next) {
2130 status = PyWideStringList_Append(&config->xoptions, entry->value);
2131 if (_PyStatus_EXCEPTION(status)) {
2132 return status;
2133 }
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002134 }
2135
Victor Stinner120b7072019-08-23 18:03:08 +01002136 _clear_preinit_entries(&_preinit_xoptions);
2137 return _PyStatus_OK();
Zackery Spytz1a2252e2019-05-06 10:56:51 -06002138}
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002139
Victor Stinner120b7072019-08-23 18:03:08 +01002140
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002141static PyObject *
Victor Stinner838f2642019-06-13 22:41:23 +02002142get_warnoptions(PyThreadState *tstate)
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002143{
Victor Stinner838f2642019-06-13 22:41:23 +02002144 PyObject *warnoptions = sys_get_object_id(tstate, &PyId_warnoptions);
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002145 if (warnoptions == NULL || !PyList_Check(warnoptions)) {
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002146 /* PEP432 TODO: we can reach this if warnoptions is NULL in the main
2147 * interpreter config. When that happens, we need to properly set
2148 * the `warnoptions` reference in the main interpreter config as well.
2149 *
2150 * For Python 3.7, we shouldn't be able to get here due to the
2151 * combination of how _PyMainInterpreter_ReadConfig and _PySys_EndInit
2152 * work, but we expect 3.8+ to make the _PyMainInterpreter_ReadConfig
2153 * call optional for embedding applications, thus making this
2154 * reachable again.
2155 */
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002156 warnoptions = PyList_New(0);
Victor Stinner838f2642019-06-13 22:41:23 +02002157 if (warnoptions == NULL) {
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002158 return NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02002159 }
2160 if (sys_set_object_id(tstate, &PyId_warnoptions, warnoptions)) {
Eric Snowdae02762017-09-14 00:35:58 -07002161 Py_DECREF(warnoptions);
2162 return NULL;
2163 }
2164 Py_DECREF(warnoptions);
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002165 }
2166 return warnoptions;
2167}
Guido van Rossum23fff912000-12-15 22:02:05 +00002168
2169void
2170PySys_ResetWarnOptions(void)
2171{
Victor Stinner50b48572018-11-01 01:51:40 +01002172 PyThreadState *tstate = _PyThreadState_GET();
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002173 if (tstate == NULL) {
2174 _clear_preinit_entries(&_preinit_warnoptions);
2175 return;
2176 }
2177
Victor Stinner838f2642019-06-13 22:41:23 +02002178 PyObject *warnoptions = sys_get_object_id(tstate, &PyId_warnoptions);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002179 if (warnoptions == NULL || !PyList_Check(warnoptions))
2180 return;
2181 PyList_SetSlice(warnoptions, 0, PyList_GET_SIZE(warnoptions), NULL);
Guido van Rossum23fff912000-12-15 22:02:05 +00002182}
2183
Victor Stinnere1b29952018-10-30 14:31:42 +01002184static int
Victor Stinner838f2642019-06-13 22:41:23 +02002185_PySys_AddWarnOptionWithError(PyThreadState *tstate, PyObject *option)
Guido van Rossum23fff912000-12-15 22:02:05 +00002186{
Victor Stinner838f2642019-06-13 22:41:23 +02002187 PyObject *warnoptions = get_warnoptions(tstate);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002188 if (warnoptions == NULL) {
2189 return -1;
2190 }
2191 if (PyList_Append(warnoptions, option)) {
2192 return -1;
2193 }
2194 return 0;
2195}
2196
2197void
2198PySys_AddWarnOptionUnicode(PyObject *option)
2199{
Victor Stinner838f2642019-06-13 22:41:23 +02002200 PyThreadState *tstate = _PyThreadState_GET();
2201 if (_PySys_AddWarnOptionWithError(tstate, option) < 0) {
Victor Stinnere1b29952018-10-30 14:31:42 +01002202 /* No return value, therefore clear error state if possible */
Victor Stinner838f2642019-06-13 22:41:23 +02002203 if (tstate) {
2204 _PyErr_Clear(tstate);
Victor Stinnere1b29952018-10-30 14:31:42 +01002205 }
2206 }
Victor Stinner9ca9c252010-05-19 16:53:30 +00002207}
2208
2209void
2210PySys_AddWarnOption(const wchar_t *s)
2211{
Victor Stinner50b48572018-11-01 01:51:40 +01002212 PyThreadState *tstate = _PyThreadState_GET();
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002213 if (tstate == NULL) {
2214 _append_preinit_entry(&_preinit_warnoptions, s);
2215 return;
2216 }
Victor Stinner9ca9c252010-05-19 16:53:30 +00002217 PyObject *unicode;
2218 unicode = PyUnicode_FromWideChar(s, -1);
2219 if (unicode == NULL)
2220 return;
2221 PySys_AddWarnOptionUnicode(unicode);
2222 Py_DECREF(unicode);
Guido van Rossum23fff912000-12-15 22:02:05 +00002223}
2224
Christian Heimes33fe8092008-04-13 13:53:33 +00002225int
2226PySys_HasWarnOptions(void)
2227{
Victor Stinner838f2642019-06-13 22:41:23 +02002228 PyThreadState *tstate = _PyThreadState_GET();
2229 PyObject *warnoptions = sys_get_object_id(tstate, &PyId_warnoptions);
Serhiy Storchakadffccc62018-12-10 13:50:22 +02002230 return (warnoptions != NULL && PyList_Check(warnoptions)
2231 && PyList_GET_SIZE(warnoptions) > 0);
Christian Heimes33fe8092008-04-13 13:53:33 +00002232}
2233
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002234static PyObject *
Victor Stinner838f2642019-06-13 22:41:23 +02002235get_xoptions(PyThreadState *tstate)
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002236{
Victor Stinner838f2642019-06-13 22:41:23 +02002237 PyObject *xoptions = sys_get_object_id(tstate, &PyId__xoptions);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002238 if (xoptions == NULL || !PyDict_Check(xoptions)) {
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002239 /* PEP432 TODO: we can reach this if xoptions is NULL in the main
2240 * interpreter config. When that happens, we need to properly set
2241 * the `xoptions` reference in the main interpreter config as well.
2242 *
2243 * For Python 3.7, we shouldn't be able to get here due to the
2244 * combination of how _PyMainInterpreter_ReadConfig and _PySys_EndInit
2245 * work, but we expect 3.8+ to make the _PyMainInterpreter_ReadConfig
2246 * call optional for embedding applications, thus making this
2247 * reachable again.
2248 */
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002249 xoptions = PyDict_New();
Victor Stinner838f2642019-06-13 22:41:23 +02002250 if (xoptions == NULL) {
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002251 return NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02002252 }
2253 if (sys_set_object_id(tstate, &PyId__xoptions, xoptions)) {
Eric Snowdae02762017-09-14 00:35:58 -07002254 Py_DECREF(xoptions);
2255 return NULL;
2256 }
2257 Py_DECREF(xoptions);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002258 }
2259 return xoptions;
2260}
2261
Victor Stinnere1b29952018-10-30 14:31:42 +01002262static int
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002263_PySys_AddXOptionWithError(const wchar_t *s)
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002264{
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002265 PyObject *name = NULL, *value = NULL;
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002266
Victor Stinner838f2642019-06-13 22:41:23 +02002267 PyThreadState *tstate = _PyThreadState_GET();
2268 PyObject *opts = get_xoptions(tstate);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002269 if (opts == NULL) {
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002270 goto error;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002271 }
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002272
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002273 const wchar_t *name_end = wcschr(s, L'=');
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002274 if (!name_end) {
2275 name = PyUnicode_FromWideChar(s, -1);
2276 value = Py_True;
2277 Py_INCREF(value);
2278 }
2279 else {
2280 name = PyUnicode_FromWideChar(s, name_end - s);
2281 value = PyUnicode_FromWideChar(name_end + 1, -1);
2282 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002283 if (name == NULL || value == NULL) {
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002284 goto error;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002285 }
2286 if (PyDict_SetItem(opts, name, value) < 0) {
2287 goto error;
2288 }
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002289 Py_DECREF(name);
2290 Py_DECREF(value);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002291 return 0;
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002292
2293error:
2294 Py_XDECREF(name);
2295 Py_XDECREF(value);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002296 return -1;
2297}
2298
2299void
2300PySys_AddXOption(const wchar_t *s)
2301{
Victor Stinner50b48572018-11-01 01:51:40 +01002302 PyThreadState *tstate = _PyThreadState_GET();
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002303 if (tstate == NULL) {
2304 _append_preinit_entry(&_preinit_xoptions, s);
2305 return;
2306 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002307 if (_PySys_AddXOptionWithError(s) < 0) {
2308 /* No return value, therefore clear error state if possible */
Victor Stinner120b7072019-08-23 18:03:08 +01002309 _PyErr_Clear(tstate);
Victor Stinner0cae6092016-11-11 01:43:56 +01002310 }
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002311}
2312
2313PyObject *
2314PySys_GetXOptions(void)
2315{
Victor Stinner838f2642019-06-13 22:41:23 +02002316 PyThreadState *tstate = _PyThreadState_GET();
2317 return get_xoptions(tstate);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002318}
2319
Guido van Rossum40552d01998-08-06 03:34:39 +00002320/* XXX This doc string is too long to be a single string literal in VC++ 5.0.
2321 Two literals concatenated works just fine. If you have a K&R compiler
2322 or other abomination that however *does* understand longer strings,
2323 get rid of the !!! comment in the middle and the quotes that surround it. */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002324PyDoc_VAR(sys_doc) =
2325PyDoc_STR(
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002326"This module provides access to some objects used or maintained by the\n\
2327interpreter and to functions that interact strongly with the interpreter.\n\
2328\n\
2329Dynamic objects:\n\
2330\n\
2331argv -- command line arguments; argv[0] is the script pathname if known\n\
2332path -- module search path; path[0] is the script directory, else ''\n\
2333modules -- dictionary of loaded modules\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002334\n\
2335displayhook -- called to show results in an interactive session\n\
2336excepthook -- called to handle any uncaught exception other than SystemExit\n\
2337 To customize printing in an interactive session or to install a custom\n\
2338 top-level exception handler, assign other functions to replace these.\n\
2339\n\
Benjamin Peterson06157a42008-07-15 00:28:36 +00002340stdin -- standard input file object; used by input()\n\
Georg Brandl88fc6642007-02-09 21:28:07 +00002341stdout -- standard output file object; used by print()\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002342stderr -- standard error object; used for error messages\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002343 By assigning other file objects (or objects that behave like files)\n\
2344 to these, it is possible to redirect all of the interpreter's I/O.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002345\n\
2346last_type -- type of last uncaught exception\n\
2347last_value -- value of last uncaught exception\n\
2348last_traceback -- traceback of last uncaught exception\n\
2349 These three are only available in an interactive session after a\n\
2350 traceback has been printed.\n\
Guido van Rossuma71b5f41999-01-14 19:07:00 +00002351"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002352)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002353/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002354PyDoc_STR(
Guido van Rossuma71b5f41999-01-14 19:07:00 +00002355"\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002356Static objects:\n\
2357\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002358builtin_module_names -- tuple of module names built into this interpreter\n\
2359copyright -- copyright notice pertaining to this interpreter\n\
2360exec_prefix -- prefix used to find the machine-specific Python library\n\
Petri Lehtinen4b0eab62012-02-02 21:23:15 +02002361executable -- absolute path of the executable binary of the Python interpreter\n\
Raymond Hettinger71170742019-09-11 07:17:32 -07002362float_info -- a named tuple with information about the float implementation.\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002363float_repr_style -- string indicating the style of repr() output for floats\n\
Raymond Hettinger71170742019-09-11 07:17:32 -07002364hash_info -- a named tuple with information about the hash algorithm.\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002365hexversion -- version information encoded as a single integer\n\
Barry Warsaw409da152012-06-03 16:18:47 -04002366implementation -- Python implementation information.\n\
Raymond Hettinger71170742019-09-11 07:17:32 -07002367int_info -- a named tuple with information about the int implementation.\n\
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00002368maxsize -- the largest supported length of containers.\n\
Serhiy Storchakad3faf432015-01-18 11:28:37 +02002369maxunicode -- the value of the largest Unicode code point\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002370platform -- platform identifier\n\
2371prefix -- prefix used to find the Python library\n\
Raymond Hettinger71170742019-09-11 07:17:32 -07002372thread_info -- a named tuple with information about the thread implementation.\n\
Fred Drake801c08d2000-04-13 15:29:10 +00002373version -- the version of this interpreter as a string\n\
Eric Smith0e5b5622009-02-06 01:32:42 +00002374version_info -- version information as a named tuple\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002375"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002376)
Steve Dowercc16be82016-09-08 10:35:16 -07002377#ifdef MS_COREDLL
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002378/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002379PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002380"dllhandle -- [Windows only] integer handle of the Python DLL\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002381winver -- [Windows only] version number of the Python DLL\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002382"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002383)
Steve Dowercc16be82016-09-08 10:35:16 -07002384#endif /* MS_COREDLL */
2385#ifdef MS_WINDOWS
2386/* concatenating string here */
2387PyDoc_STR(
oldkaa0735f2018-02-02 16:52:55 +08002388"_enablelegacywindowsfsencoding -- [Windows only]\n\
Steve Dowercc16be82016-09-08 10:35:16 -07002389"
2390)
2391#endif
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002392PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002393"__stdin__ -- the original stdin; don't touch!\n\
2394__stdout__ -- the original stdout; don't touch!\n\
2395__stderr__ -- the original stderr; don't touch!\n\
2396__displayhook__ -- the original displayhook; don't touch!\n\
2397__excepthook__ -- the original excepthook; don't touch!\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002398\n\
2399Functions:\n\
2400\n\
Georg Brandl1a3284e2007-12-02 09:40:06 +00002401displayhook() -- print an object to the screen, and save it in builtins._\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002402excepthook() -- print an exception and its traceback to sys.stderr\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002403exc_info() -- return thread-safe information about the current exception\n\
2404exit() -- exit the interpreter by raising SystemExit\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00002405getdlopenflags() -- returns flags to be used for dlopen() calls\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00002406getprofile() -- get the global profiling function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002407getrefcount() -- return the reference count for an object (plus one :-)\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00002408getrecursionlimit() -- return the max recursion depth for the interpreter\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00002409getsizeof() -- return the size of an object in bytes\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00002410gettrace() -- get the global debug tracing function\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00002411setdlopenflags() -- set the flags to be used for dlopen() calls\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002412setprofile() -- set the global profiling function\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00002413setrecursionlimit() -- set the max recursion depth for the interpreter\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002414settrace() -- set the global debug tracing function\n\
Fred Drakeccede592000-08-14 20:59:57 +00002415"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002416)
Fred Drakeccede592000-08-14 20:59:57 +00002417/* end of sys_doc */ ;
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002418
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002419
2420PyDoc_STRVAR(flags__doc__,
2421"sys.flags\n\
2422\n\
2423Flags provided through command line arguments or environment vars.");
2424
2425static PyTypeObject FlagsType;
2426
2427static PyStructSequence_Field flags_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002428 {"debug", "-d"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002429 {"inspect", "-i"},
2430 {"interactive", "-i"},
2431 {"optimize", "-O or -OO"},
2432 {"dont_write_bytecode", "-B"},
2433 {"no_user_site", "-s"},
2434 {"no_site", "-S"},
2435 {"ignore_environment", "-E"},
2436 {"verbose", "-v"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002437 /* {"unbuffered", "-u"}, */
2438 /* {"skip_first", "-x"}, */
Georg Brandl8aa7e992010-12-28 18:30:18 +00002439 {"bytes_warning", "-b"},
2440 {"quiet", "-q"},
Georg Brandl09a7c722012-02-20 21:31:46 +01002441 {"hash_randomization", "-R"},
Christian Heimesad73a9c2013-08-10 16:36:18 +02002442 {"isolated", "-I"},
Victor Stinner5e3806f2017-11-30 11:40:24 +01002443 {"dev_mode", "-X dev"},
Victor Stinner91106cd2017-12-13 12:29:09 +01002444 {"utf8_mode", "-X utf8"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002445 {0}
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002446};
2447
2448static PyStructSequence_Desc flags_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002449 "sys.flags", /* name */
2450 flags__doc__, /* doc */
2451 flags_fields, /* fields */
Victor Stinner1def7752020-04-23 03:03:24 +02002452 15
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002453};
2454
2455static PyObject*
Victor Stinner01b1cc12019-11-20 02:27:56 +01002456make_flags(PyThreadState *tstate)
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002457{
Victor Stinner01b1cc12019-11-20 02:27:56 +01002458 PyInterpreterState *interp = tstate->interp;
2459 const PyPreConfig *preconfig = &interp->runtime->preconfig;
Victor Stinnerda7933e2020-04-13 03:04:28 +02002460 const PyConfig *config = _PyInterpreterState_GetConfig(interp);
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002461
Victor Stinner01b1cc12019-11-20 02:27:56 +01002462 PyObject *seq = PyStructSequence_New(&FlagsType);
2463 if (seq == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002464 return NULL;
Victor Stinner01b1cc12019-11-20 02:27:56 +01002465 }
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002466
Victor Stinner01b1cc12019-11-20 02:27:56 +01002467 int pos = 0;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002468#define SetFlag(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 PyStructSequence_SET_ITEM(seq, pos++, PyLong_FromLong(flag))
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002470
Victor Stinnerfbca9082018-08-30 00:50:45 +02002471 SetFlag(config->parser_debug);
2472 SetFlag(config->inspect);
2473 SetFlag(config->interactive);
2474 SetFlag(config->optimization_level);
2475 SetFlag(!config->write_bytecode);
2476 SetFlag(!config->user_site_directory);
2477 SetFlag(!config->site_import);
Victor Stinner20004952019-03-26 02:31:11 +01002478 SetFlag(!config->use_environment);
Victor Stinnerfbca9082018-08-30 00:50:45 +02002479 SetFlag(config->verbose);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002480 /* SetFlag(saw_unbuffered_flag); */
2481 /* SetFlag(skipfirstline); */
Victor Stinnerfbca9082018-08-30 00:50:45 +02002482 SetFlag(config->bytes_warning);
2483 SetFlag(config->quiet);
2484 SetFlag(config->use_hash_seed == 0 || config->hash_seed != 0);
Victor Stinner20004952019-03-26 02:31:11 +01002485 SetFlag(config->isolated);
2486 PyStructSequence_SET_ITEM(seq, pos++, PyBool_FromLong(config->dev_mode));
2487 SetFlag(preconfig->utf8_mode);
Victor Stinner91106cd2017-12-13 12:29:09 +01002488#undef SetFlag
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002489
Victor Stinner838f2642019-06-13 22:41:23 +02002490 if (_PyErr_Occurred(tstate)) {
Serhiy Storchaka87a854d2013-12-17 14:59:42 +02002491 Py_DECREF(seq);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002492 return NULL;
2493 }
2494 return seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002495}
2496
Eric Smith0e5b5622009-02-06 01:32:42 +00002497PyDoc_STRVAR(version_info__doc__,
2498"sys.version_info\n\
2499\n\
2500Version information as a named tuple.");
2501
2502static PyTypeObject VersionInfoType;
2503
2504static PyStructSequence_Field version_info_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002505 {"major", "Major release number"},
2506 {"minor", "Minor release number"},
2507 {"micro", "Patch release number"},
Ned Deilyda4887a2016-11-04 17:03:34 -04002508 {"releaselevel", "'alpha', 'beta', 'candidate', or 'final'"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002509 {"serial", "Serial release number"},
2510 {0}
Eric Smith0e5b5622009-02-06 01:32:42 +00002511};
2512
2513static PyStructSequence_Desc version_info_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002514 "sys.version_info", /* name */
2515 version_info__doc__, /* doc */
2516 version_info_fields, /* fields */
2517 5
Eric Smith0e5b5622009-02-06 01:32:42 +00002518};
2519
2520static PyObject *
Victor Stinner838f2642019-06-13 22:41:23 +02002521make_version_info(PyThreadState *tstate)
Eric Smith0e5b5622009-02-06 01:32:42 +00002522{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002523 PyObject *version_info;
2524 char *s;
2525 int pos = 0;
Eric Smith0e5b5622009-02-06 01:32:42 +00002526
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002527 version_info = PyStructSequence_New(&VersionInfoType);
2528 if (version_info == NULL) {
2529 return NULL;
2530 }
Eric Smith0e5b5622009-02-06 01:32:42 +00002531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002532 /*
2533 * These release level checks are mutually exclusive and cover
2534 * the field, so don't get too fancy with the pre-processor!
2535 */
Eric Smith0e5b5622009-02-06 01:32:42 +00002536#if PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_ALPHA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002537 s = "alpha";
Eric Smith0e5b5622009-02-06 01:32:42 +00002538#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_BETA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002539 s = "beta";
Eric Smith0e5b5622009-02-06 01:32:42 +00002540#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_GAMMA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 s = "candidate";
Eric Smith0e5b5622009-02-06 01:32:42 +00002542#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_FINAL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002543 s = "final";
Eric Smith0e5b5622009-02-06 01:32:42 +00002544#endif
2545
2546#define SetIntItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002547 PyStructSequence_SET_ITEM(version_info, pos++, PyLong_FromLong(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00002548#define SetStrItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002549 PyStructSequence_SET_ITEM(version_info, pos++, PyUnicode_FromString(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00002550
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002551 SetIntItem(PY_MAJOR_VERSION);
2552 SetIntItem(PY_MINOR_VERSION);
2553 SetIntItem(PY_MICRO_VERSION);
2554 SetStrItem(s);
2555 SetIntItem(PY_RELEASE_SERIAL);
Eric Smith0e5b5622009-02-06 01:32:42 +00002556#undef SetIntItem
2557#undef SetStrItem
2558
Victor Stinner838f2642019-06-13 22:41:23 +02002559 if (_PyErr_Occurred(tstate)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002560 Py_CLEAR(version_info);
2561 return NULL;
2562 }
2563 return version_info;
Eric Smith0e5b5622009-02-06 01:32:42 +00002564}
2565
Brett Cannon3adc7b72012-07-09 14:22:12 -04002566/* sys.implementation values */
2567#define NAME "cpython"
2568const char *_PySys_ImplName = NAME;
Victor Stinnercf01b682015-11-05 11:21:38 +01002569#define MAJOR Py_STRINGIFY(PY_MAJOR_VERSION)
2570#define MINOR Py_STRINGIFY(PY_MINOR_VERSION)
Ned Deily529ea5d2014-06-30 23:31:14 -07002571#define TAG NAME "-" MAJOR MINOR
Brett Cannon3adc7b72012-07-09 14:22:12 -04002572const char *_PySys_ImplCacheTag = TAG;
2573#undef NAME
Brett Cannon3adc7b72012-07-09 14:22:12 -04002574#undef MAJOR
2575#undef MINOR
2576#undef TAG
2577
Barry Warsaw409da152012-06-03 16:18:47 -04002578static PyObject *
2579make_impl_info(PyObject *version_info)
2580{
2581 int res;
2582 PyObject *impl_info, *value, *ns;
2583
2584 impl_info = PyDict_New();
2585 if (impl_info == NULL)
2586 return NULL;
2587
2588 /* populate the dict */
2589
Brett Cannon3adc7b72012-07-09 14:22:12 -04002590 value = PyUnicode_FromString(_PySys_ImplName);
Barry Warsaw409da152012-06-03 16:18:47 -04002591 if (value == NULL)
2592 goto error;
2593 res = PyDict_SetItemString(impl_info, "name", value);
2594 Py_DECREF(value);
2595 if (res < 0)
2596 goto error;
2597
Brett Cannon3adc7b72012-07-09 14:22:12 -04002598 value = PyUnicode_FromString(_PySys_ImplCacheTag);
Barry Warsaw409da152012-06-03 16:18:47 -04002599 if (value == NULL)
2600 goto error;
2601 res = PyDict_SetItemString(impl_info, "cache_tag", value);
2602 Py_DECREF(value);
2603 if (res < 0)
2604 goto error;
Barry Warsaw409da152012-06-03 16:18:47 -04002605
2606 res = PyDict_SetItemString(impl_info, "version", version_info);
2607 if (res < 0)
2608 goto error;
2609
2610 value = PyLong_FromLong(PY_VERSION_HEX);
2611 if (value == NULL)
2612 goto error;
2613 res = PyDict_SetItemString(impl_info, "hexversion", value);
2614 Py_DECREF(value);
2615 if (res < 0)
2616 goto error;
2617
doko@ubuntu.com55532312016-06-14 08:55:19 +02002618#ifdef MULTIARCH
2619 value = PyUnicode_FromString(MULTIARCH);
2620 if (value == NULL)
2621 goto error;
2622 res = PyDict_SetItemString(impl_info, "_multiarch", value);
2623 Py_DECREF(value);
2624 if (res < 0)
2625 goto error;
2626#endif
2627
Barry Warsaw409da152012-06-03 16:18:47 -04002628 /* dict ready */
2629
2630 ns = _PyNamespace_New(impl_info);
2631 Py_DECREF(impl_info);
2632 return ns;
2633
2634error:
2635 Py_CLEAR(impl_info);
2636 return NULL;
2637}
2638
Martin v. Löwis1a214512008-06-11 05:26:20 +00002639static struct PyModuleDef sysmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002640 PyModuleDef_HEAD_INIT,
2641 "sys",
2642 sys_doc,
2643 -1, /* multiple "initialization" just copies the module dict. */
2644 sys_methods,
2645 NULL,
2646 NULL,
2647 NULL,
2648 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00002649};
2650
Eric Snow6b4be192017-05-22 21:36:03 -07002651/* Updating the sys namespace, returning NULL pointer on error */
Victor Stinner8fea2522013-10-27 17:15:42 +01002652#define SET_SYS_FROM_STRING_BORROW(key, value) \
Victor Stinner58049602013-07-22 22:40:00 +02002653 do { \
Victor Stinner58049602013-07-22 22:40:00 +02002654 PyObject *v = (value); \
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002655 if (v == NULL) { \
2656 goto err_occurred; \
2657 } \
Victor Stinner58049602013-07-22 22:40:00 +02002658 res = PyDict_SetItemString(sysdict, key, v); \
2659 if (res < 0) { \
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002660 goto err_occurred; \
Victor Stinner8fea2522013-10-27 17:15:42 +01002661 } \
2662 } while (0)
2663#define SET_SYS_FROM_STRING(key, value) \
2664 do { \
Victor Stinner8fea2522013-10-27 17:15:42 +01002665 PyObject *v = (value); \
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002666 if (v == NULL) { \
2667 goto err_occurred; \
2668 } \
Victor Stinner8fea2522013-10-27 17:15:42 +01002669 res = PyDict_SetItemString(sysdict, key, v); \
2670 Py_DECREF(v); \
2671 if (res < 0) { \
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002672 goto err_occurred; \
Victor Stinner58049602013-07-22 22:40:00 +02002673 } \
2674 } while (0)
Guido van Rossum25ce5661997-08-02 03:10:38 +00002675
Victor Stinner331a6a52019-05-27 16:39:22 +02002676static PyStatus
Victor Stinner01b1cc12019-11-20 02:27:56 +01002677_PySys_InitCore(PyThreadState *tstate, PyObject *sysdict)
Eric Snow6b4be192017-05-22 21:36:03 -07002678{
Victor Stinnerab672812019-01-23 15:04:40 +01002679 PyObject *version_info;
Eric Snow6b4be192017-05-22 21:36:03 -07002680 int res;
2681
Nick Coghland6009512014-11-20 21:39:37 +10002682 /* stdin/stdout/stderr are set in pylifecycle.c */
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002683
Victor Stinner8fea2522013-10-27 17:15:42 +01002684 SET_SYS_FROM_STRING_BORROW("__displayhook__",
2685 PyDict_GetItemString(sysdict, "displayhook"));
2686 SET_SYS_FROM_STRING_BORROW("__excepthook__",
2687 PyDict_GetItemString(sysdict, "excepthook"));
Barry Warsaw36c1d1f2017-10-05 12:11:18 -04002688 SET_SYS_FROM_STRING_BORROW(
2689 "__breakpointhook__",
2690 PyDict_GetItemString(sysdict, "breakpointhook"));
Victor Stinneref9d9b62019-05-22 11:28:22 +02002691 SET_SYS_FROM_STRING_BORROW("__unraisablehook__",
2692 PyDict_GetItemString(sysdict, "unraisablehook"));
2693
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002694 SET_SYS_FROM_STRING("version",
2695 PyUnicode_FromString(Py_GetVersion()));
2696 SET_SYS_FROM_STRING("hexversion",
2697 PyLong_FromLong(PY_VERSION_HEX));
Ned Deily5c4b0d02017-03-04 00:19:55 -05002698 SET_SYS_FROM_STRING("_git",
2699 Py_BuildValue("(szz)", "CPython", _Py_gitidentifier(),
2700 _Py_gitversion()));
INADA Naoki6b42eb12017-06-29 15:31:38 +09002701 SET_SYS_FROM_STRING("_framework", PyUnicode_FromString(_PYTHONFRAMEWORK));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002702 SET_SYS_FROM_STRING("api_version",
2703 PyLong_FromLong(PYTHON_API_VERSION));
2704 SET_SYS_FROM_STRING("copyright",
2705 PyUnicode_FromString(Py_GetCopyright()));
2706 SET_SYS_FROM_STRING("platform",
2707 PyUnicode_FromString(Py_GetPlatform()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002708 SET_SYS_FROM_STRING("maxsize",
2709 PyLong_FromSsize_t(PY_SSIZE_T_MAX));
2710 SET_SYS_FROM_STRING("float_info",
2711 PyFloat_GetInfo());
2712 SET_SYS_FROM_STRING("int_info",
2713 PyLong_GetInfo());
Mark Dickinsondc787d22010-05-23 13:33:13 +00002714 /* initialize hash_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002715 if (Hash_InfoType.tp_name == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002716 if (PyStructSequence_InitType2(&Hash_InfoType, &hash_info_desc) < 0) {
2717 goto type_init_failed;
2718 }
Victor Stinner1c8f0592013-07-22 22:24:54 +02002719 }
Mark Dickinsondc787d22010-05-23 13:33:13 +00002720 SET_SYS_FROM_STRING("hash_info",
Victor Stinner838f2642019-06-13 22:41:23 +02002721 get_hash_info(tstate));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002722 SET_SYS_FROM_STRING("maxunicode",
Ezio Melotti48a2f8f2011-09-29 00:18:19 +03002723 PyLong_FromLong(0x10FFFF));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002724 SET_SYS_FROM_STRING("builtin_module_names",
2725 list_builtin_module_names());
Christian Heimes743e0cd2012-10-17 23:52:17 +02002726#if PY_BIG_ENDIAN
2727 SET_SYS_FROM_STRING("byteorder",
2728 PyUnicode_FromString("big"));
2729#else
2730 SET_SYS_FROM_STRING("byteorder",
2731 PyUnicode_FromString("little"));
2732#endif
Fred Drake099325e2000-08-14 15:47:03 +00002733
Guido van Rossum8b9ea871996-08-23 18:14:47 +00002734#ifdef MS_COREDLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002735 SET_SYS_FROM_STRING("dllhandle",
2736 PyLong_FromVoidPtr(PyWin_DLLhModule));
2737 SET_SYS_FROM_STRING("winver",
2738 PyUnicode_FromString(PyWin_DLLVersionString));
Guido van Rossumc606fe11996-04-09 02:37:57 +00002739#endif
Barry Warsaw8cf4eae2010-10-16 01:04:07 +00002740#ifdef ABIFLAGS
2741 SET_SYS_FROM_STRING("abiflags",
2742 PyUnicode_FromString(ABIFLAGS));
2743#endif
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002744
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002745 /* version_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002746 if (VersionInfoType.tp_name == NULL) {
2747 if (PyStructSequence_InitType2(&VersionInfoType,
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002748 &version_info_desc) < 0) {
2749 goto type_init_failed;
2750 }
Victor Stinner1c8f0592013-07-22 22:24:54 +02002751 }
Victor Stinner838f2642019-06-13 22:41:23 +02002752 version_info = make_version_info(tstate);
Barry Warsaw409da152012-06-03 16:18:47 -04002753 SET_SYS_FROM_STRING("version_info", version_info);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002754 /* prevent user from creating new instances */
2755 VersionInfoType.tp_init = NULL;
2756 VersionInfoType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02002757 res = PyDict_DelItemString(VersionInfoType.tp_dict, "__new__");
Victor Stinner838f2642019-06-13 22:41:23 +02002758 if (res < 0 && _PyErr_ExceptionMatches(tstate, PyExc_KeyError)) {
2759 _PyErr_Clear(tstate);
2760 }
Eric Smith0e5b5622009-02-06 01:32:42 +00002761
Barry Warsaw409da152012-06-03 16:18:47 -04002762 /* implementation */
2763 SET_SYS_FROM_STRING("implementation", make_impl_info(version_info));
2764
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002765 /* flags */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002766 if (FlagsType.tp_name == 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002767 if (PyStructSequence_InitType2(&FlagsType, &flags_desc) < 0) {
2768 goto type_init_failed;
2769 }
Victor Stinner1c8f0592013-07-22 22:24:54 +02002770 }
Victor Stinner43125222019-04-24 18:23:53 +02002771 /* Set flags to their default values (updated by _PySys_InitMain()) */
Victor Stinner01b1cc12019-11-20 02:27:56 +01002772 SET_SYS_FROM_STRING("flags", make_flags(tstate));
Eric Smithf7bb5782010-01-27 00:44:57 +00002773
2774#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002775 /* getwindowsversion */
2776 if (WindowsVersionType.tp_name == 0)
Victor Stinner1c8f0592013-07-22 22:24:54 +02002777 if (PyStructSequence_InitType2(&WindowsVersionType,
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002778 &windows_version_desc) < 0) {
2779 goto type_init_failed;
2780 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002781 /* prevent user from creating new instances */
2782 WindowsVersionType.tp_init = NULL;
2783 WindowsVersionType.tp_new = NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02002784 assert(!_PyErr_Occurred(tstate));
Antoine Pitrou871dfc42014-04-28 13:07:06 +02002785 res = PyDict_DelItemString(WindowsVersionType.tp_dict, "__new__");
Victor Stinner838f2642019-06-13 22:41:23 +02002786 if (res < 0 && _PyErr_ExceptionMatches(tstate, PyExc_KeyError)) {
2787 _PyErr_Clear(tstate);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002788 }
Eric Smithf7bb5782010-01-27 00:44:57 +00002789#endif
2790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002791 /* float repr style: 0.03 (short) vs 0.029999999999999999 (legacy) */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002792#ifndef PY_NO_SHORT_FLOAT_REPR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002793 SET_SYS_FROM_STRING("float_repr_style",
2794 PyUnicode_FromString("short"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002795#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002796 SET_SYS_FROM_STRING("float_repr_style",
2797 PyUnicode_FromString("legacy"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002798#endif
2799
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002800 SET_SYS_FROM_STRING("thread_info", PyThread_GetInfo());
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002801
Yury Selivanoveb636452016-09-08 22:01:51 -07002802 /* initialize asyncgen_hooks */
2803 if (AsyncGenHooksType.tp_name == NULL) {
2804 if (PyStructSequence_InitType2(
2805 &AsyncGenHooksType, &asyncgen_hooks_desc) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002806 goto type_init_failed;
Yury Selivanoveb636452016-09-08 22:01:51 -07002807 }
2808 }
2809
Victor Stinner838f2642019-06-13 22:41:23 +02002810 if (_PyErr_Occurred(tstate)) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002811 goto err_occurred;
2812 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002813 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002814
2815type_init_failed:
Victor Stinner331a6a52019-05-27 16:39:22 +02002816 return _PyStatus_ERR("failed to initialize a type");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002817
2818err_occurred:
Victor Stinner331a6a52019-05-27 16:39:22 +02002819 return _PyStatus_ERR("can't initialize sys module");
Guido van Rossum5b3138b1990-11-18 17:41:40 +00002820}
2821
Eric Snow6b4be192017-05-22 21:36:03 -07002822/* Updating the sys namespace, returning integer error codes */
Eric Snow6b4be192017-05-22 21:36:03 -07002823#define SET_SYS_FROM_STRING_INT_RESULT(key, value) \
2824 do { \
2825 PyObject *v = (value); \
2826 if (v == NULL) \
2827 return -1; \
2828 res = PyDict_SetItemString(sysdict, key, v); \
2829 Py_DECREF(v); \
2830 if (res < 0) { \
2831 return res; \
2832 } \
2833 } while (0)
2834
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002835
2836static int
2837sys_add_xoption(PyObject *opts, const wchar_t *s)
2838{
2839 PyObject *name, *value;
2840
2841 const wchar_t *name_end = wcschr(s, L'=');
2842 if (!name_end) {
2843 name = PyUnicode_FromWideChar(s, -1);
2844 value = Py_True;
2845 Py_INCREF(value);
2846 }
2847 else {
2848 name = PyUnicode_FromWideChar(s, name_end - s);
2849 value = PyUnicode_FromWideChar(name_end + 1, -1);
2850 }
2851 if (name == NULL || value == NULL) {
2852 goto error;
2853 }
2854 if (PyDict_SetItem(opts, name, value) < 0) {
2855 goto error;
2856 }
2857 Py_DECREF(name);
2858 Py_DECREF(value);
2859 return 0;
2860
2861error:
2862 Py_XDECREF(name);
2863 Py_XDECREF(value);
2864 return -1;
2865}
2866
2867
2868static PyObject*
Victor Stinner331a6a52019-05-27 16:39:22 +02002869sys_create_xoptions_dict(const PyConfig *config)
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002870{
2871 Py_ssize_t nxoption = config->xoptions.length;
2872 wchar_t * const * xoptions = config->xoptions.items;
2873 PyObject *dict = PyDict_New();
2874 if (dict == NULL) {
2875 return NULL;
2876 }
2877
2878 for (Py_ssize_t i=0; i < nxoption; i++) {
2879 const wchar_t *option = xoptions[i];
2880 if (sys_add_xoption(dict, option) < 0) {
2881 Py_DECREF(dict);
2882 return NULL;
2883 }
2884 }
2885
2886 return dict;
2887}
2888
2889
Eric Snow6b4be192017-05-22 21:36:03 -07002890int
Victor Stinner01b1cc12019-11-20 02:27:56 +01002891_PySys_InitMain(PyThreadState *tstate)
Eric Snow6b4be192017-05-22 21:36:03 -07002892{
Victor Stinner838f2642019-06-13 22:41:23 +02002893 PyObject *sysdict = tstate->interp->sysdict;
Victor Stinnerda7933e2020-04-13 03:04:28 +02002894 const PyConfig *config = _PyInterpreterState_GetConfig(tstate->interp);
Eric Snow6b4be192017-05-22 21:36:03 -07002895 int res;
2896
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002897#define COPY_LIST(KEY, VALUE) \
Victor Stinner37cd9822018-11-16 11:55:35 +01002898 do { \
Victor Stinner331a6a52019-05-27 16:39:22 +02002899 PyObject *list = _PyWideStringList_AsList(&(VALUE)); \
Victor Stinner37cd9822018-11-16 11:55:35 +01002900 if (list == NULL) { \
2901 return -1; \
2902 } \
2903 SET_SYS_FROM_STRING_BORROW(KEY, list); \
2904 Py_DECREF(list); \
2905 } while (0)
2906
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002907#define SET_SYS_FROM_WSTR(KEY, VALUE) \
2908 do { \
2909 PyObject *str = PyUnicode_FromWideChar(VALUE, -1); \
2910 if (str == NULL) { \
2911 return -1; \
2912 } \
2913 SET_SYS_FROM_STRING_BORROW(KEY, str); \
2914 Py_DECREF(str); \
2915 } while (0)
Victor Stinner37cd9822018-11-16 11:55:35 +01002916
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002917 COPY_LIST("path", config->module_search_paths);
2918
2919 SET_SYS_FROM_WSTR("executable", config->executable);
Steve Dower9048c492019-06-29 10:34:11 -07002920 SET_SYS_FROM_WSTR("_base_executable", config->base_executable);
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002921 SET_SYS_FROM_WSTR("prefix", config->prefix);
2922 SET_SYS_FROM_WSTR("base_prefix", config->base_prefix);
2923 SET_SYS_FROM_WSTR("exec_prefix", config->exec_prefix);
2924 SET_SYS_FROM_WSTR("base_exec_prefix", config->base_exec_prefix);
Sandro Mani8f023a22020-06-08 17:28:11 +02002925 SET_SYS_FROM_WSTR("platlibdir", config->platlibdir);
Victor Stinner41264f12017-12-15 02:05:29 +01002926
Carl Meyerb193fa92018-06-15 22:40:56 -06002927 if (config->pycache_prefix != NULL) {
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002928 SET_SYS_FROM_WSTR("pycache_prefix", config->pycache_prefix);
Carl Meyerb193fa92018-06-15 22:40:56 -06002929 } else {
2930 PyDict_SetItemString(sysdict, "pycache_prefix", Py_None);
2931 }
2932
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002933 COPY_LIST("argv", config->argv);
Victor Stinnerdd8a93e2020-06-30 00:49:03 +02002934 COPY_LIST("orig_argv", config->orig_argv);
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002935 COPY_LIST("warnoptions", config->warnoptions);
2936
2937 PyObject *xoptions = sys_create_xoptions_dict(config);
2938 if (xoptions == NULL) {
2939 return -1;
Victor Stinner41264f12017-12-15 02:05:29 +01002940 }
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002941 SET_SYS_FROM_STRING_BORROW("_xoptions", xoptions);
Pablo Galindo34ef64f2019-03-27 12:43:47 +00002942 Py_DECREF(xoptions);
Victor Stinner41264f12017-12-15 02:05:29 +01002943
Victor Stinner37cd9822018-11-16 11:55:35 +01002944#undef COPY_LIST
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002945#undef SET_SYS_FROM_WSTR
Victor Stinner37cd9822018-11-16 11:55:35 +01002946
Victor Stinner8510f432020-03-10 09:53:09 +01002947
Eric Snow6b4be192017-05-22 21:36:03 -07002948 /* Set flags to their final values */
Victor Stinner01b1cc12019-11-20 02:27:56 +01002949 SET_SYS_FROM_STRING_INT_RESULT("flags", make_flags(tstate));
Eric Snow6b4be192017-05-22 21:36:03 -07002950 /* prevent user from creating new instances */
2951 FlagsType.tp_init = NULL;
2952 FlagsType.tp_new = NULL;
2953 res = PyDict_DelItemString(FlagsType.tp_dict, "__new__");
2954 if (res < 0) {
Victor Stinner838f2642019-06-13 22:41:23 +02002955 if (!_PyErr_ExceptionMatches(tstate, PyExc_KeyError)) {
Eric Snow6b4be192017-05-22 21:36:03 -07002956 return res;
2957 }
Victor Stinner838f2642019-06-13 22:41:23 +02002958 _PyErr_Clear(tstate);
Eric Snow6b4be192017-05-22 21:36:03 -07002959 }
2960
2961 SET_SYS_FROM_STRING_INT_RESULT("dont_write_bytecode",
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002962 PyBool_FromLong(!config->write_bytecode));
Eric Snow6b4be192017-05-22 21:36:03 -07002963
Victor Stinner838f2642019-06-13 22:41:23 +02002964 if (get_warnoptions(tstate) == NULL) {
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002965 return -1;
Victor Stinner838f2642019-06-13 22:41:23 +02002966 }
Victor Stinner865de272017-06-08 13:27:47 +02002967
Victor Stinner838f2642019-06-13 22:41:23 +02002968 if (get_xoptions(tstate) == NULL)
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002969 return -1;
Eric Snow6b4be192017-05-22 21:36:03 -07002970
Victor Stinner838f2642019-06-13 22:41:23 +02002971 if (_PyErr_Occurred(tstate)) {
2972 goto err_occurred;
2973 }
2974
Eric Snow6b4be192017-05-22 21:36:03 -07002975 return 0;
Victor Stinner41264f12017-12-15 02:05:29 +01002976
2977err_occurred:
2978 return -1;
Eric Snow6b4be192017-05-22 21:36:03 -07002979}
2980
Victor Stinner8510f432020-03-10 09:53:09 +01002981#undef SET_SYS_FROM_STRING
Victor Stinner41264f12017-12-15 02:05:29 +01002982#undef SET_SYS_FROM_STRING_BORROW
Eric Snow6b4be192017-05-22 21:36:03 -07002983#undef SET_SYS_FROM_STRING_INT_RESULT
Eric Snow6b4be192017-05-22 21:36:03 -07002984
Victor Stinnerab672812019-01-23 15:04:40 +01002985
2986/* Set up a preliminary stderr printer until we have enough
2987 infrastructure for the io module in place.
2988
2989 Use UTF-8/surrogateescape and ignore EAGAIN errors. */
Victor Stinner81fe5bd2019-12-06 02:43:30 +01002990static PyStatus
Victor Stinnerab672812019-01-23 15:04:40 +01002991_PySys_SetPreliminaryStderr(PyObject *sysdict)
2992{
2993 PyObject *pstderr = PyFile_NewStdPrinter(fileno(stderr));
2994 if (pstderr == NULL) {
2995 goto error;
2996 }
2997 if (_PyDict_SetItemId(sysdict, &PyId_stderr, pstderr) < 0) {
2998 goto error;
2999 }
3000 if (PyDict_SetItemString(sysdict, "__stderr__", pstderr) < 0) {
3001 goto error;
3002 }
3003 Py_DECREF(pstderr);
Victor Stinner331a6a52019-05-27 16:39:22 +02003004 return _PyStatus_OK();
Victor Stinnerab672812019-01-23 15:04:40 +01003005
3006error:
3007 Py_XDECREF(pstderr);
Victor Stinner331a6a52019-05-27 16:39:22 +02003008 return _PyStatus_ERR("can't set preliminary stderr");
Victor Stinnerab672812019-01-23 15:04:40 +01003009}
3010
3011
3012/* Create sys module without all attributes: _PySys_InitMain() should be called
3013 later to add remaining attributes. */
Victor Stinner331a6a52019-05-27 16:39:22 +02003014PyStatus
Victor Stinner01b1cc12019-11-20 02:27:56 +01003015_PySys_Create(PyThreadState *tstate, PyObject **sysmod_p)
Victor Stinnerab672812019-01-23 15:04:40 +01003016{
Victor Stinner81fe5bd2019-12-06 02:43:30 +01003017 assert(!_PyErr_Occurred(tstate));
3018
Victor Stinnerb45d2592019-06-20 00:05:23 +02003019 PyInterpreterState *interp = tstate->interp;
Victor Stinner838f2642019-06-13 22:41:23 +02003020
Victor Stinnerab672812019-01-23 15:04:40 +01003021 PyObject *modules = PyDict_New();
3022 if (modules == NULL) {
Victor Stinner81fe5bd2019-12-06 02:43:30 +01003023 goto error;
Victor Stinnerab672812019-01-23 15:04:40 +01003024 }
3025 interp->modules = modules;
3026
3027 PyObject *sysmod = _PyModule_CreateInitialized(&sysmodule, PYTHON_API_VERSION);
3028 if (sysmod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02003029 return _PyStatus_ERR("failed to create a module object");
Victor Stinnerab672812019-01-23 15:04:40 +01003030 }
3031
3032 PyObject *sysdict = PyModule_GetDict(sysmod);
3033 if (sysdict == NULL) {
Victor Stinner81fe5bd2019-12-06 02:43:30 +01003034 goto error;
Victor Stinnerab672812019-01-23 15:04:40 +01003035 }
3036 Py_INCREF(sysdict);
3037 interp->sysdict = sysdict;
3038
3039 if (PyDict_SetItemString(sysdict, "modules", interp->modules) < 0) {
Victor Stinner81fe5bd2019-12-06 02:43:30 +01003040 goto error;
Victor Stinnerab672812019-01-23 15:04:40 +01003041 }
3042
Victor Stinner331a6a52019-05-27 16:39:22 +02003043 PyStatus status = _PySys_SetPreliminaryStderr(sysdict);
3044 if (_PyStatus_EXCEPTION(status)) {
3045 return status;
Victor Stinnerab672812019-01-23 15:04:40 +01003046 }
3047
Victor Stinner01b1cc12019-11-20 02:27:56 +01003048 status = _PySys_InitCore(tstate, sysdict);
Victor Stinner331a6a52019-05-27 16:39:22 +02003049 if (_PyStatus_EXCEPTION(status)) {
3050 return status;
Victor Stinnerab672812019-01-23 15:04:40 +01003051 }
3052
Victor Stinner81fe5bd2019-12-06 02:43:30 +01003053 if (_PyImport_FixupBuiltin(sysmod, "sys", interp->modules) < 0) {
3054 goto error;
3055 }
3056
3057 assert(!_PyErr_Occurred(tstate));
Victor Stinnerab672812019-01-23 15:04:40 +01003058
3059 *sysmod_p = sysmod;
Victor Stinner331a6a52019-05-27 16:39:22 +02003060 return _PyStatus_OK();
Victor Stinner81fe5bd2019-12-06 02:43:30 +01003061
3062error:
3063 return _PyStatus_ERR("can't initialize sys module");
Victor Stinnerab672812019-01-23 15:04:40 +01003064}
3065
3066
Guido van Rossum65bf9f21997-04-29 18:33:38 +00003067static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00003068makepathobject(const wchar_t *path, wchar_t delim)
Guido van Rossum5b3138b1990-11-18 17:41:40 +00003069{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003070 int i, n;
3071 const wchar_t *p;
3072 PyObject *v, *w;
Tim Peters216b78b2006-01-06 02:40:53 +00003073
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003074 n = 1;
3075 p = path;
3076 while ((p = wcschr(p, delim)) != NULL) {
3077 n++;
3078 p++;
3079 }
3080 v = PyList_New(n);
3081 if (v == NULL)
3082 return NULL;
3083 for (i = 0; ; i++) {
3084 p = wcschr(path, delim);
3085 if (p == NULL)
3086 p = path + wcslen(path); /* End of string */
3087 w = PyUnicode_FromWideChar(path, (Py_ssize_t)(p - path));
3088 if (w == NULL) {
3089 Py_DECREF(v);
3090 return NULL;
3091 }
Zackery Spytz99d56b52018-12-08 07:16:55 -07003092 PyList_SET_ITEM(v, i, w);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003093 if (*p == '\0')
3094 break;
3095 path = p+1;
3096 }
3097 return v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003098}
3099
3100void
Martin v. Löwis790465f2008-04-05 20:41:37 +00003101PySys_SetPath(const wchar_t *path)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003102{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003103 PyObject *v;
3104 if ((v = makepathobject(path, DELIM)) == NULL)
3105 Py_FatalError("can't create sys.path");
Victor Stinner838f2642019-06-13 22:41:23 +02003106 PyThreadState *tstate = _PyThreadState_GET();
3107 if (sys_set_object_id(tstate, &PyId_path, v) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003108 Py_FatalError("can't assign sys.path");
Victor Stinner838f2642019-06-13 22:41:23 +02003109 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003110 Py_DECREF(v);
Guido van Rossum3f5da241990-12-20 15:06:42 +00003111}
3112
Guido van Rossum65bf9f21997-04-29 18:33:38 +00003113static PyObject *
Victor Stinner74f65682019-03-15 15:08:05 +01003114make_sys_argv(int argc, wchar_t * const * argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00003115{
Victor Stinner74f65682019-03-15 15:08:05 +01003116 PyObject *list = PyList_New(argc);
3117 if (list == NULL) {
3118 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003119 }
Victor Stinner74f65682019-03-15 15:08:05 +01003120
3121 for (Py_ssize_t i = 0; i < argc; i++) {
3122 PyObject *v = PyUnicode_FromWideChar(argv[i], -1);
3123 if (v == NULL) {
3124 Py_DECREF(list);
3125 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003126 }
Victor Stinner74f65682019-03-15 15:08:05 +01003127 PyList_SET_ITEM(list, i, v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003128 }
Victor Stinner74f65682019-03-15 15:08:05 +01003129 return list;
Guido van Rossum3f5da241990-12-20 15:06:42 +00003130}
3131
Victor Stinner11a247d2017-12-13 21:05:57 +01003132void
3133PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)
Victor Stinnerd5dda982017-12-13 17:31:16 +01003134{
Victor Stinnerc4868252019-08-23 11:04:16 +01003135 wchar_t* empty_argv[1] = {L""};
Victor Stinner838f2642019-06-13 22:41:23 +02003136 PyThreadState *tstate = _PyThreadState_GET();
3137
Victor Stinner74f65682019-03-15 15:08:05 +01003138 if (argc < 1 || argv == NULL) {
3139 /* Ensure at least one (empty) argument is seen */
Victor Stinner74f65682019-03-15 15:08:05 +01003140 argv = empty_argv;
3141 argc = 1;
3142 }
3143
3144 PyObject *av = make_sys_argv(argc, argv);
Victor Stinnerd5dda982017-12-13 17:31:16 +01003145 if (av == NULL) {
Victor Stinner11a247d2017-12-13 21:05:57 +01003146 Py_FatalError("no mem for sys.argv");
Victor Stinnerd5dda982017-12-13 17:31:16 +01003147 }
Victor Stinner838f2642019-06-13 22:41:23 +02003148 if (sys_set_object(tstate, "argv", av) != 0) {
Victor Stinnerd5dda982017-12-13 17:31:16 +01003149 Py_DECREF(av);
Victor Stinner11a247d2017-12-13 21:05:57 +01003150 Py_FatalError("can't assign sys.argv");
Victor Stinnerd5dda982017-12-13 17:31:16 +01003151 }
3152 Py_DECREF(av);
3153
3154 if (updatepath) {
3155 /* If argv[0] is not '-c' nor '-m', prepend argv[0] to sys.path.
3156 If argv[0] is a symlink, use the real path. */
Victor Stinner331a6a52019-05-27 16:39:22 +02003157 const PyWideStringList argv_list = {.length = argc, .items = argv};
Victor Stinnerdcf61712019-03-19 16:09:27 +01003158 PyObject *path0 = NULL;
3159 if (_PyPathConfig_ComputeSysPath0(&argv_list, &path0)) {
3160 if (path0 == NULL) {
3161 Py_FatalError("can't compute path0 from argv");
Victor Stinner11a247d2017-12-13 21:05:57 +01003162 }
Victor Stinnerdcf61712019-03-19 16:09:27 +01003163
Victor Stinner838f2642019-06-13 22:41:23 +02003164 PyObject *sys_path = sys_get_object_id(tstate, &PyId_path);
Victor Stinnerdcf61712019-03-19 16:09:27 +01003165 if (sys_path != NULL) {
3166 if (PyList_Insert(sys_path, 0, path0) < 0) {
3167 Py_DECREF(path0);
3168 Py_FatalError("can't prepend path0 to sys.path");
3169 }
3170 }
3171 Py_DECREF(path0);
Victor Stinner11a247d2017-12-13 21:05:57 +01003172 }
Victor Stinnerd5dda982017-12-13 17:31:16 +01003173 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003174}
Guido van Rossuma890e681998-05-12 14:59:24 +00003175
Antoine Pitrouf978fac2010-05-21 17:25:34 +00003176void
3177PySys_SetArgv(int argc, wchar_t **argv)
3178{
Christian Heimesad73a9c2013-08-10 16:36:18 +02003179 PySys_SetArgvEx(argc, argv, Py_IsolatedFlag == 0);
Antoine Pitrouf978fac2010-05-21 17:25:34 +00003180}
3181
Victor Stinner14284c22010-04-23 12:02:30 +00003182/* Reimplementation of PyFile_WriteString() no calling indirectly
3183 PyErr_CheckSignals(): avoid the call to PyObject_Str(). */
3184
3185static int
Victor Stinner79766632010-08-16 17:36:42 +00003186sys_pyfile_write_unicode(PyObject *unicode, PyObject *file)
Victor Stinner14284c22010-04-23 12:02:30 +00003187{
Victor Stinnerecccc4f2010-06-08 20:46:00 +00003188 if (file == NULL)
3189 return -1;
Jeroen Demeyerb1263d52019-06-28 11:49:00 +02003190 assert(unicode != NULL);
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02003191 PyObject *result = _PyObject_CallMethodIdOneArg(file, &PyId_write, unicode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003192 if (result == NULL) {
Jeroen Demeyerb1263d52019-06-28 11:49:00 +02003193 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003194 }
Jeroen Demeyerb1263d52019-06-28 11:49:00 +02003195 Py_DECREF(result);
3196 return 0;
Victor Stinner14284c22010-04-23 12:02:30 +00003197}
3198
Victor Stinner79766632010-08-16 17:36:42 +00003199static int
3200sys_pyfile_write(const char *text, PyObject *file)
3201{
3202 PyObject *unicode = NULL;
3203 int err;
3204
3205 if (file == NULL)
3206 return -1;
3207
3208 unicode = PyUnicode_FromString(text);
3209 if (unicode == NULL)
3210 return -1;
3211
3212 err = sys_pyfile_write_unicode(unicode, file);
3213 Py_DECREF(unicode);
3214 return err;
3215}
Guido van Rossuma890e681998-05-12 14:59:24 +00003216
3217/* APIs to write to sys.stdout or sys.stderr using a printf-like interface.
3218 Adapted from code submitted by Just van Rossum.
3219
3220 PySys_WriteStdout(format, ...)
3221 PySys_WriteStderr(format, ...)
3222
3223 The first function writes to sys.stdout; the second to sys.stderr. When
3224 there is a problem, they write to the real (C level) stdout or stderr;
Guido van Rossum8442af31998-10-12 18:22:10 +00003225 no exceptions are raised.
Guido van Rossuma890e681998-05-12 14:59:24 +00003226
Victor Stinner14284c22010-04-23 12:02:30 +00003227 PyErr_CheckSignals() is not called to avoid the execution of the Python
Victor Stinner79766632010-08-16 17:36:42 +00003228 signal handlers: they may raise a new exception whereas sys_write()
3229 ignores all exceptions.
Victor Stinner14284c22010-04-23 12:02:30 +00003230
Guido van Rossuma890e681998-05-12 14:59:24 +00003231 Both take a printf-style format string as their first argument followed
3232 by a variable length argument list determined by the format string.
3233
3234 *** WARNING ***
3235
3236 The format should limit the total size of the formatted output string to
3237 1000 bytes. In particular, this means that no unrestricted "%s" formats
3238 should occur; these should be limited using "%.<N>s where <N> is a
3239 decimal number calculated so that <N> plus the maximum size of other
3240 formatted text does not exceed 1000 bytes. Also watch out for "%f",
3241 which can print hundreds of digits for very large numbers.
3242
3243 */
3244
3245static void
Victor Stinner09054372013-11-06 22:41:44 +01003246sys_write(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Guido van Rossuma890e681998-05-12 14:59:24 +00003247{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003248 PyObject *file;
3249 PyObject *error_type, *error_value, *error_traceback;
3250 char buffer[1001];
3251 int written;
Victor Stinner838f2642019-06-13 22:41:23 +02003252 PyThreadState *tstate = _PyThreadState_GET();
Guido van Rossuma890e681998-05-12 14:59:24 +00003253
Victor Stinner838f2642019-06-13 22:41:23 +02003254 _PyErr_Fetch(tstate, &error_type, &error_value, &error_traceback);
3255 file = sys_get_object_id(tstate, key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003256 written = PyOS_vsnprintf(buffer, sizeof(buffer), format, va);
3257 if (sys_pyfile_write(buffer, file) != 0) {
Victor Stinner838f2642019-06-13 22:41:23 +02003258 _PyErr_Clear(tstate);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003259 fputs(buffer, fp);
3260 }
3261 if (written < 0 || (size_t)written >= sizeof(buffer)) {
3262 const char *truncated = "... truncated";
Victor Stinner79766632010-08-16 17:36:42 +00003263 if (sys_pyfile_write(truncated, file) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003264 fputs(truncated, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003265 }
Victor Stinner838f2642019-06-13 22:41:23 +02003266 _PyErr_Restore(tstate, error_type, error_value, error_traceback);
Guido van Rossuma890e681998-05-12 14:59:24 +00003267}
3268
3269void
Guido van Rossuma890e681998-05-12 14:59:24 +00003270PySys_WriteStdout(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00003271{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003272 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00003273
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003274 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01003275 sys_write(&PyId_stdout, stdout, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003276 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00003277}
3278
3279void
Guido van Rossuma890e681998-05-12 14:59:24 +00003280PySys_WriteStderr(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00003281{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003282 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00003283
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003284 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01003285 sys_write(&PyId_stderr, stderr, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00003286 va_end(va);
3287}
3288
3289static void
Victor Stinner09054372013-11-06 22:41:44 +01003290sys_format(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Victor Stinner79766632010-08-16 17:36:42 +00003291{
3292 PyObject *file, *message;
3293 PyObject *error_type, *error_value, *error_traceback;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02003294 const char *utf8;
Victor Stinner838f2642019-06-13 22:41:23 +02003295 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner79766632010-08-16 17:36:42 +00003296
Victor Stinner838f2642019-06-13 22:41:23 +02003297 _PyErr_Fetch(tstate, &error_type, &error_value, &error_traceback);
3298 file = sys_get_object_id(tstate, key);
Victor Stinner79766632010-08-16 17:36:42 +00003299 message = PyUnicode_FromFormatV(format, va);
3300 if (message != NULL) {
3301 if (sys_pyfile_write_unicode(message, file) != 0) {
Victor Stinner838f2642019-06-13 22:41:23 +02003302 _PyErr_Clear(tstate);
Serhiy Storchaka06515832016-11-20 09:13:07 +02003303 utf8 = PyUnicode_AsUTF8(message);
Victor Stinner79766632010-08-16 17:36:42 +00003304 if (utf8 != NULL)
3305 fputs(utf8, fp);
3306 }
3307 Py_DECREF(message);
3308 }
Victor Stinner838f2642019-06-13 22:41:23 +02003309 _PyErr_Restore(tstate, error_type, error_value, error_traceback);
Victor Stinner79766632010-08-16 17:36:42 +00003310}
3311
3312void
3313PySys_FormatStdout(const char *format, ...)
3314{
3315 va_list va;
3316
3317 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01003318 sys_format(&PyId_stdout, stdout, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00003319 va_end(va);
3320}
3321
3322void
3323PySys_FormatStderr(const char *format, ...)
3324{
3325 va_list va;
3326
3327 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01003328 sys_format(&PyId_stderr, stderr, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003329 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00003330}