14 } PyBaseExceptionObject
;
26 PyObject
*print_file_and_line
;
27 } PySyntaxErrorObject
;
29 #ifdef Py_USING_UNICODE
40 } PyUnicodeErrorObject
;
59 } PyEnvironmentErrorObject
;
71 } PyWindowsErrorObject
;
74 /* Error handling definitions */
76 PyAPI_FUNC(void) PyErr_SetNone(PyObject
*);
77 PyAPI_FUNC(void) PyErr_SetObject(PyObject
*, PyObject
*);
78 PyAPI_FUNC(void) PyErr_SetString(PyObject
*, const char *);
79 PyAPI_FUNC(PyObject
*) PyErr_Occurred(void);
80 PyAPI_FUNC(void) PyErr_Clear(void);
81 PyAPI_FUNC(void) PyErr_Fetch(PyObject
**, PyObject
**, PyObject
**);
82 PyAPI_FUNC(void) PyErr_Restore(PyObject
*, PyObject
*, PyObject
*);
85 #define _PyErr_OCCURRED() PyErr_Occurred()
87 #define _PyErr_OCCURRED() (_PyThreadState_Current->curexc_type)
90 /* Error testing and normalization */
91 PyAPI_FUNC(int) PyErr_GivenExceptionMatches(PyObject
*, PyObject
*);
92 PyAPI_FUNC(int) PyErr_ExceptionMatches(PyObject
*);
93 PyAPI_FUNC(void) PyErr_NormalizeException(PyObject
**, PyObject
**, PyObject
**);
97 #define PyExceptionClass_Check(x) \
98 (PyClass_Check((x)) || (PyType_Check((x)) && \
99 PyType_FastSubclass((PyTypeObject*)(x), Py_TPFLAGS_BASE_EXC_SUBCLASS)))
101 #define PyExceptionInstance_Check(x) \
102 (PyInstance_Check((x)) || \
103 PyType_FastSubclass((x)->ob_type, Py_TPFLAGS_BASE_EXC_SUBCLASS))
105 #define PyExceptionClass_Name(x) \
106 (PyClass_Check((x)) \
107 ? PyString_AS_STRING(((PyClassObject*)(x))->cl_name) \
108 : (char *)(((PyTypeObject*)(x))->tp_name))
110 #define PyExceptionInstance_Class(x) \
111 ((PyInstance_Check((x)) \
112 ? (PyObject*)((PyInstanceObject*)(x))->in_class \
113 : (PyObject*)((x)->ob_type)))
116 /* Predefined exceptions */
118 PyAPI_DATA(PyObject
*) PyExc_BaseException
;
119 PyAPI_DATA(PyObject
*) PyExc_Exception
;
120 PyAPI_DATA(PyObject
*) PyExc_StopIteration
;
121 PyAPI_DATA(PyObject
*) PyExc_GeneratorExit
;
122 PyAPI_DATA(PyObject
*) PyExc_StandardError
;
123 PyAPI_DATA(PyObject
*) PyExc_ArithmeticError
;
124 PyAPI_DATA(PyObject
*) PyExc_LookupError
;
126 PyAPI_DATA(PyObject
*) PyExc_AssertionError
;
127 PyAPI_DATA(PyObject
*) PyExc_AttributeError
;
128 PyAPI_DATA(PyObject
*) PyExc_EOFError
;
129 PyAPI_DATA(PyObject
*) PyExc_FloatingPointError
;
130 PyAPI_DATA(PyObject
*) PyExc_EnvironmentError
;
131 PyAPI_DATA(PyObject
*) PyExc_IOError
;
132 PyAPI_DATA(PyObject
*) PyExc_OSError
;
133 PyAPI_DATA(PyObject
*) PyExc_ImportError
;
134 PyAPI_DATA(PyObject
*) PyExc_IndexError
;
135 PyAPI_DATA(PyObject
*) PyExc_KeyError
;
136 PyAPI_DATA(PyObject
*) PyExc_KeyboardInterrupt
;
137 PyAPI_DATA(PyObject
*) PyExc_MemoryError
;
138 PyAPI_DATA(PyObject
*) PyExc_NameError
;
139 PyAPI_DATA(PyObject
*) PyExc_OverflowError
;
140 PyAPI_DATA(PyObject
*) PyExc_RuntimeError
;
141 PyAPI_DATA(PyObject
*) PyExc_NotImplementedError
;
142 PyAPI_DATA(PyObject
*) PyExc_SyntaxError
;
143 PyAPI_DATA(PyObject
*) PyExc_IndentationError
;
144 PyAPI_DATA(PyObject
*) PyExc_TabError
;
145 PyAPI_DATA(PyObject
*) PyExc_ReferenceError
;
146 PyAPI_DATA(PyObject
*) PyExc_SystemError
;
147 PyAPI_DATA(PyObject
*) PyExc_SystemExit
;
148 PyAPI_DATA(PyObject
*) PyExc_TypeError
;
149 PyAPI_DATA(PyObject
*) PyExc_UnboundLocalError
;
150 PyAPI_DATA(PyObject
*) PyExc_UnicodeError
;
151 PyAPI_DATA(PyObject
*) PyExc_UnicodeEncodeError
;
152 PyAPI_DATA(PyObject
*) PyExc_UnicodeDecodeError
;
153 PyAPI_DATA(PyObject
*) PyExc_UnicodeTranslateError
;
154 PyAPI_DATA(PyObject
*) PyExc_ValueError
;
155 PyAPI_DATA(PyObject
*) PyExc_ZeroDivisionError
;
157 PyAPI_DATA(PyObject
*) PyExc_WindowsError
;
160 PyAPI_DATA(PyObject
*) PyExc_VMSError
;
163 PyAPI_DATA(PyObject
*) PyExc_MemoryErrorInst
;
165 /* Predefined warning categories */
166 PyAPI_DATA(PyObject
*) PyExc_Warning
;
167 PyAPI_DATA(PyObject
*) PyExc_UserWarning
;
168 PyAPI_DATA(PyObject
*) PyExc_DeprecationWarning
;
169 PyAPI_DATA(PyObject
*) PyExc_PendingDeprecationWarning
;
170 PyAPI_DATA(PyObject
*) PyExc_SyntaxWarning
;
171 PyAPI_DATA(PyObject
*) PyExc_RuntimeWarning
;
172 PyAPI_DATA(PyObject
*) PyExc_FutureWarning
;
173 PyAPI_DATA(PyObject
*) PyExc_ImportWarning
;
174 PyAPI_DATA(PyObject
*) PyExc_UnicodeWarning
;
177 /* Convenience functions */
179 PyAPI_FUNC(int) PyErr_BadArgument(void);
180 PyAPI_FUNC(PyObject
*) PyErr_NoMemory(void);
181 PyAPI_FUNC(PyObject
*) PyErr_SetFromErrno(PyObject
*);
182 PyAPI_FUNC(PyObject
*) PyErr_SetFromErrnoWithFilenameObject(
183 PyObject
*, PyObject
*);
184 PyAPI_FUNC(PyObject
*) PyErr_SetFromErrnoWithFilename(PyObject
*, char *);
185 #ifdef Py_WIN_WIDE_FILENAMES
186 PyAPI_FUNC(PyObject
*) PyErr_SetFromErrnoWithUnicodeFilename(
187 PyObject
*, Py_UNICODE
*);
188 #endif /* Py_WIN_WIDE_FILENAMES */
190 PyAPI_FUNC(PyObject
*) PyErr_Format(PyObject
*, const char *, ...)
191 Py_GCC_ATTRIBUTE((format(printf
, 2, 3)));
194 PyAPI_FUNC(PyObject
*) PyErr_SetFromWindowsErrWithFilenameObject(
196 PyAPI_FUNC(PyObject
*) PyErr_SetFromWindowsErrWithFilename(
198 #ifdef Py_WIN_WIDE_FILENAMES
199 PyAPI_FUNC(PyObject
*) PyErr_SetFromWindowsErrWithUnicodeFilename(
200 int, const Py_UNICODE
*);
201 #endif /* Py_WIN_WIDE_FILENAMES */
202 PyAPI_FUNC(PyObject
*) PyErr_SetFromWindowsErr(int);
203 PyAPI_FUNC(PyObject
*) PyErr_SetExcFromWindowsErrWithFilenameObject(
204 PyObject
*,int, PyObject
*);
205 PyAPI_FUNC(PyObject
*) PyErr_SetExcFromWindowsErrWithFilename(
206 PyObject
*,int, const char *);
207 #ifdef Py_WIN_WIDE_FILENAMES
208 PyAPI_FUNC(PyObject
*) PyErr_SetExcFromWindowsErrWithUnicodeFilename(
209 PyObject
*,int, const Py_UNICODE
*);
210 #endif /* Py_WIN_WIDE_FILENAMES */
211 PyAPI_FUNC(PyObject
*) PyErr_SetExcFromWindowsErr(PyObject
*, int);
212 #endif /* MS_WINDOWS */
214 /* Export the old function so that the existing API remains available: */
215 PyAPI_FUNC(void) PyErr_BadInternalCall(void);
216 PyAPI_FUNC(void) _PyErr_BadInternalCall(char *filename
, int lineno
);
217 /* Mask the old API with a call to the new API for code compiled under
219 #define PyErr_BadInternalCall() _PyErr_BadInternalCall(__FILE__, __LINE__)
221 /* Function to create a new exception */
222 PyAPI_FUNC(PyObject
*) PyErr_NewException(char *name
, PyObject
*base
,
224 PyAPI_FUNC(void) PyErr_WriteUnraisable(PyObject
*);
226 /* Issue a warning or exception */
227 PyAPI_FUNC(int) PyErr_WarnEx(PyObject
*category
, const char *msg
,
228 Py_ssize_t stack_level
);
229 PyAPI_FUNC(int) PyErr_WarnExplicit(PyObject
*, const char *,
231 const char *, PyObject
*);
232 /* PyErr_Warn is only for backwards compatability and will be removed.
233 Use PyErr_WarnEx instead. */
234 #define PyErr_Warn(category, msg) PyErr_WarnEx(category, msg, 1)
236 /* In sigcheck.c or signalmodule.c */
237 PyAPI_FUNC(int) PyErr_CheckSignals(void);
238 PyAPI_FUNC(void) PyErr_SetInterrupt(void);
240 /* Support for adding program text to SyntaxErrors */
241 PyAPI_FUNC(void) PyErr_SyntaxLocation(const char *, int);
242 PyAPI_FUNC(PyObject
*) PyErr_ProgramText(const char *, int);
244 #ifdef Py_USING_UNICODE
245 /* The following functions are used to create and modify unicode
248 /* create a UnicodeDecodeError object */
249 PyAPI_FUNC(PyObject
*) PyUnicodeDecodeError_Create(
250 const char *, const char *, Py_ssize_t
, Py_ssize_t
, Py_ssize_t
, const char *);
252 /* create a UnicodeEncodeError object */
253 PyAPI_FUNC(PyObject
*) PyUnicodeEncodeError_Create(
254 const char *, const Py_UNICODE
*, Py_ssize_t
, Py_ssize_t
, Py_ssize_t
, const char *);
256 /* create a UnicodeTranslateError object */
257 PyAPI_FUNC(PyObject
*) PyUnicodeTranslateError_Create(
258 const Py_UNICODE
*, Py_ssize_t
, Py_ssize_t
, Py_ssize_t
, const char *);
260 /* get the encoding attribute */
261 PyAPI_FUNC(PyObject
*) PyUnicodeEncodeError_GetEncoding(PyObject
*);
262 PyAPI_FUNC(PyObject
*) PyUnicodeDecodeError_GetEncoding(PyObject
*);
264 /* get the object attribute */
265 PyAPI_FUNC(PyObject
*) PyUnicodeEncodeError_GetObject(PyObject
*);
266 PyAPI_FUNC(PyObject
*) PyUnicodeDecodeError_GetObject(PyObject
*);
267 PyAPI_FUNC(PyObject
*) PyUnicodeTranslateError_GetObject(PyObject
*);
269 /* get the value of the start attribute (the int * may not be NULL)
270 return 0 on success, -1 on failure */
271 PyAPI_FUNC(int) PyUnicodeEncodeError_GetStart(PyObject
*, Py_ssize_t
*);
272 PyAPI_FUNC(int) PyUnicodeDecodeError_GetStart(PyObject
*, Py_ssize_t
*);
273 PyAPI_FUNC(int) PyUnicodeTranslateError_GetStart(PyObject
*, Py_ssize_t
*);
275 /* assign a new value to the start attribute
276 return 0 on success, -1 on failure */
277 PyAPI_FUNC(int) PyUnicodeEncodeError_SetStart(PyObject
*, Py_ssize_t
);
278 PyAPI_FUNC(int) PyUnicodeDecodeError_SetStart(PyObject
*, Py_ssize_t
);
279 PyAPI_FUNC(int) PyUnicodeTranslateError_SetStart(PyObject
*, Py_ssize_t
);
281 /* get the value of the end attribute (the int *may not be NULL)
282 return 0 on success, -1 on failure */
283 PyAPI_FUNC(int) PyUnicodeEncodeError_GetEnd(PyObject
*, Py_ssize_t
*);
284 PyAPI_FUNC(int) PyUnicodeDecodeError_GetEnd(PyObject
*, Py_ssize_t
*);
285 PyAPI_FUNC(int) PyUnicodeTranslateError_GetEnd(PyObject
*, Py_ssize_t
*);
287 /* assign a new value to the end attribute
288 return 0 on success, -1 on failure */
289 PyAPI_FUNC(int) PyUnicodeEncodeError_SetEnd(PyObject
*, Py_ssize_t
);
290 PyAPI_FUNC(int) PyUnicodeDecodeError_SetEnd(PyObject
*, Py_ssize_t
);
291 PyAPI_FUNC(int) PyUnicodeTranslateError_SetEnd(PyObject
*, Py_ssize_t
);
293 /* get the value of the reason attribute */
294 PyAPI_FUNC(PyObject
*) PyUnicodeEncodeError_GetReason(PyObject
*);
295 PyAPI_FUNC(PyObject
*) PyUnicodeDecodeError_GetReason(PyObject
*);
296 PyAPI_FUNC(PyObject
*) PyUnicodeTranslateError_GetReason(PyObject
*);
298 /* assign a new value to the reason attribute
299 return 0 on success, -1 on failure */
300 PyAPI_FUNC(int) PyUnicodeEncodeError_SetReason(
301 PyObject
*, const char *);
302 PyAPI_FUNC(int) PyUnicodeDecodeError_SetReason(
303 PyObject
*, const char *);
304 PyAPI_FUNC(int) PyUnicodeTranslateError_SetReason(
305 PyObject
*, const char *);
309 /* These APIs aren't really part of the error implementation, but
310 often needed to format error messages; the native C lib APIs are
311 not available on all platforms, which is why we provide emulations
312 for those platforms in Python/mysnprintf.c,
313 WARNING: The return value of snprintf varies across platforms; do
314 not rely on any particular behavior; eventually the C99 defn may
317 #if defined(MS_WIN32) && !defined(HAVE_SNPRINTF)
318 # define HAVE_SNPRINTF
319 # define snprintf _snprintf
320 # define vsnprintf _vsnprintf
324 PyAPI_FUNC(int) PyOS_snprintf(char *str
, size_t size
, const char *format
, ...)
325 Py_GCC_ATTRIBUTE((format(printf
, 3, 4)));
326 PyAPI_FUNC(int) PyOS_vsnprintf(char *str
, size_t size
, const char *format
, va_list va
)
327 Py_GCC_ATTRIBUTE((format(printf
, 3, 0)));
332 #endif /* !Py_ERRORS_H */