blob: 5a9a624279ddf86430bed890f122890da46adcfb [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum373c8691997-04-29 18:22:47 +00002/* Error handling */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003
Guido van Rossum373c8691997-04-29 18:22:47 +00004#include "Python.h"
Guido van Rossumf22120a1990-12-20 23:05:40 +00005
Guido van Rossum53e8d441995-03-09 12:11:31 +00006#ifndef __STDC__
Guido van Rossum7844e381997-04-11 20:44:04 +00007#ifndef MS_WINDOWS
Tim Petersdbd9ba62000-07-09 03:09:57 +00008extern char *strerror(int);
Guido van Rossum53e8d441995-03-09 12:11:31 +00009#endif
Guido van Rossum7844e381997-04-11 20:44:04 +000010#endif
Guido van Rossumf5401bd1990-11-02 17:50:28 +000011
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000012#ifdef MS_WINDOWS
Martin v. Löwis5d12abe2007-09-03 07:40:24 +000013#include <windows.h>
14#include <winbase.h>
Guido van Rossum743007d1999-04-21 15:27:31 +000015#endif
16
Jeremy Hyltonb69a27e2000-09-01 03:49:47 +000017#include <ctype.h>
18
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000019#ifdef __cplusplus
20extern "C" {
21#endif
22
23
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000024void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000025PyErr_Restore(PyObject *type, PyObject *value, PyObject *traceback)
Guido van Rossum1ae940a1995-01-02 19:04:15 +000026{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000027 PyThreadState *tstate = PyThreadState_GET();
28 PyObject *oldtype, *oldvalue, *oldtraceback;
Guido van Rossum1ae940a1995-01-02 19:04:15 +000029
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000030 if (traceback != NULL && !PyTraceBack_Check(traceback)) {
31 /* XXX Should never happen -- fatal error instead? */
32 /* Well, it could be None. */
33 Py_DECREF(traceback);
34 traceback = NULL;
35 }
Guido van Rossuma027efa1997-05-05 20:56:21 +000036
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000037 /* Save these in locals to safeguard against recursive
38 invocation through Py_XDECREF */
39 oldtype = tstate->curexc_type;
40 oldvalue = tstate->curexc_value;
41 oldtraceback = tstate->curexc_traceback;
Guido van Rossuma027efa1997-05-05 20:56:21 +000042
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000043 tstate->curexc_type = type;
44 tstate->curexc_value = value;
45 tstate->curexc_traceback = traceback;
Guido van Rossuma027efa1997-05-05 20:56:21 +000046
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000047 Py_XDECREF(oldtype);
48 Py_XDECREF(oldvalue);
49 Py_XDECREF(oldtraceback);
Guido van Rossum1ae940a1995-01-02 19:04:15 +000050}
51
52void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000053PyErr_SetObject(PyObject *exception, PyObject *value)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000054{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000055 PyThreadState *tstate = PyThreadState_GET();
56 PyObject *exc_value;
57 PyObject *tb = NULL;
Guido van Rossumb4fb6e42008-06-14 20:20:24 +000058
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000059 if (exception != NULL &&
60 !PyExceptionClass_Check(exception)) {
61 PyErr_Format(PyExc_SystemError,
62 "exception %R not a BaseException subclass",
63 exception);
64 return;
65 }
66 Py_XINCREF(value);
67 exc_value = tstate->exc_value;
68 if (exc_value != NULL && exc_value != Py_None) {
69 /* Implicit exception chaining */
70 Py_INCREF(exc_value);
71 if (value == NULL || !PyExceptionInstance_Check(value)) {
72 /* We must normalize the value right now */
73 PyObject *args, *fixed_value;
74 if (value == NULL || value == Py_None)
75 args = PyTuple_New(0);
76 else if (PyTuple_Check(value)) {
77 Py_INCREF(value);
78 args = value;
79 }
80 else
81 args = PyTuple_Pack(1, value);
82 fixed_value = args ?
83 PyEval_CallObject(exception, args) : NULL;
84 Py_XDECREF(args);
85 Py_XDECREF(value);
86 if (fixed_value == NULL)
87 return;
88 value = fixed_value;
89 }
90 /* Avoid reference cycles through the context chain.
91 This is O(chain length) but context chains are
92 usually very short. Sensitive readers may try
93 to inline the call to PyException_GetContext. */
94 if (exc_value != value) {
95 PyObject *o = exc_value, *context;
96 while ((context = PyException_GetContext(o))) {
97 Py_DECREF(context);
98 if (context == value) {
99 PyException_SetContext(o, NULL);
100 break;
101 }
102 o = context;
103 }
104 PyException_SetContext(value, exc_value);
105 } else {
106 Py_DECREF(exc_value);
107 }
108 }
109 if (value != NULL && PyExceptionInstance_Check(value))
110 tb = PyException_GetTraceback(value);
111 Py_XINCREF(exception);
112 PyErr_Restore(exception, value, tb);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000113}
114
115void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000116PyErr_SetNone(PyObject *exception)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000117{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000118 PyErr_SetObject(exception, (PyObject *)NULL);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000119}
120
121void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000122PyErr_SetString(PyObject *exception, const char *string)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000123{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000124 PyObject *value = PyUnicode_FromString(string);
125 PyErr_SetObject(exception, value);
126 Py_XDECREF(value);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000127}
128
Guido van Rossum3a241811994-08-29 12:14:12 +0000129
Guido van Rossum373c8691997-04-29 18:22:47 +0000130PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000131PyErr_Occurred(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000132{
Jeffrey Yasskin8e0bdfd2010-05-13 18:31:05 +0000133 /* If there is no thread state, PyThreadState_GET calls
134 Py_FatalError, which calls PyErr_Occurred. To avoid the
135 resulting infinite loop, we inline PyThreadState_GET here and
136 treat no thread as no error. */
137 PyThreadState *tstate =
138 ((PyThreadState*)_Py_atomic_load_relaxed(&_PyThreadState_Current));
Guido van Rossuma027efa1997-05-05 20:56:21 +0000139
Jeffrey Yasskin8e0bdfd2010-05-13 18:31:05 +0000140 return tstate == NULL ? NULL : tstate->curexc_type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000141}
142
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000143
144int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000145PyErr_GivenExceptionMatches(PyObject *err, PyObject *exc)
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000146{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000147 if (err == NULL || exc == NULL) {
148 /* maybe caused by "import exceptions" that failed early on */
149 return 0;
150 }
151 if (PyTuple_Check(exc)) {
152 Py_ssize_t i, n;
153 n = PyTuple_Size(exc);
154 for (i = 0; i < n; i++) {
155 /* Test recursively */
156 if (PyErr_GivenExceptionMatches(
157 err, PyTuple_GET_ITEM(exc, i)))
158 {
159 return 1;
160 }
161 }
162 return 0;
163 }
164 /* err might be an instance, so check its class. */
165 if (PyExceptionInstance_Check(err))
166 err = PyExceptionInstance_Class(err);
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000167
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000168 if (PyExceptionClass_Check(err) && PyExceptionClass_Check(exc)) {
169 int res = 0;
170 PyObject *exception, *value, *tb;
171 PyErr_Fetch(&exception, &value, &tb);
172 /* PyObject_IsSubclass() can recurse and therefore is
173 not safe (see test_bad_getattr in test.pickletester). */
174 res = PyType_IsSubtype((PyTypeObject *)err, (PyTypeObject *)exc);
175 /* This function must not fail, so print the error here */
176 if (res == -1) {
177 PyErr_WriteUnraisable(err);
178 res = 0;
179 }
180 PyErr_Restore(exception, value, tb);
181 return res;
182 }
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000184 return err == exc;
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000185}
Guido van Rossum743007d1999-04-21 15:27:31 +0000186
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000187
188int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000189PyErr_ExceptionMatches(PyObject *exc)
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000190{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000191 return PyErr_GivenExceptionMatches(PyErr_Occurred(), exc);
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000192}
193
194
195/* Used in many places to normalize a raised exception, including in
196 eval_code2(), do_raise(), and PyErr_Print()
Benjamin Petersone6528212008-07-15 15:32:09 +0000197
198 XXX: should PyErr_NormalizeException() also call
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000199 PyException_SetTraceback() with the resulting value and tb?
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000200*/
201void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000202PyErr_NormalizeException(PyObject **exc, PyObject **val, PyObject **tb)
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000203{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000204 PyObject *type = *exc;
205 PyObject *value = *val;
206 PyObject *inclass = NULL;
207 PyObject *initial_tb = NULL;
208 PyThreadState *tstate = NULL;
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000210 if (type == NULL) {
211 /* There was no exception, so nothing to do. */
212 return;
213 }
Guido van Rossumed473a42000-08-07 19:18:27 +0000214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000215 /* If PyErr_SetNone() was used, the value will have been actually
216 set to NULL.
217 */
218 if (!value) {
219 value = Py_None;
220 Py_INCREF(value);
221 }
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000222
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000223 if (PyExceptionInstance_Check(value))
224 inclass = PyExceptionInstance_Class(value);
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000225
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000226 /* Normalize the exception so that if the type is a class, the
227 value will be an instance.
228 */
229 if (PyExceptionClass_Check(type)) {
230 /* if the value was not an instance, or is not an instance
231 whose class is (or is derived from) type, then use the
232 value as an argument to instantiation of the type
233 class.
234 */
235 if (!inclass || !PyObject_IsSubclass(inclass, type)) {
236 PyObject *args, *res;
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000237
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000238 if (value == Py_None)
239 args = PyTuple_New(0);
240 else if (PyTuple_Check(value)) {
241 Py_INCREF(value);
242 args = value;
243 }
244 else
245 args = PyTuple_Pack(1, value);
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000246
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000247 if (args == NULL)
248 goto finally;
249 res = PyEval_CallObject(type, args);
250 Py_DECREF(args);
251 if (res == NULL)
252 goto finally;
253 Py_DECREF(value);
254 value = res;
255 }
256 /* if the class of the instance doesn't exactly match the
257 class of the type, believe the instance
258 */
259 else if (inclass != type) {
260 Py_DECREF(type);
261 type = inclass;
262 Py_INCREF(type);
263 }
264 }
265 *exc = type;
266 *val = value;
267 return;
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000268finally:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000269 Py_DECREF(type);
270 Py_DECREF(value);
271 /* If the new exception doesn't set a traceback and the old
272 exception had a traceback, use the old traceback for the
273 new exception. It's better than nothing.
274 */
275 initial_tb = *tb;
276 PyErr_Fetch(exc, val, tb);
277 if (initial_tb != NULL) {
278 if (*tb == NULL)
279 *tb = initial_tb;
280 else
281 Py_DECREF(initial_tb);
282 }
283 /* normalize recursively */
284 tstate = PyThreadState_GET();
285 if (++tstate->recursion_depth > Py_GetRecursionLimit()) {
286 --tstate->recursion_depth;
287 /* throw away the old exception... */
288 Py_DECREF(*exc);
289 Py_DECREF(*val);
290 /* ... and use the recursion error instead */
291 *exc = PyExc_RuntimeError;
292 *val = PyExc_RecursionErrorInst;
293 Py_INCREF(*exc);
294 Py_INCREF(*val);
295 /* just keeping the old traceback */
296 return;
297 }
298 PyErr_NormalizeException(exc, val, tb);
299 --tstate->recursion_depth;
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000300}
301
302
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000303void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000304PyErr_Fetch(PyObject **p_type, PyObject **p_value, PyObject **p_traceback)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000305{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000306 PyThreadState *tstate = PyThreadState_GET();
Guido van Rossuma027efa1997-05-05 20:56:21 +0000307
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000308 *p_type = tstate->curexc_type;
309 *p_value = tstate->curexc_value;
310 *p_traceback = tstate->curexc_traceback;
Guido van Rossuma027efa1997-05-05 20:56:21 +0000311
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000312 tstate->curexc_type = NULL;
313 tstate->curexc_value = NULL;
314 tstate->curexc_traceback = NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000315}
316
317void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000318PyErr_Clear(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000319{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000320 PyErr_Restore(NULL, NULL, NULL);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000321}
Guido van Rossum7d310eb1990-10-14 20:00:05 +0000322
323/* Convenience functions to set a type error exception and return 0 */
324
325int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000326PyErr_BadArgument(void)
Guido van Rossum7d310eb1990-10-14 20:00:05 +0000327{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000328 PyErr_SetString(PyExc_TypeError,
329 "bad argument type for built-in operation");
330 return 0;
Guido van Rossum7d310eb1990-10-14 20:00:05 +0000331}
332
Guido van Rossum373c8691997-04-29 18:22:47 +0000333PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000334PyErr_NoMemory(void)
Guido van Rossum7d310eb1990-10-14 20:00:05 +0000335{
Antoine Pitrou07e20ef2010-10-28 22:56:58 +0000336 PyErr_SetNone(PyExc_MemoryError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000337 return NULL;
Guido van Rossum7d310eb1990-10-14 20:00:05 +0000338}
339
Guido van Rossum373c8691997-04-29 18:22:47 +0000340PyObject *
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000341PyErr_SetFromErrnoWithFilenameObject(PyObject *exc, PyObject *filenameObject)
Guido van Rossum7d310eb1990-10-14 20:00:05 +0000342{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 PyObject *message;
344 PyObject *v;
345 int i = errno;
Martin v. Löwis5d12abe2007-09-03 07:40:24 +0000346#ifndef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 char *s;
Martin v. Löwis5d12abe2007-09-03 07:40:24 +0000348#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 WCHAR *s_buf = NULL;
Martin v. Löwis5d12abe2007-09-03 07:40:24 +0000350#endif /* Unix/Windows */
Martin v. Löwis5d12abe2007-09-03 07:40:24 +0000351
Guido van Rossume9fbc091995-02-18 14:52:19 +0000352#ifdef EINTR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000353 if (i == EINTR && PyErr_CheckSignals())
354 return NULL;
Guido van Rossume9fbc091995-02-18 14:52:19 +0000355#endif
Martin v. Löwis5d12abe2007-09-03 07:40:24 +0000356
Martin v. Löwis5d12abe2007-09-03 07:40:24 +0000357#ifndef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000358 if (i == 0)
359 s = "Error"; /* Sometimes errno didn't get set */
360 else
361 s = strerror(i);
362 message = PyUnicode_DecodeUTF8(s, strlen(s), "ignore");
Guido van Rossum743007d1999-04-21 15:27:31 +0000363#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000364 if (i == 0)
365 message = PyUnicode_FromString("Error"); /* Sometimes errno didn't get set */
366 else
367 {
368 /* Note that the Win32 errors do not lineup with the
369 errno error. So if the error is in the MSVC error
370 table, we use it, otherwise we assume it really _is_
371 a Win32 error code
372 */
373 if (i > 0 && i < _sys_nerr) {
374 message = PyUnicode_FromString(_sys_errlist[i]);
375 }
376 else {
377 int len = FormatMessageW(
378 FORMAT_MESSAGE_ALLOCATE_BUFFER |
379 FORMAT_MESSAGE_FROM_SYSTEM |
380 FORMAT_MESSAGE_IGNORE_INSERTS,
381 NULL, /* no message source */
382 i,
383 MAKELANGID(LANG_NEUTRAL,
384 SUBLANG_DEFAULT),
385 /* Default language */
386 (LPWSTR) &s_buf,
387 0, /* size not used */
388 NULL); /* no args */
389 if (len==0) {
390 /* Only ever seen this in out-of-mem
391 situations */
392 s_buf = NULL;
393 message = PyUnicode_FromFormat("Windows Error 0x%X", i);
394 } else {
395 /* remove trailing cr/lf and dots */
396 while (len > 0 && (s_buf[len-1] <= L' ' || s_buf[len-1] == L'.'))
397 s_buf[--len] = L'\0';
398 message = PyUnicode_FromUnicode(s_buf, len);
399 }
400 }
401 }
Martin v. Löwis3484a182002-03-09 12:07:51 +0000402#endif /* Unix/Windows */
Martin v. Löwis5d12abe2007-09-03 07:40:24 +0000403
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000404 if (message == NULL)
405 {
Martin v. Löwis5d12abe2007-09-03 07:40:24 +0000406#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000407 LocalFree(s_buf);
Martin v. Löwis5d12abe2007-09-03 07:40:24 +0000408#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000409 return NULL;
410 }
Martin v. Löwis5d12abe2007-09-03 07:40:24 +0000411
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000412 if (filenameObject != NULL)
413 v = Py_BuildValue("(iOO)", i, message, filenameObject);
414 else
415 v = Py_BuildValue("(iO)", i, message);
416 Py_DECREF(message);
Martin v. Löwis5d12abe2007-09-03 07:40:24 +0000417
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000418 if (v != NULL) {
419 PyErr_SetObject(exc, v);
420 Py_DECREF(v);
421 }
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000422#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000423 LocalFree(s_buf);
Guido van Rossum743007d1999-04-21 15:27:31 +0000424#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000425 return NULL;
Guido van Rossum7d310eb1990-10-14 20:00:05 +0000426}
Guido van Rossum743007d1999-04-21 15:27:31 +0000427
Barry Warsaw97d95151998-07-23 16:05:56 +0000428
429PyObject *
Neal Norwitzb382b842007-08-24 20:00:37 +0000430PyErr_SetFromErrnoWithFilename(PyObject *exc, const char *filename)
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000431{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000432 PyObject *name = filename ? PyUnicode_DecodeFSDefault(filename) : NULL;
433 PyObject *result = PyErr_SetFromErrnoWithFilenameObject(exc, name);
434 Py_XDECREF(name);
435 return result;
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000436}
437
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +0000438#ifdef MS_WINDOWS
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000439PyObject *
Neal Norwitzb382b842007-08-24 20:00:37 +0000440PyErr_SetFromErrnoWithUnicodeFilename(PyObject *exc, const Py_UNICODE *filename)
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000441{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000442 PyObject *name = filename ?
443 PyUnicode_FromUnicode(filename, wcslen(filename)) :
444 NULL;
445 PyObject *result = PyErr_SetFromErrnoWithFilenameObject(exc, name);
446 Py_XDECREF(name);
447 return result;
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000448}
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +0000449#endif /* MS_WINDOWS */
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000450
451PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000452PyErr_SetFromErrno(PyObject *exc)
Barry Warsaw97d95151998-07-23 16:05:56 +0000453{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000454 return PyErr_SetFromErrnoWithFilenameObject(exc, NULL);
Barry Warsaw97d95151998-07-23 16:05:56 +0000455}
Guido van Rossum683a0721990-10-21 22:09:12 +0000456
Brett Cannonbf364092006-03-01 04:25:17 +0000457#ifdef MS_WINDOWS
Guido van Rossum795e1892000-02-17 15:19:15 +0000458/* Windows specific error code handling */
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000459PyObject *PyErr_SetExcFromWindowsErrWithFilenameObject(
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000460 PyObject *exc,
461 int ierr,
462 PyObject *filenameObject)
Guido van Rossum795e1892000-02-17 15:19:15 +0000463{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000464 int len;
465 WCHAR *s_buf = NULL; /* Free via LocalFree */
466 PyObject *message;
467 PyObject *v;
468 DWORD err = (DWORD)ierr;
469 if (err==0) err = GetLastError();
470 len = FormatMessageW(
471 /* Error API error */
472 FORMAT_MESSAGE_ALLOCATE_BUFFER |
473 FORMAT_MESSAGE_FROM_SYSTEM |
474 FORMAT_MESSAGE_IGNORE_INSERTS,
475 NULL, /* no message source */
476 err,
477 MAKELANGID(LANG_NEUTRAL,
478 SUBLANG_DEFAULT), /* Default language */
479 (LPWSTR) &s_buf,
480 0, /* size not used */
481 NULL); /* no args */
482 if (len==0) {
483 /* Only seen this in out of mem situations */
484 message = PyUnicode_FromFormat("Windows Error 0x%X", err);
485 s_buf = NULL;
486 } else {
487 /* remove trailing cr/lf and dots */
488 while (len > 0 && (s_buf[len-1] <= L' ' || s_buf[len-1] == L'.'))
489 s_buf[--len] = L'\0';
490 message = PyUnicode_FromUnicode(s_buf, len);
491 }
Martin v. Löwis5d12abe2007-09-03 07:40:24 +0000492
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000493 if (message == NULL)
494 {
495 LocalFree(s_buf);
496 return NULL;
497 }
Martin v. Löwis5d12abe2007-09-03 07:40:24 +0000498
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000499 if (filenameObject != NULL)
500 v = Py_BuildValue("(iOO)", err, message, filenameObject);
501 else
502 v = Py_BuildValue("(iO)", err, message);
503 Py_DECREF(message);
Martin v. Löwis5d12abe2007-09-03 07:40:24 +0000504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000505 if (v != NULL) {
506 PyErr_SetObject(exc, v);
507 Py_DECREF(v);
508 }
509 LocalFree(s_buf);
510 return NULL;
Guido van Rossum795e1892000-02-17 15:19:15 +0000511}
512
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000513PyObject *PyErr_SetExcFromWindowsErrWithFilename(
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514 PyObject *exc,
515 int ierr,
516 const char *filename)
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000517{
Victor Stinner92be9392010-12-28 00:28:21 +0000518 PyObject *name = filename ? PyUnicode_DecodeFSDefault(filename) : NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000519 PyObject *ret = PyErr_SetExcFromWindowsErrWithFilenameObject(exc,
520 ierr,
521 name);
522 Py_XDECREF(name);
523 return ret;
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000524}
525
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000526PyObject *PyErr_SetExcFromWindowsErrWithUnicodeFilename(
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000527 PyObject *exc,
528 int ierr,
529 const Py_UNICODE *filename)
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000530{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000531 PyObject *name = filename ?
532 PyUnicode_FromUnicode(filename, wcslen(filename)) :
533 NULL;
534 PyObject *ret = PyErr_SetExcFromWindowsErrWithFilenameObject(exc,
535 ierr,
536 name);
537 Py_XDECREF(name);
538 return ret;
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000539}
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000540
Thomas Heller085358a2002-07-29 14:27:41 +0000541PyObject *PyErr_SetExcFromWindowsErr(PyObject *exc, int ierr)
542{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000543 return PyErr_SetExcFromWindowsErrWithFilename(exc, ierr, NULL);
Thomas Heller085358a2002-07-29 14:27:41 +0000544}
545
Guido van Rossum795e1892000-02-17 15:19:15 +0000546PyObject *PyErr_SetFromWindowsErr(int ierr)
547{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000548 return PyErr_SetExcFromWindowsErrWithFilename(PyExc_WindowsError,
549 ierr, NULL);
Thomas Heller085358a2002-07-29 14:27:41 +0000550}
551PyObject *PyErr_SetFromWindowsErrWithFilename(
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000552 int ierr,
553 const char *filename)
Thomas Heller085358a2002-07-29 14:27:41 +0000554{
Victor Stinner92be9392010-12-28 00:28:21 +0000555 PyObject *name = filename ? PyUnicode_DecodeFSDefault(filename) : NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000556 PyObject *result = PyErr_SetExcFromWindowsErrWithFilenameObject(
557 PyExc_WindowsError,
558 ierr, name);
559 Py_XDECREF(name);
560 return result;
Guido van Rossum795e1892000-02-17 15:19:15 +0000561}
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000562
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000563PyObject *PyErr_SetFromWindowsErrWithUnicodeFilename(
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000564 int ierr,
565 const Py_UNICODE *filename)
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000566{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000567 PyObject *name = filename ?
568 PyUnicode_FromUnicode(filename, wcslen(filename)) :
569 NULL;
570 PyObject *result = PyErr_SetExcFromWindowsErrWithFilenameObject(
571 PyExc_WindowsError,
572 ierr, name);
573 Py_XDECREF(name);
574 return result;
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000575}
Guido van Rossum795e1892000-02-17 15:19:15 +0000576#endif /* MS_WINDOWS */
577
Guido van Rossum683a0721990-10-21 22:09:12 +0000578void
Neal Norwitzb382b842007-08-24 20:00:37 +0000579_PyErr_BadInternalCall(const char *filename, int lineno)
Fred Drake6d63adf2000-08-24 22:38:39 +0000580{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000581 PyErr_Format(PyExc_SystemError,
582 "%s:%d: bad argument to internal function",
583 filename, lineno);
Fred Drake6d63adf2000-08-24 22:38:39 +0000584}
585
586/* Remove the preprocessor macro for PyErr_BadInternalCall() so that we can
587 export the entry point for existing object code: */
588#undef PyErr_BadInternalCall
589void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000590PyErr_BadInternalCall(void)
Guido van Rossum683a0721990-10-21 22:09:12 +0000591{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000592 PyErr_Format(PyExc_SystemError,
593 "bad argument to internal function");
Guido van Rossum683a0721990-10-21 22:09:12 +0000594}
Fred Drake6d63adf2000-08-24 22:38:39 +0000595#define PyErr_BadInternalCall() _PyErr_BadInternalCall(__FILE__, __LINE__)
596
Guido van Rossum1548bac1997-02-14 17:09:47 +0000597
598
Guido van Rossum1548bac1997-02-14 17:09:47 +0000599PyObject *
600PyErr_Format(PyObject *exception, const char *format, ...)
Guido van Rossum1548bac1997-02-14 17:09:47 +0000601{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000602 va_list vargs;
603 PyObject* string;
Guido van Rossum1548bac1997-02-14 17:09:47 +0000604
Jeremy Hyltonb69a27e2000-09-01 03:49:47 +0000605#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000606 va_start(vargs, format);
Jeremy Hyltonb69a27e2000-09-01 03:49:47 +0000607#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000608 va_start(vargs);
Jeremy Hyltonb69a27e2000-09-01 03:49:47 +0000609#endif
Guido van Rossum1548bac1997-02-14 17:09:47 +0000610
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000611 string = PyUnicode_FromFormatV(format, vargs);
612 PyErr_SetObject(exception, string);
613 Py_XDECREF(string);
614 va_end(vargs);
615 return NULL;
Guido van Rossum1548bac1997-02-14 17:09:47 +0000616}
Guido van Rossum7617e051997-09-16 18:43:50 +0000617
618
Thomas Wouters477c8d52006-05-27 19:21:47 +0000619
Guido van Rossum7617e051997-09-16 18:43:50 +0000620PyObject *
Neal Norwitzb382b842007-08-24 20:00:37 +0000621PyErr_NewException(const char *name, PyObject *base, PyObject *dict)
Guido van Rossum7617e051997-09-16 18:43:50 +0000622{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000623 const char *dot;
624 PyObject *modulename = NULL;
625 PyObject *classname = NULL;
626 PyObject *mydict = NULL;
627 PyObject *bases = NULL;
628 PyObject *result = NULL;
629 dot = strrchr(name, '.');
630 if (dot == NULL) {
631 PyErr_SetString(PyExc_SystemError,
632 "PyErr_NewException: name must be module.class");
633 return NULL;
634 }
635 if (base == NULL)
636 base = PyExc_Exception;
637 if (dict == NULL) {
638 dict = mydict = PyDict_New();
639 if (dict == NULL)
640 goto failure;
641 }
642 if (PyDict_GetItemString(dict, "__module__") == NULL) {
643 modulename = PyUnicode_FromStringAndSize(name,
644 (Py_ssize_t)(dot-name));
645 if (modulename == NULL)
646 goto failure;
647 if (PyDict_SetItemString(dict, "__module__", modulename) != 0)
648 goto failure;
649 }
650 if (PyTuple_Check(base)) {
651 bases = base;
652 /* INCREF as we create a new ref in the else branch */
653 Py_INCREF(bases);
654 } else {
655 bases = PyTuple_Pack(1, base);
656 if (bases == NULL)
657 goto failure;
658 }
659 /* Create a real new-style class. */
Victor Stinner7eeb5b52010-06-07 19:57:46 +0000660 result = PyObject_CallFunction((PyObject *)&PyType_Type, "sOO",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000661 dot+1, bases, dict);
Guido van Rossum7617e051997-09-16 18:43:50 +0000662 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000663 Py_XDECREF(bases);
664 Py_XDECREF(mydict);
665 Py_XDECREF(classname);
666 Py_XDECREF(modulename);
667 return result;
Guido van Rossum7617e051997-09-16 18:43:50 +0000668}
Jeremy Hyltonb709df32000-09-01 02:47:25 +0000669
Georg Brandl1e28a272009-12-28 08:41:01 +0000670
671/* Create an exception with docstring */
672PyObject *
673PyErr_NewExceptionWithDoc(const char *name, const char *doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000674 PyObject *base, PyObject *dict)
Georg Brandl1e28a272009-12-28 08:41:01 +0000675{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000676 int result;
677 PyObject *ret = NULL;
678 PyObject *mydict = NULL; /* points to the dict only if we create it */
679 PyObject *docobj;
Georg Brandl1e28a272009-12-28 08:41:01 +0000680
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000681 if (dict == NULL) {
682 dict = mydict = PyDict_New();
683 if (dict == NULL) {
684 return NULL;
685 }
686 }
Georg Brandl1e28a272009-12-28 08:41:01 +0000687
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000688 if (doc != NULL) {
689 docobj = PyUnicode_FromString(doc);
690 if (docobj == NULL)
691 goto failure;
692 result = PyDict_SetItemString(dict, "__doc__", docobj);
693 Py_DECREF(docobj);
694 if (result < 0)
695 goto failure;
696 }
Georg Brandl1e28a272009-12-28 08:41:01 +0000697
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000698 ret = PyErr_NewException(name, base, dict);
Georg Brandl1e28a272009-12-28 08:41:01 +0000699 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000700 Py_XDECREF(mydict);
701 return ret;
Georg Brandl1e28a272009-12-28 08:41:01 +0000702}
703
704
Jeremy Hyltonb709df32000-09-01 02:47:25 +0000705/* Call when an exception has occurred but there is no way for Python
706 to handle it. Examples: exception in __del__ or during GC. */
707void
708PyErr_WriteUnraisable(PyObject *obj)
709{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000710 PyObject *f, *t, *v, *tb;
711 PyErr_Fetch(&t, &v, &tb);
712 f = PySys_GetObject("stderr");
713 if (f != NULL && f != Py_None) {
714 PyFile_WriteString("Exception ", f);
715 if (t) {
716 PyObject* moduleName;
717 char* className;
718 assert(PyExceptionClass_Check(t));
719 className = PyExceptionClass_Name(t);
720 if (className != NULL) {
721 char *dot = strrchr(className, '.');
722 if (dot != NULL)
723 className = dot+1;
724 }
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000725
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000726 moduleName = PyObject_GetAttrString(t, "__module__");
727 if (moduleName == NULL)
728 PyFile_WriteString("<unknown>", f);
729 else {
730 char* modstr = _PyUnicode_AsString(moduleName);
731 if (modstr &&
732 strcmp(modstr, "builtins") != 0)
733 {
734 PyFile_WriteString(modstr, f);
735 PyFile_WriteString(".", f);
736 }
737 }
738 if (className == NULL)
739 PyFile_WriteString("<unknown>", f);
740 else
741 PyFile_WriteString(className, f);
742 if (v && v != Py_None) {
743 PyFile_WriteString(": ", f);
744 PyFile_WriteObject(v, f, 0);
745 }
746 Py_XDECREF(moduleName);
747 }
Georg Brandl08be72d2010-10-24 15:11:22 +0000748 if (obj) {
749 PyFile_WriteString(" in ", f);
750 PyFile_WriteObject(obj, f, 0);
751 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000752 PyFile_WriteString(" ignored\n", f);
753 PyErr_Clear(); /* Just in case */
754 }
755 Py_XDECREF(t);
756 Py_XDECREF(v);
757 Py_XDECREF(tb);
Jeremy Hyltonb709df32000-09-01 02:47:25 +0000758}
Guido van Rossumcfd42b52000-12-15 21:58:52 +0000759
Armin Rigo092381a2003-10-25 14:29:27 +0000760extern PyObject *PyModule_GetWarningsModule(void);
Guido van Rossumcfd42b52000-12-15 21:58:52 +0000761
Guido van Rossum2fd45652001-02-28 21:46:24 +0000762
Benjamin Peterson2c539712010-09-20 22:42:10 +0000763void
764PyErr_SyntaxLocation(const char *filename, int lineno) {
765 PyErr_SyntaxLocationEx(filename, lineno, -1);
766}
767
768
Martin v. Löwiscfeb3b62002-03-03 21:30:27 +0000769/* Set file and line information for the current exception.
770 If the exception is not a SyntaxError, also sets additional attributes
771 to make printing of exceptions believe it is a syntax error. */
Guido van Rossum2fd45652001-02-28 21:46:24 +0000772
Jeremy Hyltonad3d3f22001-02-28 17:47:12 +0000773void
Benjamin Peterson2c539712010-09-20 22:42:10 +0000774PyErr_SyntaxLocationEx(const char *filename, int lineno, int col_offset)
Jeremy Hyltonad3d3f22001-02-28 17:47:12 +0000775{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000776 PyObject *exc, *v, *tb, *tmp;
Jeremy Hyltonad3d3f22001-02-28 17:47:12 +0000777
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 /* add attributes for the line number and filename for the error */
779 PyErr_Fetch(&exc, &v, &tb);
780 PyErr_NormalizeException(&exc, &v, &tb);
781 /* XXX check that it is, indeed, a syntax error. It might not
782 * be, though. */
783 tmp = PyLong_FromLong(lineno);
784 if (tmp == NULL)
785 PyErr_Clear();
786 else {
787 if (PyObject_SetAttrString(v, "lineno", tmp))
788 PyErr_Clear();
789 Py_DECREF(tmp);
790 }
Benjamin Peterson2c539712010-09-20 22:42:10 +0000791 if (col_offset >= 0) {
792 tmp = PyLong_FromLong(col_offset);
793 if (tmp == NULL)
794 PyErr_Clear();
795 else {
796 if (PyObject_SetAttrString(v, "offset", tmp))
797 PyErr_Clear();
798 Py_DECREF(tmp);
799 }
800 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000801 if (filename != NULL) {
Victor Stinner15a71cd2010-10-17 19:03:16 +0000802 tmp = PyUnicode_DecodeFSDefault(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000803 if (tmp == NULL)
804 PyErr_Clear();
805 else {
806 if (PyObject_SetAttrString(v, "filename", tmp))
807 PyErr_Clear();
808 Py_DECREF(tmp);
809 }
Jeremy Hyltonad3d3f22001-02-28 17:47:12 +0000810
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000811 tmp = PyErr_ProgramText(filename, lineno);
812 if (tmp) {
813 if (PyObject_SetAttrString(v, "text", tmp))
814 PyErr_Clear();
815 Py_DECREF(tmp);
816 }
817 }
818 if (PyObject_SetAttrString(v, "offset", Py_None)) {
819 PyErr_Clear();
820 }
821 if (exc != PyExc_SyntaxError) {
822 if (!PyObject_HasAttrString(v, "msg")) {
823 tmp = PyObject_Str(v);
824 if (tmp) {
825 if (PyObject_SetAttrString(v, "msg", tmp))
826 PyErr_Clear();
827 Py_DECREF(tmp);
828 } else {
829 PyErr_Clear();
830 }
831 }
832 if (!PyObject_HasAttrString(v, "print_file_and_line")) {
833 if (PyObject_SetAttrString(v, "print_file_and_line",
834 Py_None))
835 PyErr_Clear();
836 }
837 }
838 PyErr_Restore(exc, v, tb);
Jeremy Hyltonad3d3f22001-02-28 17:47:12 +0000839}
840
Guido van Rossumebe8f8a2007-10-10 18:53:36 +0000841/* Attempt to load the line of text that the exception refers to. If it
842 fails, it will return NULL but will not set an exception.
Jeremy Hyltonad3d3f22001-02-28 17:47:12 +0000843
844 XXX The functionality of this function is quite similar to the
Guido van Rossumebe8f8a2007-10-10 18:53:36 +0000845 functionality in tb_displayline() in traceback.c. */
Jeremy Hyltonad3d3f22001-02-28 17:47:12 +0000846
847PyObject *
Martin v. Löwis95292d62002-12-11 14:04:59 +0000848PyErr_ProgramText(const char *filename, int lineno)
Jeremy Hyltonad3d3f22001-02-28 17:47:12 +0000849{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000850 FILE *fp;
851 int i;
852 char linebuf[1000];
Jeremy Hyltonad3d3f22001-02-28 17:47:12 +0000853
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000854 if (filename == NULL || *filename == '\0' || lineno <= 0)
855 return NULL;
856 fp = fopen(filename, "r" PY_STDIOTEXTMODE);
857 if (fp == NULL)
858 return NULL;
859 for (i = 0; i < lineno; i++) {
860 char *pLastChar = &linebuf[sizeof(linebuf) - 2];
861 do {
862 *pLastChar = '\0';
863 if (Py_UniversalNewlineFgets(linebuf, sizeof linebuf,
864 fp, NULL) == NULL)
865 break;
866 /* fgets read *something*; if it didn't get as
867 far as pLastChar, it must have found a newline
868 or hit the end of the file; if pLastChar is \n,
869 it obviously found a newline; else we haven't
870 yet seen a newline, so must continue */
871 } while (*pLastChar != '\0' && *pLastChar != '\n');
872 }
873 fclose(fp);
874 if (i == lineno) {
875 char *p = linebuf;
876 PyObject *res;
877 while (*p == ' ' || *p == '\t' || *p == '\014')
878 p++;
879 res = PyUnicode_FromString(p);
880 if (res == NULL)
881 PyErr_Clear();
882 return res;
883 }
884 return NULL;
Jeremy Hyltonad3d3f22001-02-28 17:47:12 +0000885}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000886
887#ifdef __cplusplus
888}
889#endif