blob: dfa069e01d9607c1e2ff2aa6fd6cc2bc8eeccbe1 [file] [log] [blame]
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001/*
2 * New exceptions.c written in Iceland by Richard Jones and Georg Brandl.
3 *
4 * Thanks go to Tim Peters and Michael Hudson for debugging.
5 */
6
Thomas Wouters477c8d52006-05-27 19:21:47 +00007#define PY_SSIZE_T_CLEAN
8#include <Python.h>
Victor Stinner331a6a52019-05-27 16:39:22 +02009#include "pycore_initconfig.h"
Victor Stinnerbcda8f12018-11-21 22:27:47 +010010#include "pycore_object.h"
Victor Stinner4a21e572020-04-15 02:35:41 +020011#include "structmember.h" // PyMemberDef
Victor Stinner361dcdc2020-04-15 03:24:57 +020012#include "osdefs.h" // SEP
Thomas Wouters477c8d52006-05-27 19:21:47 +000013
Thomas Wouters477c8d52006-05-27 19:21:47 +000014
Antoine Pitrou6b4883d2011-10-12 02:54:14 +020015/* Compatibility aliases */
16PyObject *PyExc_EnvironmentError = NULL;
17PyObject *PyExc_IOError = NULL;
18#ifdef MS_WINDOWS
19PyObject *PyExc_WindowsError = NULL;
20#endif
Antoine Pitrou6b4883d2011-10-12 02:54:14 +020021
Victor Stinner281cce12020-06-23 22:55:46 +020022
23static struct _Py_exc_state*
24get_exc_state(void)
25{
26 PyInterpreterState *interp = _PyInterpreterState_GET();
27 return &interp->exc_state;
28}
Antoine Pitrou6b4883d2011-10-12 02:54:14 +020029
30
Thomas Wouters477c8d52006-05-27 19:21:47 +000031/* NOTE: If the exception class hierarchy changes, don't forget to update
32 * Lib/test/exception_hierarchy.txt
33 */
34
Thomas Wouters477c8d52006-05-27 19:21:47 +000035/*
36 * BaseException
37 */
38static PyObject *
39BaseException_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
40{
41 PyBaseExceptionObject *self;
42
43 self = (PyBaseExceptionObject *)type->tp_alloc(type, 0);
Guido van Rossumd8faa362007-04-27 19:54:29 +000044 if (!self)
45 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +000046 /* the dict is created on the fly in PyObject_GenericSetAttr */
Guido van Rossumebe3e162007-05-17 18:20:34 +000047 self->dict = NULL;
Collin Winter1966f1c2007-09-01 20:26:44 +000048 self->traceback = self->cause = self->context = NULL;
Benjamin Petersond5a1c442012-05-14 22:09:31 -070049 self->suppress_context = 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +000050
Richard Oudkerk5562d9d2012-07-28 17:45:28 +010051 if (args) {
52 self->args = args;
53 Py_INCREF(args);
54 return (PyObject *)self;
55 }
56
Thomas Wouters477c8d52006-05-27 19:21:47 +000057 self->args = PyTuple_New(0);
58 if (!self->args) {
59 Py_DECREF(self);
60 return NULL;
61 }
62
Thomas Wouters477c8d52006-05-27 19:21:47 +000063 return (PyObject *)self;
64}
65
66static int
67BaseException_init(PyBaseExceptionObject *self, PyObject *args, PyObject *kwds)
68{
Christian Heimes90aa7642007-12-19 02:45:37 +000069 if (!_PyArg_NoKeywords(Py_TYPE(self)->tp_name, kwds))
Thomas Wouters4d70c3d2006-06-08 14:42:34 +000070 return -1;
71
Serhiy Storchaka576f1322016-01-05 21:27:54 +020072 Py_INCREF(args);
Serhiy Storchakaec397562016-04-06 09:50:03 +030073 Py_XSETREF(self->args, args);
Thomas Wouters477c8d52006-05-27 19:21:47 +000074
Thomas Wouters477c8d52006-05-27 19:21:47 +000075 return 0;
76}
77
Thomas Wouters4d70c3d2006-06-08 14:42:34 +000078static int
Thomas Wouters477c8d52006-05-27 19:21:47 +000079BaseException_clear(PyBaseExceptionObject *self)
80{
81 Py_CLEAR(self->dict);
82 Py_CLEAR(self->args);
Collin Winter828f04a2007-08-31 00:04:24 +000083 Py_CLEAR(self->traceback);
Collin Winter1966f1c2007-09-01 20:26:44 +000084 Py_CLEAR(self->cause);
85 Py_CLEAR(self->context);
Thomas Wouters477c8d52006-05-27 19:21:47 +000086 return 0;
87}
88
89static void
90BaseException_dealloc(PyBaseExceptionObject *self)
91{
Thomas Wouters89f507f2006-12-13 04:49:30 +000092 _PyObject_GC_UNTRACK(self);
Thomas Wouters477c8d52006-05-27 19:21:47 +000093 BaseException_clear(self);
Christian Heimes90aa7642007-12-19 02:45:37 +000094 Py_TYPE(self)->tp_free((PyObject *)self);
Thomas Wouters477c8d52006-05-27 19:21:47 +000095}
96
Thomas Wouters4d70c3d2006-06-08 14:42:34 +000097static int
Thomas Wouters477c8d52006-05-27 19:21:47 +000098BaseException_traverse(PyBaseExceptionObject *self, visitproc visit, void *arg)
99{
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000100 Py_VISIT(self->dict);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000101 Py_VISIT(self->args);
Collin Winter828f04a2007-08-31 00:04:24 +0000102 Py_VISIT(self->traceback);
Collin Winter1966f1c2007-09-01 20:26:44 +0000103 Py_VISIT(self->cause);
104 Py_VISIT(self->context);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000105 return 0;
106}
107
108static PyObject *
109BaseException_str(PyBaseExceptionObject *self)
110{
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000111 switch (PyTuple_GET_SIZE(self->args)) {
Thomas Wouters477c8d52006-05-27 19:21:47 +0000112 case 0:
Walter Dörwaldf5bec7c2007-05-26 15:03:32 +0000113 return PyUnicode_FromString("");
Thomas Wouters477c8d52006-05-27 19:21:47 +0000114 case 1:
Thomas Heller519a0422007-11-15 20:48:54 +0000115 return PyObject_Str(PyTuple_GET_ITEM(self->args, 0));
Thomas Wouters477c8d52006-05-27 19:21:47 +0000116 default:
Thomas Heller519a0422007-11-15 20:48:54 +0000117 return PyObject_Str(self->args);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000118 }
Thomas Wouters477c8d52006-05-27 19:21:47 +0000119}
120
121static PyObject *
122BaseException_repr(PyBaseExceptionObject *self)
123{
Serhiy Storchaka4ab46d72017-09-17 21:11:04 +0300124 const char *name = _PyType_Name(Py_TYPE(self));
Serhiy Storchakaf8a4c032017-11-15 17:53:28 +0200125 if (PyTuple_GET_SIZE(self->args) == 1)
126 return PyUnicode_FromFormat("%s(%R)", name,
127 PyTuple_GET_ITEM(self->args, 0));
128 else
129 return PyUnicode_FromFormat("%s%R", name, self->args);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000130}
131
132/* Pickling support */
133static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +0530134BaseException_reduce(PyBaseExceptionObject *self, PyObject *Py_UNUSED(ignored))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000135{
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000136 if (self->args && self->dict)
Christian Heimes90aa7642007-12-19 02:45:37 +0000137 return PyTuple_Pack(3, Py_TYPE(self), self->args, self->dict);
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000138 else
Christian Heimes90aa7642007-12-19 02:45:37 +0000139 return PyTuple_Pack(2, Py_TYPE(self), self->args);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000140}
141
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000142/*
143 * Needed for backward compatibility, since exceptions used to store
144 * all their attributes in the __dict__. Code is taken from cPickle's
145 * load_build function.
146 */
147static PyObject *
148BaseException_setstate(PyObject *self, PyObject *state)
149{
150 PyObject *d_key, *d_value;
151 Py_ssize_t i = 0;
152
153 if (state != Py_None) {
154 if (!PyDict_Check(state)) {
155 PyErr_SetString(PyExc_TypeError, "state is not a dictionary");
156 return NULL;
157 }
158 while (PyDict_Next(state, &i, &d_key, &d_value)) {
159 if (PyObject_SetAttr(self, d_key, d_value) < 0)
160 return NULL;
161 }
162 }
163 Py_RETURN_NONE;
164}
Thomas Wouters477c8d52006-05-27 19:21:47 +0000165
Collin Winter828f04a2007-08-31 00:04:24 +0000166static PyObject *
167BaseException_with_traceback(PyObject *self, PyObject *tb) {
168 if (PyException_SetTraceback(self, tb))
169 return NULL;
170
171 Py_INCREF(self);
172 return self;
173}
174
Georg Brandl76941002008-05-05 21:38:47 +0000175PyDoc_STRVAR(with_traceback_doc,
176"Exception.with_traceback(tb) --\n\
177 set self.__traceback__ to tb and return self.");
178
Thomas Wouters477c8d52006-05-27 19:21:47 +0000179
180static PyMethodDef BaseException_methods[] = {
181 {"__reduce__", (PyCFunction)BaseException_reduce, METH_NOARGS },
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000182 {"__setstate__", (PyCFunction)BaseException_setstate, METH_O },
Georg Brandl76941002008-05-05 21:38:47 +0000183 {"with_traceback", (PyCFunction)BaseException_with_traceback, METH_O,
184 with_traceback_doc},
Thomas Wouters477c8d52006-05-27 19:21:47 +0000185 {NULL, NULL, 0, NULL},
186};
187
Thomas Wouters477c8d52006-05-27 19:21:47 +0000188static PyObject *
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +0200189BaseException_get_args(PyBaseExceptionObject *self, void *Py_UNUSED(ignored))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000190{
191 if (self->args == NULL) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200192 Py_RETURN_NONE;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000193 }
194 Py_INCREF(self->args);
195 return self->args;
196}
197
198static int
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +0200199BaseException_set_args(PyBaseExceptionObject *self, PyObject *val, void *Py_UNUSED(ignored))
Thomas Wouters477c8d52006-05-27 19:21:47 +0000200{
201 PyObject *seq;
202 if (val == NULL) {
203 PyErr_SetString(PyExc_TypeError, "args may not be deleted");
204 return -1;
205 }
206 seq = PySequence_Tuple(val);
Benjamin Peterson90b13582012-02-03 19:22:31 -0500207 if (!seq)
208 return -1;
Serhiy Storchaka48842712016-04-06 09:45:48 +0300209 Py_XSETREF(self->args, seq);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000210 return 0;
211}
212
Collin Winter828f04a2007-08-31 00:04:24 +0000213static PyObject *
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +0200214BaseException_get_tb(PyBaseExceptionObject *self, void *Py_UNUSED(ignored))
Collin Winter828f04a2007-08-31 00:04:24 +0000215{
216 if (self->traceback == NULL) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200217 Py_RETURN_NONE;
Collin Winter828f04a2007-08-31 00:04:24 +0000218 }
219 Py_INCREF(self->traceback);
220 return self->traceback;
221}
222
223static int
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +0200224BaseException_set_tb(PyBaseExceptionObject *self, PyObject *tb, void *Py_UNUSED(ignored))
Collin Winter828f04a2007-08-31 00:04:24 +0000225{
226 if (tb == NULL) {
227 PyErr_SetString(PyExc_TypeError, "__traceback__ may not be deleted");
228 return -1;
229 }
230 else if (!(tb == Py_None || PyTraceBack_Check(tb))) {
231 PyErr_SetString(PyExc_TypeError,
232 "__traceback__ must be a traceback or None");
233 return -1;
234 }
235
Serhiy Storchaka37665722016-08-20 21:22:03 +0300236 Py_INCREF(tb);
Serhiy Storchaka48842712016-04-06 09:45:48 +0300237 Py_XSETREF(self->traceback, tb);
Collin Winter828f04a2007-08-31 00:04:24 +0000238 return 0;
239}
240
Georg Brandlab6f2f62009-03-31 04:16:10 +0000241static PyObject *
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +0200242BaseException_get_context(PyObject *self, void *Py_UNUSED(ignored))
243{
Georg Brandlab6f2f62009-03-31 04:16:10 +0000244 PyObject *res = PyException_GetContext(self);
Benjamin Peterson90b13582012-02-03 19:22:31 -0500245 if (res)
246 return res; /* new reference already returned above */
Georg Brandlab6f2f62009-03-31 04:16:10 +0000247 Py_RETURN_NONE;
248}
249
250static int
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +0200251BaseException_set_context(PyObject *self, PyObject *arg, void *Py_UNUSED(ignored))
252{
Georg Brandlab6f2f62009-03-31 04:16:10 +0000253 if (arg == NULL) {
254 PyErr_SetString(PyExc_TypeError, "__context__ may not be deleted");
255 return -1;
256 } else if (arg == Py_None) {
257 arg = NULL;
258 } else if (!PyExceptionInstance_Check(arg)) {
259 PyErr_SetString(PyExc_TypeError, "exception context must be None "
260 "or derive from BaseException");
261 return -1;
262 } else {
263 /* PyException_SetContext steals this reference */
264 Py_INCREF(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000265 }
Georg Brandlab6f2f62009-03-31 04:16:10 +0000266 PyException_SetContext(self, arg);
267 return 0;
268}
269
270static PyObject *
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +0200271BaseException_get_cause(PyObject *self, void *Py_UNUSED(ignored))
272{
Georg Brandlab6f2f62009-03-31 04:16:10 +0000273 PyObject *res = PyException_GetCause(self);
Benjamin Peterson90b13582012-02-03 19:22:31 -0500274 if (res)
275 return res; /* new reference already returned above */
Benjamin Petersond5a1c442012-05-14 22:09:31 -0700276 Py_RETURN_NONE;
Georg Brandlab6f2f62009-03-31 04:16:10 +0000277}
278
279static int
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +0200280BaseException_set_cause(PyObject *self, PyObject *arg, void *Py_UNUSED(ignored))
281{
Georg Brandlab6f2f62009-03-31 04:16:10 +0000282 if (arg == NULL) {
283 PyErr_SetString(PyExc_TypeError, "__cause__ may not be deleted");
284 return -1;
Benjamin Petersond5a1c442012-05-14 22:09:31 -0700285 } else if (arg == Py_None) {
286 arg = NULL;
287 } else if (!PyExceptionInstance_Check(arg)) {
288 PyErr_SetString(PyExc_TypeError, "exception cause must be None "
289 "or derive from BaseException");
290 return -1;
291 } else {
292 /* PyException_SetCause steals this reference */
293 Py_INCREF(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000294 }
Benjamin Petersond5a1c442012-05-14 22:09:31 -0700295 PyException_SetCause(self, arg);
296 return 0;
Georg Brandlab6f2f62009-03-31 04:16:10 +0000297}
298
Guido van Rossum360e4b82007-05-14 22:51:27 +0000299
Thomas Wouters477c8d52006-05-27 19:21:47 +0000300static PyGetSetDef BaseException_getset[] = {
Benjamin Peterson23d7f122012-02-19 20:02:57 -0500301 {"__dict__", PyObject_GenericGetDict, PyObject_GenericSetDict},
Thomas Wouters477c8d52006-05-27 19:21:47 +0000302 {"args", (getter)BaseException_get_args, (setter)BaseException_set_args},
Collin Winter828f04a2007-08-31 00:04:24 +0000303 {"__traceback__", (getter)BaseException_get_tb, (setter)BaseException_set_tb},
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +0200304 {"__context__", BaseException_get_context,
305 BaseException_set_context, PyDoc_STR("exception context")},
306 {"__cause__", BaseException_get_cause,
307 BaseException_set_cause, PyDoc_STR("exception cause")},
Thomas Wouters477c8d52006-05-27 19:21:47 +0000308 {NULL},
309};
310
311
Victor Stinnerb0be6b32020-05-05 17:07:41 +0200312static inline PyBaseExceptionObject*
313_PyBaseExceptionObject_cast(PyObject *exc)
314{
315 assert(PyExceptionInstance_Check(exc));
316 return (PyBaseExceptionObject *)exc;
317}
318
319
Collin Winter828f04a2007-08-31 00:04:24 +0000320PyObject *
Victor Stinnerb0be6b32020-05-05 17:07:41 +0200321PyException_GetTraceback(PyObject *self)
322{
323 PyBaseExceptionObject *base_self = _PyBaseExceptionObject_cast(self);
Collin Winter828f04a2007-08-31 00:04:24 +0000324 Py_XINCREF(base_self->traceback);
325 return base_self->traceback;
326}
327
328
329int
Victor Stinnerb0be6b32020-05-05 17:07:41 +0200330PyException_SetTraceback(PyObject *self, PyObject *tb)
331{
332 return BaseException_set_tb(_PyBaseExceptionObject_cast(self), tb, NULL);
Collin Winter828f04a2007-08-31 00:04:24 +0000333}
334
335PyObject *
Victor Stinnerb0be6b32020-05-05 17:07:41 +0200336PyException_GetCause(PyObject *self)
337{
338 PyObject *cause = _PyBaseExceptionObject_cast(self)->cause;
Collin Winter828f04a2007-08-31 00:04:24 +0000339 Py_XINCREF(cause);
340 return cause;
341}
342
343/* Steals a reference to cause */
344void
Serhiy Storchaka576f1322016-01-05 21:27:54 +0200345PyException_SetCause(PyObject *self, PyObject *cause)
346{
Victor Stinnerb0be6b32020-05-05 17:07:41 +0200347 PyBaseExceptionObject *base_self = _PyBaseExceptionObject_cast(self);
348 base_self->suppress_context = 1;
349 Py_XSETREF(base_self->cause, cause);
Collin Winter828f04a2007-08-31 00:04:24 +0000350}
351
352PyObject *
Victor Stinnerb0be6b32020-05-05 17:07:41 +0200353PyException_GetContext(PyObject *self)
354{
355 PyObject *context = _PyBaseExceptionObject_cast(self)->context;
Collin Winter828f04a2007-08-31 00:04:24 +0000356 Py_XINCREF(context);
357 return context;
358}
359
360/* Steals a reference to context */
361void
Serhiy Storchaka576f1322016-01-05 21:27:54 +0200362PyException_SetContext(PyObject *self, PyObject *context)
363{
Victor Stinnerb0be6b32020-05-05 17:07:41 +0200364 Py_XSETREF(_PyBaseExceptionObject_cast(self)->context, context);
Collin Winter828f04a2007-08-31 00:04:24 +0000365}
366
Serhiy Storchakaceeef102018-06-15 11:09:43 +0300367const char *
Christian Tismerea62ce72018-06-09 20:32:25 +0200368PyExceptionClass_Name(PyObject *ob)
369{
Victor Stinnerb0be6b32020-05-05 17:07:41 +0200370 assert(PyExceptionClass_Check(ob));
Serhiy Storchakaceeef102018-06-15 11:09:43 +0300371 return ((PyTypeObject*)ob)->tp_name;
Christian Tismerea62ce72018-06-09 20:32:25 +0200372}
Collin Winter828f04a2007-08-31 00:04:24 +0000373
Benjamin Petersond5a1c442012-05-14 22:09:31 -0700374static struct PyMemberDef BaseException_members[] = {
375 {"__suppress_context__", T_BOOL,
Antoine Pitrou32bc80c2012-05-16 12:51:55 +0200376 offsetof(PyBaseExceptionObject, suppress_context)},
377 {NULL}
Benjamin Petersond5a1c442012-05-14 22:09:31 -0700378};
379
380
Thomas Wouters477c8d52006-05-27 19:21:47 +0000381static PyTypeObject _PyExc_BaseException = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000382 PyVarObject_HEAD_INIT(NULL, 0)
Neal Norwitz2633c692007-02-26 22:22:47 +0000383 "BaseException", /*tp_name*/
Thomas Wouters477c8d52006-05-27 19:21:47 +0000384 sizeof(PyBaseExceptionObject), /*tp_basicsize*/
385 0, /*tp_itemsize*/
386 (destructor)BaseException_dealloc, /*tp_dealloc*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +0200387 0, /*tp_vectorcall_offset*/
Thomas Wouters477c8d52006-05-27 19:21:47 +0000388 0, /*tp_getattr*/
389 0, /*tp_setattr*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +0200390 0, /*tp_as_async*/
Thomas Wouters477c8d52006-05-27 19:21:47 +0000391 (reprfunc)BaseException_repr, /*tp_repr*/
392 0, /*tp_as_number*/
Brett Cannonba7bf492007-02-27 00:15:55 +0000393 0, /*tp_as_sequence*/
Thomas Wouters477c8d52006-05-27 19:21:47 +0000394 0, /*tp_as_mapping*/
395 0, /*tp_hash */
396 0, /*tp_call*/
397 (reprfunc)BaseException_str, /*tp_str*/
398 PyObject_GenericGetAttr, /*tp_getattro*/
399 PyObject_GenericSetAttr, /*tp_setattro*/
400 0, /*tp_as_buffer*/
Thomas Wouters27d517b2007-02-25 20:39:11 +0000401 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC |
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000402 Py_TPFLAGS_BASE_EXC_SUBCLASS, /*tp_flags*/
Thomas Wouters477c8d52006-05-27 19:21:47 +0000403 PyDoc_STR("Common base class for all exceptions"), /* tp_doc */
404 (traverseproc)BaseException_traverse, /* tp_traverse */
405 (inquiry)BaseException_clear, /* tp_clear */
406 0, /* tp_richcompare */
407 0, /* tp_weaklistoffset */
408 0, /* tp_iter */
409 0, /* tp_iternext */
410 BaseException_methods, /* tp_methods */
Benjamin Petersond5a1c442012-05-14 22:09:31 -0700411 BaseException_members, /* tp_members */
Thomas Wouters477c8d52006-05-27 19:21:47 +0000412 BaseException_getset, /* tp_getset */
413 0, /* tp_base */
414 0, /* tp_dict */
415 0, /* tp_descr_get */
416 0, /* tp_descr_set */
417 offsetof(PyBaseExceptionObject, dict), /* tp_dictoffset */
418 (initproc)BaseException_init, /* tp_init */
419 0, /* tp_alloc */
420 BaseException_new, /* tp_new */
421};
422/* the CPython API expects exceptions to be (PyObject *) - both a hold-over
Min ho Kimc4cacc82019-07-31 08:16:13 +1000423from the previous implementation and also allowing Python objects to be used
Thomas Wouters477c8d52006-05-27 19:21:47 +0000424in the API */
425PyObject *PyExc_BaseException = (PyObject *)&_PyExc_BaseException;
426
427/* note these macros omit the last semicolon so the macro invocation may
428 * include it and not look strange.
429 */
430#define SimpleExtendsException(EXCBASE, EXCNAME, EXCDOC) \
431static PyTypeObject _PyExc_ ## EXCNAME = { \
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000432 PyVarObject_HEAD_INIT(NULL, 0) \
Neal Norwitz2633c692007-02-26 22:22:47 +0000433 # EXCNAME, \
Thomas Wouters477c8d52006-05-27 19:21:47 +0000434 sizeof(PyBaseExceptionObject), \
435 0, (destructor)BaseException_dealloc, 0, 0, 0, 0, 0, 0, 0, \
436 0, 0, 0, 0, 0, 0, 0, \
437 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, \
438 PyDoc_STR(EXCDOC), (traverseproc)BaseException_traverse, \
439 (inquiry)BaseException_clear, 0, 0, 0, 0, 0, 0, 0, &_ ## EXCBASE, \
440 0, 0, 0, offsetof(PyBaseExceptionObject, dict), \
441 (initproc)BaseException_init, 0, BaseException_new,\
442}; \
443PyObject *PyExc_ ## EXCNAME = (PyObject *)&_PyExc_ ## EXCNAME
444
445#define MiddlingExtendsException(EXCBASE, EXCNAME, EXCSTORE, EXCDOC) \
446static PyTypeObject _PyExc_ ## EXCNAME = { \
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000447 PyVarObject_HEAD_INIT(NULL, 0) \
Neal Norwitz2633c692007-02-26 22:22:47 +0000448 # EXCNAME, \
Thomas Wouters477c8d52006-05-27 19:21:47 +0000449 sizeof(Py ## EXCSTORE ## Object), \
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000450 0, (destructor)EXCSTORE ## _dealloc, 0, 0, 0, 0, 0, 0, 0, 0, 0, \
Thomas Wouters477c8d52006-05-27 19:21:47 +0000451 0, 0, 0, 0, 0, \
452 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, \
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000453 PyDoc_STR(EXCDOC), (traverseproc)EXCSTORE ## _traverse, \
454 (inquiry)EXCSTORE ## _clear, 0, 0, 0, 0, 0, 0, 0, &_ ## EXCBASE, \
Thomas Wouters477c8d52006-05-27 19:21:47 +0000455 0, 0, 0, offsetof(Py ## EXCSTORE ## Object, dict), \
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200456 (initproc)EXCSTORE ## _init, 0, 0, \
Thomas Wouters477c8d52006-05-27 19:21:47 +0000457}; \
458PyObject *PyExc_ ## EXCNAME = (PyObject *)&_PyExc_ ## EXCNAME
459
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200460#define ComplexExtendsException(EXCBASE, EXCNAME, EXCSTORE, EXCNEW, \
461 EXCMETHODS, EXCMEMBERS, EXCGETSET, \
462 EXCSTR, EXCDOC) \
Thomas Wouters477c8d52006-05-27 19:21:47 +0000463static PyTypeObject _PyExc_ ## EXCNAME = { \
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000464 PyVarObject_HEAD_INIT(NULL, 0) \
Neal Norwitz2633c692007-02-26 22:22:47 +0000465 # EXCNAME, \
Thomas Wouters477c8d52006-05-27 19:21:47 +0000466 sizeof(Py ## EXCSTORE ## Object), 0, \
467 (destructor)EXCSTORE ## _dealloc, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, \
468 (reprfunc)EXCSTR, 0, 0, 0, \
469 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, \
470 PyDoc_STR(EXCDOC), (traverseproc)EXCSTORE ## _traverse, \
471 (inquiry)EXCSTORE ## _clear, 0, 0, 0, 0, EXCMETHODS, \
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200472 EXCMEMBERS, EXCGETSET, &_ ## EXCBASE, \
Thomas Wouters477c8d52006-05-27 19:21:47 +0000473 0, 0, 0, offsetof(Py ## EXCSTORE ## Object, dict), \
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200474 (initproc)EXCSTORE ## _init, 0, EXCNEW,\
Thomas Wouters477c8d52006-05-27 19:21:47 +0000475}; \
476PyObject *PyExc_ ## EXCNAME = (PyObject *)&_PyExc_ ## EXCNAME
477
478
479/*
480 * Exception extends BaseException
481 */
482SimpleExtendsException(PyExc_BaseException, Exception,
483 "Common base class for all non-exit exceptions.");
484
485
486/*
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000487 * TypeError extends Exception
Thomas Wouters477c8d52006-05-27 19:21:47 +0000488 */
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000489SimpleExtendsException(PyExc_Exception, TypeError,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000490 "Inappropriate argument type.");
491
492
493/*
Yury Selivanov75445082015-05-11 22:57:16 -0400494 * StopAsyncIteration extends Exception
495 */
496SimpleExtendsException(PyExc_Exception, StopAsyncIteration,
497 "Signal the end from iterator.__anext__().");
498
499
500/*
Thomas Wouters477c8d52006-05-27 19:21:47 +0000501 * StopIteration extends Exception
502 */
Nick Coghlan1f7ce622012-01-13 21:43:40 +1000503
504static PyMemberDef StopIteration_members[] = {
505 {"value", T_OBJECT, offsetof(PyStopIterationObject, value), 0,
506 PyDoc_STR("generator return value")},
507 {NULL} /* Sentinel */
508};
509
510static int
511StopIteration_init(PyStopIterationObject *self, PyObject *args, PyObject *kwds)
512{
513 Py_ssize_t size = PyTuple_GET_SIZE(args);
514 PyObject *value;
515
516 if (BaseException_init((PyBaseExceptionObject *)self, args, kwds) == -1)
517 return -1;
518 Py_CLEAR(self->value);
519 if (size > 0)
520 value = PyTuple_GET_ITEM(args, 0);
521 else
522 value = Py_None;
523 Py_INCREF(value);
524 self->value = value;
525 return 0;
526}
527
528static int
529StopIteration_clear(PyStopIterationObject *self)
530{
531 Py_CLEAR(self->value);
532 return BaseException_clear((PyBaseExceptionObject *)self);
533}
534
535static void
536StopIteration_dealloc(PyStopIterationObject *self)
537{
538 _PyObject_GC_UNTRACK(self);
539 StopIteration_clear(self);
540 Py_TYPE(self)->tp_free((PyObject *)self);
541}
542
543static int
544StopIteration_traverse(PyStopIterationObject *self, visitproc visit, void *arg)
545{
546 Py_VISIT(self->value);
547 return BaseException_traverse((PyBaseExceptionObject *)self, visit, arg);
548}
549
Nick Coghlan1f7ce622012-01-13 21:43:40 +1000550ComplexExtendsException(
551 PyExc_Exception, /* base */
552 StopIteration, /* name */
553 StopIteration, /* prefix for *_init, etc */
554 0, /* new */
555 0, /* methods */
556 StopIteration_members, /* members */
557 0, /* getset */
558 0, /* str */
559 "Signal the end from iterator.__next__()."
560);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000561
562
563/*
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000564 * GeneratorExit extends BaseException
Thomas Wouters477c8d52006-05-27 19:21:47 +0000565 */
Christian Heimescbf3b5c2007-12-03 21:02:03 +0000566SimpleExtendsException(PyExc_BaseException, GeneratorExit,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000567 "Request that a generator exit.");
568
569
570/*
571 * SystemExit extends BaseException
572 */
Thomas Wouters477c8d52006-05-27 19:21:47 +0000573
574static int
575SystemExit_init(PySystemExitObject *self, PyObject *args, PyObject *kwds)
576{
577 Py_ssize_t size = PyTuple_GET_SIZE(args);
578
579 if (BaseException_init((PyBaseExceptionObject *)self, args, kwds) == -1)
580 return -1;
581
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000582 if (size == 0)
583 return 0;
Serhiy Storchaka191321d2015-12-27 15:41:34 +0200584 if (size == 1) {
585 Py_INCREF(PyTuple_GET_ITEM(args, 0));
Serhiy Storchaka48842712016-04-06 09:45:48 +0300586 Py_XSETREF(self->code, PyTuple_GET_ITEM(args, 0));
Serhiy Storchaka191321d2015-12-27 15:41:34 +0200587 }
588 else { /* size > 1 */
589 Py_INCREF(args);
Serhiy Storchaka48842712016-04-06 09:45:48 +0300590 Py_XSETREF(self->code, args);
Serhiy Storchaka191321d2015-12-27 15:41:34 +0200591 }
Thomas Wouters477c8d52006-05-27 19:21:47 +0000592 return 0;
593}
594
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000595static int
Thomas Wouters477c8d52006-05-27 19:21:47 +0000596SystemExit_clear(PySystemExitObject *self)
597{
598 Py_CLEAR(self->code);
599 return BaseException_clear((PyBaseExceptionObject *)self);
600}
601
602static void
603SystemExit_dealloc(PySystemExitObject *self)
604{
Thomas Wouters89f507f2006-12-13 04:49:30 +0000605 _PyObject_GC_UNTRACK(self);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000606 SystemExit_clear(self);
Christian Heimes90aa7642007-12-19 02:45:37 +0000607 Py_TYPE(self)->tp_free((PyObject *)self);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000608}
609
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000610static int
Thomas Wouters477c8d52006-05-27 19:21:47 +0000611SystemExit_traverse(PySystemExitObject *self, visitproc visit, void *arg)
612{
613 Py_VISIT(self->code);
614 return BaseException_traverse((PyBaseExceptionObject *)self, visit, arg);
615}
616
617static PyMemberDef SystemExit_members[] = {
Thomas Wouters477c8d52006-05-27 19:21:47 +0000618 {"code", T_OBJECT, offsetof(PySystemExitObject, code), 0,
619 PyDoc_STR("exception code")},
620 {NULL} /* Sentinel */
621};
622
623ComplexExtendsException(PyExc_BaseException, SystemExit, SystemExit,
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200624 0, 0, SystemExit_members, 0, 0,
Thomas Wouters477c8d52006-05-27 19:21:47 +0000625 "Request to exit from the interpreter.");
626
627/*
628 * KeyboardInterrupt extends BaseException
629 */
630SimpleExtendsException(PyExc_BaseException, KeyboardInterrupt,
631 "Program interrupted by user.");
632
633
634/*
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000635 * ImportError extends Exception
Thomas Wouters477c8d52006-05-27 19:21:47 +0000636 */
Thomas Wouters477c8d52006-05-27 19:21:47 +0000637
Brett Cannon79ec55e2012-04-12 20:24:54 -0400638static int
639ImportError_init(PyImportErrorObject *self, PyObject *args, PyObject *kwds)
640{
Serhiy Storchaka47dee112016-09-27 20:45:35 +0300641 static char *kwlist[] = {"name", "path", 0};
642 PyObject *empty_tuple;
Brett Cannon79ec55e2012-04-12 20:24:54 -0400643 PyObject *msg = NULL;
644 PyObject *name = NULL;
645 PyObject *path = NULL;
646
Serhiy Storchaka47dee112016-09-27 20:45:35 +0300647 if (BaseException_init((PyBaseExceptionObject *)self, args, NULL) == -1)
Brett Cannon79ec55e2012-04-12 20:24:54 -0400648 return -1;
649
Serhiy Storchaka47dee112016-09-27 20:45:35 +0300650 empty_tuple = PyTuple_New(0);
651 if (!empty_tuple)
652 return -1;
653 if (!PyArg_ParseTupleAndKeywords(empty_tuple, kwds, "|$OO:ImportError", kwlist,
654 &name, &path)) {
655 Py_DECREF(empty_tuple);
656 return -1;
657 }
658 Py_DECREF(empty_tuple);
659
Serhiy Storchakae9e44482016-09-28 07:53:32 +0300660 Py_XINCREF(name);
661 Py_XSETREF(self->name, name);
662
663 Py_XINCREF(path);
664 Py_XSETREF(self->path, path);
665
Serhiy Storchaka47dee112016-09-27 20:45:35 +0300666 if (PyTuple_GET_SIZE(args) == 1) {
667 msg = PyTuple_GET_ITEM(args, 0);
668 Py_INCREF(msg);
Serhiy Storchaka47dee112016-09-27 20:45:35 +0300669 }
Serhiy Storchakae9e44482016-09-28 07:53:32 +0300670 Py_XSETREF(self->msg, msg);
Brett Cannon79ec55e2012-04-12 20:24:54 -0400671
672 return 0;
673}
674
675static int
676ImportError_clear(PyImportErrorObject *self)
677{
678 Py_CLEAR(self->msg);
679 Py_CLEAR(self->name);
680 Py_CLEAR(self->path);
681 return BaseException_clear((PyBaseExceptionObject *)self);
682}
683
684static void
685ImportError_dealloc(PyImportErrorObject *self)
686{
687 _PyObject_GC_UNTRACK(self);
688 ImportError_clear(self);
689 Py_TYPE(self)->tp_free((PyObject *)self);
690}
691
692static int
693ImportError_traverse(PyImportErrorObject *self, visitproc visit, void *arg)
694{
695 Py_VISIT(self->msg);
696 Py_VISIT(self->name);
697 Py_VISIT(self->path);
698 return BaseException_traverse((PyBaseExceptionObject *)self, visit, arg);
699}
700
701static PyObject *
702ImportError_str(PyImportErrorObject *self)
703{
Brett Cannon07c6e712012-08-24 13:05:09 -0400704 if (self->msg && PyUnicode_CheckExact(self->msg)) {
Brett Cannon79ec55e2012-04-12 20:24:54 -0400705 Py_INCREF(self->msg);
706 return self->msg;
707 }
708 else {
709 return BaseException_str((PyBaseExceptionObject *)self);
710 }
711}
712
Serhiy Storchakab7853962017-04-08 09:55:07 +0300713static PyObject *
714ImportError_getstate(PyImportErrorObject *self)
715{
716 PyObject *dict = ((PyBaseExceptionObject *)self)->dict;
717 if (self->name || self->path) {
718 _Py_IDENTIFIER(name);
719 _Py_IDENTIFIER(path);
720 dict = dict ? PyDict_Copy(dict) : PyDict_New();
721 if (dict == NULL)
722 return NULL;
723 if (self->name && _PyDict_SetItemId(dict, &PyId_name, self->name) < 0) {
724 Py_DECREF(dict);
725 return NULL;
726 }
727 if (self->path && _PyDict_SetItemId(dict, &PyId_path, self->path) < 0) {
728 Py_DECREF(dict);
729 return NULL;
730 }
731 return dict;
732 }
733 else if (dict) {
734 Py_INCREF(dict);
735 return dict;
736 }
737 else {
738 Py_RETURN_NONE;
739 }
740}
741
742/* Pickling support */
743static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +0530744ImportError_reduce(PyImportErrorObject *self, PyObject *Py_UNUSED(ignored))
Serhiy Storchakab7853962017-04-08 09:55:07 +0300745{
746 PyObject *res;
747 PyObject *args;
748 PyObject *state = ImportError_getstate(self);
749 if (state == NULL)
750 return NULL;
751 args = ((PyBaseExceptionObject *)self)->args;
752 if (state == Py_None)
753 res = PyTuple_Pack(2, Py_TYPE(self), args);
754 else
755 res = PyTuple_Pack(3, Py_TYPE(self), args, state);
756 Py_DECREF(state);
757 return res;
758}
759
Brett Cannon79ec55e2012-04-12 20:24:54 -0400760static PyMemberDef ImportError_members[] = {
761 {"msg", T_OBJECT, offsetof(PyImportErrorObject, msg), 0,
762 PyDoc_STR("exception message")},
763 {"name", T_OBJECT, offsetof(PyImportErrorObject, name), 0,
764 PyDoc_STR("module name")},
765 {"path", T_OBJECT, offsetof(PyImportErrorObject, path), 0,
766 PyDoc_STR("module path")},
767 {NULL} /* Sentinel */
768};
769
770static PyMethodDef ImportError_methods[] = {
Serhiy Storchakab7853962017-04-08 09:55:07 +0300771 {"__reduce__", (PyCFunction)ImportError_reduce, METH_NOARGS},
Brett Cannon79ec55e2012-04-12 20:24:54 -0400772 {NULL}
773};
774
775ComplexExtendsException(PyExc_Exception, ImportError,
776 ImportError, 0 /* new */,
777 ImportError_methods, ImportError_members,
778 0 /* getset */, ImportError_str,
779 "Import can't find module, or can't find name in "
780 "module.");
Thomas Wouters477c8d52006-05-27 19:21:47 +0000781
782/*
Eric Snowc9432652016-09-07 15:42:32 -0700783 * ModuleNotFoundError extends ImportError
784 */
785
786MiddlingExtendsException(PyExc_ImportError, ModuleNotFoundError, ImportError,
787 "Module not found.");
788
789/*
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200790 * OSError extends Exception
Thomas Wouters477c8d52006-05-27 19:21:47 +0000791 */
792
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200793#ifdef MS_WINDOWS
794#include "errmap.h"
795#endif
796
Thomas Wouters477c8d52006-05-27 19:21:47 +0000797/* Where a function has a single filename, such as open() or some
798 * of the os module functions, PyErr_SetFromErrnoWithFilename() is
799 * called, giving a third argument which is the filename. But, so
800 * that old code using in-place unpacking doesn't break, e.g.:
801 *
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200802 * except OSError, (errno, strerror):
Thomas Wouters477c8d52006-05-27 19:21:47 +0000803 *
804 * we hack args so that it only contains two items. This also
805 * means we need our own __str__() which prints out the filename
806 * when it was supplied.
Larry Hastingsb0827312014-02-09 22:05:19 -0800807 *
808 * (If a function has two filenames, such as rename(), symlink(),
Larry Hastings8f9f0f12014-02-10 03:43:57 -0800809 * or copy(), PyErr_SetFromErrnoWithFilenameObjects() is called,
810 * which allows passing in a second filename.)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000811 */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200812
Antoine Pitroue0e27352011-12-15 14:31:28 +0100813/* This function doesn't cleanup on error, the caller should */
814static int
815oserror_parse_args(PyObject **p_args,
816 PyObject **myerrno, PyObject **strerror,
Larry Hastingsb0827312014-02-09 22:05:19 -0800817 PyObject **filename, PyObject **filename2
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200818#ifdef MS_WINDOWS
Antoine Pitroue0e27352011-12-15 14:31:28 +0100819 , PyObject **winerror
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200820#endif
Antoine Pitroue0e27352011-12-15 14:31:28 +0100821 )
822{
823 Py_ssize_t nargs;
824 PyObject *args = *p_args;
Larry Hastingsb0827312014-02-09 22:05:19 -0800825#ifndef MS_WINDOWS
826 /*
827 * ignored on non-Windows platforms,
828 * but parsed so OSError has a consistent signature
829 */
830 PyObject *_winerror = NULL;
831 PyObject **winerror = &_winerror;
832#endif /* MS_WINDOWS */
Thomas Wouters477c8d52006-05-27 19:21:47 +0000833
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200834 nargs = PyTuple_GET_SIZE(args);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000835
Larry Hastingsb0827312014-02-09 22:05:19 -0800836 if (nargs >= 2 && nargs <= 5) {
837 if (!PyArg_UnpackTuple(args, "OSError", 2, 5,
838 myerrno, strerror,
839 filename, winerror, filename2))
Antoine Pitroue0e27352011-12-15 14:31:28 +0100840 return -1;
Larry Hastingsb0827312014-02-09 22:05:19 -0800841#ifdef MS_WINDOWS
Antoine Pitroue0e27352011-12-15 14:31:28 +0100842 if (*winerror && PyLong_Check(*winerror)) {
843 long errcode, winerrcode;
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200844 PyObject *newargs;
845 Py_ssize_t i;
846
Antoine Pitroue0e27352011-12-15 14:31:28 +0100847 winerrcode = PyLong_AsLong(*winerror);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200848 if (winerrcode == -1 && PyErr_Occurred())
Antoine Pitroue0e27352011-12-15 14:31:28 +0100849 return -1;
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200850 /* Set errno to the corresponding POSIX errno (overriding
851 first argument). Windows Socket error codes (>= 10000)
852 have the same value as their POSIX counterparts.
853 */
854 if (winerrcode < 10000)
855 errcode = winerror_to_errno(winerrcode);
856 else
857 errcode = winerrcode;
Antoine Pitroue0e27352011-12-15 14:31:28 +0100858 *myerrno = PyLong_FromLong(errcode);
859 if (!*myerrno)
860 return -1;
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200861 newargs = PyTuple_New(nargs);
862 if (!newargs)
Antoine Pitroue0e27352011-12-15 14:31:28 +0100863 return -1;
864 PyTuple_SET_ITEM(newargs, 0, *myerrno);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200865 for (i = 1; i < nargs; i++) {
866 PyObject *val = PyTuple_GET_ITEM(args, i);
867 Py_INCREF(val);
868 PyTuple_SET_ITEM(newargs, i, val);
869 }
870 Py_DECREF(args);
Antoine Pitroue0e27352011-12-15 14:31:28 +0100871 args = *p_args = newargs;
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200872 }
Larry Hastingsb0827312014-02-09 22:05:19 -0800873#endif /* MS_WINDOWS */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200874 }
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000875
Antoine Pitroue0e27352011-12-15 14:31:28 +0100876 return 0;
877}
Thomas Wouters477c8d52006-05-27 19:21:47 +0000878
Antoine Pitroue0e27352011-12-15 14:31:28 +0100879static int
880oserror_init(PyOSErrorObject *self, PyObject **p_args,
881 PyObject *myerrno, PyObject *strerror,
Larry Hastingsb0827312014-02-09 22:05:19 -0800882 PyObject *filename, PyObject *filename2
Antoine Pitroue0e27352011-12-15 14:31:28 +0100883#ifdef MS_WINDOWS
884 , PyObject *winerror
885#endif
886 )
887{
888 PyObject *args = *p_args;
889 Py_ssize_t nargs = PyTuple_GET_SIZE(args);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000890
891 /* self->filename will remain Py_None otherwise */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200892 if (filename && filename != Py_None) {
Andy Lesterdffe4c02020-03-04 07:15:20 -0600893 if (Py_IS_TYPE(self, (PyTypeObject *) PyExc_BlockingIOError) &&
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200894 PyNumber_Check(filename)) {
895 /* BlockingIOError's 3rd argument can be the number of
896 * characters written.
897 */
898 self->written = PyNumber_AsSsize_t(filename, PyExc_ValueError);
899 if (self->written == -1 && PyErr_Occurred())
Antoine Pitroue0e27352011-12-15 14:31:28 +0100900 return -1;
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200901 }
902 else {
903 Py_INCREF(filename);
904 self->filename = filename;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000905
Larry Hastingsb0827312014-02-09 22:05:19 -0800906 if (filename2 && filename2 != Py_None) {
907 Py_INCREF(filename2);
908 self->filename2 = filename2;
909 }
910
911 if (nargs >= 2 && nargs <= 5) {
912 /* filename, filename2, and winerror are removed from the args tuple
913 (for compatibility purposes, see test_exceptions.py) */
Antoine Pitroue0e27352011-12-15 14:31:28 +0100914 PyObject *subslice = PyTuple_GetSlice(args, 0, 2);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200915 if (!subslice)
Antoine Pitroue0e27352011-12-15 14:31:28 +0100916 return -1;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000917
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200918 Py_DECREF(args); /* replacing args */
Antoine Pitroue0e27352011-12-15 14:31:28 +0100919 *p_args = args = subslice;
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200920 }
921 }
Thomas Wouters477c8d52006-05-27 19:21:47 +0000922 }
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200923 Py_XINCREF(myerrno);
924 self->myerrno = myerrno;
925
926 Py_XINCREF(strerror);
927 self->strerror = strerror;
928
929#ifdef MS_WINDOWS
930 Py_XINCREF(winerror);
931 self->winerror = winerror;
932#endif
933
Antoine Pitroue0e27352011-12-15 14:31:28 +0100934 /* Steals the reference to args */
Serhiy Storchaka48842712016-04-06 09:45:48 +0300935 Py_XSETREF(self->args, args);
Victor Stinner46ef3192013-11-14 22:31:41 +0100936 *p_args = args = NULL;
Antoine Pitroue0e27352011-12-15 14:31:28 +0100937
938 return 0;
939}
940
941static PyObject *
942OSError_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
943static int
944OSError_init(PyOSErrorObject *self, PyObject *args, PyObject *kwds);
945
946static int
947oserror_use_init(PyTypeObject *type)
948{
Martin Panter7462b6492015-11-02 03:37:02 +0000949 /* When __init__ is defined in an OSError subclass, we want any
Antoine Pitroue0e27352011-12-15 14:31:28 +0100950 extraneous argument to __new__ to be ignored. The only reasonable
951 solution, given __new__ takes a variable number of arguments,
952 is to defer arg parsing and initialization to __init__.
953
Martin Pantere26da7c2016-06-02 10:07:09 +0000954 But when __new__ is overridden as well, it should call our __new__
Antoine Pitroue0e27352011-12-15 14:31:28 +0100955 with the right arguments.
956
957 (see http://bugs.python.org/issue12555#msg148829 )
958 */
959 if (type->tp_init != (initproc) OSError_init &&
960 type->tp_new == (newfunc) OSError_new) {
961 assert((PyObject *) type != PyExc_OSError);
962 return 1;
963 }
964 return 0;
965}
966
967static PyObject *
968OSError_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
969{
970 PyOSErrorObject *self = NULL;
Larry Hastingsb0827312014-02-09 22:05:19 -0800971 PyObject *myerrno = NULL, *strerror = NULL;
972 PyObject *filename = NULL, *filename2 = NULL;
Antoine Pitroue0e27352011-12-15 14:31:28 +0100973#ifdef MS_WINDOWS
974 PyObject *winerror = NULL;
975#endif
976
Victor Stinner46ef3192013-11-14 22:31:41 +0100977 Py_INCREF(args);
978
Antoine Pitroue0e27352011-12-15 14:31:28 +0100979 if (!oserror_use_init(type)) {
980 if (!_PyArg_NoKeywords(type->tp_name, kwds))
Victor Stinner46ef3192013-11-14 22:31:41 +0100981 goto error;
Antoine Pitroue0e27352011-12-15 14:31:28 +0100982
Larry Hastingsb0827312014-02-09 22:05:19 -0800983 if (oserror_parse_args(&args, &myerrno, &strerror,
984 &filename, &filename2
Antoine Pitroue0e27352011-12-15 14:31:28 +0100985#ifdef MS_WINDOWS
986 , &winerror
987#endif
988 ))
989 goto error;
990
Victor Stinner281cce12020-06-23 22:55:46 +0200991 struct _Py_exc_state *state = get_exc_state();
Antoine Pitroue0e27352011-12-15 14:31:28 +0100992 if (myerrno && PyLong_Check(myerrno) &&
Victor Stinner281cce12020-06-23 22:55:46 +0200993 state->errnomap && (PyObject *) type == PyExc_OSError) {
Antoine Pitroue0e27352011-12-15 14:31:28 +0100994 PyObject *newtype;
Victor Stinner281cce12020-06-23 22:55:46 +0200995 newtype = PyDict_GetItemWithError(state->errnomap, myerrno);
Antoine Pitroue0e27352011-12-15 14:31:28 +0100996 if (newtype) {
997 assert(PyType_Check(newtype));
998 type = (PyTypeObject *) newtype;
999 }
1000 else if (PyErr_Occurred())
1001 goto error;
1002 }
1003 }
1004
1005 self = (PyOSErrorObject *) type->tp_alloc(type, 0);
1006 if (!self)
1007 goto error;
1008
1009 self->dict = NULL;
1010 self->traceback = self->cause = self->context = NULL;
1011 self->written = -1;
1012
1013 if (!oserror_use_init(type)) {
Larry Hastingsb0827312014-02-09 22:05:19 -08001014 if (oserror_init(self, &args, myerrno, strerror, filename, filename2
Antoine Pitroue0e27352011-12-15 14:31:28 +01001015#ifdef MS_WINDOWS
1016 , winerror
1017#endif
1018 ))
1019 goto error;
1020 }
Antoine Pitrouf87289b2012-06-30 23:37:47 +02001021 else {
1022 self->args = PyTuple_New(0);
1023 if (self->args == NULL)
1024 goto error;
1025 }
Antoine Pitroue0e27352011-12-15 14:31:28 +01001026
Victor Stinner46ef3192013-11-14 22:31:41 +01001027 Py_XDECREF(args);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001028 return (PyObject *) self;
1029
1030error:
1031 Py_XDECREF(args);
1032 Py_XDECREF(self);
1033 return NULL;
1034}
1035
1036static int
Antoine Pitroue0e27352011-12-15 14:31:28 +01001037OSError_init(PyOSErrorObject *self, PyObject *args, PyObject *kwds)
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001038{
Larry Hastingsb0827312014-02-09 22:05:19 -08001039 PyObject *myerrno = NULL, *strerror = NULL;
1040 PyObject *filename = NULL, *filename2 = NULL;
Antoine Pitroue0e27352011-12-15 14:31:28 +01001041#ifdef MS_WINDOWS
1042 PyObject *winerror = NULL;
1043#endif
1044
1045 if (!oserror_use_init(Py_TYPE(self)))
1046 /* Everything already done in OSError_new */
1047 return 0;
1048
1049 if (!_PyArg_NoKeywords(Py_TYPE(self)->tp_name, kwds))
1050 return -1;
1051
1052 Py_INCREF(args);
Larry Hastingsb0827312014-02-09 22:05:19 -08001053 if (oserror_parse_args(&args, &myerrno, &strerror, &filename, &filename2
Antoine Pitroue0e27352011-12-15 14:31:28 +01001054#ifdef MS_WINDOWS
1055 , &winerror
1056#endif
1057 ))
1058 goto error;
1059
Larry Hastingsb0827312014-02-09 22:05:19 -08001060 if (oserror_init(self, &args, myerrno, strerror, filename, filename2
Antoine Pitroue0e27352011-12-15 14:31:28 +01001061#ifdef MS_WINDOWS
1062 , winerror
1063#endif
1064 ))
1065 goto error;
1066
Thomas Wouters477c8d52006-05-27 19:21:47 +00001067 return 0;
Antoine Pitroue0e27352011-12-15 14:31:28 +01001068
1069error:
Serhiy Storchaka37665722016-08-20 21:22:03 +03001070 Py_DECREF(args);
Antoine Pitroue0e27352011-12-15 14:31:28 +01001071 return -1;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001072}
1073
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001074static int
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001075OSError_clear(PyOSErrorObject *self)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001076{
1077 Py_CLEAR(self->myerrno);
1078 Py_CLEAR(self->strerror);
1079 Py_CLEAR(self->filename);
Larry Hastingsb0827312014-02-09 22:05:19 -08001080 Py_CLEAR(self->filename2);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001081#ifdef MS_WINDOWS
1082 Py_CLEAR(self->winerror);
1083#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +00001084 return BaseException_clear((PyBaseExceptionObject *)self);
1085}
1086
1087static void
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001088OSError_dealloc(PyOSErrorObject *self)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001089{
Thomas Wouters89f507f2006-12-13 04:49:30 +00001090 _PyObject_GC_UNTRACK(self);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001091 OSError_clear(self);
Christian Heimes90aa7642007-12-19 02:45:37 +00001092 Py_TYPE(self)->tp_free((PyObject *)self);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001093}
1094
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001095static int
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001096OSError_traverse(PyOSErrorObject *self, visitproc visit,
Thomas Wouters477c8d52006-05-27 19:21:47 +00001097 void *arg)
1098{
1099 Py_VISIT(self->myerrno);
1100 Py_VISIT(self->strerror);
1101 Py_VISIT(self->filename);
Larry Hastingsb0827312014-02-09 22:05:19 -08001102 Py_VISIT(self->filename2);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001103#ifdef MS_WINDOWS
1104 Py_VISIT(self->winerror);
1105#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +00001106 return BaseException_traverse((PyBaseExceptionObject *)self, visit, arg);
1107}
1108
1109static PyObject *
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001110OSError_str(PyOSErrorObject *self)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001111{
Larry Hastingsb0827312014-02-09 22:05:19 -08001112#define OR_NONE(x) ((x)?(x):Py_None)
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001113#ifdef MS_WINDOWS
1114 /* If available, winerror has the priority over myerrno */
Larry Hastingsb0827312014-02-09 22:05:19 -08001115 if (self->winerror && self->filename) {
1116 if (self->filename2) {
1117 return PyUnicode_FromFormat("[WinError %S] %S: %R -> %R",
1118 OR_NONE(self->winerror),
1119 OR_NONE(self->strerror),
1120 self->filename,
1121 self->filename2);
1122 } else {
1123 return PyUnicode_FromFormat("[WinError %S] %S: %R",
1124 OR_NONE(self->winerror),
1125 OR_NONE(self->strerror),
1126 self->filename);
1127 }
1128 }
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001129 if (self->winerror && self->strerror)
Richard Oudkerk30147712012-08-28 19:33:26 +01001130 return PyUnicode_FromFormat("[WinError %S] %S",
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001131 self->winerror ? self->winerror: Py_None,
1132 self->strerror ? self->strerror: Py_None);
1133#endif
Larry Hastingsb0827312014-02-09 22:05:19 -08001134 if (self->filename) {
1135 if (self->filename2) {
1136 return PyUnicode_FromFormat("[Errno %S] %S: %R -> %R",
1137 OR_NONE(self->myerrno),
1138 OR_NONE(self->strerror),
1139 self->filename,
1140 self->filename2);
1141 } else {
1142 return PyUnicode_FromFormat("[Errno %S] %S: %R",
1143 OR_NONE(self->myerrno),
1144 OR_NONE(self->strerror),
1145 self->filename);
1146 }
1147 }
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001148 if (self->myerrno && self->strerror)
Walter Dörwaldf5bec7c2007-05-26 15:03:32 +00001149 return PyUnicode_FromFormat("[Errno %S] %S",
Serhiy Storchaka37665722016-08-20 21:22:03 +03001150 self->myerrno, self->strerror);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001151 return BaseException_str((PyBaseExceptionObject *)self);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001152}
1153
Thomas Wouters477c8d52006-05-27 19:21:47 +00001154static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05301155OSError_reduce(PyOSErrorObject *self, PyObject *Py_UNUSED(ignored))
Thomas Wouters477c8d52006-05-27 19:21:47 +00001156{
1157 PyObject *args = self->args;
1158 PyObject *res = NULL, *tmp;
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001159
Thomas Wouters477c8d52006-05-27 19:21:47 +00001160 /* self->args is only the first two real arguments if there was a
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001161 * file name given to OSError. */
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001162 if (PyTuple_GET_SIZE(args) == 2 && self->filename) {
Larry Hastingsb0827312014-02-09 22:05:19 -08001163 Py_ssize_t size = self->filename2 ? 5 : 3;
1164 args = PyTuple_New(size);
Benjamin Peterson90b13582012-02-03 19:22:31 -05001165 if (!args)
1166 return NULL;
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001167
1168 tmp = PyTuple_GET_ITEM(self->args, 0);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001169 Py_INCREF(tmp);
1170 PyTuple_SET_ITEM(args, 0, tmp);
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001171
1172 tmp = PyTuple_GET_ITEM(self->args, 1);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001173 Py_INCREF(tmp);
1174 PyTuple_SET_ITEM(args, 1, tmp);
1175
1176 Py_INCREF(self->filename);
1177 PyTuple_SET_ITEM(args, 2, self->filename);
Larry Hastingsb0827312014-02-09 22:05:19 -08001178
1179 if (self->filename2) {
1180 /*
1181 * This tuple is essentially used as OSError(*args).
1182 * So, to recreate filename2, we need to pass in
1183 * winerror as well.
1184 */
1185 Py_INCREF(Py_None);
1186 PyTuple_SET_ITEM(args, 3, Py_None);
1187
1188 /* filename2 */
1189 Py_INCREF(self->filename2);
1190 PyTuple_SET_ITEM(args, 4, self->filename2);
1191 }
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001192 } else
Thomas Wouters477c8d52006-05-27 19:21:47 +00001193 Py_INCREF(args);
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001194
1195 if (self->dict)
Christian Heimes90aa7642007-12-19 02:45:37 +00001196 res = PyTuple_Pack(3, Py_TYPE(self), args, self->dict);
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001197 else
Christian Heimes90aa7642007-12-19 02:45:37 +00001198 res = PyTuple_Pack(2, Py_TYPE(self), args);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001199 Py_DECREF(args);
1200 return res;
1201}
1202
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001203static PyObject *
1204OSError_written_get(PyOSErrorObject *self, void *context)
1205{
1206 if (self->written == -1) {
1207 PyErr_SetString(PyExc_AttributeError, "characters_written");
1208 return NULL;
1209 }
1210 return PyLong_FromSsize_t(self->written);
1211}
Thomas Wouters477c8d52006-05-27 19:21:47 +00001212
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001213static int
1214OSError_written_set(PyOSErrorObject *self, PyObject *arg, void *context)
1215{
Serhiy Storchakae2af34f2018-12-17 16:43:14 +02001216 if (arg == NULL) {
1217 if (self->written == -1) {
1218 PyErr_SetString(PyExc_AttributeError, "characters_written");
1219 return -1;
1220 }
1221 self->written = -1;
1222 return 0;
1223 }
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001224 Py_ssize_t n;
1225 n = PyNumber_AsSsize_t(arg, PyExc_ValueError);
1226 if (n == -1 && PyErr_Occurred())
1227 return -1;
1228 self->written = n;
1229 return 0;
1230}
1231
1232static PyMemberDef OSError_members[] = {
1233 {"errno", T_OBJECT, offsetof(PyOSErrorObject, myerrno), 0,
1234 PyDoc_STR("POSIX exception code")},
1235 {"strerror", T_OBJECT, offsetof(PyOSErrorObject, strerror), 0,
1236 PyDoc_STR("exception strerror")},
1237 {"filename", T_OBJECT, offsetof(PyOSErrorObject, filename), 0,
1238 PyDoc_STR("exception filename")},
Larry Hastingsb0827312014-02-09 22:05:19 -08001239 {"filename2", T_OBJECT, offsetof(PyOSErrorObject, filename2), 0,
1240 PyDoc_STR("second exception filename")},
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001241#ifdef MS_WINDOWS
1242 {"winerror", T_OBJECT, offsetof(PyOSErrorObject, winerror), 0,
1243 PyDoc_STR("Win32 exception code")},
1244#endif
1245 {NULL} /* Sentinel */
1246};
1247
1248static PyMethodDef OSError_methods[] = {
1249 {"__reduce__", (PyCFunction)OSError_reduce, METH_NOARGS},
Thomas Wouters477c8d52006-05-27 19:21:47 +00001250 {NULL}
1251};
1252
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001253static PyGetSetDef OSError_getset[] = {
1254 {"characters_written", (getter) OSError_written_get,
1255 (setter) OSError_written_set, NULL},
1256 {NULL}
1257};
1258
1259
1260ComplexExtendsException(PyExc_Exception, OSError,
1261 OSError, OSError_new,
1262 OSError_methods, OSError_members, OSError_getset,
1263 OSError_str,
Thomas Wouters477c8d52006-05-27 19:21:47 +00001264 "Base class for I/O related errors.");
1265
1266
1267/*
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001268 * Various OSError subclasses
Thomas Wouters477c8d52006-05-27 19:21:47 +00001269 */
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001270MiddlingExtendsException(PyExc_OSError, BlockingIOError, OSError,
1271 "I/O operation would block.");
1272MiddlingExtendsException(PyExc_OSError, ConnectionError, OSError,
1273 "Connection error.");
1274MiddlingExtendsException(PyExc_OSError, ChildProcessError, OSError,
1275 "Child process error.");
1276MiddlingExtendsException(PyExc_ConnectionError, BrokenPipeError, OSError,
1277 "Broken pipe.");
1278MiddlingExtendsException(PyExc_ConnectionError, ConnectionAbortedError, OSError,
1279 "Connection aborted.");
1280MiddlingExtendsException(PyExc_ConnectionError, ConnectionRefusedError, OSError,
1281 "Connection refused.");
1282MiddlingExtendsException(PyExc_ConnectionError, ConnectionResetError, OSError,
1283 "Connection reset.");
1284MiddlingExtendsException(PyExc_OSError, FileExistsError, OSError,
1285 "File already exists.");
1286MiddlingExtendsException(PyExc_OSError, FileNotFoundError, OSError,
1287 "File not found.");
1288MiddlingExtendsException(PyExc_OSError, IsADirectoryError, OSError,
1289 "Operation doesn't work on directories.");
1290MiddlingExtendsException(PyExc_OSError, NotADirectoryError, OSError,
1291 "Operation only works on directories.");
1292MiddlingExtendsException(PyExc_OSError, InterruptedError, OSError,
1293 "Interrupted by signal.");
1294MiddlingExtendsException(PyExc_OSError, PermissionError, OSError,
1295 "Not enough permissions.");
1296MiddlingExtendsException(PyExc_OSError, ProcessLookupError, OSError,
1297 "Process not found.");
1298MiddlingExtendsException(PyExc_OSError, TimeoutError, OSError,
1299 "Timeout expired.");
Thomas Wouters477c8d52006-05-27 19:21:47 +00001300
1301/*
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001302 * EOFError extends Exception
Thomas Wouters477c8d52006-05-27 19:21:47 +00001303 */
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001304SimpleExtendsException(PyExc_Exception, EOFError,
Thomas Wouters477c8d52006-05-27 19:21:47 +00001305 "Read beyond end of file.");
1306
1307
1308/*
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001309 * RuntimeError extends Exception
Thomas Wouters477c8d52006-05-27 19:21:47 +00001310 */
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001311SimpleExtendsException(PyExc_Exception, RuntimeError,
Thomas Wouters477c8d52006-05-27 19:21:47 +00001312 "Unspecified run-time error.");
1313
Yury Selivanovf488fb42015-07-03 01:04:23 -04001314/*
1315 * RecursionError extends RuntimeError
1316 */
1317SimpleExtendsException(PyExc_RuntimeError, RecursionError,
1318 "Recursion limit exceeded.");
Thomas Wouters477c8d52006-05-27 19:21:47 +00001319
1320/*
1321 * NotImplementedError extends RuntimeError
1322 */
1323SimpleExtendsException(PyExc_RuntimeError, NotImplementedError,
1324 "Method or function hasn't been implemented yet.");
1325
1326/*
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001327 * NameError extends Exception
Thomas Wouters477c8d52006-05-27 19:21:47 +00001328 */
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001329SimpleExtendsException(PyExc_Exception, NameError,
Thomas Wouters477c8d52006-05-27 19:21:47 +00001330 "Name not found globally.");
1331
1332/*
1333 * UnboundLocalError extends NameError
1334 */
1335SimpleExtendsException(PyExc_NameError, UnboundLocalError,
1336 "Local name referenced but not bound to a value.");
1337
1338/*
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001339 * AttributeError extends Exception
Thomas Wouters477c8d52006-05-27 19:21:47 +00001340 */
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001341SimpleExtendsException(PyExc_Exception, AttributeError,
Thomas Wouters477c8d52006-05-27 19:21:47 +00001342 "Attribute not found.");
1343
1344
1345/*
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001346 * SyntaxError extends Exception
Thomas Wouters477c8d52006-05-27 19:21:47 +00001347 */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001348
Raymond Hettinger7ea386e2016-08-25 21:11:50 -07001349/* Helper function to customize error message for some syntax errors */
Nick Coghlan5b1fdc12014-06-16 19:48:02 +10001350static int _report_missing_parentheses(PySyntaxErrorObject *self);
1351
Thomas Wouters477c8d52006-05-27 19:21:47 +00001352static int
1353SyntaxError_init(PySyntaxErrorObject *self, PyObject *args, PyObject *kwds)
1354{
1355 PyObject *info = NULL;
1356 Py_ssize_t lenargs = PyTuple_GET_SIZE(args);
1357
1358 if (BaseException_init((PyBaseExceptionObject *)self, args, kwds) == -1)
1359 return -1;
1360
1361 if (lenargs >= 1) {
Serhiy Storchaka4a1e70f2015-12-27 12:36:18 +02001362 Py_INCREF(PyTuple_GET_ITEM(args, 0));
Serhiy Storchaka48842712016-04-06 09:45:48 +03001363 Py_XSETREF(self->msg, PyTuple_GET_ITEM(args, 0));
Thomas Wouters477c8d52006-05-27 19:21:47 +00001364 }
1365 if (lenargs == 2) {
1366 info = PyTuple_GET_ITEM(args, 1);
1367 info = PySequence_Tuple(info);
Benjamin Peterson90b13582012-02-03 19:22:31 -05001368 if (!info)
1369 return -1;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001370
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001371 if (PyTuple_GET_SIZE(info) != 4) {
1372 /* not a very good error message, but it's what Python 2.4 gives */
1373 PyErr_SetString(PyExc_IndexError, "tuple index out of range");
1374 Py_DECREF(info);
1375 return -1;
1376 }
1377
Serhiy Storchaka4a1e70f2015-12-27 12:36:18 +02001378 Py_INCREF(PyTuple_GET_ITEM(info, 0));
Serhiy Storchaka48842712016-04-06 09:45:48 +03001379 Py_XSETREF(self->filename, PyTuple_GET_ITEM(info, 0));
Thomas Wouters477c8d52006-05-27 19:21:47 +00001380
Serhiy Storchaka4a1e70f2015-12-27 12:36:18 +02001381 Py_INCREF(PyTuple_GET_ITEM(info, 1));
Serhiy Storchaka48842712016-04-06 09:45:48 +03001382 Py_XSETREF(self->lineno, PyTuple_GET_ITEM(info, 1));
Thomas Wouters477c8d52006-05-27 19:21:47 +00001383
Serhiy Storchaka4a1e70f2015-12-27 12:36:18 +02001384 Py_INCREF(PyTuple_GET_ITEM(info, 2));
Serhiy Storchaka48842712016-04-06 09:45:48 +03001385 Py_XSETREF(self->offset, PyTuple_GET_ITEM(info, 2));
Thomas Wouters477c8d52006-05-27 19:21:47 +00001386
Serhiy Storchaka4a1e70f2015-12-27 12:36:18 +02001387 Py_INCREF(PyTuple_GET_ITEM(info, 3));
Serhiy Storchaka48842712016-04-06 09:45:48 +03001388 Py_XSETREF(self->text, PyTuple_GET_ITEM(info, 3));
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001389
1390 Py_DECREF(info);
Nick Coghlan5b1fdc12014-06-16 19:48:02 +10001391
Martijn Pieters772d8092017-08-22 21:16:23 +01001392 /*
1393 * Issue #21669: Custom error for 'print' & 'exec' as statements
1394 *
1395 * Only applies to SyntaxError instances, not to subclasses such
1396 * as TabError or IndentationError (see issue #31161)
1397 */
Andy Lesterdffe4c02020-03-04 07:15:20 -06001398 if (Py_IS_TYPE(self, (PyTypeObject *)PyExc_SyntaxError) &&
Martijn Pieters772d8092017-08-22 21:16:23 +01001399 self->text && PyUnicode_Check(self->text) &&
1400 _report_missing_parentheses(self) < 0) {
1401 return -1;
Nick Coghlan5b1fdc12014-06-16 19:48:02 +10001402 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001403 }
1404 return 0;
1405}
1406
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001407static int
Thomas Wouters477c8d52006-05-27 19:21:47 +00001408SyntaxError_clear(PySyntaxErrorObject *self)
1409{
1410 Py_CLEAR(self->msg);
1411 Py_CLEAR(self->filename);
1412 Py_CLEAR(self->lineno);
1413 Py_CLEAR(self->offset);
1414 Py_CLEAR(self->text);
1415 Py_CLEAR(self->print_file_and_line);
1416 return BaseException_clear((PyBaseExceptionObject *)self);
1417}
1418
1419static void
1420SyntaxError_dealloc(PySyntaxErrorObject *self)
1421{
Thomas Wouters89f507f2006-12-13 04:49:30 +00001422 _PyObject_GC_UNTRACK(self);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001423 SyntaxError_clear(self);
Christian Heimes90aa7642007-12-19 02:45:37 +00001424 Py_TYPE(self)->tp_free((PyObject *)self);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001425}
1426
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001427static int
Thomas Wouters477c8d52006-05-27 19:21:47 +00001428SyntaxError_traverse(PySyntaxErrorObject *self, visitproc visit, void *arg)
1429{
1430 Py_VISIT(self->msg);
1431 Py_VISIT(self->filename);
1432 Py_VISIT(self->lineno);
1433 Py_VISIT(self->offset);
1434 Py_VISIT(self->text);
1435 Py_VISIT(self->print_file_and_line);
1436 return BaseException_traverse((PyBaseExceptionObject *)self, visit, arg);
1437}
1438
1439/* This is called "my_basename" instead of just "basename" to avoid name
1440 conflicts with glibc; basename is already prototyped if _GNU_SOURCE is
1441 defined, and Python does define that. */
Victor Stinner6237daf2010-04-28 17:26:19 +00001442static PyObject*
1443my_basename(PyObject *name)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001444{
Victor Stinner6237daf2010-04-28 17:26:19 +00001445 Py_ssize_t i, size, offset;
Victor Stinner31392e72011-10-05 20:14:23 +02001446 int kind;
Serhiy Storchakacd8295f2020-04-11 10:48:40 +03001447 const void *data;
Victor Stinner31392e72011-10-05 20:14:23 +02001448
1449 if (PyUnicode_READY(name))
1450 return NULL;
1451 kind = PyUnicode_KIND(name);
1452 data = PyUnicode_DATA(name);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001453 size = PyUnicode_GET_LENGTH(name);
Victor Stinner6237daf2010-04-28 17:26:19 +00001454 offset = 0;
1455 for(i=0; i < size; i++) {
Victor Stinner361dcdc2020-04-15 03:24:57 +02001456 if (PyUnicode_READ(kind, data, i) == SEP) {
Victor Stinner6237daf2010-04-28 17:26:19 +00001457 offset = i + 1;
Victor Stinner361dcdc2020-04-15 03:24:57 +02001458 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001459 }
Victor Stinner361dcdc2020-04-15 03:24:57 +02001460 if (offset != 0) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001461 return PyUnicode_Substring(name, offset, size);
Victor Stinner361dcdc2020-04-15 03:24:57 +02001462 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001463 else {
Victor Stinner6237daf2010-04-28 17:26:19 +00001464 Py_INCREF(name);
1465 return name;
1466 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001467}
1468
1469
1470static PyObject *
1471SyntaxError_str(PySyntaxErrorObject *self)
1472{
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001473 int have_lineno = 0;
Victor Stinner6237daf2010-04-28 17:26:19 +00001474 PyObject *filename;
1475 PyObject *result;
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +00001476 /* Below, we always ignore overflow errors, just printing -1.
1477 Still, we cannot allow an OverflowError to be raised, so
1478 we need to call PyLong_AsLongAndOverflow. */
1479 int overflow;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001480
1481 /* XXX -- do all the additional formatting with filename and
1482 lineno here */
1483
Neal Norwitzed2b7392007-08-26 04:51:10 +00001484 if (self->filename && PyUnicode_Check(self->filename)) {
Victor Stinner6237daf2010-04-28 17:26:19 +00001485 filename = my_basename(self->filename);
1486 if (filename == NULL)
1487 return NULL;
1488 } else {
1489 filename = NULL;
Martin v. Löwis10a60b32007-07-18 02:28:27 +00001490 }
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +00001491 have_lineno = (self->lineno != NULL) && PyLong_CheckExact(self->lineno);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001492
Martin v. Löwis10a60b32007-07-18 02:28:27 +00001493 if (!filename && !have_lineno)
Thomas Heller519a0422007-11-15 20:48:54 +00001494 return PyObject_Str(self->msg ? self->msg : Py_None);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001495
Martin v. Löwis10a60b32007-07-18 02:28:27 +00001496 if (filename && have_lineno)
Victor Stinner6237daf2010-04-28 17:26:19 +00001497 result = PyUnicode_FromFormat("%S (%U, line %ld)",
Walter Dörwaldf5bec7c2007-05-26 15:03:32 +00001498 self->msg ? self->msg : Py_None,
Victor Stinner6237daf2010-04-28 17:26:19 +00001499 filename,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001500 PyLong_AsLongAndOverflow(self->lineno, &overflow));
Martin v. Löwis10a60b32007-07-18 02:28:27 +00001501 else if (filename)
Victor Stinner6237daf2010-04-28 17:26:19 +00001502 result = PyUnicode_FromFormat("%S (%U)",
Walter Dörwaldf5bec7c2007-05-26 15:03:32 +00001503 self->msg ? self->msg : Py_None,
Victor Stinner6237daf2010-04-28 17:26:19 +00001504 filename);
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001505 else /* only have_lineno */
Victor Stinner6237daf2010-04-28 17:26:19 +00001506 result = PyUnicode_FromFormat("%S (line %ld)",
Walter Dörwaldf5bec7c2007-05-26 15:03:32 +00001507 self->msg ? self->msg : Py_None,
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +00001508 PyLong_AsLongAndOverflow(self->lineno, &overflow));
Victor Stinner6237daf2010-04-28 17:26:19 +00001509 Py_XDECREF(filename);
1510 return result;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001511}
1512
1513static PyMemberDef SyntaxError_members[] = {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001514 {"msg", T_OBJECT, offsetof(PySyntaxErrorObject, msg), 0,
1515 PyDoc_STR("exception msg")},
1516 {"filename", T_OBJECT, offsetof(PySyntaxErrorObject, filename), 0,
1517 PyDoc_STR("exception filename")},
1518 {"lineno", T_OBJECT, offsetof(PySyntaxErrorObject, lineno), 0,
1519 PyDoc_STR("exception lineno")},
1520 {"offset", T_OBJECT, offsetof(PySyntaxErrorObject, offset), 0,
1521 PyDoc_STR("exception offset")},
1522 {"text", T_OBJECT, offsetof(PySyntaxErrorObject, text), 0,
1523 PyDoc_STR("exception text")},
1524 {"print_file_and_line", T_OBJECT,
1525 offsetof(PySyntaxErrorObject, print_file_and_line), 0,
1526 PyDoc_STR("exception print_file_and_line")},
1527 {NULL} /* Sentinel */
1528};
1529
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001530ComplexExtendsException(PyExc_Exception, SyntaxError, SyntaxError,
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001531 0, 0, SyntaxError_members, 0,
Thomas Wouters477c8d52006-05-27 19:21:47 +00001532 SyntaxError_str, "Invalid syntax.");
1533
1534
1535/*
1536 * IndentationError extends SyntaxError
1537 */
1538MiddlingExtendsException(PyExc_SyntaxError, IndentationError, SyntaxError,
1539 "Improper indentation.");
1540
1541
1542/*
1543 * TabError extends IndentationError
1544 */
1545MiddlingExtendsException(PyExc_IndentationError, TabError, SyntaxError,
1546 "Improper mixture of spaces and tabs.");
1547
1548
1549/*
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001550 * LookupError extends Exception
Thomas Wouters477c8d52006-05-27 19:21:47 +00001551 */
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001552SimpleExtendsException(PyExc_Exception, LookupError,
Thomas Wouters477c8d52006-05-27 19:21:47 +00001553 "Base class for lookup errors.");
1554
1555
1556/*
1557 * IndexError extends LookupError
1558 */
1559SimpleExtendsException(PyExc_LookupError, IndexError,
1560 "Sequence index out of range.");
1561
1562
1563/*
1564 * KeyError extends LookupError
1565 */
1566static PyObject *
1567KeyError_str(PyBaseExceptionObject *self)
1568{
1569 /* If args is a tuple of exactly one item, apply repr to args[0].
1570 This is done so that e.g. the exception raised by {}[''] prints
1571 KeyError: ''
1572 rather than the confusing
1573 KeyError
1574 alone. The downside is that if KeyError is raised with an explanatory
1575 string, that string will be displayed in quotes. Too bad.
1576 If args is anything else, use the default BaseException__str__().
1577 */
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001578 if (PyTuple_GET_SIZE(self->args) == 1) {
Walter Dörwaldf5bec7c2007-05-26 15:03:32 +00001579 return PyObject_Repr(PyTuple_GET_ITEM(self->args, 0));
Thomas Wouters477c8d52006-05-27 19:21:47 +00001580 }
1581 return BaseException_str(self);
1582}
1583
1584ComplexExtendsException(PyExc_LookupError, KeyError, BaseException,
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02001585 0, 0, 0, 0, KeyError_str, "Mapping key not found.");
Thomas Wouters477c8d52006-05-27 19:21:47 +00001586
1587
1588/*
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001589 * ValueError extends Exception
Thomas Wouters477c8d52006-05-27 19:21:47 +00001590 */
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001591SimpleExtendsException(PyExc_Exception, ValueError,
Thomas Wouters477c8d52006-05-27 19:21:47 +00001592 "Inappropriate argument value (of correct type).");
1593
1594/*
1595 * UnicodeError extends ValueError
1596 */
1597
1598SimpleExtendsException(PyExc_ValueError, UnicodeError,
1599 "Unicode related error.");
1600
Thomas Wouters477c8d52006-05-27 19:21:47 +00001601static PyObject *
Guido van Rossum98297ee2007-11-06 21:34:58 +00001602get_string(PyObject *attr, const char *name)
Walter Dörwald612344f2007-05-04 19:28:21 +00001603{
1604 if (!attr) {
1605 PyErr_Format(PyExc_TypeError, "%.200s attribute not set", name);
1606 return NULL;
1607 }
1608
Christian Heimes72b710a2008-05-26 13:28:38 +00001609 if (!PyBytes_Check(attr)) {
Walter Dörwald612344f2007-05-04 19:28:21 +00001610 PyErr_Format(PyExc_TypeError, "%.200s attribute must be bytes", name);
1611 return NULL;
1612 }
1613 Py_INCREF(attr);
1614 return attr;
1615}
1616
1617static PyObject *
Thomas Wouters477c8d52006-05-27 19:21:47 +00001618get_unicode(PyObject *attr, const char *name)
1619{
1620 if (!attr) {
1621 PyErr_Format(PyExc_TypeError, "%.200s attribute not set", name);
1622 return NULL;
1623 }
1624
1625 if (!PyUnicode_Check(attr)) {
1626 PyErr_Format(PyExc_TypeError,
1627 "%.200s attribute must be unicode", name);
1628 return NULL;
1629 }
1630 Py_INCREF(attr);
1631 return attr;
1632}
1633
Walter Dörwaldd2034312007-05-18 16:29:38 +00001634static int
1635set_unicodefromstring(PyObject **attr, const char *value)
1636{
1637 PyObject *obj = PyUnicode_FromString(value);
1638 if (!obj)
1639 return -1;
Serhiy Storchaka48842712016-04-06 09:45:48 +03001640 Py_XSETREF(*attr, obj);
Walter Dörwaldd2034312007-05-18 16:29:38 +00001641 return 0;
1642}
1643
Thomas Wouters477c8d52006-05-27 19:21:47 +00001644PyObject *
1645PyUnicodeEncodeError_GetEncoding(PyObject *exc)
1646{
Walter Dörwaldd2034312007-05-18 16:29:38 +00001647 return get_unicode(((PyUnicodeErrorObject *)exc)->encoding, "encoding");
Thomas Wouters477c8d52006-05-27 19:21:47 +00001648}
1649
1650PyObject *
1651PyUnicodeDecodeError_GetEncoding(PyObject *exc)
1652{
Walter Dörwaldd2034312007-05-18 16:29:38 +00001653 return get_unicode(((PyUnicodeErrorObject *)exc)->encoding, "encoding");
Thomas Wouters477c8d52006-05-27 19:21:47 +00001654}
1655
1656PyObject *
1657PyUnicodeEncodeError_GetObject(PyObject *exc)
1658{
1659 return get_unicode(((PyUnicodeErrorObject *)exc)->object, "object");
1660}
1661
1662PyObject *
1663PyUnicodeDecodeError_GetObject(PyObject *exc)
1664{
Guido van Rossum98297ee2007-11-06 21:34:58 +00001665 return get_string(((PyUnicodeErrorObject *)exc)->object, "object");
Thomas Wouters477c8d52006-05-27 19:21:47 +00001666}
1667
1668PyObject *
1669PyUnicodeTranslateError_GetObject(PyObject *exc)
1670{
1671 return get_unicode(((PyUnicodeErrorObject *)exc)->object, "object");
1672}
1673
1674int
1675PyUnicodeEncodeError_GetStart(PyObject *exc, Py_ssize_t *start)
1676{
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001677 Py_ssize_t size;
1678 PyObject *obj = get_unicode(((PyUnicodeErrorObject *)exc)->object,
1679 "object");
1680 if (!obj)
1681 return -1;
1682 *start = ((PyUnicodeErrorObject *)exc)->start;
Victor Stinner9e30aa52011-11-21 02:49:52 +01001683 size = PyUnicode_GET_LENGTH(obj);
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001684 if (*start<0)
1685 *start = 0; /*XXX check for values <0*/
1686 if (*start>=size)
1687 *start = size-1;
1688 Py_DECREF(obj);
1689 return 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001690}
1691
1692
1693int
1694PyUnicodeDecodeError_GetStart(PyObject *exc, Py_ssize_t *start)
1695{
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001696 Py_ssize_t size;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001697 PyObject *obj = get_string(((PyUnicodeErrorObject *)exc)->object, "object");
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001698 if (!obj)
1699 return -1;
Christian Heimes72b710a2008-05-26 13:28:38 +00001700 size = PyBytes_GET_SIZE(obj);
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001701 *start = ((PyUnicodeErrorObject *)exc)->start;
1702 if (*start<0)
1703 *start = 0;
1704 if (*start>=size)
1705 *start = size-1;
1706 Py_DECREF(obj);
1707 return 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001708}
1709
1710
1711int
1712PyUnicodeTranslateError_GetStart(PyObject *exc, Py_ssize_t *start)
1713{
1714 return PyUnicodeEncodeError_GetStart(exc, start);
1715}
1716
1717
1718int
1719PyUnicodeEncodeError_SetStart(PyObject *exc, Py_ssize_t start)
1720{
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001721 ((PyUnicodeErrorObject *)exc)->start = start;
1722 return 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001723}
1724
1725
1726int
1727PyUnicodeDecodeError_SetStart(PyObject *exc, Py_ssize_t start)
1728{
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001729 ((PyUnicodeErrorObject *)exc)->start = start;
1730 return 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001731}
1732
1733
1734int
1735PyUnicodeTranslateError_SetStart(PyObject *exc, Py_ssize_t start)
1736{
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001737 ((PyUnicodeErrorObject *)exc)->start = start;
1738 return 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001739}
1740
1741
1742int
1743PyUnicodeEncodeError_GetEnd(PyObject *exc, Py_ssize_t *end)
1744{
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001745 Py_ssize_t size;
1746 PyObject *obj = get_unicode(((PyUnicodeErrorObject *)exc)->object,
1747 "object");
1748 if (!obj)
1749 return -1;
1750 *end = ((PyUnicodeErrorObject *)exc)->end;
Victor Stinner9e30aa52011-11-21 02:49:52 +01001751 size = PyUnicode_GET_LENGTH(obj);
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001752 if (*end<1)
1753 *end = 1;
1754 if (*end>size)
1755 *end = size;
1756 Py_DECREF(obj);
1757 return 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001758}
1759
1760
1761int
1762PyUnicodeDecodeError_GetEnd(PyObject *exc, Py_ssize_t *end)
1763{
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001764 Py_ssize_t size;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001765 PyObject *obj = get_string(((PyUnicodeErrorObject *)exc)->object, "object");
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001766 if (!obj)
1767 return -1;
Christian Heimes72b710a2008-05-26 13:28:38 +00001768 size = PyBytes_GET_SIZE(obj);
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001769 *end = ((PyUnicodeErrorObject *)exc)->end;
1770 if (*end<1)
1771 *end = 1;
1772 if (*end>size)
1773 *end = size;
1774 Py_DECREF(obj);
1775 return 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001776}
1777
1778
1779int
Max Bernsteine6a0e802019-04-02 01:16:22 -07001780PyUnicodeTranslateError_GetEnd(PyObject *exc, Py_ssize_t *end)
Thomas Wouters477c8d52006-05-27 19:21:47 +00001781{
Max Bernsteine6a0e802019-04-02 01:16:22 -07001782 return PyUnicodeEncodeError_GetEnd(exc, end);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001783}
1784
1785
1786int
1787PyUnicodeEncodeError_SetEnd(PyObject *exc, Py_ssize_t end)
1788{
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001789 ((PyUnicodeErrorObject *)exc)->end = end;
1790 return 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001791}
1792
1793
1794int
1795PyUnicodeDecodeError_SetEnd(PyObject *exc, Py_ssize_t end)
1796{
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001797 ((PyUnicodeErrorObject *)exc)->end = end;
1798 return 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001799}
1800
1801
1802int
1803PyUnicodeTranslateError_SetEnd(PyObject *exc, Py_ssize_t end)
1804{
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001805 ((PyUnicodeErrorObject *)exc)->end = end;
1806 return 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001807}
1808
1809PyObject *
1810PyUnicodeEncodeError_GetReason(PyObject *exc)
1811{
Walter Dörwaldd2034312007-05-18 16:29:38 +00001812 return get_unicode(((PyUnicodeErrorObject *)exc)->reason, "reason");
Thomas Wouters477c8d52006-05-27 19:21:47 +00001813}
1814
1815
1816PyObject *
1817PyUnicodeDecodeError_GetReason(PyObject *exc)
1818{
Walter Dörwaldd2034312007-05-18 16:29:38 +00001819 return get_unicode(((PyUnicodeErrorObject *)exc)->reason, "reason");
Thomas Wouters477c8d52006-05-27 19:21:47 +00001820}
1821
1822
1823PyObject *
1824PyUnicodeTranslateError_GetReason(PyObject *exc)
1825{
Walter Dörwaldd2034312007-05-18 16:29:38 +00001826 return get_unicode(((PyUnicodeErrorObject *)exc)->reason, "reason");
Thomas Wouters477c8d52006-05-27 19:21:47 +00001827}
1828
1829
1830int
1831PyUnicodeEncodeError_SetReason(PyObject *exc, const char *reason)
1832{
Walter Dörwaldd2034312007-05-18 16:29:38 +00001833 return set_unicodefromstring(&((PyUnicodeErrorObject *)exc)->reason,
1834 reason);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001835}
1836
1837
1838int
1839PyUnicodeDecodeError_SetReason(PyObject *exc, const char *reason)
1840{
Walter Dörwaldd2034312007-05-18 16:29:38 +00001841 return set_unicodefromstring(&((PyUnicodeErrorObject *)exc)->reason,
1842 reason);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001843}
1844
1845
1846int
1847PyUnicodeTranslateError_SetReason(PyObject *exc, const char *reason)
1848{
Walter Dörwaldd2034312007-05-18 16:29:38 +00001849 return set_unicodefromstring(&((PyUnicodeErrorObject *)exc)->reason,
1850 reason);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001851}
1852
1853
Thomas Wouters477c8d52006-05-27 19:21:47 +00001854static int
Thomas Wouters477c8d52006-05-27 19:21:47 +00001855UnicodeError_clear(PyUnicodeErrorObject *self)
1856{
1857 Py_CLEAR(self->encoding);
1858 Py_CLEAR(self->object);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001859 Py_CLEAR(self->reason);
1860 return BaseException_clear((PyBaseExceptionObject *)self);
1861}
1862
1863static void
1864UnicodeError_dealloc(PyUnicodeErrorObject *self)
1865{
Thomas Wouters89f507f2006-12-13 04:49:30 +00001866 _PyObject_GC_UNTRACK(self);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001867 UnicodeError_clear(self);
Christian Heimes90aa7642007-12-19 02:45:37 +00001868 Py_TYPE(self)->tp_free((PyObject *)self);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001869}
1870
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001871static int
Thomas Wouters477c8d52006-05-27 19:21:47 +00001872UnicodeError_traverse(PyUnicodeErrorObject *self, visitproc visit, void *arg)
1873{
1874 Py_VISIT(self->encoding);
1875 Py_VISIT(self->object);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001876 Py_VISIT(self->reason);
1877 return BaseException_traverse((PyBaseExceptionObject *)self, visit, arg);
1878}
1879
1880static PyMemberDef UnicodeError_members[] = {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001881 {"encoding", T_OBJECT, offsetof(PyUnicodeErrorObject, encoding), 0,
1882 PyDoc_STR("exception encoding")},
1883 {"object", T_OBJECT, offsetof(PyUnicodeErrorObject, object), 0,
1884 PyDoc_STR("exception object")},
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001885 {"start", T_PYSSIZET, offsetof(PyUnicodeErrorObject, start), 0,
Thomas Wouters477c8d52006-05-27 19:21:47 +00001886 PyDoc_STR("exception start")},
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001887 {"end", T_PYSSIZET, offsetof(PyUnicodeErrorObject, end), 0,
Thomas Wouters477c8d52006-05-27 19:21:47 +00001888 PyDoc_STR("exception end")},
1889 {"reason", T_OBJECT, offsetof(PyUnicodeErrorObject, reason), 0,
1890 PyDoc_STR("exception reason")},
1891 {NULL} /* Sentinel */
1892};
1893
1894
1895/*
1896 * UnicodeEncodeError extends UnicodeError
1897 */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001898
1899static int
1900UnicodeEncodeError_init(PyObject *self, PyObject *args, PyObject *kwds)
1901{
Guido van Rossum98297ee2007-11-06 21:34:58 +00001902 PyUnicodeErrorObject *err;
1903
Thomas Wouters477c8d52006-05-27 19:21:47 +00001904 if (BaseException_init((PyBaseExceptionObject *)self, args, kwds) == -1)
1905 return -1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001906
1907 err = (PyUnicodeErrorObject *)self;
1908
1909 Py_CLEAR(err->encoding);
1910 Py_CLEAR(err->object);
1911 Py_CLEAR(err->reason);
1912
Serhiy Storchakaf8d7d412016-10-23 15:12:25 +03001913 if (!PyArg_ParseTuple(args, "UUnnU",
1914 &err->encoding, &err->object,
1915 &err->start, &err->end, &err->reason)) {
1916 err->encoding = err->object = err->reason = NULL;
Martin v. Löwisb09af032011-11-04 11:16:41 +01001917 return -1;
1918 }
1919
Guido van Rossum98297ee2007-11-06 21:34:58 +00001920 Py_INCREF(err->encoding);
1921 Py_INCREF(err->object);
1922 Py_INCREF(err->reason);
1923
1924 return 0;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001925}
1926
1927static PyObject *
1928UnicodeEncodeError_str(PyObject *self)
1929{
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001930 PyUnicodeErrorObject *uself = (PyUnicodeErrorObject *)self;
Eric Smith0facd772010-02-24 15:42:29 +00001931 PyObject *result = NULL;
1932 PyObject *reason_str = NULL;
1933 PyObject *encoding_str = NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001934
Benjamin Peterson9b09ba12014-04-02 12:15:06 -04001935 if (!uself->object)
1936 /* Not properly initialized. */
1937 return PyUnicode_FromString("");
1938
Eric Smith0facd772010-02-24 15:42:29 +00001939 /* Get reason and encoding as strings, which they might not be if
Martin Pantereb995702016-07-28 01:11:04 +00001940 they've been modified after we were constructed. */
Eric Smith0facd772010-02-24 15:42:29 +00001941 reason_str = PyObject_Str(uself->reason);
1942 if (reason_str == NULL)
1943 goto done;
1944 encoding_str = PyObject_Str(uself->encoding);
1945 if (encoding_str == NULL)
1946 goto done;
1947
Victor Stinnerda1ddf32011-11-20 22:50:23 +01001948 if (uself->start < PyUnicode_GET_LENGTH(uself->object) && uself->end == uself->start+1) {
1949 Py_UCS4 badchar = PyUnicode_ReadChar(uself->object, uself->start);
Walter Dörwald787b03b2007-06-05 13:29:29 +00001950 const char *fmt;
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001951 if (badchar <= 0xff)
Walter Dörwald32a4c712007-06-20 09:25:34 +00001952 fmt = "'%U' codec can't encode character '\\x%02x' in position %zd: %U";
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001953 else if (badchar <= 0xffff)
Walter Dörwald32a4c712007-06-20 09:25:34 +00001954 fmt = "'%U' codec can't encode character '\\u%04x' in position %zd: %U";
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001955 else
Walter Dörwald32a4c712007-06-20 09:25:34 +00001956 fmt = "'%U' codec can't encode character '\\U%08x' in position %zd: %U";
Eric Smith0facd772010-02-24 15:42:29 +00001957 result = PyUnicode_FromFormat(
Walter Dörwald787b03b2007-06-05 13:29:29 +00001958 fmt,
Eric Smith0facd772010-02-24 15:42:29 +00001959 encoding_str,
Victor Stinnerda1ddf32011-11-20 22:50:23 +01001960 (int)badchar,
Guido van Rossum7eaf8222007-06-18 17:58:50 +00001961 uself->start,
Eric Smith0facd772010-02-24 15:42:29 +00001962 reason_str);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001963 }
Eric Smith0facd772010-02-24 15:42:29 +00001964 else {
1965 result = PyUnicode_FromFormat(
1966 "'%U' codec can't encode characters in position %zd-%zd: %U",
1967 encoding_str,
1968 uself->start,
1969 uself->end-1,
1970 reason_str);
1971 }
1972done:
1973 Py_XDECREF(reason_str);
1974 Py_XDECREF(encoding_str);
1975 return result;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001976}
1977
1978static PyTypeObject _PyExc_UnicodeEncodeError = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00001979 PyVarObject_HEAD_INIT(NULL, 0)
Neal Norwitz2633c692007-02-26 22:22:47 +00001980 "UnicodeEncodeError",
Thomas Wouters477c8d52006-05-27 19:21:47 +00001981 sizeof(PyUnicodeErrorObject), 0,
1982 (destructor)UnicodeError_dealloc, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
1983 (reprfunc)UnicodeEncodeError_str, 0, 0, 0,
1984 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001985 PyDoc_STR("Unicode encoding error."), (traverseproc)UnicodeError_traverse,
1986 (inquiry)UnicodeError_clear, 0, 0, 0, 0, 0, UnicodeError_members,
Thomas Wouters477c8d52006-05-27 19:21:47 +00001987 0, &_PyExc_UnicodeError, 0, 0, 0, offsetof(PyUnicodeErrorObject, dict),
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001988 (initproc)UnicodeEncodeError_init, 0, BaseException_new,
Thomas Wouters477c8d52006-05-27 19:21:47 +00001989};
1990PyObject *PyExc_UnicodeEncodeError = (PyObject *)&_PyExc_UnicodeEncodeError;
1991
1992PyObject *
1993PyUnicodeEncodeError_Create(
1994 const char *encoding, const Py_UNICODE *object, Py_ssize_t length,
1995 Py_ssize_t start, Py_ssize_t end, const char *reason)
1996{
Victor Stinner7eeb5b52010-06-07 19:57:46 +00001997 return PyObject_CallFunction(PyExc_UnicodeEncodeError, "su#nns",
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001998 encoding, object, length, start, end, reason);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001999}
2000
2001
2002/*
2003 * UnicodeDecodeError extends UnicodeError
2004 */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002005
2006static int
2007UnicodeDecodeError_init(PyObject *self, PyObject *args, PyObject *kwds)
2008{
Guido van Rossum98297ee2007-11-06 21:34:58 +00002009 PyUnicodeErrorObject *ude;
Guido van Rossum98297ee2007-11-06 21:34:58 +00002010
Thomas Wouters477c8d52006-05-27 19:21:47 +00002011 if (BaseException_init((PyBaseExceptionObject *)self, args, kwds) == -1)
2012 return -1;
Guido van Rossum98297ee2007-11-06 21:34:58 +00002013
2014 ude = (PyUnicodeErrorObject *)self;
2015
2016 Py_CLEAR(ude->encoding);
2017 Py_CLEAR(ude->object);
2018 Py_CLEAR(ude->reason);
2019
Serhiy Storchakaf8d7d412016-10-23 15:12:25 +03002020 if (!PyArg_ParseTuple(args, "UOnnU",
2021 &ude->encoding, &ude->object,
2022 &ude->start, &ude->end, &ude->reason)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002023 ude->encoding = ude->object = ude->reason = NULL;
2024 return -1;
2025 }
2026
Guido van Rossum98297ee2007-11-06 21:34:58 +00002027 Py_INCREF(ude->encoding);
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002028 Py_INCREF(ude->object);
Guido van Rossum98297ee2007-11-06 21:34:58 +00002029 Py_INCREF(ude->reason);
2030
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002031 if (!PyBytes_Check(ude->object)) {
2032 Py_buffer view;
2033 if (PyObject_GetBuffer(ude->object, &view, PyBUF_SIMPLE) != 0)
2034 goto error;
Serhiy Storchaka48842712016-04-06 09:45:48 +03002035 Py_XSETREF(ude->object, PyBytes_FromStringAndSize(view.buf, view.len));
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002036 PyBuffer_Release(&view);
2037 if (!ude->object)
2038 goto error;
2039 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002040 return 0;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002041
2042error:
2043 Py_CLEAR(ude->encoding);
2044 Py_CLEAR(ude->object);
2045 Py_CLEAR(ude->reason);
2046 return -1;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002047}
2048
2049static PyObject *
2050UnicodeDecodeError_str(PyObject *self)
2051{
Guido van Rossum7eaf8222007-06-18 17:58:50 +00002052 PyUnicodeErrorObject *uself = (PyUnicodeErrorObject *)self;
Eric Smith0facd772010-02-24 15:42:29 +00002053 PyObject *result = NULL;
2054 PyObject *reason_str = NULL;
2055 PyObject *encoding_str = NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002056
Benjamin Peterson9b09ba12014-04-02 12:15:06 -04002057 if (!uself->object)
2058 /* Not properly initialized. */
2059 return PyUnicode_FromString("");
2060
Eric Smith0facd772010-02-24 15:42:29 +00002061 /* Get reason and encoding as strings, which they might not be if
Martin Pantereb995702016-07-28 01:11:04 +00002062 they've been modified after we were constructed. */
Eric Smith0facd772010-02-24 15:42:29 +00002063 reason_str = PyObject_Str(uself->reason);
2064 if (reason_str == NULL)
2065 goto done;
2066 encoding_str = PyObject_Str(uself->encoding);
2067 if (encoding_str == NULL)
2068 goto done;
2069
2070 if (uself->start < PyBytes_GET_SIZE(uself->object) && uself->end == uself->start+1) {
Christian Heimes72b710a2008-05-26 13:28:38 +00002071 int byte = (int)(PyBytes_AS_STRING(((PyUnicodeErrorObject *)self)->object)[uself->start]&0xff);
Eric Smith0facd772010-02-24 15:42:29 +00002072 result = PyUnicode_FromFormat(
Walter Dörwald787b03b2007-06-05 13:29:29 +00002073 "'%U' codec can't decode byte 0x%02x in position %zd: %U",
Eric Smith0facd772010-02-24 15:42:29 +00002074 encoding_str,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002075 byte,
Guido van Rossum7eaf8222007-06-18 17:58:50 +00002076 uself->start,
Eric Smith0facd772010-02-24 15:42:29 +00002077 reason_str);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002078 }
Eric Smith0facd772010-02-24 15:42:29 +00002079 else {
2080 result = PyUnicode_FromFormat(
2081 "'%U' codec can't decode bytes in position %zd-%zd: %U",
2082 encoding_str,
2083 uself->start,
2084 uself->end-1,
2085 reason_str
2086 );
2087 }
2088done:
2089 Py_XDECREF(reason_str);
2090 Py_XDECREF(encoding_str);
2091 return result;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002092}
2093
2094static PyTypeObject _PyExc_UnicodeDecodeError = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002095 PyVarObject_HEAD_INIT(NULL, 0)
Neal Norwitz2633c692007-02-26 22:22:47 +00002096 "UnicodeDecodeError",
Thomas Wouters477c8d52006-05-27 19:21:47 +00002097 sizeof(PyUnicodeErrorObject), 0,
2098 (destructor)UnicodeError_dealloc, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2099 (reprfunc)UnicodeDecodeError_str, 0, 0, 0,
2100 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002101 PyDoc_STR("Unicode decoding error."), (traverseproc)UnicodeError_traverse,
2102 (inquiry)UnicodeError_clear, 0, 0, 0, 0, 0, UnicodeError_members,
Thomas Wouters477c8d52006-05-27 19:21:47 +00002103 0, &_PyExc_UnicodeError, 0, 0, 0, offsetof(PyUnicodeErrorObject, dict),
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002104 (initproc)UnicodeDecodeError_init, 0, BaseException_new,
Thomas Wouters477c8d52006-05-27 19:21:47 +00002105};
2106PyObject *PyExc_UnicodeDecodeError = (PyObject *)&_PyExc_UnicodeDecodeError;
2107
2108PyObject *
2109PyUnicodeDecodeError_Create(
2110 const char *encoding, const char *object, Py_ssize_t length,
2111 Py_ssize_t start, Py_ssize_t end, const char *reason)
2112{
Victor Stinner7eeb5b52010-06-07 19:57:46 +00002113 return PyObject_CallFunction(PyExc_UnicodeDecodeError, "sy#nns",
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002114 encoding, object, length, start, end, reason);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002115}
2116
2117
2118/*
2119 * UnicodeTranslateError extends UnicodeError
2120 */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002121
2122static int
2123UnicodeTranslateError_init(PyUnicodeErrorObject *self, PyObject *args,
2124 PyObject *kwds)
2125{
2126 if (BaseException_init((PyBaseExceptionObject *)self, args, kwds) == -1)
2127 return -1;
2128
2129 Py_CLEAR(self->object);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002130 Py_CLEAR(self->reason);
2131
Serhiy Storchakaf8d7d412016-10-23 15:12:25 +03002132 if (!PyArg_ParseTuple(args, "UnnU",
2133 &self->object,
2134 &self->start, &self->end, &self->reason)) {
Guido van Rossum7eaf8222007-06-18 17:58:50 +00002135 self->object = self->reason = NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002136 return -1;
2137 }
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002138
Thomas Wouters477c8d52006-05-27 19:21:47 +00002139 Py_INCREF(self->object);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002140 Py_INCREF(self->reason);
2141
2142 return 0;
2143}
2144
2145
2146static PyObject *
2147UnicodeTranslateError_str(PyObject *self)
2148{
Guido van Rossum7eaf8222007-06-18 17:58:50 +00002149 PyUnicodeErrorObject *uself = (PyUnicodeErrorObject *)self;
Eric Smith0facd772010-02-24 15:42:29 +00002150 PyObject *result = NULL;
2151 PyObject *reason_str = NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002152
Benjamin Peterson9b09ba12014-04-02 12:15:06 -04002153 if (!uself->object)
2154 /* Not properly initialized. */
2155 return PyUnicode_FromString("");
2156
Eric Smith0facd772010-02-24 15:42:29 +00002157 /* Get reason as a string, which it might not be if it's been
Martin Pantereb995702016-07-28 01:11:04 +00002158 modified after we were constructed. */
Eric Smith0facd772010-02-24 15:42:29 +00002159 reason_str = PyObject_Str(uself->reason);
2160 if (reason_str == NULL)
2161 goto done;
2162
Victor Stinner53b33e72011-11-21 01:17:27 +01002163 if (uself->start < PyUnicode_GET_LENGTH(uself->object) && uself->end == uself->start+1) {
2164 Py_UCS4 badchar = PyUnicode_ReadChar(uself->object, uself->start);
Walter Dörwald787b03b2007-06-05 13:29:29 +00002165 const char *fmt;
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002166 if (badchar <= 0xff)
Walter Dörwald32a4c712007-06-20 09:25:34 +00002167 fmt = "can't translate character '\\x%02x' in position %zd: %U";
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002168 else if (badchar <= 0xffff)
Walter Dörwald32a4c712007-06-20 09:25:34 +00002169 fmt = "can't translate character '\\u%04x' in position %zd: %U";
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002170 else
Walter Dörwald32a4c712007-06-20 09:25:34 +00002171 fmt = "can't translate character '\\U%08x' in position %zd: %U";
Benjamin Petersonc5f4e1e2010-02-25 01:22:28 +00002172 result = PyUnicode_FromFormat(
Walter Dörwald787b03b2007-06-05 13:29:29 +00002173 fmt,
Victor Stinner53b33e72011-11-21 01:17:27 +01002174 (int)badchar,
Guido van Rossum7eaf8222007-06-18 17:58:50 +00002175 uself->start,
Eric Smith0facd772010-02-24 15:42:29 +00002176 reason_str
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002177 );
Eric Smith0facd772010-02-24 15:42:29 +00002178 } else {
2179 result = PyUnicode_FromFormat(
2180 "can't translate characters in position %zd-%zd: %U",
2181 uself->start,
2182 uself->end-1,
2183 reason_str
2184 );
Thomas Wouters477c8d52006-05-27 19:21:47 +00002185 }
Eric Smith0facd772010-02-24 15:42:29 +00002186done:
2187 Py_XDECREF(reason_str);
2188 return result;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002189}
2190
2191static PyTypeObject _PyExc_UnicodeTranslateError = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002192 PyVarObject_HEAD_INIT(NULL, 0)
Neal Norwitz2633c692007-02-26 22:22:47 +00002193 "UnicodeTranslateError",
Thomas Wouters477c8d52006-05-27 19:21:47 +00002194 sizeof(PyUnicodeErrorObject), 0,
2195 (destructor)UnicodeError_dealloc, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
2196 (reprfunc)UnicodeTranslateError_str, 0, 0, 0,
2197 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002198 PyDoc_STR("Unicode translation error."), (traverseproc)UnicodeError_traverse,
Thomas Wouters477c8d52006-05-27 19:21:47 +00002199 (inquiry)UnicodeError_clear, 0, 0, 0, 0, 0, UnicodeError_members,
2200 0, &_PyExc_UnicodeError, 0, 0, 0, offsetof(PyUnicodeErrorObject, dict),
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002201 (initproc)UnicodeTranslateError_init, 0, BaseException_new,
Thomas Wouters477c8d52006-05-27 19:21:47 +00002202};
2203PyObject *PyExc_UnicodeTranslateError = (PyObject *)&_PyExc_UnicodeTranslateError;
2204
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002205/* Deprecated. */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002206PyObject *
2207PyUnicodeTranslateError_Create(
2208 const Py_UNICODE *object, Py_ssize_t length,
2209 Py_ssize_t start, Py_ssize_t end, const char *reason)
2210{
2211 return PyObject_CallFunction(PyExc_UnicodeTranslateError, "u#nns",
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002212 object, length, start, end, reason);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002213}
Thomas Wouters477c8d52006-05-27 19:21:47 +00002214
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002215PyObject *
2216_PyUnicodeTranslateError_Create(
2217 PyObject *object,
2218 Py_ssize_t start, Py_ssize_t end, const char *reason)
2219{
Victor Stinner69598d42014-04-04 20:59:44 +02002220 return PyObject_CallFunction(PyExc_UnicodeTranslateError, "Onns",
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002221 object, start, end, reason);
2222}
Thomas Wouters477c8d52006-05-27 19:21:47 +00002223
2224/*
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002225 * AssertionError extends Exception
Thomas Wouters477c8d52006-05-27 19:21:47 +00002226 */
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002227SimpleExtendsException(PyExc_Exception, AssertionError,
Thomas Wouters477c8d52006-05-27 19:21:47 +00002228 "Assertion failed.");
2229
2230
2231/*
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002232 * ArithmeticError extends Exception
Thomas Wouters477c8d52006-05-27 19:21:47 +00002233 */
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002234SimpleExtendsException(PyExc_Exception, ArithmeticError,
Thomas Wouters477c8d52006-05-27 19:21:47 +00002235 "Base class for arithmetic errors.");
2236
2237
2238/*
2239 * FloatingPointError extends ArithmeticError
2240 */
2241SimpleExtendsException(PyExc_ArithmeticError, FloatingPointError,
2242 "Floating point operation failed.");
2243
2244
2245/*
2246 * OverflowError extends ArithmeticError
2247 */
2248SimpleExtendsException(PyExc_ArithmeticError, OverflowError,
2249 "Result too large to be represented.");
2250
2251
2252/*
2253 * ZeroDivisionError extends ArithmeticError
2254 */
2255SimpleExtendsException(PyExc_ArithmeticError, ZeroDivisionError,
2256 "Second argument to a division or modulo operation was zero.");
2257
2258
2259/*
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002260 * SystemError extends Exception
Thomas Wouters477c8d52006-05-27 19:21:47 +00002261 */
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002262SimpleExtendsException(PyExc_Exception, SystemError,
Thomas Wouters477c8d52006-05-27 19:21:47 +00002263 "Internal error in the Python interpreter.\n"
2264 "\n"
2265 "Please report this to the Python maintainer, along with the traceback,\n"
2266 "the Python version, and the hardware/OS platform and version.");
2267
2268
2269/*
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002270 * ReferenceError extends Exception
Thomas Wouters477c8d52006-05-27 19:21:47 +00002271 */
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002272SimpleExtendsException(PyExc_Exception, ReferenceError,
Thomas Wouters477c8d52006-05-27 19:21:47 +00002273 "Weak ref proxy used after referent went away.");
2274
2275
2276/*
Guido van Rossumcd16bf62007-06-13 18:07:49 +00002277 * MemoryError extends Exception
Thomas Wouters477c8d52006-05-27 19:21:47 +00002278 */
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002279
2280#define MEMERRORS_SAVE 16
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002281
2282static PyObject *
2283MemoryError_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
2284{
2285 PyBaseExceptionObject *self;
2286
Pablo Galindo9b648a92020-09-01 19:39:46 +01002287 /* If this is a subclass of MemoryError, don't use the freelist
2288 * and just return a fresh object */
2289 if (type != (PyTypeObject *) PyExc_MemoryError) {
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002290 return BaseException_new(type, args, kwds);
Pablo Galindo9b648a92020-09-01 19:39:46 +01002291 }
Victor Stinner281cce12020-06-23 22:55:46 +02002292
2293 struct _Py_exc_state *state = get_exc_state();
2294 if (state->memerrors_freelist == NULL) {
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002295 return BaseException_new(type, args, kwds);
Victor Stinner281cce12020-06-23 22:55:46 +02002296 }
2297
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002298 /* Fetch object from freelist and revive it */
Victor Stinner281cce12020-06-23 22:55:46 +02002299 self = state->memerrors_freelist;
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002300 self->args = PyTuple_New(0);
2301 /* This shouldn't happen since the empty tuple is persistent */
Victor Stinner281cce12020-06-23 22:55:46 +02002302 if (self->args == NULL) {
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002303 return NULL;
Victor Stinner281cce12020-06-23 22:55:46 +02002304 }
2305
2306 state->memerrors_freelist = (PyBaseExceptionObject *) self->dict;
2307 state->memerrors_numfree--;
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002308 self->dict = NULL;
2309 _Py_NewReference((PyObject *)self);
2310 _PyObject_GC_TRACK(self);
2311 return (PyObject *)self;
2312}
2313
2314static void
2315MemoryError_dealloc(PyBaseExceptionObject *self)
2316{
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002317 BaseException_clear(self);
Victor Stinner281cce12020-06-23 22:55:46 +02002318
Pablo Galindo9b648a92020-09-01 19:39:46 +01002319 /* If this is a subclass of MemoryError, we don't need to
2320 * do anything in the free-list*/
2321 if (!Py_IS_TYPE(self, (PyTypeObject *) PyExc_MemoryError)) {
Victor Stinnerbbeb2232020-09-23 23:25:40 +02002322 Py_TYPE(self)->tp_free((PyObject *)self);
2323 return;
Pablo Galindo9b648a92020-09-01 19:39:46 +01002324 }
2325
2326 _PyObject_GC_UNTRACK(self);
2327
Victor Stinner281cce12020-06-23 22:55:46 +02002328 struct _Py_exc_state *state = get_exc_state();
2329 if (state->memerrors_numfree >= MEMERRORS_SAVE) {
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002330 Py_TYPE(self)->tp_free((PyObject *)self);
Victor Stinner281cce12020-06-23 22:55:46 +02002331 }
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002332 else {
Victor Stinner281cce12020-06-23 22:55:46 +02002333 self->dict = (PyObject *) state->memerrors_freelist;
2334 state->memerrors_freelist = self;
2335 state->memerrors_numfree++;
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002336 }
2337}
2338
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002339static int
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002340preallocate_memerrors(void)
2341{
2342 /* We create enough MemoryErrors and then decref them, which will fill
2343 up the freelist. */
2344 int i;
2345 PyObject *errors[MEMERRORS_SAVE];
2346 for (i = 0; i < MEMERRORS_SAVE; i++) {
2347 errors[i] = MemoryError_new((PyTypeObject *) PyExc_MemoryError,
2348 NULL, NULL);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002349 if (!errors[i]) {
2350 return -1;
2351 }
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002352 }
2353 for (i = 0; i < MEMERRORS_SAVE; i++) {
2354 Py_DECREF(errors[i]);
2355 }
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002356 return 0;
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002357}
2358
2359static void
Victor Stinner281cce12020-06-23 22:55:46 +02002360free_preallocated_memerrors(struct _Py_exc_state *state)
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002361{
Victor Stinner281cce12020-06-23 22:55:46 +02002362 while (state->memerrors_freelist != NULL) {
2363 PyObject *self = (PyObject *) state->memerrors_freelist;
2364 state->memerrors_freelist = (PyBaseExceptionObject *)state->memerrors_freelist->dict;
Antoine Pitrou07e20ef2010-10-28 22:56:58 +00002365 Py_TYPE(self)->tp_free((PyObject *)self);
2366 }
2367}
2368
2369
2370static PyTypeObject _PyExc_MemoryError = {
2371 PyVarObject_HEAD_INIT(NULL, 0)
2372 "MemoryError",
2373 sizeof(PyBaseExceptionObject),
2374 0, (destructor)MemoryError_dealloc, 0, 0, 0, 0, 0, 0, 0,
2375 0, 0, 0, 0, 0, 0, 0,
2376 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
2377 PyDoc_STR("Out of memory."), (traverseproc)BaseException_traverse,
2378 (inquiry)BaseException_clear, 0, 0, 0, 0, 0, 0, 0, &_PyExc_Exception,
2379 0, 0, 0, offsetof(PyBaseExceptionObject, dict),
2380 (initproc)BaseException_init, 0, MemoryError_new
2381};
2382PyObject *PyExc_MemoryError = (PyObject *) &_PyExc_MemoryError;
2383
Thomas Wouters477c8d52006-05-27 19:21:47 +00002384
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00002385/*
2386 * BufferError extends Exception
2387 */
2388SimpleExtendsException(PyExc_Exception, BufferError, "Buffer error.");
2389
Thomas Wouters477c8d52006-05-27 19:21:47 +00002390
2391/* Warning category docstrings */
2392
2393/*
2394 * Warning extends Exception
2395 */
2396SimpleExtendsException(PyExc_Exception, Warning,
2397 "Base class for warning categories.");
2398
2399
2400/*
2401 * UserWarning extends Warning
2402 */
2403SimpleExtendsException(PyExc_Warning, UserWarning,
2404 "Base class for warnings generated by user code.");
2405
2406
2407/*
2408 * DeprecationWarning extends Warning
2409 */
2410SimpleExtendsException(PyExc_Warning, DeprecationWarning,
2411 "Base class for warnings about deprecated features.");
2412
2413
2414/*
2415 * PendingDeprecationWarning extends Warning
2416 */
2417SimpleExtendsException(PyExc_Warning, PendingDeprecationWarning,
2418 "Base class for warnings about features which will be deprecated\n"
2419 "in the future.");
2420
2421
2422/*
2423 * SyntaxWarning extends Warning
2424 */
2425SimpleExtendsException(PyExc_Warning, SyntaxWarning,
2426 "Base class for warnings about dubious syntax.");
2427
2428
2429/*
2430 * RuntimeWarning extends Warning
2431 */
2432SimpleExtendsException(PyExc_Warning, RuntimeWarning,
2433 "Base class for warnings about dubious runtime behavior.");
2434
2435
2436/*
2437 * FutureWarning extends Warning
2438 */
2439SimpleExtendsException(PyExc_Warning, FutureWarning,
2440 "Base class for warnings about constructs that will change semantically\n"
2441 "in the future.");
2442
2443
2444/*
2445 * ImportWarning extends Warning
2446 */
2447SimpleExtendsException(PyExc_Warning, ImportWarning,
2448 "Base class for warnings about probable mistakes in module imports");
2449
2450
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00002451/*
2452 * UnicodeWarning extends Warning
2453 */
2454SimpleExtendsException(PyExc_Warning, UnicodeWarning,
2455 "Base class for warnings about Unicode related problems, mostly\n"
2456 "related to conversion problems.");
2457
Georg Brandl08be72d2010-10-24 15:11:22 +00002458
Guido van Rossum98297ee2007-11-06 21:34:58 +00002459/*
2460 * BytesWarning extends Warning
2461 */
2462SimpleExtendsException(PyExc_Warning, BytesWarning,
2463 "Base class for warnings about bytes and buffer related problems, mostly\n"
2464 "related to conversion from str or comparing to str.");
2465
2466
Georg Brandl08be72d2010-10-24 15:11:22 +00002467/*
Inada Naoki48274832021-03-29 12:28:14 +09002468 * EncodingWarning extends Warning
2469 */
2470SimpleExtendsException(PyExc_Warning, EncodingWarning,
2471 "Base class for warnings about encodings.");
2472
2473
2474/*
Georg Brandl08be72d2010-10-24 15:11:22 +00002475 * ResourceWarning extends Warning
2476 */
2477SimpleExtendsException(PyExc_Warning, ResourceWarning,
2478 "Base class for warnings about resource usage.");
2479
2480
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00002481
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02002482#ifdef MS_WINDOWS
Antoine Pitrou7faf7052013-03-31 22:48:04 +02002483#include <winsock2.h>
Brian Curtin401f9f32012-05-13 11:19:23 -05002484/* The following constants were added to errno.h in VS2010 but have
2485 preferred WSA equivalents. */
2486#undef EADDRINUSE
2487#undef EADDRNOTAVAIL
2488#undef EAFNOSUPPORT
2489#undef EALREADY
2490#undef ECONNABORTED
2491#undef ECONNREFUSED
2492#undef ECONNRESET
2493#undef EDESTADDRREQ
2494#undef EHOSTUNREACH
2495#undef EINPROGRESS
2496#undef EISCONN
2497#undef ELOOP
2498#undef EMSGSIZE
2499#undef ENETDOWN
2500#undef ENETRESET
2501#undef ENETUNREACH
2502#undef ENOBUFS
2503#undef ENOPROTOOPT
2504#undef ENOTCONN
2505#undef ENOTSOCK
2506#undef EOPNOTSUPP
2507#undef EPROTONOSUPPORT
2508#undef EPROTOTYPE
2509#undef ETIMEDOUT
2510#undef EWOULDBLOCK
2511
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02002512#if defined(WSAEALREADY) && !defined(EALREADY)
2513#define EALREADY WSAEALREADY
2514#endif
2515#if defined(WSAECONNABORTED) && !defined(ECONNABORTED)
2516#define ECONNABORTED WSAECONNABORTED
2517#endif
2518#if defined(WSAECONNREFUSED) && !defined(ECONNREFUSED)
2519#define ECONNREFUSED WSAECONNREFUSED
2520#endif
2521#if defined(WSAECONNRESET) && !defined(ECONNRESET)
2522#define ECONNRESET WSAECONNRESET
2523#endif
2524#if defined(WSAEINPROGRESS) && !defined(EINPROGRESS)
2525#define EINPROGRESS WSAEINPROGRESS
2526#endif
2527#if defined(WSAESHUTDOWN) && !defined(ESHUTDOWN)
2528#define ESHUTDOWN WSAESHUTDOWN
2529#endif
2530#if defined(WSAETIMEDOUT) && !defined(ETIMEDOUT)
2531#define ETIMEDOUT WSAETIMEDOUT
2532#endif
2533#if defined(WSAEWOULDBLOCK) && !defined(EWOULDBLOCK)
2534#define EWOULDBLOCK WSAEWOULDBLOCK
2535#endif
2536#endif /* MS_WINDOWS */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002537
Victor Stinner331a6a52019-05-27 16:39:22 +02002538PyStatus
Victor Stinnerbcb094b2021-02-19 15:10:45 +01002539_PyExc_Init(PyInterpreterState *interp)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002540{
Victor Stinnerbcb094b2021-02-19 15:10:45 +01002541 struct _Py_exc_state *state = &interp->exc_state;
Victor Stinner281cce12020-06-23 22:55:46 +02002542
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002543#define PRE_INIT(TYPE) \
2544 if (!(_PyExc_ ## TYPE.tp_flags & Py_TPFLAGS_READY)) { \
2545 if (PyType_Ready(&_PyExc_ ## TYPE) < 0) { \
Victor Stinner331a6a52019-05-27 16:39:22 +02002546 return _PyStatus_ERR("exceptions bootstrapping error."); \
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002547 } \
2548 Py_INCREF(PyExc_ ## TYPE); \
2549 }
2550
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002551#define ADD_ERRNO(TYPE, CODE) \
2552 do { \
2553 PyObject *_code = PyLong_FromLong(CODE); \
2554 assert(_PyObject_RealIsSubclass(PyExc_ ## TYPE, PyExc_OSError)); \
Serhiy Storchakaed1007c2020-11-21 19:17:46 +02002555 if (!_code || PyDict_SetItem(state->errnomap, _code, PyExc_ ## TYPE)) { \
2556 Py_XDECREF(_code); \
Victor Stinner331a6a52019-05-27 16:39:22 +02002557 return _PyStatus_ERR("errmap insertion problem."); \
Serhiy Storchakaed1007c2020-11-21 19:17:46 +02002558 } \
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002559 Py_DECREF(_code); \
2560 } while (0)
2561
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002562 PRE_INIT(BaseException);
2563 PRE_INIT(Exception);
2564 PRE_INIT(TypeError);
2565 PRE_INIT(StopAsyncIteration);
2566 PRE_INIT(StopIteration);
2567 PRE_INIT(GeneratorExit);
2568 PRE_INIT(SystemExit);
2569 PRE_INIT(KeyboardInterrupt);
2570 PRE_INIT(ImportError);
2571 PRE_INIT(ModuleNotFoundError);
2572 PRE_INIT(OSError);
2573 PRE_INIT(EOFError);
2574 PRE_INIT(RuntimeError);
2575 PRE_INIT(RecursionError);
2576 PRE_INIT(NotImplementedError);
2577 PRE_INIT(NameError);
2578 PRE_INIT(UnboundLocalError);
2579 PRE_INIT(AttributeError);
2580 PRE_INIT(SyntaxError);
2581 PRE_INIT(IndentationError);
2582 PRE_INIT(TabError);
2583 PRE_INIT(LookupError);
2584 PRE_INIT(IndexError);
2585 PRE_INIT(KeyError);
2586 PRE_INIT(ValueError);
2587 PRE_INIT(UnicodeError);
2588 PRE_INIT(UnicodeEncodeError);
2589 PRE_INIT(UnicodeDecodeError);
2590 PRE_INIT(UnicodeTranslateError);
2591 PRE_INIT(AssertionError);
2592 PRE_INIT(ArithmeticError);
2593 PRE_INIT(FloatingPointError);
2594 PRE_INIT(OverflowError);
2595 PRE_INIT(ZeroDivisionError);
2596 PRE_INIT(SystemError);
2597 PRE_INIT(ReferenceError);
2598 PRE_INIT(MemoryError);
2599 PRE_INIT(BufferError);
2600 PRE_INIT(Warning);
2601 PRE_INIT(UserWarning);
Inada Naoki48274832021-03-29 12:28:14 +09002602 PRE_INIT(EncodingWarning);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002603 PRE_INIT(DeprecationWarning);
2604 PRE_INIT(PendingDeprecationWarning);
2605 PRE_INIT(SyntaxWarning);
2606 PRE_INIT(RuntimeWarning);
2607 PRE_INIT(FutureWarning);
2608 PRE_INIT(ImportWarning);
2609 PRE_INIT(UnicodeWarning);
2610 PRE_INIT(BytesWarning);
2611 PRE_INIT(ResourceWarning);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002612
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02002613 /* OSError subclasses */
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002614 PRE_INIT(ConnectionError);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02002615
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002616 PRE_INIT(BlockingIOError);
2617 PRE_INIT(BrokenPipeError);
2618 PRE_INIT(ChildProcessError);
2619 PRE_INIT(ConnectionAbortedError);
2620 PRE_INIT(ConnectionRefusedError);
2621 PRE_INIT(ConnectionResetError);
2622 PRE_INIT(FileExistsError);
2623 PRE_INIT(FileNotFoundError);
2624 PRE_INIT(IsADirectoryError);
2625 PRE_INIT(NotADirectoryError);
2626 PRE_INIT(InterruptedError);
2627 PRE_INIT(PermissionError);
2628 PRE_INIT(ProcessLookupError);
2629 PRE_INIT(TimeoutError);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02002630
Victor Stinner6d43f6f2019-01-22 21:18:05 +01002631 if (preallocate_memerrors() < 0) {
Victor Stinner281cce12020-06-23 22:55:46 +02002632 return _PyStatus_NO_MEMORY();
Victor Stinner6d43f6f2019-01-22 21:18:05 +01002633 }
2634
2635 /* Add exceptions to errnomap */
Victor Stinner281cce12020-06-23 22:55:46 +02002636 assert(state->errnomap == NULL);
2637 state->errnomap = PyDict_New();
2638 if (!state->errnomap) {
2639 return _PyStatus_NO_MEMORY();
Victor Stinner6d43f6f2019-01-22 21:18:05 +01002640 }
2641
2642 ADD_ERRNO(BlockingIOError, EAGAIN);
2643 ADD_ERRNO(BlockingIOError, EALREADY);
2644 ADD_ERRNO(BlockingIOError, EINPROGRESS);
2645 ADD_ERRNO(BlockingIOError, EWOULDBLOCK);
2646 ADD_ERRNO(BrokenPipeError, EPIPE);
2647#ifdef ESHUTDOWN
2648 ADD_ERRNO(BrokenPipeError, ESHUTDOWN);
2649#endif
2650 ADD_ERRNO(ChildProcessError, ECHILD);
2651 ADD_ERRNO(ConnectionAbortedError, ECONNABORTED);
2652 ADD_ERRNO(ConnectionRefusedError, ECONNREFUSED);
2653 ADD_ERRNO(ConnectionResetError, ECONNRESET);
2654 ADD_ERRNO(FileExistsError, EEXIST);
2655 ADD_ERRNO(FileNotFoundError, ENOENT);
2656 ADD_ERRNO(IsADirectoryError, EISDIR);
2657 ADD_ERRNO(NotADirectoryError, ENOTDIR);
2658 ADD_ERRNO(InterruptedError, EINTR);
2659 ADD_ERRNO(PermissionError, EACCES);
2660 ADD_ERRNO(PermissionError, EPERM);
2661 ADD_ERRNO(ProcessLookupError, ESRCH);
2662 ADD_ERRNO(TimeoutError, ETIMEDOUT);
2663
Victor Stinner331a6a52019-05-27 16:39:22 +02002664 return _PyStatus_OK();
Victor Stinner6d43f6f2019-01-22 21:18:05 +01002665
2666#undef PRE_INIT
2667#undef ADD_ERRNO
2668}
2669
2670
2671/* Add exception types to the builtins module */
Victor Stinner331a6a52019-05-27 16:39:22 +02002672PyStatus
Victor Stinner6d43f6f2019-01-22 21:18:05 +01002673_PyBuiltins_AddExceptions(PyObject *bltinmod)
2674{
2675#define POST_INIT(TYPE) \
2676 if (PyDict_SetItemString(bdict, # TYPE, PyExc_ ## TYPE)) { \
Victor Stinner331a6a52019-05-27 16:39:22 +02002677 return _PyStatus_ERR("Module dictionary insertion problem."); \
Victor Stinner6d43f6f2019-01-22 21:18:05 +01002678 }
2679
2680#define INIT_ALIAS(NAME, TYPE) \
2681 do { \
2682 Py_INCREF(PyExc_ ## TYPE); \
2683 Py_XDECREF(PyExc_ ## NAME); \
2684 PyExc_ ## NAME = PyExc_ ## TYPE; \
2685 if (PyDict_SetItemString(bdict, # NAME, PyExc_ ## NAME)) { \
Victor Stinner331a6a52019-05-27 16:39:22 +02002686 return _PyStatus_ERR("Module dictionary insertion problem."); \
Victor Stinner6d43f6f2019-01-22 21:18:05 +01002687 } \
2688 } while (0)
2689
2690 PyObject *bdict;
2691
Thomas Wouters477c8d52006-05-27 19:21:47 +00002692 bdict = PyModule_GetDict(bltinmod);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002693 if (bdict == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002694 return _PyStatus_ERR("exceptions bootstrapping error.");
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002695 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00002696
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002697 POST_INIT(BaseException);
2698 POST_INIT(Exception);
2699 POST_INIT(TypeError);
2700 POST_INIT(StopAsyncIteration);
2701 POST_INIT(StopIteration);
2702 POST_INIT(GeneratorExit);
2703 POST_INIT(SystemExit);
2704 POST_INIT(KeyboardInterrupt);
2705 POST_INIT(ImportError);
2706 POST_INIT(ModuleNotFoundError);
2707 POST_INIT(OSError);
2708 INIT_ALIAS(EnvironmentError, OSError);
2709 INIT_ALIAS(IOError, OSError);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002710#ifdef MS_WINDOWS
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002711 INIT_ALIAS(WindowsError, OSError);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002712#endif
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002713 POST_INIT(EOFError);
2714 POST_INIT(RuntimeError);
2715 POST_INIT(RecursionError);
2716 POST_INIT(NotImplementedError);
2717 POST_INIT(NameError);
2718 POST_INIT(UnboundLocalError);
2719 POST_INIT(AttributeError);
2720 POST_INIT(SyntaxError);
2721 POST_INIT(IndentationError);
2722 POST_INIT(TabError);
2723 POST_INIT(LookupError);
2724 POST_INIT(IndexError);
2725 POST_INIT(KeyError);
2726 POST_INIT(ValueError);
2727 POST_INIT(UnicodeError);
2728 POST_INIT(UnicodeEncodeError);
2729 POST_INIT(UnicodeDecodeError);
2730 POST_INIT(UnicodeTranslateError);
2731 POST_INIT(AssertionError);
2732 POST_INIT(ArithmeticError);
2733 POST_INIT(FloatingPointError);
2734 POST_INIT(OverflowError);
2735 POST_INIT(ZeroDivisionError);
2736 POST_INIT(SystemError);
2737 POST_INIT(ReferenceError);
2738 POST_INIT(MemoryError);
2739 POST_INIT(BufferError);
2740 POST_INIT(Warning);
2741 POST_INIT(UserWarning);
Inada Naoki48274832021-03-29 12:28:14 +09002742 POST_INIT(EncodingWarning);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002743 POST_INIT(DeprecationWarning);
2744 POST_INIT(PendingDeprecationWarning);
2745 POST_INIT(SyntaxWarning);
2746 POST_INIT(RuntimeWarning);
2747 POST_INIT(FutureWarning);
2748 POST_INIT(ImportWarning);
2749 POST_INIT(UnicodeWarning);
2750 POST_INIT(BytesWarning);
2751 POST_INIT(ResourceWarning);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002752
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02002753 /* OSError subclasses */
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002754 POST_INIT(ConnectionError);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02002755
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002756 POST_INIT(BlockingIOError);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002757 POST_INIT(BrokenPipeError);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002758 POST_INIT(ChildProcessError);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002759 POST_INIT(ConnectionAbortedError);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002760 POST_INIT(ConnectionRefusedError);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002761 POST_INIT(ConnectionResetError);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002762 POST_INIT(FileExistsError);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002763 POST_INIT(FileNotFoundError);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002764 POST_INIT(IsADirectoryError);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002765 POST_INIT(NotADirectoryError);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002766 POST_INIT(InterruptedError);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002767 POST_INIT(PermissionError);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002768 POST_INIT(ProcessLookupError);
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002769 POST_INIT(TimeoutError);
Antoine Pitrou6b4883d2011-10-12 02:54:14 +02002770
Victor Stinner331a6a52019-05-27 16:39:22 +02002771 return _PyStatus_OK();
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002772
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01002773#undef POST_INIT
2774#undef INIT_ALIAS
Thomas Wouters477c8d52006-05-27 19:21:47 +00002775}
2776
2777void
Victor Stinnerbcb094b2021-02-19 15:10:45 +01002778_PyExc_Fini(PyInterpreterState *interp)
Thomas Wouters477c8d52006-05-27 19:21:47 +00002779{
Victor Stinnerbcb094b2021-02-19 15:10:45 +01002780 struct _Py_exc_state *state = &interp->exc_state;
Victor Stinner281cce12020-06-23 22:55:46 +02002781 free_preallocated_memerrors(state);
2782 Py_CLEAR(state->errnomap);
Thomas Wouters477c8d52006-05-27 19:21:47 +00002783}
Nick Coghlan8b097b42013-11-13 23:49:21 +10002784
2785/* Helper to do the equivalent of "raise X from Y" in C, but always using
2786 * the current exception rather than passing one in.
2787 *
2788 * We currently limit this to *only* exceptions that use the BaseException
2789 * tp_init and tp_new methods, since we can be reasonably sure we can wrap
2790 * those correctly without losing data and without losing backwards
2791 * compatibility.
2792 *
2793 * We also aim to rule out *all* exceptions that might be storing additional
2794 * state, whether by having a size difference relative to BaseException,
2795 * additional arguments passed in during construction or by having a
2796 * non-empty instance dict.
2797 *
2798 * We need to be very careful with what we wrap, since changing types to
2799 * a broader exception type would be backwards incompatible for
2800 * existing codecs, and with different init or new method implementations
2801 * may either not support instantiation with PyErr_Format or lose
2802 * information when instantiated that way.
2803 *
2804 * XXX (ncoghlan): This could be made more comprehensive by exploiting the
2805 * fact that exceptions are expected to support pickling. If more builtin
2806 * exceptions (e.g. AttributeError) start to be converted to rich
2807 * exceptions with additional attributes, that's probably a better approach
2808 * to pursue over adding special cases for particular stateful subclasses.
2809 *
2810 * Returns a borrowed reference to the new exception (if any), NULL if the
2811 * existing exception was left in place.
2812 */
2813PyObject *
2814_PyErr_TrySetFromCause(const char *format, ...)
2815{
2816 PyObject* msg_prefix;
2817 PyObject *exc, *val, *tb;
2818 PyTypeObject *caught_type;
Christian Heimes6a3db252013-11-14 01:47:14 +01002819 PyObject **dictptr;
Nick Coghlan8b097b42013-11-13 23:49:21 +10002820 PyObject *instance_args;
Nick Coghlanf1de55f2013-11-19 22:33:10 +10002821 Py_ssize_t num_args, caught_type_size, base_exc_size;
Nick Coghlan8b097b42013-11-13 23:49:21 +10002822 PyObject *new_exc, *new_val, *new_tb;
2823 va_list vargs;
Nick Coghlanf1de55f2013-11-19 22:33:10 +10002824 int same_basic_size;
Nick Coghlan8b097b42013-11-13 23:49:21 +10002825
Nick Coghlan8b097b42013-11-13 23:49:21 +10002826 PyErr_Fetch(&exc, &val, &tb);
Benjamin Peterson079c9982013-11-13 23:25:01 -05002827 caught_type = (PyTypeObject *)exc;
Nick Coghlanf1de55f2013-11-19 22:33:10 +10002828 /* Ensure type info indicates no extra state is stored at the C level
2829 * and that the type can be reinstantiated using PyErr_Format
2830 */
2831 caught_type_size = caught_type->tp_basicsize;
2832 base_exc_size = _PyExc_BaseException.tp_basicsize;
2833 same_basic_size = (
2834 caught_type_size == base_exc_size ||
2835 (PyType_SUPPORTS_WEAKREFS(caught_type) &&
Victor Stinner12174a52014-08-15 23:17:38 +02002836 (caught_type_size == base_exc_size + (Py_ssize_t)sizeof(PyObject *))
Nick Coghlanf1de55f2013-11-19 22:33:10 +10002837 )
2838 );
Benjamin Peterson079c9982013-11-13 23:25:01 -05002839 if (caught_type->tp_init != (initproc)BaseException_init ||
Nick Coghlan8b097b42013-11-13 23:49:21 +10002840 caught_type->tp_new != BaseException_new ||
Nick Coghlanf1de55f2013-11-19 22:33:10 +10002841 !same_basic_size ||
Benjamin Peterson079c9982013-11-13 23:25:01 -05002842 caught_type->tp_itemsize != _PyExc_BaseException.tp_itemsize) {
Nick Coghlan8b097b42013-11-13 23:49:21 +10002843 /* We can't be sure we can wrap this safely, since it may contain
2844 * more state than just the exception type. Accordingly, we just
2845 * leave it alone.
2846 */
2847 PyErr_Restore(exc, val, tb);
2848 return NULL;
2849 }
2850
2851 /* Check the args are empty or contain a single string */
2852 PyErr_NormalizeException(&exc, &val, &tb);
Benjamin Peterson079c9982013-11-13 23:25:01 -05002853 instance_args = ((PyBaseExceptionObject *)val)->args;
Nick Coghlan8b097b42013-11-13 23:49:21 +10002854 num_args = PyTuple_GET_SIZE(instance_args);
Benjamin Peterson079c9982013-11-13 23:25:01 -05002855 if (num_args > 1 ||
Nick Coghlan8b097b42013-11-13 23:49:21 +10002856 (num_args == 1 &&
Benjamin Peterson079c9982013-11-13 23:25:01 -05002857 !PyUnicode_CheckExact(PyTuple_GET_ITEM(instance_args, 0)))) {
Nick Coghlan8b097b42013-11-13 23:49:21 +10002858 /* More than 1 arg, or the one arg we do have isn't a string
2859 */
2860 PyErr_Restore(exc, val, tb);
2861 return NULL;
2862 }
2863
2864 /* Ensure the instance dict is also empty */
Christian Heimes6a3db252013-11-14 01:47:14 +01002865 dictptr = _PyObject_GetDictPtr(val);
Benjamin Peterson079c9982013-11-13 23:25:01 -05002866 if (dictptr != NULL && *dictptr != NULL &&
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03002867 PyDict_GET_SIZE(*dictptr) > 0) {
Nick Coghlan8b097b42013-11-13 23:49:21 +10002868 /* While we could potentially copy a non-empty instance dictionary
2869 * to the replacement exception, for now we take the more
2870 * conservative path of leaving exceptions with attributes set
2871 * alone.
2872 */
2873 PyErr_Restore(exc, val, tb);
2874 return NULL;
2875 }
2876
2877 /* For exceptions that we can wrap safely, we chain the original
2878 * exception to a new one of the exact same type with an
2879 * error message that mentions the additional details and the
2880 * original exception.
2881 *
2882 * It would be nice to wrap OSError and various other exception
2883 * types as well, but that's quite a bit trickier due to the extra
2884 * state potentially stored on OSError instances.
2885 */
Nick Coghlan77b286b2014-01-27 00:53:38 +10002886 /* Ensure the traceback is set correctly on the existing exception */
2887 if (tb != NULL) {
2888 PyException_SetTraceback(val, tb);
2889 Py_DECREF(tb);
2890 }
Benjamin Petersone109ee82013-11-13 23:49:49 -05002891
Christian Heimes507eabd2013-11-14 01:39:35 +01002892#ifdef HAVE_STDARG_PROTOTYPES
2893 va_start(vargs, format);
2894#else
2895 va_start(vargs);
2896#endif
Nick Coghlan8b097b42013-11-13 23:49:21 +10002897 msg_prefix = PyUnicode_FromFormatV(format, vargs);
Christian Heimes507eabd2013-11-14 01:39:35 +01002898 va_end(vargs);
Benjamin Petersone109ee82013-11-13 23:49:49 -05002899 if (msg_prefix == NULL) {
Nick Coghlan4b9b9362013-11-16 00:34:13 +10002900 Py_DECREF(exc);
Benjamin Petersone109ee82013-11-13 23:49:49 -05002901 Py_DECREF(val);
Nick Coghlan8b097b42013-11-13 23:49:21 +10002902 return NULL;
Benjamin Petersone109ee82013-11-13 23:49:49 -05002903 }
Nick Coghlan8b097b42013-11-13 23:49:21 +10002904
2905 PyErr_Format(exc, "%U (%s: %S)",
2906 msg_prefix, Py_TYPE(val)->tp_name, val);
Nick Coghlan4b9b9362013-11-16 00:34:13 +10002907 Py_DECREF(exc);
Benjamin Petersone109ee82013-11-13 23:49:49 -05002908 Py_DECREF(msg_prefix);
Nick Coghlan8b097b42013-11-13 23:49:21 +10002909 PyErr_Fetch(&new_exc, &new_val, &new_tb);
2910 PyErr_NormalizeException(&new_exc, &new_val, &new_tb);
2911 PyException_SetCause(new_val, val);
2912 PyErr_Restore(new_exc, new_val, new_tb);
2913 return new_val;
2914}
Nick Coghlan5b1fdc12014-06-16 19:48:02 +10002915
2916
2917/* To help with migration from Python 2, SyntaxError.__init__ applies some
2918 * heuristics to try to report a more meaningful exception when print and
2919 * exec are used like statements.
2920 *
2921 * The heuristics are currently expected to detect the following cases:
2922 * - top level statement
2923 * - statement in a nested suite
2924 * - trailing section of a one line complex statement
2925 *
2926 * They're currently known not to trigger:
2927 * - after a semi-colon
2928 *
2929 * The error message can be a bit odd in cases where the "arguments" are
2930 * completely illegal syntactically, but that isn't worth the hassle of
2931 * fixing.
2932 *
2933 * We also can't do anything about cases that are legal Python 3 syntax
2934 * but mean something entirely different from what they did in Python 2
2935 * (omitting the arguments entirely, printing items preceded by a unary plus
2936 * or minus, using the stream redirection syntax).
2937 */
2938
Sanyam Khurana3a7f0352017-06-20 19:01:32 +05302939
2940// Static helper for setting legacy print error message
2941static int
2942_set_legacy_print_statement_msg(PySyntaxErrorObject *self, Py_ssize_t start)
2943{
Nitish Chandra43c0f1a2018-01-28 16:26:02 +05302944 // PRINT_OFFSET is to remove the `print ` prefix from the data.
Sanyam Khurana3a7f0352017-06-20 19:01:32 +05302945 const int PRINT_OFFSET = 6;
Sanyam Khuranad57f26c2018-01-20 08:42:22 +05302946 const int STRIP_BOTH = 2;
Nitish Chandra43c0f1a2018-01-28 16:26:02 +05302947 Py_ssize_t start_pos = start + PRINT_OFFSET;
2948 Py_ssize_t text_len = PyUnicode_GET_LENGTH(self->text);
2949 Py_UCS4 semicolon = ';';
2950 Py_ssize_t end_pos = PyUnicode_FindChar(self->text, semicolon,
2951 start_pos, text_len, 1);
2952 if (end_pos < -1) {
2953 return -1;
2954 } else if (end_pos == -1) {
2955 end_pos = text_len;
Sanyam Khuranad57f26c2018-01-20 08:42:22 +05302956 }
Nitish Chandra43c0f1a2018-01-28 16:26:02 +05302957
2958 PyObject *data = PyUnicode_Substring(self->text, start_pos, end_pos);
Sanyam Khurana3a7f0352017-06-20 19:01:32 +05302959 if (data == NULL) {
Sanyam Khurana3a7f0352017-06-20 19:01:32 +05302960 return -1;
2961 }
Nitish Chandra43c0f1a2018-01-28 16:26:02 +05302962
2963 PyObject *strip_sep_obj = PyUnicode_FromString(" \t\r\n");
2964 if (strip_sep_obj == NULL) {
2965 Py_DECREF(data);
2966 return -1;
2967 }
2968
Sanyam Khuranad57f26c2018-01-20 08:42:22 +05302969 PyObject *new_data = _PyUnicode_XStrip(data, STRIP_BOTH, strip_sep_obj);
Sanyam Khurana3a7f0352017-06-20 19:01:32 +05302970 Py_DECREF(data);
2971 Py_DECREF(strip_sep_obj);
Sanyam Khurana3a7f0352017-06-20 19:01:32 +05302972 if (new_data == NULL) {
2973 return -1;
2974 }
2975 // gets the modified text_len after stripping `print `
2976 text_len = PyUnicode_GET_LENGTH(new_data);
2977 const char *maybe_end_arg = "";
2978 if (text_len > 0 && PyUnicode_READ_CHAR(new_data, text_len-1) == ',') {
2979 maybe_end_arg = " end=\" \"";
2980 }
2981 PyObject *error_msg = PyUnicode_FromFormat(
2982 "Missing parentheses in call to 'print'. Did you mean print(%U%s)?",
2983 new_data, maybe_end_arg
2984 );
2985 Py_DECREF(new_data);
2986 if (error_msg == NULL)
2987 return -1;
2988
2989 Py_XSETREF(self->msg, error_msg);
2990 return 1;
2991}
2992
Nick Coghlan5b1fdc12014-06-16 19:48:02 +10002993static int
2994_check_for_legacy_statements(PySyntaxErrorObject *self, Py_ssize_t start)
2995{
2996 /* Return values:
2997 * -1: an error occurred
2998 * 0: nothing happened
2999 * 1: the check triggered & the error message was changed
3000 */
3001 static PyObject *print_prefix = NULL;
3002 static PyObject *exec_prefix = NULL;
Zackery Spytza4b48f12018-10-12 02:20:59 -06003003 Py_ssize_t text_len = PyUnicode_GET_LENGTH(self->text), match;
Nick Coghlan5b1fdc12014-06-16 19:48:02 +10003004 int kind = PyUnicode_KIND(self->text);
Serhiy Storchakacd8295f2020-04-11 10:48:40 +03003005 const void *data = PyUnicode_DATA(self->text);
Nick Coghlan5b1fdc12014-06-16 19:48:02 +10003006
3007 /* Ignore leading whitespace */
3008 while (start < text_len) {
3009 Py_UCS4 ch = PyUnicode_READ(kind, data, start);
3010 if (!Py_UNICODE_ISSPACE(ch))
3011 break;
3012 start++;
3013 }
3014 /* Checking against an empty or whitespace-only part of the string */
3015 if (start == text_len) {
3016 return 0;
3017 }
3018
3019 /* Check for legacy print statements */
3020 if (print_prefix == NULL) {
3021 print_prefix = PyUnicode_InternFromString("print ");
3022 if (print_prefix == NULL) {
3023 return -1;
3024 }
3025 }
Zackery Spytza4b48f12018-10-12 02:20:59 -06003026 match = PyUnicode_Tailmatch(self->text, print_prefix,
3027 start, text_len, -1);
3028 if (match == -1) {
3029 return -1;
3030 }
3031 if (match) {
Sanyam Khurana3a7f0352017-06-20 19:01:32 +05303032 return _set_legacy_print_statement_msg(self, start);
Nick Coghlan5b1fdc12014-06-16 19:48:02 +10003033 }
3034
3035 /* Check for legacy exec statements */
3036 if (exec_prefix == NULL) {
3037 exec_prefix = PyUnicode_InternFromString("exec ");
3038 if (exec_prefix == NULL) {
3039 return -1;
3040 }
3041 }
Zackery Spytza4b48f12018-10-12 02:20:59 -06003042 match = PyUnicode_Tailmatch(self->text, exec_prefix, start, text_len, -1);
3043 if (match == -1) {
3044 return -1;
3045 }
3046 if (match) {
3047 PyObject *msg = PyUnicode_FromString("Missing parentheses in call "
3048 "to 'exec'");
3049 if (msg == NULL) {
3050 return -1;
3051 }
3052 Py_XSETREF(self->msg, msg);
Nick Coghlan5b1fdc12014-06-16 19:48:02 +10003053 return 1;
3054 }
3055 /* Fall back to the default error message */
3056 return 0;
3057}
3058
3059static int
3060_report_missing_parentheses(PySyntaxErrorObject *self)
3061{
3062 Py_UCS4 left_paren = 40;
3063 Py_ssize_t left_paren_index;
3064 Py_ssize_t text_len = PyUnicode_GET_LENGTH(self->text);
3065 int legacy_check_result = 0;
3066
3067 /* Skip entirely if there is an opening parenthesis */
3068 left_paren_index = PyUnicode_FindChar(self->text, left_paren,
3069 0, text_len, 1);
3070 if (left_paren_index < -1) {
3071 return -1;
3072 }
3073 if (left_paren_index != -1) {
3074 /* Use default error message for any line with an opening paren */
3075 return 0;
3076 }
3077 /* Handle the simple statement case */
3078 legacy_check_result = _check_for_legacy_statements(self, 0);
3079 if (legacy_check_result < 0) {
3080 return -1;
3081
3082 }
3083 if (legacy_check_result == 0) {
3084 /* Handle the one-line complex statement case */
3085 Py_UCS4 colon = 58;
3086 Py_ssize_t colon_index;
3087 colon_index = PyUnicode_FindChar(self->text, colon,
3088 0, text_len, 1);
3089 if (colon_index < -1) {
3090 return -1;
3091 }
3092 if (colon_index >= 0 && colon_index < text_len) {
3093 /* Check again, starting from just after the colon */
3094 if (_check_for_legacy_statements(self, colon_index+1) < 0) {
3095 return -1;
3096 }
3097 }
3098 }
3099 return 0;
3100}