blob: 0f86cfb194237f39f6974dbf65de380f4e6070df [file] [log] [blame]
Georg Brandl43ab1002006-05-28 20:57:09 +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
Richard Jones7b9558d2006-05-27 12:29:24 +00007#define PY_SSIZE_T_CLEAN
8#include <Python.h>
9#include "structmember.h"
10#include "osdefs.h"
11
Richard Jones7b9558d2006-05-27 12:29:24 +000012#define EXC_MODULE_NAME "exceptions."
13
Richard Jonesc5b2a2e2006-05-27 16:07:28 +000014/* NOTE: If the exception class hierarchy changes, don't forget to update
15 * Lib/test/exception_hierarchy.txt
16 */
17
18PyDoc_STRVAR(exceptions_doc, "Python's standard exception class hierarchy.\n\
19\n\
20Exceptions found here are defined both in the exceptions module and the\n\
21built-in namespace. It is recommended that user-defined exceptions\n\
22inherit from Exception. See the documentation for the exception\n\
23inheritance hierarchy.\n\
24");
25
Richard Jones7b9558d2006-05-27 12:29:24 +000026/*
27 * BaseException
28 */
29static PyObject *
30BaseException_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
31{
32 PyBaseExceptionObject *self;
33
34 self = (PyBaseExceptionObject *)type->tp_alloc(type, 0);
Georg Brandlc02e1312007-04-11 17:16:24 +000035 if (!self)
36 return NULL;
Richard Jones7b9558d2006-05-27 12:29:24 +000037 /* the dict is created on the fly in PyObject_GenericSetAttr */
38 self->message = self->dict = NULL;
39
Georg Brandld7e9f602007-08-21 06:03:43 +000040 self->args = PyTuple_New(0);
41 if (!self->args) {
Richard Jones7b9558d2006-05-27 12:29:24 +000042 Py_DECREF(self);
43 return NULL;
44 }
Georg Brandld7e9f602007-08-21 06:03:43 +000045
Gregory P. Smithdd96db62008-06-09 04:58:54 +000046 self->message = PyString_FromString("");
Richard Jones7b9558d2006-05-27 12:29:24 +000047 if (!self->message) {
48 Py_DECREF(self);
49 return NULL;
50 }
Georg Brandld7e9f602007-08-21 06:03:43 +000051
Richard Jones7b9558d2006-05-27 12:29:24 +000052 return (PyObject *)self;
53}
54
55static int
56BaseException_init(PyBaseExceptionObject *self, PyObject *args, PyObject *kwds)
57{
Christian Heimese93237d2007-12-19 02:37:44 +000058 if (!_PyArg_NoKeywords(Py_TYPE(self)->tp_name, kwds))
Georg Brandlb0432bc2006-05-30 08:17:00 +000059 return -1;
60
Richard Jones7b9558d2006-05-27 12:29:24 +000061 Py_DECREF(self->args);
62 self->args = args;
63 Py_INCREF(self->args);
64
65 if (PyTuple_GET_SIZE(self->args) == 1) {
Michael W. Hudson22a80e72006-05-28 15:51:40 +000066 Py_CLEAR(self->message);
Richard Jones7b9558d2006-05-27 12:29:24 +000067 self->message = PyTuple_GET_ITEM(self->args, 0);
Michael W. Hudson22a80e72006-05-28 15:51:40 +000068 Py_INCREF(self->message);
Richard Jones7b9558d2006-05-27 12:29:24 +000069 }
70 return 0;
71}
72
Michael W. Hudson96495ee2006-05-28 17:40:29 +000073static int
Richard Jones7b9558d2006-05-27 12:29:24 +000074BaseException_clear(PyBaseExceptionObject *self)
75{
76 Py_CLEAR(self->dict);
77 Py_CLEAR(self->args);
78 Py_CLEAR(self->message);
79 return 0;
80}
81
82static void
83BaseException_dealloc(PyBaseExceptionObject *self)
84{
Georg Brandl38f62372006-09-06 06:50:05 +000085 _PyObject_GC_UNTRACK(self);
Richard Jones7b9558d2006-05-27 12:29:24 +000086 BaseException_clear(self);
Christian Heimese93237d2007-12-19 02:37:44 +000087 Py_TYPE(self)->tp_free((PyObject *)self);
Richard Jones7b9558d2006-05-27 12:29:24 +000088}
89
Michael W. Hudson96495ee2006-05-28 17:40:29 +000090static int
Richard Jones7b9558d2006-05-27 12:29:24 +000091BaseException_traverse(PyBaseExceptionObject *self, visitproc visit, void *arg)
92{
Michael W. Hudson22a80e72006-05-28 15:51:40 +000093 Py_VISIT(self->dict);
Richard Jones7b9558d2006-05-27 12:29:24 +000094 Py_VISIT(self->args);
95 Py_VISIT(self->message);
96 return 0;
97}
98
99static PyObject *
100BaseException_str(PyBaseExceptionObject *self)
101{
102 PyObject *out;
103
Michael W. Hudson22a80e72006-05-28 15:51:40 +0000104 switch (PyTuple_GET_SIZE(self->args)) {
Richard Jones7b9558d2006-05-27 12:29:24 +0000105 case 0:
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000106 out = PyString_FromString("");
Richard Jones7b9558d2006-05-27 12:29:24 +0000107 break;
108 case 1:
Michael W. Hudson22a80e72006-05-28 15:51:40 +0000109 out = PyObject_Str(PyTuple_GET_ITEM(self->args, 0));
Richard Jones7b9558d2006-05-27 12:29:24 +0000110 break;
Richard Jones7b9558d2006-05-27 12:29:24 +0000111 default:
112 out = PyObject_Str(self->args);
113 break;
114 }
115
116 return out;
117}
118
Nick Coghlan524b7772008-07-08 14:08:04 +0000119#ifdef Py_USING_UNICODE
120static PyObject *
121BaseException_unicode(PyBaseExceptionObject *self)
122{
123 PyObject *out;
124
Ezio Melottif84caf42009-12-24 22:25:17 +0000125 /* issue6108: if __str__ has been overridden in the subclass, unicode()
126 should return the message returned by __str__ as used to happen
127 before this method was implemented. */
128 if (Py_TYPE(self)->tp_str != (reprfunc)BaseException_str) {
129 PyObject *str;
130 /* Unlike PyObject_Str, tp_str can return unicode (i.e. return the
131 equivalent of unicode(e.__str__()) instead of unicode(str(e))). */
132 str = Py_TYPE(self)->tp_str((PyObject*)self);
133 if (str == NULL)
134 return NULL;
135 out = PyObject_Unicode(str);
136 Py_DECREF(str);
137 return out;
138 }
139
Nick Coghlan524b7772008-07-08 14:08:04 +0000140 switch (PyTuple_GET_SIZE(self->args)) {
141 case 0:
142 out = PyUnicode_FromString("");
143 break;
144 case 1:
145 out = PyObject_Unicode(PyTuple_GET_ITEM(self->args, 0));
146 break;
147 default:
148 out = PyObject_Unicode(self->args);
149 break;
150 }
151
152 return out;
153}
154#endif
155
Richard Jones7b9558d2006-05-27 12:29:24 +0000156static PyObject *
157BaseException_repr(PyBaseExceptionObject *self)
158{
Richard Jones7b9558d2006-05-27 12:29:24 +0000159 PyObject *repr_suffix;
160 PyObject *repr;
161 char *name;
162 char *dot;
163
Michael W. Hudson22a80e72006-05-28 15:51:40 +0000164 repr_suffix = PyObject_Repr(self->args);
165 if (!repr_suffix)
Richard Jones7b9558d2006-05-27 12:29:24 +0000166 return NULL;
Richard Jones7b9558d2006-05-27 12:29:24 +0000167
Christian Heimese93237d2007-12-19 02:37:44 +0000168 name = (char *)Py_TYPE(self)->tp_name;
Richard Jones7b9558d2006-05-27 12:29:24 +0000169 dot = strrchr(name, '.');
170 if (dot != NULL) name = dot+1;
171
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000172 repr = PyString_FromString(name);
Richard Jones7b9558d2006-05-27 12:29:24 +0000173 if (!repr) {
174 Py_DECREF(repr_suffix);
175 return NULL;
176 }
177
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000178 PyString_ConcatAndDel(&repr, repr_suffix);
Richard Jones7b9558d2006-05-27 12:29:24 +0000179 return repr;
180}
181
182/* Pickling support */
183static PyObject *
184BaseException_reduce(PyBaseExceptionObject *self)
185{
Georg Brandlddba4732006-05-30 07:04:55 +0000186 if (self->args && self->dict)
Christian Heimese93237d2007-12-19 02:37:44 +0000187 return PyTuple_Pack(3, Py_TYPE(self), self->args, self->dict);
Georg Brandl05f97bf2006-05-30 07:13:29 +0000188 else
Christian Heimese93237d2007-12-19 02:37:44 +0000189 return PyTuple_Pack(2, Py_TYPE(self), self->args);
Richard Jones7b9558d2006-05-27 12:29:24 +0000190}
191
Georg Brandl85ac8502006-06-01 06:39:19 +0000192/*
193 * Needed for backward compatibility, since exceptions used to store
194 * all their attributes in the __dict__. Code is taken from cPickle's
195 * load_build function.
196 */
197static PyObject *
198BaseException_setstate(PyObject *self, PyObject *state)
199{
200 PyObject *d_key, *d_value;
201 Py_ssize_t i = 0;
202
203 if (state != Py_None) {
204 if (!PyDict_Check(state)) {
205 PyErr_SetString(PyExc_TypeError, "state is not a dictionary");
206 return NULL;
207 }
208 while (PyDict_Next(state, &i, &d_key, &d_value)) {
209 if (PyObject_SetAttr(self, d_key, d_value) < 0)
210 return NULL;
211 }
212 }
213 Py_RETURN_NONE;
214}
Richard Jones7b9558d2006-05-27 12:29:24 +0000215
Richard Jones7b9558d2006-05-27 12:29:24 +0000216
217static PyMethodDef BaseException_methods[] = {
218 {"__reduce__", (PyCFunction)BaseException_reduce, METH_NOARGS },
Georg Brandl85ac8502006-06-01 06:39:19 +0000219 {"__setstate__", (PyCFunction)BaseException_setstate, METH_O },
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000220#ifdef Py_USING_UNICODE
Nick Coghlan524b7772008-07-08 14:08:04 +0000221 {"__unicode__", (PyCFunction)BaseException_unicode, METH_NOARGS },
222#endif
Richard Jones7b9558d2006-05-27 12:29:24 +0000223 {NULL, NULL, 0, NULL},
224};
225
226
227
228static PyObject *
229BaseException_getitem(PyBaseExceptionObject *self, Py_ssize_t index)
230{
Benjamin Peterson9f4f4812008-04-27 03:01:45 +0000231 if (PyErr_WarnPy3k("__getitem__ not supported for exception "
232 "classes in 3.x; use args attribute", 1) < 0)
233 return NULL;
Richard Jones7b9558d2006-05-27 12:29:24 +0000234 return PySequence_GetItem(self->args, index);
235}
236
Brett Cannonf6aa86e2006-09-20 18:43:13 +0000237static PyObject *
238BaseException_getslice(PyBaseExceptionObject *self,
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000239 Py_ssize_t start, Py_ssize_t stop)
Brett Cannonf6aa86e2006-09-20 18:43:13 +0000240{
Benjamin Peterson9f4f4812008-04-27 03:01:45 +0000241 if (PyErr_WarnPy3k("__getslice__ not supported for exception "
242 "classes in 3.x; use args attribute", 1) < 0)
243 return NULL;
Brett Cannonf6aa86e2006-09-20 18:43:13 +0000244 return PySequence_GetSlice(self->args, start, stop);
245}
246
Richard Jones7b9558d2006-05-27 12:29:24 +0000247static PySequenceMethods BaseException_as_sequence = {
248 0, /* sq_length; */
249 0, /* sq_concat; */
250 0, /* sq_repeat; */
251 (ssizeargfunc)BaseException_getitem, /* sq_item; */
Brett Cannonf6aa86e2006-09-20 18:43:13 +0000252 (ssizessizeargfunc)BaseException_getslice, /* sq_slice; */
Richard Jones7b9558d2006-05-27 12:29:24 +0000253 0, /* sq_ass_item; */
254 0, /* sq_ass_slice; */
255 0, /* sq_contains; */
256 0, /* sq_inplace_concat; */
257 0 /* sq_inplace_repeat; */
258};
259
Richard Jones7b9558d2006-05-27 12:29:24 +0000260static PyObject *
261BaseException_get_dict(PyBaseExceptionObject *self)
262{
263 if (self->dict == NULL) {
264 self->dict = PyDict_New();
265 if (!self->dict)
266 return NULL;
267 }
268 Py_INCREF(self->dict);
269 return self->dict;
270}
271
272static int
273BaseException_set_dict(PyBaseExceptionObject *self, PyObject *val)
274{
275 if (val == NULL) {
276 PyErr_SetString(PyExc_TypeError, "__dict__ may not be deleted");
277 return -1;
278 }
279 if (!PyDict_Check(val)) {
280 PyErr_SetString(PyExc_TypeError, "__dict__ must be a dictionary");
281 return -1;
282 }
283 Py_CLEAR(self->dict);
284 Py_INCREF(val);
285 self->dict = val;
286 return 0;
287}
288
289static PyObject *
290BaseException_get_args(PyBaseExceptionObject *self)
291{
292 if (self->args == NULL) {
293 Py_INCREF(Py_None);
294 return Py_None;
295 }
296 Py_INCREF(self->args);
297 return self->args;
298}
299
300static int
301BaseException_set_args(PyBaseExceptionObject *self, PyObject *val)
302{
303 PyObject *seq;
304 if (val == NULL) {
305 PyErr_SetString(PyExc_TypeError, "args may not be deleted");
306 return -1;
307 }
308 seq = PySequence_Tuple(val);
Benjamin Peterson4c79aec2012-02-03 19:22:31 -0500309 if (!seq)
310 return -1;
Georg Brandlc7c51142006-05-29 09:46:51 +0000311 Py_CLEAR(self->args);
Richard Jones7b9558d2006-05-27 12:29:24 +0000312 self->args = seq;
313 return 0;
314}
315
Brett Cannon229cee22007-05-05 01:34:02 +0000316static PyObject *
317BaseException_get_message(PyBaseExceptionObject *self)
318{
Georg Brandl0674d3f2009-09-16 20:30:09 +0000319 PyObject *msg;
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000320
Georg Brandl0674d3f2009-09-16 20:30:09 +0000321 /* if "message" is in self->dict, accessing a user-set message attribute */
322 if (self->dict &&
323 (msg = PyDict_GetItemString(self->dict, "message"))) {
324 Py_INCREF(msg);
325 return msg;
326 }
Brett Cannon229cee22007-05-05 01:34:02 +0000327
Georg Brandl0674d3f2009-09-16 20:30:09 +0000328 if (self->message == NULL) {
329 PyErr_SetString(PyExc_AttributeError, "message attribute was deleted");
330 return NULL;
331 }
332
333 /* accessing the deprecated "builtin" message attribute of Exception */
334 if (PyErr_WarnEx(PyExc_DeprecationWarning,
335 "BaseException.message has been deprecated as "
336 "of Python 2.6", 1) < 0)
337 return NULL;
338
339 Py_INCREF(self->message);
340 return self->message;
Brett Cannon229cee22007-05-05 01:34:02 +0000341}
342
343static int
344BaseException_set_message(PyBaseExceptionObject *self, PyObject *val)
345{
Georg Brandl0674d3f2009-09-16 20:30:09 +0000346 /* if val is NULL, delete the message attribute */
347 if (val == NULL) {
348 if (self->dict && PyDict_GetItemString(self->dict, "message")) {
349 if (PyDict_DelItemString(self->dict, "message") < 0)
350 return -1;
351 }
Mark Dickinson7cac1c22013-03-03 11:13:34 +0000352 Py_CLEAR(self->message);
Georg Brandl0674d3f2009-09-16 20:30:09 +0000353 return 0;
354 }
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000355
Georg Brandl0674d3f2009-09-16 20:30:09 +0000356 /* else set it in __dict__, but may need to create the dict first */
357 if (self->dict == NULL) {
358 self->dict = PyDict_New();
359 if (!self->dict)
360 return -1;
361 }
362 return PyDict_SetItemString(self->dict, "message", val);
Brett Cannon229cee22007-05-05 01:34:02 +0000363}
364
Richard Jones7b9558d2006-05-27 12:29:24 +0000365static PyGetSetDef BaseException_getset[] = {
366 {"__dict__", (getter)BaseException_get_dict, (setter)BaseException_set_dict},
367 {"args", (getter)BaseException_get_args, (setter)BaseException_set_args},
Brett Cannon229cee22007-05-05 01:34:02 +0000368 {"message", (getter)BaseException_get_message,
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000369 (setter)BaseException_set_message},
Richard Jones7b9558d2006-05-27 12:29:24 +0000370 {NULL},
371};
372
373
374static PyTypeObject _PyExc_BaseException = {
375 PyObject_HEAD_INIT(NULL)
376 0, /*ob_size*/
377 EXC_MODULE_NAME "BaseException", /*tp_name*/
378 sizeof(PyBaseExceptionObject), /*tp_basicsize*/
379 0, /*tp_itemsize*/
380 (destructor)BaseException_dealloc, /*tp_dealloc*/
381 0, /*tp_print*/
382 0, /*tp_getattr*/
383 0, /*tp_setattr*/
384 0, /* tp_compare; */
385 (reprfunc)BaseException_repr, /*tp_repr*/
386 0, /*tp_as_number*/
387 &BaseException_as_sequence, /*tp_as_sequence*/
388 0, /*tp_as_mapping*/
389 0, /*tp_hash */
390 0, /*tp_call*/
391 (reprfunc)BaseException_str, /*tp_str*/
392 PyObject_GenericGetAttr, /*tp_getattro*/
393 PyObject_GenericSetAttr, /*tp_setattro*/
394 0, /*tp_as_buffer*/
Neal Norwitzee3a1b52007-02-25 19:44:48 +0000395 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC |
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000396 Py_TPFLAGS_BASE_EXC_SUBCLASS, /*tp_flags*/
Richard Jones7b9558d2006-05-27 12:29:24 +0000397 PyDoc_STR("Common base class for all exceptions"), /* tp_doc */
398 (traverseproc)BaseException_traverse, /* tp_traverse */
399 (inquiry)BaseException_clear, /* tp_clear */
400 0, /* tp_richcompare */
401 0, /* tp_weaklistoffset */
402 0, /* tp_iter */
403 0, /* tp_iternext */
404 BaseException_methods, /* tp_methods */
Brett Cannon229cee22007-05-05 01:34:02 +0000405 0, /* tp_members */
Richard Jones7b9558d2006-05-27 12:29:24 +0000406 BaseException_getset, /* tp_getset */
407 0, /* tp_base */
408 0, /* tp_dict */
409 0, /* tp_descr_get */
410 0, /* tp_descr_set */
411 offsetof(PyBaseExceptionObject, dict), /* tp_dictoffset */
412 (initproc)BaseException_init, /* tp_init */
413 0, /* tp_alloc */
414 BaseException_new, /* tp_new */
415};
416/* the CPython API expects exceptions to be (PyObject *) - both a hold-over
417from the previous implmentation and also allowing Python objects to be used
418in the API */
419PyObject *PyExc_BaseException = (PyObject *)&_PyExc_BaseException;
420
Richard Jones2d555b32006-05-27 16:15:11 +0000421/* note these macros omit the last semicolon so the macro invocation may
422 * include it and not look strange.
423 */
Richard Jones7b9558d2006-05-27 12:29:24 +0000424#define SimpleExtendsException(EXCBASE, EXCNAME, EXCDOC) \
425static PyTypeObject _PyExc_ ## EXCNAME = { \
426 PyObject_HEAD_INIT(NULL) \
427 0, \
428 EXC_MODULE_NAME # EXCNAME, \
429 sizeof(PyBaseExceptionObject), \
430 0, (destructor)BaseException_dealloc, 0, 0, 0, 0, 0, 0, 0, \
431 0, 0, 0, 0, 0, 0, 0, \
432 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, \
433 PyDoc_STR(EXCDOC), (traverseproc)BaseException_traverse, \
434 (inquiry)BaseException_clear, 0, 0, 0, 0, 0, 0, 0, &_ ## EXCBASE, \
435 0, 0, 0, offsetof(PyBaseExceptionObject, dict), \
436 (initproc)BaseException_init, 0, BaseException_new,\
437}; \
Richard Jones2d555b32006-05-27 16:15:11 +0000438PyObject *PyExc_ ## EXCNAME = (PyObject *)&_PyExc_ ## EXCNAME
Richard Jones7b9558d2006-05-27 12:29:24 +0000439
440#define MiddlingExtendsException(EXCBASE, EXCNAME, EXCSTORE, EXCDOC) \
441static PyTypeObject _PyExc_ ## EXCNAME = { \
442 PyObject_HEAD_INIT(NULL) \
443 0, \
444 EXC_MODULE_NAME # EXCNAME, \
445 sizeof(Py ## EXCSTORE ## Object), \
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000446 0, (destructor)EXCSTORE ## _dealloc, 0, 0, 0, 0, 0, 0, 0, 0, 0, \
Richard Jones7b9558d2006-05-27 12:29:24 +0000447 0, 0, 0, 0, 0, \
448 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, \
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000449 PyDoc_STR(EXCDOC), (traverseproc)EXCSTORE ## _traverse, \
450 (inquiry)EXCSTORE ## _clear, 0, 0, 0, 0, 0, 0, 0, &_ ## EXCBASE, \
Richard Jones7b9558d2006-05-27 12:29:24 +0000451 0, 0, 0, offsetof(Py ## EXCSTORE ## Object, dict), \
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000452 (initproc)EXCSTORE ## _init, 0, BaseException_new,\
Richard Jones7b9558d2006-05-27 12:29:24 +0000453}; \
Richard Jones2d555b32006-05-27 16:15:11 +0000454PyObject *PyExc_ ## EXCNAME = (PyObject *)&_PyExc_ ## EXCNAME
Richard Jones7b9558d2006-05-27 12:29:24 +0000455
456#define ComplexExtendsException(EXCBASE, EXCNAME, EXCSTORE, EXCDEALLOC, EXCMETHODS, EXCMEMBERS, EXCSTR, EXCDOC) \
457static PyTypeObject _PyExc_ ## EXCNAME = { \
458 PyObject_HEAD_INIT(NULL) \
459 0, \
460 EXC_MODULE_NAME # EXCNAME, \
461 sizeof(Py ## EXCSTORE ## Object), 0, \
462 (destructor)EXCSTORE ## _dealloc, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, \
463 (reprfunc)EXCSTR, 0, 0, 0, \
464 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, \
465 PyDoc_STR(EXCDOC), (traverseproc)EXCSTORE ## _traverse, \
466 (inquiry)EXCSTORE ## _clear, 0, 0, 0, 0, EXCMETHODS, \
467 EXCMEMBERS, 0, &_ ## EXCBASE, \
468 0, 0, 0, offsetof(Py ## EXCSTORE ## Object, dict), \
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000469 (initproc)EXCSTORE ## _init, 0, BaseException_new,\
Richard Jones7b9558d2006-05-27 12:29:24 +0000470}; \
Richard Jones2d555b32006-05-27 16:15:11 +0000471PyObject *PyExc_ ## EXCNAME = (PyObject *)&_PyExc_ ## EXCNAME
Richard Jones7b9558d2006-05-27 12:29:24 +0000472
473
474/*
475 * Exception extends BaseException
476 */
477SimpleExtendsException(PyExc_BaseException, Exception,
Richard Jones2d555b32006-05-27 16:15:11 +0000478 "Common base class for all non-exit exceptions.");
Richard Jones7b9558d2006-05-27 12:29:24 +0000479
480
481/*
482 * StandardError extends Exception
483 */
Michael W. Hudson22a80e72006-05-28 15:51:40 +0000484SimpleExtendsException(PyExc_Exception, StandardError,
Richard Jones7b9558d2006-05-27 12:29:24 +0000485 "Base class for all standard Python exceptions that do not represent\n"
Richard Jones2d555b32006-05-27 16:15:11 +0000486 "interpreter exiting.");
Richard Jones7b9558d2006-05-27 12:29:24 +0000487
488
489/*
490 * TypeError extends StandardError
491 */
492SimpleExtendsException(PyExc_StandardError, TypeError,
Richard Jones2d555b32006-05-27 16:15:11 +0000493 "Inappropriate argument type.");
Richard Jones7b9558d2006-05-27 12:29:24 +0000494
495
496/*
497 * StopIteration extends Exception
498 */
499SimpleExtendsException(PyExc_Exception, StopIteration,
Richard Jones2d555b32006-05-27 16:15:11 +0000500 "Signal the end from iterator.next().");
Richard Jones7b9558d2006-05-27 12:29:24 +0000501
502
503/*
Christian Heimes44eeaec2007-12-03 20:01:02 +0000504 * GeneratorExit extends BaseException
Richard Jones7b9558d2006-05-27 12:29:24 +0000505 */
Christian Heimes44eeaec2007-12-03 20:01:02 +0000506SimpleExtendsException(PyExc_BaseException, GeneratorExit,
Richard Jones2d555b32006-05-27 16:15:11 +0000507 "Request that a generator exit.");
Richard Jones7b9558d2006-05-27 12:29:24 +0000508
509
510/*
511 * SystemExit extends BaseException
512 */
Richard Jones7b9558d2006-05-27 12:29:24 +0000513
514static int
515SystemExit_init(PySystemExitObject *self, PyObject *args, PyObject *kwds)
516{
517 Py_ssize_t size = PyTuple_GET_SIZE(args);
518
519 if (BaseException_init((PyBaseExceptionObject *)self, args, kwds) == -1)
520 return -1;
521
Michael W. Hudson22a80e72006-05-28 15:51:40 +0000522 if (size == 0)
523 return 0;
524 Py_CLEAR(self->code);
Richard Jones7b9558d2006-05-27 12:29:24 +0000525 if (size == 1)
526 self->code = PyTuple_GET_ITEM(args, 0);
527 else if (size > 1)
528 self->code = args;
529 Py_INCREF(self->code);
530 return 0;
531}
532
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000533static int
Richard Jones7b9558d2006-05-27 12:29:24 +0000534SystemExit_clear(PySystemExitObject *self)
535{
536 Py_CLEAR(self->code);
537 return BaseException_clear((PyBaseExceptionObject *)self);
538}
539
540static void
541SystemExit_dealloc(PySystemExitObject *self)
542{
Georg Brandl38f62372006-09-06 06:50:05 +0000543 _PyObject_GC_UNTRACK(self);
Richard Jones7b9558d2006-05-27 12:29:24 +0000544 SystemExit_clear(self);
Christian Heimese93237d2007-12-19 02:37:44 +0000545 Py_TYPE(self)->tp_free((PyObject *)self);
Richard Jones7b9558d2006-05-27 12:29:24 +0000546}
547
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000548static int
Richard Jones7b9558d2006-05-27 12:29:24 +0000549SystemExit_traverse(PySystemExitObject *self, visitproc visit, void *arg)
550{
551 Py_VISIT(self->code);
552 return BaseException_traverse((PyBaseExceptionObject *)self, visit, arg);
553}
554
555static PyMemberDef SystemExit_members[] = {
Richard Jones7b9558d2006-05-27 12:29:24 +0000556 {"code", T_OBJECT, offsetof(PySystemExitObject, code), 0,
557 PyDoc_STR("exception code")},
558 {NULL} /* Sentinel */
559};
560
561ComplexExtendsException(PyExc_BaseException, SystemExit, SystemExit,
562 SystemExit_dealloc, 0, SystemExit_members, 0,
Richard Jones2d555b32006-05-27 16:15:11 +0000563 "Request to exit from the interpreter.");
Richard Jones7b9558d2006-05-27 12:29:24 +0000564
565/*
566 * KeyboardInterrupt extends BaseException
567 */
568SimpleExtendsException(PyExc_BaseException, KeyboardInterrupt,
Richard Jones2d555b32006-05-27 16:15:11 +0000569 "Program interrupted by user.");
Richard Jones7b9558d2006-05-27 12:29:24 +0000570
571
572/*
573 * ImportError extends StandardError
574 */
575SimpleExtendsException(PyExc_StandardError, ImportError,
Richard Jones2d555b32006-05-27 16:15:11 +0000576 "Import can't find module, or can't find name in module.");
Richard Jones7b9558d2006-05-27 12:29:24 +0000577
578
579/*
580 * EnvironmentError extends StandardError
581 */
582
Richard Jones7b9558d2006-05-27 12:29:24 +0000583/* Where a function has a single filename, such as open() or some
584 * of the os module functions, PyErr_SetFromErrnoWithFilename() is
585 * called, giving a third argument which is the filename. But, so
586 * that old code using in-place unpacking doesn't break, e.g.:
587 *
588 * except IOError, (errno, strerror):
589 *
590 * we hack args so that it only contains two items. This also
591 * means we need our own __str__() which prints out the filename
592 * when it was supplied.
593 */
594static int
595EnvironmentError_init(PyEnvironmentErrorObject *self, PyObject *args,
596 PyObject *kwds)
597{
598 PyObject *myerrno = NULL, *strerror = NULL, *filename = NULL;
599 PyObject *subslice = NULL;
600
601 if (BaseException_init((PyBaseExceptionObject *)self, args, kwds) == -1)
602 return -1;
603
Georg Brandl3267d282006-09-30 09:03:42 +0000604 if (PyTuple_GET_SIZE(args) <= 1 || PyTuple_GET_SIZE(args) > 3) {
Richard Jones7b9558d2006-05-27 12:29:24 +0000605 return 0;
606 }
Michael W. Hudson22a80e72006-05-28 15:51:40 +0000607
608 if (!PyArg_UnpackTuple(args, "EnvironmentError", 2, 3,
Richard Jones7b9558d2006-05-27 12:29:24 +0000609 &myerrno, &strerror, &filename)) {
610 return -1;
611 }
Michael W. Hudson22a80e72006-05-28 15:51:40 +0000612 Py_CLEAR(self->myerrno); /* replacing */
Richard Jones7b9558d2006-05-27 12:29:24 +0000613 self->myerrno = myerrno;
614 Py_INCREF(self->myerrno);
615
Michael W. Hudson22a80e72006-05-28 15:51:40 +0000616 Py_CLEAR(self->strerror); /* replacing */
Richard Jones7b9558d2006-05-27 12:29:24 +0000617 self->strerror = strerror;
618 Py_INCREF(self->strerror);
619
620 /* self->filename will remain Py_None otherwise */
621 if (filename != NULL) {
Michael W. Hudson22a80e72006-05-28 15:51:40 +0000622 Py_CLEAR(self->filename); /* replacing */
Richard Jones7b9558d2006-05-27 12:29:24 +0000623 self->filename = filename;
624 Py_INCREF(self->filename);
625
626 subslice = PyTuple_GetSlice(args, 0, 2);
627 if (!subslice)
628 return -1;
629
630 Py_DECREF(self->args); /* replacing args */
631 self->args = subslice;
632 }
633 return 0;
634}
635
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000636static int
Richard Jones7b9558d2006-05-27 12:29:24 +0000637EnvironmentError_clear(PyEnvironmentErrorObject *self)
638{
639 Py_CLEAR(self->myerrno);
640 Py_CLEAR(self->strerror);
641 Py_CLEAR(self->filename);
642 return BaseException_clear((PyBaseExceptionObject *)self);
643}
644
645static void
646EnvironmentError_dealloc(PyEnvironmentErrorObject *self)
647{
Georg Brandl38f62372006-09-06 06:50:05 +0000648 _PyObject_GC_UNTRACK(self);
Richard Jones7b9558d2006-05-27 12:29:24 +0000649 EnvironmentError_clear(self);
Christian Heimese93237d2007-12-19 02:37:44 +0000650 Py_TYPE(self)->tp_free((PyObject *)self);
Richard Jones7b9558d2006-05-27 12:29:24 +0000651}
652
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000653static int
Richard Jones7b9558d2006-05-27 12:29:24 +0000654EnvironmentError_traverse(PyEnvironmentErrorObject *self, visitproc visit,
655 void *arg)
656{
657 Py_VISIT(self->myerrno);
658 Py_VISIT(self->strerror);
659 Py_VISIT(self->filename);
660 return BaseException_traverse((PyBaseExceptionObject *)self, visit, arg);
661}
662
663static PyObject *
664EnvironmentError_str(PyEnvironmentErrorObject *self)
665{
666 PyObject *rtnval = NULL;
667
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000668 if (self->filename) {
669 PyObject *fmt;
670 PyObject *repr;
671 PyObject *tuple;
Richard Jones7b9558d2006-05-27 12:29:24 +0000672
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000673 fmt = PyString_FromString("[Errno %s] %s: %s");
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000674 if (!fmt)
675 return NULL;
676
677 repr = PyObject_Repr(self->filename);
678 if (!repr) {
679 Py_DECREF(fmt);
Richard Jones7b9558d2006-05-27 12:29:24 +0000680 return NULL;
681 }
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000682 tuple = PyTuple_New(3);
683 if (!tuple) {
684 Py_DECREF(repr);
685 Py_DECREF(fmt);
686 return NULL;
687 }
688
689 if (self->myerrno) {
690 Py_INCREF(self->myerrno);
691 PyTuple_SET_ITEM(tuple, 0, self->myerrno);
692 }
693 else {
694 Py_INCREF(Py_None);
695 PyTuple_SET_ITEM(tuple, 0, Py_None);
696 }
697 if (self->strerror) {
698 Py_INCREF(self->strerror);
699 PyTuple_SET_ITEM(tuple, 1, self->strerror);
700 }
701 else {
702 Py_INCREF(Py_None);
703 PyTuple_SET_ITEM(tuple, 1, Py_None);
704 }
705
Richard Jones7b9558d2006-05-27 12:29:24 +0000706 PyTuple_SET_ITEM(tuple, 2, repr);
707
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000708 rtnval = PyString_Format(fmt, tuple);
Richard Jones7b9558d2006-05-27 12:29:24 +0000709
710 Py_DECREF(fmt);
711 Py_DECREF(tuple);
712 }
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000713 else if (self->myerrno && self->strerror) {
714 PyObject *fmt;
715 PyObject *tuple;
Richard Jones7b9558d2006-05-27 12:29:24 +0000716
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000717 fmt = PyString_FromString("[Errno %s] %s");
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000718 if (!fmt)
719 return NULL;
720
721 tuple = PyTuple_New(2);
722 if (!tuple) {
723 Py_DECREF(fmt);
Richard Jones7b9558d2006-05-27 12:29:24 +0000724 return NULL;
725 }
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000726
727 if (self->myerrno) {
728 Py_INCREF(self->myerrno);
729 PyTuple_SET_ITEM(tuple, 0, self->myerrno);
730 }
731 else {
732 Py_INCREF(Py_None);
733 PyTuple_SET_ITEM(tuple, 0, Py_None);
734 }
735 if (self->strerror) {
736 Py_INCREF(self->strerror);
737 PyTuple_SET_ITEM(tuple, 1, self->strerror);
738 }
739 else {
740 Py_INCREF(Py_None);
741 PyTuple_SET_ITEM(tuple, 1, Py_None);
742 }
Richard Jones7b9558d2006-05-27 12:29:24 +0000743
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000744 rtnval = PyString_Format(fmt, tuple);
Richard Jones7b9558d2006-05-27 12:29:24 +0000745
746 Py_DECREF(fmt);
747 Py_DECREF(tuple);
748 }
749 else
750 rtnval = BaseException_str((PyBaseExceptionObject *)self);
751
752 return rtnval;
753}
754
755static PyMemberDef EnvironmentError_members[] = {
Richard Jones7b9558d2006-05-27 12:29:24 +0000756 {"errno", T_OBJECT, offsetof(PyEnvironmentErrorObject, myerrno), 0,
Richard Jonesc5b2a2e2006-05-27 16:07:28 +0000757 PyDoc_STR("exception errno")},
Richard Jones7b9558d2006-05-27 12:29:24 +0000758 {"strerror", T_OBJECT, offsetof(PyEnvironmentErrorObject, strerror), 0,
Richard Jonesc5b2a2e2006-05-27 16:07:28 +0000759 PyDoc_STR("exception strerror")},
Richard Jones7b9558d2006-05-27 12:29:24 +0000760 {"filename", T_OBJECT, offsetof(PyEnvironmentErrorObject, filename), 0,
Richard Jonesc5b2a2e2006-05-27 16:07:28 +0000761 PyDoc_STR("exception filename")},
Richard Jones7b9558d2006-05-27 12:29:24 +0000762 {NULL} /* Sentinel */
763};
764
765
766static PyObject *
767EnvironmentError_reduce(PyEnvironmentErrorObject *self)
768{
769 PyObject *args = self->args;
770 PyObject *res = NULL, *tmp;
Georg Brandl05f97bf2006-05-30 07:13:29 +0000771
Richard Jones7b9558d2006-05-27 12:29:24 +0000772 /* self->args is only the first two real arguments if there was a
773 * file name given to EnvironmentError. */
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000774 if (PyTuple_GET_SIZE(args) == 2 && self->filename) {
Richard Jones7b9558d2006-05-27 12:29:24 +0000775 args = PyTuple_New(3);
Benjamin Peterson4c79aec2012-02-03 19:22:31 -0500776 if (!args)
777 return NULL;
Michael W. Hudson22a80e72006-05-28 15:51:40 +0000778
779 tmp = PyTuple_GET_ITEM(self->args, 0);
Richard Jones7b9558d2006-05-27 12:29:24 +0000780 Py_INCREF(tmp);
781 PyTuple_SET_ITEM(args, 0, tmp);
Michael W. Hudson22a80e72006-05-28 15:51:40 +0000782
783 tmp = PyTuple_GET_ITEM(self->args, 1);
Richard Jones7b9558d2006-05-27 12:29:24 +0000784 Py_INCREF(tmp);
785 PyTuple_SET_ITEM(args, 1, tmp);
786
787 Py_INCREF(self->filename);
788 PyTuple_SET_ITEM(args, 2, self->filename);
Georg Brandl05f97bf2006-05-30 07:13:29 +0000789 } else
Richard Jones7b9558d2006-05-27 12:29:24 +0000790 Py_INCREF(args);
Georg Brandl05f97bf2006-05-30 07:13:29 +0000791
792 if (self->dict)
Christian Heimese93237d2007-12-19 02:37:44 +0000793 res = PyTuple_Pack(3, Py_TYPE(self), args, self->dict);
Georg Brandl05f97bf2006-05-30 07:13:29 +0000794 else
Christian Heimese93237d2007-12-19 02:37:44 +0000795 res = PyTuple_Pack(2, Py_TYPE(self), args);
Richard Jones7b9558d2006-05-27 12:29:24 +0000796 Py_DECREF(args);
797 return res;
798}
799
800
801static PyMethodDef EnvironmentError_methods[] = {
802 {"__reduce__", (PyCFunction)EnvironmentError_reduce, METH_NOARGS},
803 {NULL}
804};
805
806ComplexExtendsException(PyExc_StandardError, EnvironmentError,
807 EnvironmentError, EnvironmentError_dealloc,
808 EnvironmentError_methods, EnvironmentError_members,
Michael W. Hudson22a80e72006-05-28 15:51:40 +0000809 EnvironmentError_str,
Richard Jones2d555b32006-05-27 16:15:11 +0000810 "Base class for I/O related errors.");
Richard Jones7b9558d2006-05-27 12:29:24 +0000811
812
813/*
814 * IOError extends EnvironmentError
815 */
Michael W. Hudson22a80e72006-05-28 15:51:40 +0000816MiddlingExtendsException(PyExc_EnvironmentError, IOError,
Richard Jones2d555b32006-05-27 16:15:11 +0000817 EnvironmentError, "I/O operation failed.");
Richard Jones7b9558d2006-05-27 12:29:24 +0000818
819
820/*
821 * OSError extends EnvironmentError
822 */
823MiddlingExtendsException(PyExc_EnvironmentError, OSError,
Richard Jones2d555b32006-05-27 16:15:11 +0000824 EnvironmentError, "OS system call failed.");
Richard Jones7b9558d2006-05-27 12:29:24 +0000825
826
827/*
828 * WindowsError extends OSError
829 */
830#ifdef MS_WINDOWS
831#include "errmap.h"
832
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000833static int
Richard Jones7b9558d2006-05-27 12:29:24 +0000834WindowsError_clear(PyWindowsErrorObject *self)
835{
836 Py_CLEAR(self->myerrno);
837 Py_CLEAR(self->strerror);
838 Py_CLEAR(self->filename);
839 Py_CLEAR(self->winerror);
840 return BaseException_clear((PyBaseExceptionObject *)self);
841}
842
843static void
844WindowsError_dealloc(PyWindowsErrorObject *self)
845{
Georg Brandl38f62372006-09-06 06:50:05 +0000846 _PyObject_GC_UNTRACK(self);
Richard Jones7b9558d2006-05-27 12:29:24 +0000847 WindowsError_clear(self);
Christian Heimese93237d2007-12-19 02:37:44 +0000848 Py_TYPE(self)->tp_free((PyObject *)self);
Richard Jones7b9558d2006-05-27 12:29:24 +0000849}
850
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000851static int
Richard Jones7b9558d2006-05-27 12:29:24 +0000852WindowsError_traverse(PyWindowsErrorObject *self, visitproc visit, void *arg)
853{
854 Py_VISIT(self->myerrno);
855 Py_VISIT(self->strerror);
856 Py_VISIT(self->filename);
857 Py_VISIT(self->winerror);
858 return BaseException_traverse((PyBaseExceptionObject *)self, visit, arg);
859}
860
Richard Jones7b9558d2006-05-27 12:29:24 +0000861static int
862WindowsError_init(PyWindowsErrorObject *self, PyObject *args, PyObject *kwds)
863{
864 PyObject *o_errcode = NULL;
865 long errcode;
866 long posix_errno;
867
868 if (EnvironmentError_init((PyEnvironmentErrorObject *)self, args, kwds)
869 == -1)
870 return -1;
871
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000872 if (self->myerrno == NULL)
Richard Jones7b9558d2006-05-27 12:29:24 +0000873 return 0;
Richard Jones7b9558d2006-05-27 12:29:24 +0000874
875 /* Set errno to the POSIX errno, and winerror to the Win32
876 error code. */
877 errcode = PyInt_AsLong(self->myerrno);
878 if (errcode == -1 && PyErr_Occurred())
879 return -1;
880 posix_errno = winerror_to_errno(errcode);
881
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000882 Py_CLEAR(self->winerror);
Richard Jones7b9558d2006-05-27 12:29:24 +0000883 self->winerror = self->myerrno;
884
885 o_errcode = PyInt_FromLong(posix_errno);
886 if (!o_errcode)
887 return -1;
888
889 self->myerrno = o_errcode;
890
891 return 0;
892}
893
894
895static PyObject *
896WindowsError_str(PyWindowsErrorObject *self)
897{
Richard Jones7b9558d2006-05-27 12:29:24 +0000898 PyObject *rtnval = NULL;
899
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000900 if (self->filename) {
901 PyObject *fmt;
902 PyObject *repr;
903 PyObject *tuple;
Richard Jones7b9558d2006-05-27 12:29:24 +0000904
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000905 fmt = PyString_FromString("[Error %s] %s: %s");
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000906 if (!fmt)
907 return NULL;
908
909 repr = PyObject_Repr(self->filename);
910 if (!repr) {
911 Py_DECREF(fmt);
912 return NULL;
913 }
914 tuple = PyTuple_New(3);
915 if (!tuple) {
916 Py_DECREF(repr);
917 Py_DECREF(fmt);
918 return NULL;
919 }
920
Thomas Hellerdf08f0b2006-10-27 18:31:36 +0000921 if (self->winerror) {
922 Py_INCREF(self->winerror);
923 PyTuple_SET_ITEM(tuple, 0, self->winerror);
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000924 }
925 else {
926 Py_INCREF(Py_None);
927 PyTuple_SET_ITEM(tuple, 0, Py_None);
928 }
929 if (self->strerror) {
930 Py_INCREF(self->strerror);
931 PyTuple_SET_ITEM(tuple, 1, self->strerror);
932 }
933 else {
934 Py_INCREF(Py_None);
935 PyTuple_SET_ITEM(tuple, 1, Py_None);
936 }
937
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000938 PyTuple_SET_ITEM(tuple, 2, repr);
Richard Jones7b9558d2006-05-27 12:29:24 +0000939
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000940 rtnval = PyString_Format(fmt, tuple);
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000941
942 Py_DECREF(fmt);
Richard Jones7b9558d2006-05-27 12:29:24 +0000943 Py_DECREF(tuple);
944 }
Thomas Hellerdf08f0b2006-10-27 18:31:36 +0000945 else if (self->winerror && self->strerror) {
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000946 PyObject *fmt;
947 PyObject *tuple;
948
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000949 fmt = PyString_FromString("[Error %s] %s");
Richard Jones7b9558d2006-05-27 12:29:24 +0000950 if (!fmt)
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000951 return NULL;
Richard Jones7b9558d2006-05-27 12:29:24 +0000952
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000953 tuple = PyTuple_New(2);
954 if (!tuple) {
955 Py_DECREF(fmt);
956 return NULL;
957 }
958
Thomas Hellerdf08f0b2006-10-27 18:31:36 +0000959 if (self->winerror) {
960 Py_INCREF(self->winerror);
961 PyTuple_SET_ITEM(tuple, 0, self->winerror);
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000962 }
963 else {
964 Py_INCREF(Py_None);
965 PyTuple_SET_ITEM(tuple, 0, Py_None);
966 }
967 if (self->strerror) {
968 Py_INCREF(self->strerror);
969 PyTuple_SET_ITEM(tuple, 1, self->strerror);
970 }
971 else {
972 Py_INCREF(Py_None);
973 PyTuple_SET_ITEM(tuple, 1, Py_None);
974 }
Richard Jones7b9558d2006-05-27 12:29:24 +0000975
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000976 rtnval = PyString_Format(fmt, tuple);
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000977
978 Py_DECREF(fmt);
Richard Jones7b9558d2006-05-27 12:29:24 +0000979 Py_DECREF(tuple);
980 }
981 else
Michael W. Hudson96495ee2006-05-28 17:40:29 +0000982 rtnval = EnvironmentError_str((PyEnvironmentErrorObject *)self);
Richard Jones7b9558d2006-05-27 12:29:24 +0000983
Richard Jones7b9558d2006-05-27 12:29:24 +0000984 return rtnval;
985}
986
987static PyMemberDef WindowsError_members[] = {
Richard Jones7b9558d2006-05-27 12:29:24 +0000988 {"errno", T_OBJECT, offsetof(PyWindowsErrorObject, myerrno), 0,
Richard Jonesc5b2a2e2006-05-27 16:07:28 +0000989 PyDoc_STR("POSIX exception code")},
Richard Jones7b9558d2006-05-27 12:29:24 +0000990 {"strerror", T_OBJECT, offsetof(PyWindowsErrorObject, strerror), 0,
Richard Jonesc5b2a2e2006-05-27 16:07:28 +0000991 PyDoc_STR("exception strerror")},
Richard Jones7b9558d2006-05-27 12:29:24 +0000992 {"filename", T_OBJECT, offsetof(PyWindowsErrorObject, filename), 0,
Richard Jonesc5b2a2e2006-05-27 16:07:28 +0000993 PyDoc_STR("exception filename")},
Richard Jones7b9558d2006-05-27 12:29:24 +0000994 {"winerror", T_OBJECT, offsetof(PyWindowsErrorObject, winerror), 0,
Richard Jonesc5b2a2e2006-05-27 16:07:28 +0000995 PyDoc_STR("Win32 exception code")},
Richard Jones7b9558d2006-05-27 12:29:24 +0000996 {NULL} /* Sentinel */
997};
998
Richard Jones2d555b32006-05-27 16:15:11 +0000999ComplexExtendsException(PyExc_OSError, WindowsError, WindowsError,
1000 WindowsError_dealloc, 0, WindowsError_members,
1001 WindowsError_str, "MS-Windows OS system call failed.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001002
1003#endif /* MS_WINDOWS */
1004
1005
1006/*
1007 * VMSError extends OSError (I think)
1008 */
1009#ifdef __VMS
1010MiddlingExtendsException(PyExc_OSError, VMSError, EnvironmentError,
Richard Jones2d555b32006-05-27 16:15:11 +00001011 "OpenVMS OS system call failed.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001012#endif
1013
1014
1015/*
1016 * EOFError extends StandardError
1017 */
1018SimpleExtendsException(PyExc_StandardError, EOFError,
Richard Jones2d555b32006-05-27 16:15:11 +00001019 "Read beyond end of file.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001020
1021
1022/*
1023 * RuntimeError extends StandardError
1024 */
1025SimpleExtendsException(PyExc_StandardError, RuntimeError,
Richard Jones2d555b32006-05-27 16:15:11 +00001026 "Unspecified run-time error.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001027
1028
1029/*
1030 * NotImplementedError extends RuntimeError
1031 */
1032SimpleExtendsException(PyExc_RuntimeError, NotImplementedError,
Richard Jones2d555b32006-05-27 16:15:11 +00001033 "Method or function hasn't been implemented yet.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001034
1035/*
1036 * NameError extends StandardError
1037 */
1038SimpleExtendsException(PyExc_StandardError, NameError,
Richard Jones2d555b32006-05-27 16:15:11 +00001039 "Name not found globally.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001040
1041/*
1042 * UnboundLocalError extends NameError
1043 */
1044SimpleExtendsException(PyExc_NameError, UnboundLocalError,
Richard Jones2d555b32006-05-27 16:15:11 +00001045 "Local name referenced but not bound to a value.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001046
1047/*
1048 * AttributeError extends StandardError
1049 */
1050SimpleExtendsException(PyExc_StandardError, AttributeError,
Richard Jones2d555b32006-05-27 16:15:11 +00001051 "Attribute not found.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001052
1053
1054/*
1055 * SyntaxError extends StandardError
1056 */
Richard Jones7b9558d2006-05-27 12:29:24 +00001057
1058static int
1059SyntaxError_init(PySyntaxErrorObject *self, PyObject *args, PyObject *kwds)
1060{
1061 PyObject *info = NULL;
1062 Py_ssize_t lenargs = PyTuple_GET_SIZE(args);
1063
1064 if (BaseException_init((PyBaseExceptionObject *)self, args, kwds) == -1)
1065 return -1;
1066
1067 if (lenargs >= 1) {
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001068 Py_CLEAR(self->msg);
Richard Jones7b9558d2006-05-27 12:29:24 +00001069 self->msg = PyTuple_GET_ITEM(args, 0);
1070 Py_INCREF(self->msg);
1071 }
1072 if (lenargs == 2) {
1073 info = PyTuple_GET_ITEM(args, 1);
1074 info = PySequence_Tuple(info);
Benjamin Peterson4c79aec2012-02-03 19:22:31 -05001075 if (!info)
1076 return -1;
Richard Jones7b9558d2006-05-27 12:29:24 +00001077
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001078 if (PyTuple_GET_SIZE(info) != 4) {
1079 /* not a very good error message, but it's what Python 2.4 gives */
1080 PyErr_SetString(PyExc_IndexError, "tuple index out of range");
1081 Py_DECREF(info);
1082 return -1;
1083 }
1084
1085 Py_CLEAR(self->filename);
Richard Jones7b9558d2006-05-27 12:29:24 +00001086 self->filename = PyTuple_GET_ITEM(info, 0);
1087 Py_INCREF(self->filename);
1088
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001089 Py_CLEAR(self->lineno);
Richard Jones7b9558d2006-05-27 12:29:24 +00001090 self->lineno = PyTuple_GET_ITEM(info, 1);
1091 Py_INCREF(self->lineno);
1092
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001093 Py_CLEAR(self->offset);
Richard Jones7b9558d2006-05-27 12:29:24 +00001094 self->offset = PyTuple_GET_ITEM(info, 2);
1095 Py_INCREF(self->offset);
1096
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001097 Py_CLEAR(self->text);
Richard Jones7b9558d2006-05-27 12:29:24 +00001098 self->text = PyTuple_GET_ITEM(info, 3);
1099 Py_INCREF(self->text);
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001100
1101 Py_DECREF(info);
Richard Jones7b9558d2006-05-27 12:29:24 +00001102 }
1103 return 0;
1104}
1105
Michael W. Hudson96495ee2006-05-28 17:40:29 +00001106static int
Richard Jones7b9558d2006-05-27 12:29:24 +00001107SyntaxError_clear(PySyntaxErrorObject *self)
1108{
1109 Py_CLEAR(self->msg);
1110 Py_CLEAR(self->filename);
1111 Py_CLEAR(self->lineno);
1112 Py_CLEAR(self->offset);
1113 Py_CLEAR(self->text);
1114 Py_CLEAR(self->print_file_and_line);
1115 return BaseException_clear((PyBaseExceptionObject *)self);
1116}
1117
1118static void
1119SyntaxError_dealloc(PySyntaxErrorObject *self)
1120{
Georg Brandl38f62372006-09-06 06:50:05 +00001121 _PyObject_GC_UNTRACK(self);
Richard Jones7b9558d2006-05-27 12:29:24 +00001122 SyntaxError_clear(self);
Christian Heimese93237d2007-12-19 02:37:44 +00001123 Py_TYPE(self)->tp_free((PyObject *)self);
Richard Jones7b9558d2006-05-27 12:29:24 +00001124}
1125
Michael W. Hudson96495ee2006-05-28 17:40:29 +00001126static int
Richard Jones7b9558d2006-05-27 12:29:24 +00001127SyntaxError_traverse(PySyntaxErrorObject *self, visitproc visit, void *arg)
1128{
1129 Py_VISIT(self->msg);
1130 Py_VISIT(self->filename);
1131 Py_VISIT(self->lineno);
1132 Py_VISIT(self->offset);
1133 Py_VISIT(self->text);
1134 Py_VISIT(self->print_file_and_line);
1135 return BaseException_traverse((PyBaseExceptionObject *)self, visit, arg);
1136}
1137
1138/* This is called "my_basename" instead of just "basename" to avoid name
1139 conflicts with glibc; basename is already prototyped if _GNU_SOURCE is
1140 defined, and Python does define that. */
1141static char *
1142my_basename(char *name)
1143{
1144 char *cp = name;
1145 char *result = name;
1146
1147 if (name == NULL)
1148 return "???";
1149 while (*cp != '\0') {
1150 if (*cp == SEP)
1151 result = cp + 1;
1152 ++cp;
1153 }
1154 return result;
1155}
1156
1157
1158static PyObject *
1159SyntaxError_str(PySyntaxErrorObject *self)
1160{
1161 PyObject *str;
1162 PyObject *result;
Georg Brandl43ab1002006-05-28 20:57:09 +00001163 int have_filename = 0;
1164 int have_lineno = 0;
1165 char *buffer = NULL;
Thomas Woutersc1282ee2006-05-28 21:32:12 +00001166 Py_ssize_t bufsize;
Richard Jones7b9558d2006-05-27 12:29:24 +00001167
Michael W. Hudson96495ee2006-05-28 17:40:29 +00001168 if (self->msg)
1169 str = PyObject_Str(self->msg);
1170 else
1171 str = PyObject_Str(Py_None);
Benjamin Peterson4c79aec2012-02-03 19:22:31 -05001172 if (!str)
1173 return NULL;
Georg Brandl43ab1002006-05-28 20:57:09 +00001174 /* Don't fiddle with non-string return (shouldn't happen anyway) */
Benjamin Peterson4c79aec2012-02-03 19:22:31 -05001175 if (!PyString_Check(str))
1176 return str;
Richard Jones7b9558d2006-05-27 12:29:24 +00001177
1178 /* XXX -- do all the additional formatting with filename and
1179 lineno here */
1180
Georg Brandl43ab1002006-05-28 20:57:09 +00001181 have_filename = (self->filename != NULL) &&
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001182 PyString_Check(self->filename);
Georg Brandl43ab1002006-05-28 20:57:09 +00001183 have_lineno = (self->lineno != NULL) && PyInt_Check(self->lineno);
Richard Jones7b9558d2006-05-27 12:29:24 +00001184
Georg Brandl43ab1002006-05-28 20:57:09 +00001185 if (!have_filename && !have_lineno)
1186 return str;
Richard Jones7b9558d2006-05-27 12:29:24 +00001187
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001188 bufsize = PyString_GET_SIZE(str) + 64;
Georg Brandl43ab1002006-05-28 20:57:09 +00001189 if (have_filename)
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001190 bufsize += PyString_GET_SIZE(self->filename);
Richard Jones7b9558d2006-05-27 12:29:24 +00001191
Georg Brandl43ab1002006-05-28 20:57:09 +00001192 buffer = PyMem_MALLOC(bufsize);
1193 if (buffer == NULL)
1194 return str;
Richard Jones7b9558d2006-05-27 12:29:24 +00001195
Georg Brandl43ab1002006-05-28 20:57:09 +00001196 if (have_filename && have_lineno)
1197 PyOS_snprintf(buffer, bufsize, "%s (%s, line %ld)",
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001198 PyString_AS_STRING(str),
1199 my_basename(PyString_AS_STRING(self->filename)),
Georg Brandl43ab1002006-05-28 20:57:09 +00001200 PyInt_AsLong(self->lineno));
1201 else if (have_filename)
1202 PyOS_snprintf(buffer, bufsize, "%s (%s)",
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001203 PyString_AS_STRING(str),
1204 my_basename(PyString_AS_STRING(self->filename)));
Georg Brandl43ab1002006-05-28 20:57:09 +00001205 else /* only have_lineno */
1206 PyOS_snprintf(buffer, bufsize, "%s (line %ld)",
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001207 PyString_AS_STRING(str),
Georg Brandl43ab1002006-05-28 20:57:09 +00001208 PyInt_AsLong(self->lineno));
Richard Jones7b9558d2006-05-27 12:29:24 +00001209
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001210 result = PyString_FromString(buffer);
Georg Brandl43ab1002006-05-28 20:57:09 +00001211 PyMem_FREE(buffer);
1212
1213 if (result == NULL)
1214 result = str;
1215 else
1216 Py_DECREF(str);
Richard Jones7b9558d2006-05-27 12:29:24 +00001217 return result;
1218}
1219
1220static PyMemberDef SyntaxError_members[] = {
Richard Jones7b9558d2006-05-27 12:29:24 +00001221 {"msg", T_OBJECT, offsetof(PySyntaxErrorObject, msg), 0,
1222 PyDoc_STR("exception msg")},
1223 {"filename", T_OBJECT, offsetof(PySyntaxErrorObject, filename), 0,
1224 PyDoc_STR("exception filename")},
1225 {"lineno", T_OBJECT, offsetof(PySyntaxErrorObject, lineno), 0,
1226 PyDoc_STR("exception lineno")},
1227 {"offset", T_OBJECT, offsetof(PySyntaxErrorObject, offset), 0,
1228 PyDoc_STR("exception offset")},
1229 {"text", T_OBJECT, offsetof(PySyntaxErrorObject, text), 0,
1230 PyDoc_STR("exception text")},
1231 {"print_file_and_line", T_OBJECT,
1232 offsetof(PySyntaxErrorObject, print_file_and_line), 0,
1233 PyDoc_STR("exception print_file_and_line")},
1234 {NULL} /* Sentinel */
1235};
1236
1237ComplexExtendsException(PyExc_StandardError, SyntaxError, SyntaxError,
1238 SyntaxError_dealloc, 0, SyntaxError_members,
Richard Jones2d555b32006-05-27 16:15:11 +00001239 SyntaxError_str, "Invalid syntax.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001240
1241
1242/*
1243 * IndentationError extends SyntaxError
1244 */
1245MiddlingExtendsException(PyExc_SyntaxError, IndentationError, SyntaxError,
Richard Jones2d555b32006-05-27 16:15:11 +00001246 "Improper indentation.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001247
1248
1249/*
1250 * TabError extends IndentationError
1251 */
1252MiddlingExtendsException(PyExc_IndentationError, TabError, SyntaxError,
Richard Jones2d555b32006-05-27 16:15:11 +00001253 "Improper mixture of spaces and tabs.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001254
1255
1256/*
1257 * LookupError extends StandardError
1258 */
1259SimpleExtendsException(PyExc_StandardError, LookupError,
Richard Jones2d555b32006-05-27 16:15:11 +00001260 "Base class for lookup errors.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001261
1262
1263/*
1264 * IndexError extends LookupError
1265 */
1266SimpleExtendsException(PyExc_LookupError, IndexError,
Richard Jones2d555b32006-05-27 16:15:11 +00001267 "Sequence index out of range.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001268
1269
1270/*
1271 * KeyError extends LookupError
1272 */
1273static PyObject *
1274KeyError_str(PyBaseExceptionObject *self)
1275{
1276 /* If args is a tuple of exactly one item, apply repr to args[0].
1277 This is done so that e.g. the exception raised by {}[''] prints
1278 KeyError: ''
1279 rather than the confusing
1280 KeyError
1281 alone. The downside is that if KeyError is raised with an explanatory
1282 string, that string will be displayed in quotes. Too bad.
1283 If args is anything else, use the default BaseException__str__().
1284 */
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001285 if (PyTuple_GET_SIZE(self->args) == 1) {
1286 return PyObject_Repr(PyTuple_GET_ITEM(self->args, 0));
Richard Jones7b9558d2006-05-27 12:29:24 +00001287 }
1288 return BaseException_str(self);
1289}
1290
1291ComplexExtendsException(PyExc_LookupError, KeyError, BaseException,
Richard Jones2d555b32006-05-27 16:15:11 +00001292 0, 0, 0, KeyError_str, "Mapping key not found.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001293
1294
1295/*
1296 * ValueError extends StandardError
1297 */
1298SimpleExtendsException(PyExc_StandardError, ValueError,
Richard Jones2d555b32006-05-27 16:15:11 +00001299 "Inappropriate argument value (of correct type).");
Richard Jones7b9558d2006-05-27 12:29:24 +00001300
1301/*
1302 * UnicodeError extends ValueError
1303 */
1304
1305SimpleExtendsException(PyExc_ValueError, UnicodeError,
Richard Jones2d555b32006-05-27 16:15:11 +00001306 "Unicode related error.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001307
1308#ifdef Py_USING_UNICODE
Richard Jones7b9558d2006-05-27 12:29:24 +00001309static PyObject *
1310get_string(PyObject *attr, const char *name)
1311{
1312 if (!attr) {
1313 PyErr_Format(PyExc_TypeError, "%.200s attribute not set", name);
1314 return NULL;
1315 }
1316
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001317 if (!PyString_Check(attr)) {
Richard Jones7b9558d2006-05-27 12:29:24 +00001318 PyErr_Format(PyExc_TypeError, "%.200s attribute must be str", name);
1319 return NULL;
1320 }
1321 Py_INCREF(attr);
1322 return attr;
1323}
1324
1325
1326static int
1327set_string(PyObject **attr, const char *value)
1328{
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001329 PyObject *obj = PyString_FromString(value);
Richard Jones7b9558d2006-05-27 12:29:24 +00001330 if (!obj)
1331 return -1;
Georg Brandl43ab1002006-05-28 20:57:09 +00001332 Py_CLEAR(*attr);
Richard Jones7b9558d2006-05-27 12:29:24 +00001333 *attr = obj;
1334 return 0;
1335}
1336
1337
1338static PyObject *
1339get_unicode(PyObject *attr, const char *name)
1340{
1341 if (!attr) {
1342 PyErr_Format(PyExc_TypeError, "%.200s attribute not set", name);
1343 return NULL;
1344 }
1345
1346 if (!PyUnicode_Check(attr)) {
1347 PyErr_Format(PyExc_TypeError,
1348 "%.200s attribute must be unicode", name);
1349 return NULL;
1350 }
1351 Py_INCREF(attr);
1352 return attr;
1353}
1354
1355PyObject *
1356PyUnicodeEncodeError_GetEncoding(PyObject *exc)
1357{
1358 return get_string(((PyUnicodeErrorObject *)exc)->encoding, "encoding");
1359}
1360
1361PyObject *
1362PyUnicodeDecodeError_GetEncoding(PyObject *exc)
1363{
1364 return get_string(((PyUnicodeErrorObject *)exc)->encoding, "encoding");
1365}
1366
1367PyObject *
1368PyUnicodeEncodeError_GetObject(PyObject *exc)
1369{
1370 return get_unicode(((PyUnicodeErrorObject *)exc)->object, "object");
1371}
1372
1373PyObject *
1374PyUnicodeDecodeError_GetObject(PyObject *exc)
1375{
1376 return get_string(((PyUnicodeErrorObject *)exc)->object, "object");
1377}
1378
1379PyObject *
1380PyUnicodeTranslateError_GetObject(PyObject *exc)
1381{
1382 return get_unicode(((PyUnicodeErrorObject *)exc)->object, "object");
1383}
1384
1385int
1386PyUnicodeEncodeError_GetStart(PyObject *exc, Py_ssize_t *start)
1387{
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001388 Py_ssize_t size;
1389 PyObject *obj = get_unicode(((PyUnicodeErrorObject *)exc)->object,
1390 "object");
1391 if (!obj)
1392 return -1;
1393 *start = ((PyUnicodeErrorObject *)exc)->start;
1394 size = PyUnicode_GET_SIZE(obj);
1395 if (*start<0)
1396 *start = 0; /*XXX check for values <0*/
1397 if (*start>=size)
1398 *start = size-1;
1399 Py_DECREF(obj);
1400 return 0;
Richard Jones7b9558d2006-05-27 12:29:24 +00001401}
1402
1403
1404int
1405PyUnicodeDecodeError_GetStart(PyObject *exc, Py_ssize_t *start)
1406{
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001407 Py_ssize_t size;
1408 PyObject *obj = get_string(((PyUnicodeErrorObject *)exc)->object,
1409 "object");
1410 if (!obj)
1411 return -1;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001412 size = PyString_GET_SIZE(obj);
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001413 *start = ((PyUnicodeErrorObject *)exc)->start;
1414 if (*start<0)
1415 *start = 0;
1416 if (*start>=size)
1417 *start = size-1;
1418 Py_DECREF(obj);
1419 return 0;
Richard Jones7b9558d2006-05-27 12:29:24 +00001420}
1421
1422
1423int
1424PyUnicodeTranslateError_GetStart(PyObject *exc, Py_ssize_t *start)
1425{
1426 return PyUnicodeEncodeError_GetStart(exc, start);
1427}
1428
1429
1430int
1431PyUnicodeEncodeError_SetStart(PyObject *exc, Py_ssize_t start)
1432{
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001433 ((PyUnicodeErrorObject *)exc)->start = start;
1434 return 0;
Richard Jones7b9558d2006-05-27 12:29:24 +00001435}
1436
1437
1438int
1439PyUnicodeDecodeError_SetStart(PyObject *exc, Py_ssize_t start)
1440{
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001441 ((PyUnicodeErrorObject *)exc)->start = start;
1442 return 0;
Richard Jones7b9558d2006-05-27 12:29:24 +00001443}
1444
1445
1446int
1447PyUnicodeTranslateError_SetStart(PyObject *exc, Py_ssize_t start)
1448{
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001449 ((PyUnicodeErrorObject *)exc)->start = start;
1450 return 0;
Richard Jones7b9558d2006-05-27 12:29:24 +00001451}
1452
1453
1454int
1455PyUnicodeEncodeError_GetEnd(PyObject *exc, Py_ssize_t *end)
1456{
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001457 Py_ssize_t size;
1458 PyObject *obj = get_unicode(((PyUnicodeErrorObject *)exc)->object,
1459 "object");
1460 if (!obj)
1461 return -1;
1462 *end = ((PyUnicodeErrorObject *)exc)->end;
1463 size = PyUnicode_GET_SIZE(obj);
1464 if (*end<1)
1465 *end = 1;
1466 if (*end>size)
1467 *end = size;
1468 Py_DECREF(obj);
1469 return 0;
Richard Jones7b9558d2006-05-27 12:29:24 +00001470}
1471
1472
1473int
1474PyUnicodeDecodeError_GetEnd(PyObject *exc, Py_ssize_t *end)
1475{
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001476 Py_ssize_t size;
1477 PyObject *obj = get_string(((PyUnicodeErrorObject *)exc)->object,
1478 "object");
1479 if (!obj)
1480 return -1;
1481 *end = ((PyUnicodeErrorObject *)exc)->end;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001482 size = PyString_GET_SIZE(obj);
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001483 if (*end<1)
1484 *end = 1;
1485 if (*end>size)
1486 *end = size;
1487 Py_DECREF(obj);
1488 return 0;
Richard Jones7b9558d2006-05-27 12:29:24 +00001489}
1490
1491
1492int
1493PyUnicodeTranslateError_GetEnd(PyObject *exc, Py_ssize_t *start)
1494{
1495 return PyUnicodeEncodeError_GetEnd(exc, start);
1496}
1497
1498
1499int
1500PyUnicodeEncodeError_SetEnd(PyObject *exc, Py_ssize_t end)
1501{
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001502 ((PyUnicodeErrorObject *)exc)->end = end;
1503 return 0;
Richard Jones7b9558d2006-05-27 12:29:24 +00001504}
1505
1506
1507int
1508PyUnicodeDecodeError_SetEnd(PyObject *exc, Py_ssize_t end)
1509{
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001510 ((PyUnicodeErrorObject *)exc)->end = end;
1511 return 0;
Richard Jones7b9558d2006-05-27 12:29:24 +00001512}
1513
1514
1515int
1516PyUnicodeTranslateError_SetEnd(PyObject *exc, Py_ssize_t end)
1517{
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001518 ((PyUnicodeErrorObject *)exc)->end = end;
1519 return 0;
Richard Jones7b9558d2006-05-27 12:29:24 +00001520}
1521
1522PyObject *
1523PyUnicodeEncodeError_GetReason(PyObject *exc)
1524{
1525 return get_string(((PyUnicodeErrorObject *)exc)->reason, "reason");
1526}
1527
1528
1529PyObject *
1530PyUnicodeDecodeError_GetReason(PyObject *exc)
1531{
1532 return get_string(((PyUnicodeErrorObject *)exc)->reason, "reason");
1533}
1534
1535
1536PyObject *
1537PyUnicodeTranslateError_GetReason(PyObject *exc)
1538{
1539 return get_string(((PyUnicodeErrorObject *)exc)->reason, "reason");
1540}
1541
1542
1543int
1544PyUnicodeEncodeError_SetReason(PyObject *exc, const char *reason)
1545{
1546 return set_string(&((PyUnicodeErrorObject *)exc)->reason, reason);
1547}
1548
1549
1550int
1551PyUnicodeDecodeError_SetReason(PyObject *exc, const char *reason)
1552{
1553 return set_string(&((PyUnicodeErrorObject *)exc)->reason, reason);
1554}
1555
1556
1557int
1558PyUnicodeTranslateError_SetReason(PyObject *exc, const char *reason)
1559{
1560 return set_string(&((PyUnicodeErrorObject *)exc)->reason, reason);
1561}
1562
1563
Richard Jones7b9558d2006-05-27 12:29:24 +00001564static int
1565UnicodeError_init(PyUnicodeErrorObject *self, PyObject *args, PyObject *kwds,
1566 PyTypeObject *objecttype)
1567{
Michael W. Hudson96495ee2006-05-28 17:40:29 +00001568 Py_CLEAR(self->encoding);
1569 Py_CLEAR(self->object);
Michael W. Hudson96495ee2006-05-28 17:40:29 +00001570 Py_CLEAR(self->reason);
1571
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001572 if (!PyArg_ParseTuple(args, "O!O!nnO!",
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001573 &PyString_Type, &self->encoding,
Richard Jones7b9558d2006-05-27 12:29:24 +00001574 objecttype, &self->object,
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001575 &self->start,
1576 &self->end,
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001577 &PyString_Type, &self->reason)) {
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001578 self->encoding = self->object = self->reason = NULL;
Richard Jones7b9558d2006-05-27 12:29:24 +00001579 return -1;
1580 }
1581
1582 Py_INCREF(self->encoding);
1583 Py_INCREF(self->object);
Richard Jones7b9558d2006-05-27 12:29:24 +00001584 Py_INCREF(self->reason);
1585
1586 return 0;
1587}
1588
Michael W. Hudson96495ee2006-05-28 17:40:29 +00001589static int
Richard Jones7b9558d2006-05-27 12:29:24 +00001590UnicodeError_clear(PyUnicodeErrorObject *self)
1591{
1592 Py_CLEAR(self->encoding);
1593 Py_CLEAR(self->object);
Richard Jones7b9558d2006-05-27 12:29:24 +00001594 Py_CLEAR(self->reason);
1595 return BaseException_clear((PyBaseExceptionObject *)self);
1596}
1597
1598static void
1599UnicodeError_dealloc(PyUnicodeErrorObject *self)
1600{
Georg Brandl38f62372006-09-06 06:50:05 +00001601 _PyObject_GC_UNTRACK(self);
Richard Jones7b9558d2006-05-27 12:29:24 +00001602 UnicodeError_clear(self);
Christian Heimese93237d2007-12-19 02:37:44 +00001603 Py_TYPE(self)->tp_free((PyObject *)self);
Richard Jones7b9558d2006-05-27 12:29:24 +00001604}
1605
Michael W. Hudson96495ee2006-05-28 17:40:29 +00001606static int
Richard Jones7b9558d2006-05-27 12:29:24 +00001607UnicodeError_traverse(PyUnicodeErrorObject *self, visitproc visit, void *arg)
1608{
1609 Py_VISIT(self->encoding);
1610 Py_VISIT(self->object);
Richard Jones7b9558d2006-05-27 12:29:24 +00001611 Py_VISIT(self->reason);
1612 return BaseException_traverse((PyBaseExceptionObject *)self, visit, arg);
1613}
1614
1615static PyMemberDef UnicodeError_members[] = {
Richard Jones7b9558d2006-05-27 12:29:24 +00001616 {"encoding", T_OBJECT, offsetof(PyUnicodeErrorObject, encoding), 0,
1617 PyDoc_STR("exception encoding")},
1618 {"object", T_OBJECT, offsetof(PyUnicodeErrorObject, object), 0,
1619 PyDoc_STR("exception object")},
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001620 {"start", T_PYSSIZET, offsetof(PyUnicodeErrorObject, start), 0,
Richard Jones7b9558d2006-05-27 12:29:24 +00001621 PyDoc_STR("exception start")},
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001622 {"end", T_PYSSIZET, offsetof(PyUnicodeErrorObject, end), 0,
Richard Jones7b9558d2006-05-27 12:29:24 +00001623 PyDoc_STR("exception end")},
1624 {"reason", T_OBJECT, offsetof(PyUnicodeErrorObject, reason), 0,
1625 PyDoc_STR("exception reason")},
1626 {NULL} /* Sentinel */
1627};
1628
1629
1630/*
1631 * UnicodeEncodeError extends UnicodeError
1632 */
Richard Jones7b9558d2006-05-27 12:29:24 +00001633
1634static int
1635UnicodeEncodeError_init(PyObject *self, PyObject *args, PyObject *kwds)
1636{
1637 if (BaseException_init((PyBaseExceptionObject *)self, args, kwds) == -1)
1638 return -1;
1639 return UnicodeError_init((PyUnicodeErrorObject *)self, args,
1640 kwds, &PyUnicode_Type);
1641}
1642
1643static PyObject *
1644UnicodeEncodeError_str(PyObject *self)
1645{
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001646 PyUnicodeErrorObject *uself = (PyUnicodeErrorObject *)self;
Eric Smith2d9856d2010-02-24 14:15:36 +00001647 PyObject *result = NULL;
1648 PyObject *reason_str = NULL;
1649 PyObject *encoding_str = NULL;
Richard Jones7b9558d2006-05-27 12:29:24 +00001650
Eric Smith2d9856d2010-02-24 14:15:36 +00001651 /* Get reason and encoding as strings, which they might not be if
1652 they've been modified after we were contructed. */
1653 reason_str = PyObject_Str(uself->reason);
1654 if (reason_str == NULL)
1655 goto done;
1656 encoding_str = PyObject_Str(uself->encoding);
1657 if (encoding_str == NULL)
1658 goto done;
1659
1660 if (uself->start < PyUnicode_GET_SIZE(uself->object) && uself->end == uself->start+1) {
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001661 int badchar = (int)PyUnicode_AS_UNICODE(uself->object)[uself->start];
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001662 char badchar_str[20];
1663 if (badchar <= 0xff)
1664 PyOS_snprintf(badchar_str, sizeof(badchar_str), "x%02x", badchar);
1665 else if (badchar <= 0xffff)
1666 PyOS_snprintf(badchar_str, sizeof(badchar_str), "u%04x", badchar);
1667 else
1668 PyOS_snprintf(badchar_str, sizeof(badchar_str), "U%08x", badchar);
Eric Smith2d9856d2010-02-24 14:15:36 +00001669 result = PyString_FromFormat(
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001670 "'%.400s' codec can't encode character u'\\%s' in position %zd: %.400s",
Eric Smith2d9856d2010-02-24 14:15:36 +00001671 PyString_AS_STRING(encoding_str),
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001672 badchar_str,
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001673 uself->start,
Eric Smith2d9856d2010-02-24 14:15:36 +00001674 PyString_AS_STRING(reason_str));
Richard Jones7b9558d2006-05-27 12:29:24 +00001675 }
Eric Smith2d9856d2010-02-24 14:15:36 +00001676 else {
1677 result = PyString_FromFormat(
1678 "'%.400s' codec can't encode characters in position %zd-%zd: %.400s",
1679 PyString_AS_STRING(encoding_str),
1680 uself->start,
1681 uself->end-1,
1682 PyString_AS_STRING(reason_str));
1683 }
1684done:
1685 Py_XDECREF(reason_str);
1686 Py_XDECREF(encoding_str);
1687 return result;
Richard Jones7b9558d2006-05-27 12:29:24 +00001688}
1689
1690static PyTypeObject _PyExc_UnicodeEncodeError = {
1691 PyObject_HEAD_INIT(NULL)
1692 0,
Georg Brandl38f62372006-09-06 06:50:05 +00001693 EXC_MODULE_NAME "UnicodeEncodeError",
Richard Jones7b9558d2006-05-27 12:29:24 +00001694 sizeof(PyUnicodeErrorObject), 0,
1695 (destructor)UnicodeError_dealloc, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
1696 (reprfunc)UnicodeEncodeError_str, 0, 0, 0,
1697 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
Michael W. Hudson27596272006-05-28 21:19:03 +00001698 PyDoc_STR("Unicode encoding error."), (traverseproc)UnicodeError_traverse,
1699 (inquiry)UnicodeError_clear, 0, 0, 0, 0, 0, UnicodeError_members,
Richard Jones7b9558d2006-05-27 12:29:24 +00001700 0, &_PyExc_UnicodeError, 0, 0, 0, offsetof(PyUnicodeErrorObject, dict),
Michael W. Hudson96495ee2006-05-28 17:40:29 +00001701 (initproc)UnicodeEncodeError_init, 0, BaseException_new,
Richard Jones7b9558d2006-05-27 12:29:24 +00001702};
1703PyObject *PyExc_UnicodeEncodeError = (PyObject *)&_PyExc_UnicodeEncodeError;
1704
1705PyObject *
1706PyUnicodeEncodeError_Create(
1707 const char *encoding, const Py_UNICODE *object, Py_ssize_t length,
1708 Py_ssize_t start, Py_ssize_t end, const char *reason)
1709{
1710 return PyObject_CallFunction(PyExc_UnicodeEncodeError, "su#nns",
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001711 encoding, object, length, start, end, reason);
Richard Jones7b9558d2006-05-27 12:29:24 +00001712}
1713
1714
1715/*
1716 * UnicodeDecodeError extends UnicodeError
1717 */
Richard Jones7b9558d2006-05-27 12:29:24 +00001718
1719static int
1720UnicodeDecodeError_init(PyObject *self, PyObject *args, PyObject *kwds)
1721{
1722 if (BaseException_init((PyBaseExceptionObject *)self, args, kwds) == -1)
1723 return -1;
1724 return UnicodeError_init((PyUnicodeErrorObject *)self, args,
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001725 kwds, &PyString_Type);
Richard Jones7b9558d2006-05-27 12:29:24 +00001726}
1727
1728static PyObject *
1729UnicodeDecodeError_str(PyObject *self)
1730{
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001731 PyUnicodeErrorObject *uself = (PyUnicodeErrorObject *)self;
Eric Smith2d9856d2010-02-24 14:15:36 +00001732 PyObject *result = NULL;
1733 PyObject *reason_str = NULL;
1734 PyObject *encoding_str = NULL;
Richard Jones7b9558d2006-05-27 12:29:24 +00001735
Eric Smith2d9856d2010-02-24 14:15:36 +00001736 /* Get reason and encoding as strings, which they might not be if
1737 they've been modified after we were contructed. */
1738 reason_str = PyObject_Str(uself->reason);
1739 if (reason_str == NULL)
1740 goto done;
1741 encoding_str = PyObject_Str(uself->encoding);
1742 if (encoding_str == NULL)
1743 goto done;
1744
1745 if (uself->start < PyUnicode_GET_SIZE(uself->object) && uself->end == uself->start+1) {
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001746 /* FromFormat does not support %02x, so format that separately */
1747 char byte[4];
1748 PyOS_snprintf(byte, sizeof(byte), "%02x",
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001749 ((int)PyString_AS_STRING(uself->object)[uself->start])&0xff);
Eric Smith2d9856d2010-02-24 14:15:36 +00001750 result = PyString_FromFormat(
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001751 "'%.400s' codec can't decode byte 0x%s in position %zd: %.400s",
Eric Smith2d9856d2010-02-24 14:15:36 +00001752 PyString_AS_STRING(encoding_str),
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001753 byte,
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001754 uself->start,
Eric Smith2d9856d2010-02-24 14:15:36 +00001755 PyString_AS_STRING(reason_str));
Richard Jones7b9558d2006-05-27 12:29:24 +00001756 }
Eric Smith2d9856d2010-02-24 14:15:36 +00001757 else {
1758 result = PyString_FromFormat(
1759 "'%.400s' codec can't decode bytes in position %zd-%zd: %.400s",
1760 PyString_AS_STRING(encoding_str),
1761 uself->start,
1762 uself->end-1,
1763 PyString_AS_STRING(reason_str));
1764 }
1765done:
1766 Py_XDECREF(reason_str);
1767 Py_XDECREF(encoding_str);
1768 return result;
Richard Jones7b9558d2006-05-27 12:29:24 +00001769}
1770
1771static PyTypeObject _PyExc_UnicodeDecodeError = {
1772 PyObject_HEAD_INIT(NULL)
1773 0,
1774 EXC_MODULE_NAME "UnicodeDecodeError",
1775 sizeof(PyUnicodeErrorObject), 0,
1776 (destructor)UnicodeError_dealloc, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
1777 (reprfunc)UnicodeDecodeError_str, 0, 0, 0,
1778 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
Michael W. Hudson27596272006-05-28 21:19:03 +00001779 PyDoc_STR("Unicode decoding error."), (traverseproc)UnicodeError_traverse,
1780 (inquiry)UnicodeError_clear, 0, 0, 0, 0, 0, UnicodeError_members,
Richard Jones7b9558d2006-05-27 12:29:24 +00001781 0, &_PyExc_UnicodeError, 0, 0, 0, offsetof(PyUnicodeErrorObject, dict),
Michael W. Hudson96495ee2006-05-28 17:40:29 +00001782 (initproc)UnicodeDecodeError_init, 0, BaseException_new,
Richard Jones7b9558d2006-05-27 12:29:24 +00001783};
1784PyObject *PyExc_UnicodeDecodeError = (PyObject *)&_PyExc_UnicodeDecodeError;
1785
1786PyObject *
1787PyUnicodeDecodeError_Create(
1788 const char *encoding, const char *object, Py_ssize_t length,
1789 Py_ssize_t start, Py_ssize_t end, const char *reason)
1790{
Richard Jones7b9558d2006-05-27 12:29:24 +00001791 return PyObject_CallFunction(PyExc_UnicodeDecodeError, "ss#nns",
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001792 encoding, object, length, start, end, reason);
Richard Jones7b9558d2006-05-27 12:29:24 +00001793}
1794
1795
1796/*
1797 * UnicodeTranslateError extends UnicodeError
1798 */
Richard Jones7b9558d2006-05-27 12:29:24 +00001799
1800static int
1801UnicodeTranslateError_init(PyUnicodeErrorObject *self, PyObject *args,
1802 PyObject *kwds)
1803{
1804 if (BaseException_init((PyBaseExceptionObject *)self, args, kwds) == -1)
1805 return -1;
1806
1807 Py_CLEAR(self->object);
Richard Jones7b9558d2006-05-27 12:29:24 +00001808 Py_CLEAR(self->reason);
1809
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001810 if (!PyArg_ParseTuple(args, "O!nnO!",
Richard Jones7b9558d2006-05-27 12:29:24 +00001811 &PyUnicode_Type, &self->object,
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001812 &self->start,
1813 &self->end,
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001814 &PyString_Type, &self->reason)) {
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001815 self->object = self->reason = NULL;
Richard Jones7b9558d2006-05-27 12:29:24 +00001816 return -1;
1817 }
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001818
Richard Jones7b9558d2006-05-27 12:29:24 +00001819 Py_INCREF(self->object);
Richard Jones7b9558d2006-05-27 12:29:24 +00001820 Py_INCREF(self->reason);
1821
1822 return 0;
1823}
1824
1825
1826static PyObject *
1827UnicodeTranslateError_str(PyObject *self)
1828{
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001829 PyUnicodeErrorObject *uself = (PyUnicodeErrorObject *)self;
Eric Smith2d9856d2010-02-24 14:15:36 +00001830 PyObject *result = NULL;
1831 PyObject *reason_str = NULL;
Richard Jones7b9558d2006-05-27 12:29:24 +00001832
Eric Smith2d9856d2010-02-24 14:15:36 +00001833 /* Get reason as a string, which it might not be if it's been
1834 modified after we were contructed. */
1835 reason_str = PyObject_Str(uself->reason);
1836 if (reason_str == NULL)
1837 goto done;
1838
1839 if (uself->start < PyUnicode_GET_SIZE(uself->object) && uself->end == uself->start+1) {
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001840 int badchar = (int)PyUnicode_AS_UNICODE(uself->object)[uself->start];
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001841 char badchar_str[20];
1842 if (badchar <= 0xff)
1843 PyOS_snprintf(badchar_str, sizeof(badchar_str), "x%02x", badchar);
1844 else if (badchar <= 0xffff)
1845 PyOS_snprintf(badchar_str, sizeof(badchar_str), "u%04x", badchar);
1846 else
1847 PyOS_snprintf(badchar_str, sizeof(badchar_str), "U%08x", badchar);
Eric Smith2d9856d2010-02-24 14:15:36 +00001848 result = PyString_FromFormat(
Richard Jones7b9558d2006-05-27 12:29:24 +00001849 "can't translate character u'\\%s' in position %zd: %.400s",
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001850 badchar_str,
Walter Dörwald84a3efe2007-06-13 16:57:12 +00001851 uself->start,
Eric Smith2d9856d2010-02-24 14:15:36 +00001852 PyString_AS_STRING(reason_str));
1853 } else {
1854 result = PyString_FromFormat(
1855 "can't translate characters in position %zd-%zd: %.400s",
1856 uself->start,
1857 uself->end-1,
1858 PyString_AS_STRING(reason_str));
Richard Jones7b9558d2006-05-27 12:29:24 +00001859 }
Eric Smith2d9856d2010-02-24 14:15:36 +00001860done:
1861 Py_XDECREF(reason_str);
1862 return result;
Richard Jones7b9558d2006-05-27 12:29:24 +00001863}
1864
1865static PyTypeObject _PyExc_UnicodeTranslateError = {
1866 PyObject_HEAD_INIT(NULL)
1867 0,
1868 EXC_MODULE_NAME "UnicodeTranslateError",
1869 sizeof(PyUnicodeErrorObject), 0,
1870 (destructor)UnicodeError_dealloc, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
1871 (reprfunc)UnicodeTranslateError_str, 0, 0, 0,
1872 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
Georg Brandl38f62372006-09-06 06:50:05 +00001873 PyDoc_STR("Unicode translation error."), (traverseproc)UnicodeError_traverse,
Richard Jones7b9558d2006-05-27 12:29:24 +00001874 (inquiry)UnicodeError_clear, 0, 0, 0, 0, 0, UnicodeError_members,
1875 0, &_PyExc_UnicodeError, 0, 0, 0, offsetof(PyUnicodeErrorObject, dict),
Michael W. Hudson96495ee2006-05-28 17:40:29 +00001876 (initproc)UnicodeTranslateError_init, 0, BaseException_new,
Richard Jones7b9558d2006-05-27 12:29:24 +00001877};
1878PyObject *PyExc_UnicodeTranslateError = (PyObject *)&_PyExc_UnicodeTranslateError;
1879
1880PyObject *
1881PyUnicodeTranslateError_Create(
1882 const Py_UNICODE *object, Py_ssize_t length,
1883 Py_ssize_t start, Py_ssize_t end, const char *reason)
1884{
1885 return PyObject_CallFunction(PyExc_UnicodeTranslateError, "u#nns",
Michael W. Hudson22a80e72006-05-28 15:51:40 +00001886 object, length, start, end, reason);
Richard Jones7b9558d2006-05-27 12:29:24 +00001887}
1888#endif
1889
1890
1891/*
1892 * AssertionError extends StandardError
1893 */
1894SimpleExtendsException(PyExc_StandardError, AssertionError,
Richard Jones2d555b32006-05-27 16:15:11 +00001895 "Assertion failed.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001896
1897
1898/*
1899 * ArithmeticError extends StandardError
1900 */
1901SimpleExtendsException(PyExc_StandardError, ArithmeticError,
Richard Jones2d555b32006-05-27 16:15:11 +00001902 "Base class for arithmetic errors.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001903
1904
1905/*
1906 * FloatingPointError extends ArithmeticError
1907 */
1908SimpleExtendsException(PyExc_ArithmeticError, FloatingPointError,
Richard Jones2d555b32006-05-27 16:15:11 +00001909 "Floating point operation failed.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001910
1911
1912/*
1913 * OverflowError extends ArithmeticError
1914 */
1915SimpleExtendsException(PyExc_ArithmeticError, OverflowError,
Richard Jones2d555b32006-05-27 16:15:11 +00001916 "Result too large to be represented.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001917
1918
1919/*
1920 * ZeroDivisionError extends ArithmeticError
1921 */
1922SimpleExtendsException(PyExc_ArithmeticError, ZeroDivisionError,
Richard Jones2d555b32006-05-27 16:15:11 +00001923 "Second argument to a division or modulo operation was zero.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001924
1925
1926/*
1927 * SystemError extends StandardError
1928 */
1929SimpleExtendsException(PyExc_StandardError, SystemError,
1930 "Internal error in the Python interpreter.\n"
1931 "\n"
1932 "Please report this to the Python maintainer, along with the traceback,\n"
Richard Jones2d555b32006-05-27 16:15:11 +00001933 "the Python version, and the hardware/OS platform and version.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001934
1935
1936/*
1937 * ReferenceError extends StandardError
1938 */
1939SimpleExtendsException(PyExc_StandardError, ReferenceError,
Richard Jones2d555b32006-05-27 16:15:11 +00001940 "Weak ref proxy used after referent went away.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001941
1942
1943/*
1944 * MemoryError extends StandardError
1945 */
Richard Jones2d555b32006-05-27 16:15:11 +00001946SimpleExtendsException(PyExc_StandardError, MemoryError, "Out of memory.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001947
Travis E. Oliphant3781aef2008-03-18 04:44:57 +00001948/*
1949 * BufferError extends StandardError
1950 */
1951SimpleExtendsException(PyExc_StandardError, BufferError, "Buffer error.");
1952
Richard Jones7b9558d2006-05-27 12:29:24 +00001953
1954/* Warning category docstrings */
1955
1956/*
1957 * Warning extends Exception
1958 */
1959SimpleExtendsException(PyExc_Exception, Warning,
Richard Jones2d555b32006-05-27 16:15:11 +00001960 "Base class for warning categories.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001961
1962
1963/*
1964 * UserWarning extends Warning
1965 */
1966SimpleExtendsException(PyExc_Warning, UserWarning,
Richard Jones2d555b32006-05-27 16:15:11 +00001967 "Base class for warnings generated by user code.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001968
1969
1970/*
1971 * DeprecationWarning extends Warning
1972 */
1973SimpleExtendsException(PyExc_Warning, DeprecationWarning,
Richard Jones2d555b32006-05-27 16:15:11 +00001974 "Base class for warnings about deprecated features.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001975
1976
1977/*
1978 * PendingDeprecationWarning extends Warning
1979 */
1980SimpleExtendsException(PyExc_Warning, PendingDeprecationWarning,
1981 "Base class for warnings about features which will be deprecated\n"
Richard Jones2d555b32006-05-27 16:15:11 +00001982 "in the future.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001983
1984
1985/*
1986 * SyntaxWarning extends Warning
1987 */
1988SimpleExtendsException(PyExc_Warning, SyntaxWarning,
Richard Jones2d555b32006-05-27 16:15:11 +00001989 "Base class for warnings about dubious syntax.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001990
1991
1992/*
1993 * RuntimeWarning extends Warning
1994 */
1995SimpleExtendsException(PyExc_Warning, RuntimeWarning,
Richard Jones2d555b32006-05-27 16:15:11 +00001996 "Base class for warnings about dubious runtime behavior.");
Richard Jones7b9558d2006-05-27 12:29:24 +00001997
1998
1999/*
2000 * FutureWarning extends Warning
2001 */
2002SimpleExtendsException(PyExc_Warning, FutureWarning,
2003 "Base class for warnings about constructs that will change semantically\n"
Richard Jones2d555b32006-05-27 16:15:11 +00002004 "in the future.");
Richard Jones7b9558d2006-05-27 12:29:24 +00002005
2006
2007/*
2008 * ImportWarning extends Warning
2009 */
2010SimpleExtendsException(PyExc_Warning, ImportWarning,
Richard Jones2d555b32006-05-27 16:15:11 +00002011 "Base class for warnings about probable mistakes in module imports");
Richard Jones7b9558d2006-05-27 12:29:24 +00002012
2013
Marc-André Lemburg040f76b2006-08-14 10:55:19 +00002014/*
2015 * UnicodeWarning extends Warning
2016 */
2017SimpleExtendsException(PyExc_Warning, UnicodeWarning,
2018 "Base class for warnings about Unicode related problems, mostly\n"
2019 "related to conversion problems.");
2020
Christian Heimes1a6387e2008-03-26 12:49:49 +00002021/*
2022 * BytesWarning extends Warning
2023 */
2024SimpleExtendsException(PyExc_Warning, BytesWarning,
2025 "Base class for warnings about bytes and buffer related problems, mostly\n"
2026 "related to conversion from str or comparing to str.");
Marc-André Lemburg040f76b2006-08-14 10:55:19 +00002027
Richard Jones7b9558d2006-05-27 12:29:24 +00002028/* Pre-computed MemoryError instance. Best to create this as early as
2029 * possible and not wait until a MemoryError is actually raised!
2030 */
2031PyObject *PyExc_MemoryErrorInst=NULL;
2032
Brett Cannon1e534b52007-09-07 04:18:30 +00002033/* Pre-computed RuntimeError instance for when recursion depth is reached.
2034 Meant to be used when normalizing the exception for exceeding the recursion
2035 depth will cause its own infinite recursion.
2036*/
2037PyObject *PyExc_RecursionErrorInst = NULL;
2038
Richard Jones7b9558d2006-05-27 12:29:24 +00002039/* module global functions */
2040static PyMethodDef functions[] = {
2041 /* Sentinel */
2042 {NULL, NULL}
2043};
2044
2045#define PRE_INIT(TYPE) if (PyType_Ready(&_PyExc_ ## TYPE) < 0) \
2046 Py_FatalError("exceptions bootstrapping error.");
2047
2048#define POST_INIT(TYPE) Py_INCREF(PyExc_ ## TYPE); \
2049 PyModule_AddObject(m, # TYPE, PyExc_ ## TYPE); \
2050 if (PyDict_SetItemString(bdict, # TYPE, PyExc_ ## TYPE)) \
2051 Py_FatalError("Module dictionary insertion problem.");
2052
KristjĂ¡n Valur JĂ³nssonf6083172006-06-12 15:45:12 +00002053
Richard Jones7b9558d2006-05-27 12:29:24 +00002054PyMODINIT_FUNC
Michael W. Hudson22a80e72006-05-28 15:51:40 +00002055_PyExc_Init(void)
Richard Jones7b9558d2006-05-27 12:29:24 +00002056{
2057 PyObject *m, *bltinmod, *bdict;
2058
2059 PRE_INIT(BaseException)
2060 PRE_INIT(Exception)
2061 PRE_INIT(StandardError)
2062 PRE_INIT(TypeError)
2063 PRE_INIT(StopIteration)
2064 PRE_INIT(GeneratorExit)
2065 PRE_INIT(SystemExit)
2066 PRE_INIT(KeyboardInterrupt)
2067 PRE_INIT(ImportError)
2068 PRE_INIT(EnvironmentError)
2069 PRE_INIT(IOError)
2070 PRE_INIT(OSError)
2071#ifdef MS_WINDOWS
2072 PRE_INIT(WindowsError)
2073#endif
2074#ifdef __VMS
2075 PRE_INIT(VMSError)
2076#endif
2077 PRE_INIT(EOFError)
2078 PRE_INIT(RuntimeError)
2079 PRE_INIT(NotImplementedError)
2080 PRE_INIT(NameError)
2081 PRE_INIT(UnboundLocalError)
2082 PRE_INIT(AttributeError)
2083 PRE_INIT(SyntaxError)
2084 PRE_INIT(IndentationError)
2085 PRE_INIT(TabError)
2086 PRE_INIT(LookupError)
2087 PRE_INIT(IndexError)
2088 PRE_INIT(KeyError)
2089 PRE_INIT(ValueError)
2090 PRE_INIT(UnicodeError)
2091#ifdef Py_USING_UNICODE
2092 PRE_INIT(UnicodeEncodeError)
2093 PRE_INIT(UnicodeDecodeError)
2094 PRE_INIT(UnicodeTranslateError)
2095#endif
2096 PRE_INIT(AssertionError)
2097 PRE_INIT(ArithmeticError)
2098 PRE_INIT(FloatingPointError)
2099 PRE_INIT(OverflowError)
2100 PRE_INIT(ZeroDivisionError)
2101 PRE_INIT(SystemError)
2102 PRE_INIT(ReferenceError)
2103 PRE_INIT(MemoryError)
Benjamin Petersonc0bf76d2008-07-30 17:45:10 +00002104 PRE_INIT(BufferError)
Richard Jones7b9558d2006-05-27 12:29:24 +00002105 PRE_INIT(Warning)
2106 PRE_INIT(UserWarning)
2107 PRE_INIT(DeprecationWarning)
2108 PRE_INIT(PendingDeprecationWarning)
2109 PRE_INIT(SyntaxWarning)
2110 PRE_INIT(RuntimeWarning)
2111 PRE_INIT(FutureWarning)
2112 PRE_INIT(ImportWarning)
Marc-André Lemburg040f76b2006-08-14 10:55:19 +00002113 PRE_INIT(UnicodeWarning)
Christian Heimes1a6387e2008-03-26 12:49:49 +00002114 PRE_INIT(BytesWarning)
Richard Jones7b9558d2006-05-27 12:29:24 +00002115
Richard Jonesc5b2a2e2006-05-27 16:07:28 +00002116 m = Py_InitModule4("exceptions", functions, exceptions_doc,
2117 (PyObject *)NULL, PYTHON_API_VERSION);
Benjamin Peterson4c79aec2012-02-03 19:22:31 -05002118 if (m == NULL)
2119 return;
Richard Jones7b9558d2006-05-27 12:29:24 +00002120
2121 bltinmod = PyImport_ImportModule("__builtin__");
2122 if (bltinmod == NULL)
2123 Py_FatalError("exceptions bootstrapping error.");
2124 bdict = PyModule_GetDict(bltinmod);
2125 if (bdict == NULL)
2126 Py_FatalError("exceptions bootstrapping error.");
2127
2128 POST_INIT(BaseException)
2129 POST_INIT(Exception)
2130 POST_INIT(StandardError)
2131 POST_INIT(TypeError)
2132 POST_INIT(StopIteration)
2133 POST_INIT(GeneratorExit)
2134 POST_INIT(SystemExit)
2135 POST_INIT(KeyboardInterrupt)
2136 POST_INIT(ImportError)
2137 POST_INIT(EnvironmentError)
2138 POST_INIT(IOError)
2139 POST_INIT(OSError)
2140#ifdef MS_WINDOWS
2141 POST_INIT(WindowsError)
2142#endif
2143#ifdef __VMS
2144 POST_INIT(VMSError)
2145#endif
2146 POST_INIT(EOFError)
2147 POST_INIT(RuntimeError)
2148 POST_INIT(NotImplementedError)
2149 POST_INIT(NameError)
2150 POST_INIT(UnboundLocalError)
2151 POST_INIT(AttributeError)
2152 POST_INIT(SyntaxError)
2153 POST_INIT(IndentationError)
2154 POST_INIT(TabError)
2155 POST_INIT(LookupError)
2156 POST_INIT(IndexError)
2157 POST_INIT(KeyError)
2158 POST_INIT(ValueError)
2159 POST_INIT(UnicodeError)
2160#ifdef Py_USING_UNICODE
2161 POST_INIT(UnicodeEncodeError)
2162 POST_INIT(UnicodeDecodeError)
2163 POST_INIT(UnicodeTranslateError)
2164#endif
2165 POST_INIT(AssertionError)
2166 POST_INIT(ArithmeticError)
2167 POST_INIT(FloatingPointError)
2168 POST_INIT(OverflowError)
2169 POST_INIT(ZeroDivisionError)
2170 POST_INIT(SystemError)
2171 POST_INIT(ReferenceError)
2172 POST_INIT(MemoryError)
Benjamin Petersonc0bf76d2008-07-30 17:45:10 +00002173 POST_INIT(BufferError)
Richard Jones7b9558d2006-05-27 12:29:24 +00002174 POST_INIT(Warning)
2175 POST_INIT(UserWarning)
2176 POST_INIT(DeprecationWarning)
2177 POST_INIT(PendingDeprecationWarning)
2178 POST_INIT(SyntaxWarning)
2179 POST_INIT(RuntimeWarning)
2180 POST_INIT(FutureWarning)
2181 POST_INIT(ImportWarning)
Marc-André Lemburg040f76b2006-08-14 10:55:19 +00002182 POST_INIT(UnicodeWarning)
Christian Heimes1a6387e2008-03-26 12:49:49 +00002183 POST_INIT(BytesWarning)
Richard Jones7b9558d2006-05-27 12:29:24 +00002184
2185 PyExc_MemoryErrorInst = BaseException_new(&_PyExc_MemoryError, NULL, NULL);
2186 if (!PyExc_MemoryErrorInst)
Amaury Forgeot d'Arc59ce0422009-01-17 20:18:59 +00002187 Py_FatalError("Cannot pre-allocate MemoryError instance");
Richard Jones7b9558d2006-05-27 12:29:24 +00002188
Brett Cannon1e534b52007-09-07 04:18:30 +00002189 PyExc_RecursionErrorInst = BaseException_new(&_PyExc_RuntimeError, NULL, NULL);
2190 if (!PyExc_RecursionErrorInst)
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002191 Py_FatalError("Cannot pre-allocate RuntimeError instance for "
2192 "recursion errors");
Brett Cannon1e534b52007-09-07 04:18:30 +00002193 else {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002194 PyBaseExceptionObject *err_inst =
2195 (PyBaseExceptionObject *)PyExc_RecursionErrorInst;
2196 PyObject *args_tuple;
2197 PyObject *exc_message;
2198 exc_message = PyString_FromString("maximum recursion depth exceeded");
2199 if (!exc_message)
2200 Py_FatalError("cannot allocate argument for RuntimeError "
2201 "pre-allocation");
2202 args_tuple = PyTuple_Pack(1, exc_message);
2203 if (!args_tuple)
2204 Py_FatalError("cannot allocate tuple for RuntimeError "
2205 "pre-allocation");
2206 Py_DECREF(exc_message);
2207 if (BaseException_init(err_inst, args_tuple, NULL))
2208 Py_FatalError("init of pre-allocated RuntimeError failed");
2209 Py_DECREF(args_tuple);
Brett Cannon1e534b52007-09-07 04:18:30 +00002210 }
Benjamin Peterson0f7e2df2012-02-10 08:46:54 -05002211 Py_DECREF(bltinmod);
Richard Jones7b9558d2006-05-27 12:29:24 +00002212}
2213
2214void
2215_PyExc_Fini(void)
2216{
Alexandre Vassalotti55bd1ef2009-06-12 18:56:57 +00002217 Py_CLEAR(PyExc_MemoryErrorInst);
2218 Py_CLEAR(PyExc_RecursionErrorInst);
Richard Jones7b9558d2006-05-27 12:29:24 +00002219}