1#ifndef Py_ERRORS_H
2#define Py_ERRORS_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
7#include <stdarg.h> // va_list
8
9/* Error handling definitions */
10
11PyAPI_FUNC(void) PyErr_SetNone(PyObject *);
12PyAPI_FUNC(void) PyErr_SetObject(PyObject *, PyObject *);
13PyAPI_FUNC(void) PyErr_SetString(
14 PyObject *exception,
15 const char *string /* decoded from utf-8 */
16 );
17PyAPI_FUNC(PyObject *) PyErr_Occurred(void);
18PyAPI_FUNC(void) PyErr_Clear(void);
19PyAPI_FUNC(void) PyErr_Fetch(PyObject **, PyObject **, PyObject **);
20PyAPI_FUNC(void) PyErr_Restore(PyObject *, PyObject *, PyObject *);
21PyAPI_FUNC(PyObject *) PyErr_GetRaisedException(void);
22PyAPI_FUNC(void) PyErr_SetRaisedException(PyObject *);
23#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x030b0000
24PyAPI_FUNC(PyObject*) PyErr_GetHandledException(void);
25PyAPI_FUNC(void) PyErr_SetHandledException(PyObject *);
26#endif
27#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
28PyAPI_FUNC(void) PyErr_GetExcInfo(PyObject **, PyObject **, PyObject **);
29PyAPI_FUNC(void) PyErr_SetExcInfo(PyObject *, PyObject *, PyObject *);
30#endif
31
32/* Defined in Python/pylifecycle.c
33
34 The Py_FatalError() function is replaced with a macro which logs
35 automatically the name of the current function, unless the Py_LIMITED_API
36 macro is defined. */
37PyAPI_FUNC(void) _Py_NO_RETURN Py_FatalError(const char *message);
38
39/* Error testing and normalization */
40PyAPI_FUNC(int) PyErr_GivenExceptionMatches(PyObject *, PyObject *);
41PyAPI_FUNC(int) PyErr_ExceptionMatches(PyObject *);
42PyAPI_FUNC(void) PyErr_NormalizeException(PyObject**, PyObject**, PyObject**);
43
44/* Traceback manipulation (PEP 3134) */
45PyAPI_FUNC(int) PyException_SetTraceback(PyObject *, PyObject *);
46PyAPI_FUNC(PyObject *) PyException_GetTraceback(PyObject *);
47
48/* Cause manipulation (PEP 3134) */
49PyAPI_FUNC(PyObject *) PyException_GetCause(PyObject *);
50PyAPI_FUNC(void) PyException_SetCause(PyObject *, PyObject *);
51
52/* Context manipulation (PEP 3134) */
53PyAPI_FUNC(PyObject *) PyException_GetContext(PyObject *);
54PyAPI_FUNC(void) PyException_SetContext(PyObject *, PyObject *);
55
56
57PyAPI_FUNC(PyObject *) PyException_GetArgs(PyObject *);
58PyAPI_FUNC(void) PyException_SetArgs(PyObject *, PyObject *);
59
60/* */
61
62#define PyExceptionClass_Check(x) \
63 (PyType_Check((x)) && \
64 PyType_FastSubclass((PyTypeObject*)(x), Py_TPFLAGS_BASE_EXC_SUBCLASS))
65
66#define PyExceptionInstance_Check(x) \
67 PyType_FastSubclass(Py_TYPE(x), Py_TPFLAGS_BASE_EXC_SUBCLASS)
68
69PyAPI_FUNC(const char *) PyExceptionClass_Name(PyObject *);
70
71#define PyExceptionInstance_Class(x) _PyObject_CAST(Py_TYPE(x))
72
73#define _PyBaseExceptionGroup_Check(x) \
74 PyObject_TypeCheck((x), (PyTypeObject *)PyExc_BaseExceptionGroup)
75
76/* Predefined exceptions */
77
78PyAPI_DATA(PyObject *) PyExc_BaseException;
79PyAPI_DATA(PyObject *) PyExc_Exception;
80PyAPI_DATA(PyObject *) PyExc_BaseExceptionGroup;
81#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
82PyAPI_DATA(PyObject *) PyExc_StopAsyncIteration;
83#endif
84PyAPI_DATA(PyObject *) PyExc_StopIteration;
85PyAPI_DATA(PyObject *) PyExc_GeneratorExit;
86PyAPI_DATA(PyObject *) PyExc_ArithmeticError;
87PyAPI_DATA(PyObject *) PyExc_LookupError;
88
89PyAPI_DATA(PyObject *) PyExc_AssertionError;
90PyAPI_DATA(PyObject *) PyExc_AttributeError;
91PyAPI_DATA(PyObject *) PyExc_BufferError;
92PyAPI_DATA(PyObject *) PyExc_EOFError;
93PyAPI_DATA(PyObject *) PyExc_FloatingPointError;
94PyAPI_DATA(PyObject *) PyExc_OSError;
95PyAPI_DATA(PyObject *) PyExc_ImportError;
96#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03060000
97PyAPI_DATA(PyObject *) PyExc_ModuleNotFoundError;
98#endif
99PyAPI_DATA(PyObject *) PyExc_IndexError;
100PyAPI_DATA(PyObject *) PyExc_KeyError;
101PyAPI_DATA(PyObject *) PyExc_KeyboardInterrupt;
102PyAPI_DATA(PyObject *) PyExc_MemoryError;
103PyAPI_DATA(PyObject *) PyExc_NameError;
104PyAPI_DATA(PyObject *) PyExc_OverflowError;
105PyAPI_DATA(PyObject *) PyExc_RuntimeError;
106#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
107PyAPI_DATA(PyObject *) PyExc_RecursionError;
108#endif
109PyAPI_DATA(PyObject *) PyExc_NotImplementedError;
110PyAPI_DATA(PyObject *) PyExc_SyntaxError;
111PyAPI_DATA(PyObject *) PyExc_IndentationError;
112PyAPI_DATA(PyObject *) PyExc_TabError;
113PyAPI_DATA(PyObject *) PyExc_ReferenceError;
114PyAPI_DATA(PyObject *) PyExc_SystemError;
115PyAPI_DATA(PyObject *) PyExc_SystemExit;
116PyAPI_DATA(PyObject *) PyExc_TypeError;
117PyAPI_DATA(PyObject *) PyExc_UnboundLocalError;
118PyAPI_DATA(PyObject *) PyExc_UnicodeError;
119PyAPI_DATA(PyObject *) PyExc_UnicodeEncodeError;
120PyAPI_DATA(PyObject *) PyExc_UnicodeDecodeError;
121PyAPI_DATA(PyObject *) PyExc_UnicodeTranslateError;
122PyAPI_DATA(PyObject *) PyExc_ValueError;
123PyAPI_DATA(PyObject *) PyExc_ZeroDivisionError;
124
125#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
126PyAPI_DATA(PyObject *) PyExc_BlockingIOError;
127PyAPI_DATA(PyObject *) PyExc_BrokenPipeError;
128PyAPI_DATA(PyObject *) PyExc_ChildProcessError;
129PyAPI_DATA(PyObject *) PyExc_ConnectionError;
130PyAPI_DATA(PyObject *) PyExc_ConnectionAbortedError;
131PyAPI_DATA(PyObject *) PyExc_ConnectionRefusedError;
132PyAPI_DATA(PyObject *) PyExc_ConnectionResetError;
133PyAPI_DATA(PyObject *) PyExc_FileExistsError;
134PyAPI_DATA(PyObject *) PyExc_FileNotFoundError;
135PyAPI_DATA(PyObject *) PyExc_InterruptedError;
136PyAPI_DATA(PyObject *) PyExc_IsADirectoryError;
137PyAPI_DATA(PyObject *) PyExc_NotADirectoryError;
138PyAPI_DATA(PyObject *) PyExc_PermissionError;
139PyAPI_DATA(PyObject *) PyExc_ProcessLookupError;
140PyAPI_DATA(PyObject *) PyExc_TimeoutError;
141#endif
142
143
144/* Compatibility aliases */
145PyAPI_DATA(PyObject *) PyExc_EnvironmentError;
146PyAPI_DATA(PyObject *) PyExc_IOError;
147#ifdef MS_WINDOWS
148PyAPI_DATA(PyObject *) PyExc_WindowsError;
149#endif
150
151/* Predefined warning categories */
152PyAPI_DATA(PyObject *) PyExc_Warning;
153PyAPI_DATA(PyObject *) PyExc_UserWarning;
154PyAPI_DATA(PyObject *) PyExc_DeprecationWarning;
155PyAPI_DATA(PyObject *) PyExc_PendingDeprecationWarning;
156PyAPI_DATA(PyObject *) PyExc_SyntaxWarning;
157PyAPI_DATA(PyObject *) PyExc_RuntimeWarning;
158PyAPI_DATA(PyObject *) PyExc_FutureWarning;
159PyAPI_DATA(PyObject *) PyExc_ImportWarning;
160PyAPI_DATA(PyObject *) PyExc_UnicodeWarning;
161PyAPI_DATA(PyObject *) PyExc_BytesWarning;
162PyAPI_DATA(PyObject *) PyExc_EncodingWarning;
163PyAPI_DATA(PyObject *) PyExc_ResourceWarning;
164
165
166/* Convenience functions */
167
168PyAPI_FUNC(int) PyErr_BadArgument(void);
169PyAPI_FUNC(PyObject *) PyErr_NoMemory(void);
170PyAPI_FUNC(PyObject *) PyErr_SetFromErrno(PyObject *);
171PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilenameObject(
172 PyObject *, PyObject *);
173#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03040000
174PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilenameObjects(
175 PyObject *, PyObject *, PyObject *);
176#endif
177PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilename(
178 PyObject *exc,
179 const char *filename /* decoded from the filesystem encoding */
180 );
181
182PyAPI_FUNC(PyObject *) PyErr_Format(
183 PyObject *exception,
184 const char *format, /* ASCII-encoded string */
185 ...
186 );
187#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
188PyAPI_FUNC(PyObject *) PyErr_FormatV(
189 PyObject *exception,
190 const char *format,
191 va_list vargs);
192#endif
193
194#ifdef MS_WINDOWS
195PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErrWithFilename(
196 int ierr,
197 const char *filename /* decoded from the filesystem encoding */
198 );
199PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErr(int);
200PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilenameObject(
201 PyObject *,int, PyObject *);
202#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03040000
203PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilenameObjects(
204 PyObject *,int, PyObject *, PyObject *);
205#endif
206PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilename(
207 PyObject *exc,
208 int ierr,
209 const char *filename /* decoded from the filesystem encoding */
210 );
211PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErr(PyObject *, int);
212#endif /* MS_WINDOWS */
213
214#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03060000
215PyAPI_FUNC(PyObject *) PyErr_SetImportErrorSubclass(PyObject *, PyObject *,
216 PyObject *, PyObject *);
217#endif
218#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
219PyAPI_FUNC(PyObject *) PyErr_SetImportError(PyObject *, PyObject *,
220 PyObject *);
221#endif
222
223/* Export the old function so that the existing API remains available: */
224PyAPI_FUNC(void) PyErr_BadInternalCall(void);
225PyAPI_FUNC(void) _PyErr_BadInternalCall(const char *filename, int lineno);
226/* Mask the old API with a call to the new API for code compiled under
227 Python 2.0: */
228#define PyErr_BadInternalCall() _PyErr_BadInternalCall(__FILE__, __LINE__)
229
230/* Function to create a new exception */
231PyAPI_FUNC(PyObject *) PyErr_NewException(
232 const char *name, PyObject *base, PyObject *dict);
233PyAPI_FUNC(PyObject *) PyErr_NewExceptionWithDoc(
234 const char *name, const char *doc, PyObject *base, PyObject *dict);
235PyAPI_FUNC(void) PyErr_WriteUnraisable(PyObject *);
236
237
238/* In signalmodule.c */
239PyAPI_FUNC(int) PyErr_CheckSignals(void);
240PyAPI_FUNC(void) PyErr_SetInterrupt(void);
241#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x030A0000
242PyAPI_FUNC(int) PyErr_SetInterruptEx(int signum);
243#endif
244
245/* Support for adding program text to SyntaxErrors */
246PyAPI_FUNC(void) PyErr_SyntaxLocation(
247 const char *filename, /* decoded from the filesystem encoding */
248 int lineno);
249PyAPI_FUNC(void) PyErr_SyntaxLocationEx(
250 const char *filename, /* decoded from the filesystem encoding */
251 int lineno,
252 int col_offset);
253PyAPI_FUNC(PyObject *) PyErr_ProgramText(
254 const char *filename, /* decoded from the filesystem encoding */
255 int lineno);
256
257/* The following functions are used to create and modify unicode
258 exceptions from C */
259
260/* create a UnicodeDecodeError object */
261PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_Create(
262 const char *encoding, /* UTF-8 encoded string */
263 const char *object,
264 Py_ssize_t length,
265 Py_ssize_t start,
266 Py_ssize_t end,
267 const char *reason /* UTF-8 encoded string */
268 );
269
270/* get the encoding attribute */
271PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetEncoding(PyObject *);
272PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetEncoding(PyObject *);
273
274/* get the object attribute */
275PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetObject(PyObject *);
276PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetObject(PyObject *);
277PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_GetObject(PyObject *);
278
279/* get the value of the start attribute (the int * may not be NULL)
280 return 0 on success, -1 on failure */
281PyAPI_FUNC(int) PyUnicodeEncodeError_GetStart(PyObject *, Py_ssize_t *);
282PyAPI_FUNC(int) PyUnicodeDecodeError_GetStart(PyObject *, Py_ssize_t *);
283PyAPI_FUNC(int) PyUnicodeTranslateError_GetStart(PyObject *, Py_ssize_t *);
284
285/* assign a new value to the start attribute
286 return 0 on success, -1 on failure */
287PyAPI_FUNC(int) PyUnicodeEncodeError_SetStart(PyObject *, Py_ssize_t);
288PyAPI_FUNC(int) PyUnicodeDecodeError_SetStart(PyObject *, Py_ssize_t);
289PyAPI_FUNC(int) PyUnicodeTranslateError_SetStart(PyObject *, Py_ssize_t);
290
291/* get the value of the end attribute (the int *may not be NULL)
292 return 0 on success, -1 on failure */
293PyAPI_FUNC(int) PyUnicodeEncodeError_GetEnd(PyObject *, Py_ssize_t *);
294PyAPI_FUNC(int) PyUnicodeDecodeError_GetEnd(PyObject *, Py_ssize_t *);
295PyAPI_FUNC(int) PyUnicodeTranslateError_GetEnd(PyObject *, Py_ssize_t *);
296
297/* assign a new value to the end attribute
298 return 0 on success, -1 on failure */
299PyAPI_FUNC(int) PyUnicodeEncodeError_SetEnd(PyObject *, Py_ssize_t);
300PyAPI_FUNC(int) PyUnicodeDecodeError_SetEnd(PyObject *, Py_ssize_t);
301PyAPI_FUNC(int) PyUnicodeTranslateError_SetEnd(PyObject *, Py_ssize_t);
302
303/* get the value of the reason attribute */
304PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetReason(PyObject *);
305PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetReason(PyObject *);
306PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_GetReason(PyObject *);
307
308/* assign a new value to the reason attribute
309 return 0 on success, -1 on failure */
310PyAPI_FUNC(int) PyUnicodeEncodeError_SetReason(
311 PyObject *exc,
312 const char *reason /* UTF-8 encoded string */
313 );
314PyAPI_FUNC(int) PyUnicodeDecodeError_SetReason(
315 PyObject *exc,
316 const char *reason /* UTF-8 encoded string */
317 );
318PyAPI_FUNC(int) PyUnicodeTranslateError_SetReason(
319 PyObject *exc,
320 const char *reason /* UTF-8 encoded string */
321 );
322
323PyAPI_FUNC(int) PyOS_snprintf(char *str, size_t size, const char *format, ...)
324 Py_GCC_ATTRIBUTE((format(printf, 3, 4)));
325PyAPI_FUNC(int) PyOS_vsnprintf(char *str, size_t size, const char *format, va_list va)
326 Py_GCC_ATTRIBUTE((format(printf, 3, 0)));
327
328#ifndef Py_LIMITED_API
329# define Py_CPYTHON_ERRORS_H
330# include "cpython/pyerrors.h"
331# undef Py_CPYTHON_ERRORS_H
332#endif
333
334#ifdef __cplusplus
335}
336#endif
337#endif /* !Py_ERRORS_H */
338

source code of include/python3.12/pyerrors.h