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