Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 1 | """Class based built-in exception hierarchy. |
| 2 | |
Guido van Rossum | 64e736b | 1998-10-02 01:23:47 +0000 | [diff] [blame] | 3 | New with Python 1.5, all standard built-in exceptions are now class objects by |
| 4 | default. This gives Python's exception handling mechanism a more |
| 5 | object-oriented feel. Traditionally they were string objects. Python will |
| 6 | fallback to string based exceptions if the interpreter is invoked with the -X |
| 7 | option, or if some failure occurs during class exception initialization (in |
| 8 | this case a warning will be printed). |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 9 | |
Guido van Rossum | 64e736b | 1998-10-02 01:23:47 +0000 | [diff] [blame] | 10 | Most existing code should continue to work with class based exceptions. Some |
| 11 | tricky uses of IOError may break, but the most common uses should work. |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 12 | |
Guido van Rossum | 64e736b | 1998-10-02 01:23:47 +0000 | [diff] [blame] | 13 | Here is a rundown of the class hierarchy. You can change this by editing this |
Guido van Rossum | 9a744a9 | 1999-04-08 20:27:54 +0000 | [diff] [blame] | 14 | file, but it isn't recommended because the old string based exceptions won't |
| 15 | be kept in sync. The class names described here are expected to be found by |
| 16 | the bltinmodule.c file. If you add classes here, you must modify |
| 17 | bltinmodule.c or the exceptions won't be available in the __builtin__ module, |
| 18 | nor will they be accessible from C. |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 19 | |
Guido van Rossum | 7ea1d97 | 1998-12-22 13:50:33 +0000 | [diff] [blame] | 20 | The classes with a `*' are new since Python 1.5. They are defined as tuples |
Guido van Rossum | 64e736b | 1998-10-02 01:23:47 +0000 | [diff] [blame] | 21 | containing the derived exceptions when string-based exceptions are used. If |
| 22 | you define your own class based exceptions, they should be derived from |
| 23 | Exception. |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 24 | |
| 25 | Exception(*) |
| 26 | | |
Guido van Rossum | 9a744a9 | 1999-04-08 20:27:54 +0000 | [diff] [blame] | 27 | +-- SystemExit |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 28 | +-- StandardError(*) |
| 29 | | |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 30 | +-- KeyboardInterrupt |
| 31 | +-- ImportError |
Guido van Rossum | 64e736b | 1998-10-02 01:23:47 +0000 | [diff] [blame] | 32 | +-- EnvironmentError(*) |
| 33 | | | |
| 34 | | +-- IOError |
| 35 | | +-- OSError(*) |
Guido van Rossum | aad6761 | 2000-05-08 17:31:04 +0000 | [diff] [blame] | 36 | | | |
| 37 | | +-- WindowsError(*) |
Guido van Rossum | 64e736b | 1998-10-02 01:23:47 +0000 | [diff] [blame] | 38 | | |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 39 | +-- EOFError |
| 40 | +-- RuntimeError |
Guido van Rossum | 7ea1d97 | 1998-12-22 13:50:33 +0000 | [diff] [blame] | 41 | | | |
| 42 | | +-- NotImplementedError(*) |
| 43 | | |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 44 | +-- NameError |
Guido van Rossum | aad6761 | 2000-05-08 17:31:04 +0000 | [diff] [blame] | 45 | | | |
| 46 | | +-- UnboundLocalError(*) |
| 47 | | |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 48 | +-- AttributeError |
| 49 | +-- SyntaxError |
| 50 | +-- TypeError |
| 51 | +-- AssertionError |
| 52 | +-- LookupError(*) |
| 53 | | | |
| 54 | | +-- IndexError |
| 55 | | +-- KeyError |
| 56 | | |
| 57 | +-- ArithmeticError(*) |
| 58 | | | |
| 59 | | +-- OverflowError |
| 60 | | +-- ZeroDivisionError |
| 61 | | +-- FloatingPointError |
| 62 | | |
| 63 | +-- ValueError |
Guido van Rossum | aad6761 | 2000-05-08 17:31:04 +0000 | [diff] [blame] | 64 | | | |
| 65 | | +-- UnicodeError(*) |
| 66 | | |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 67 | +-- SystemError |
| 68 | +-- MemoryError |
| 69 | """ |
| 70 | |
| 71 | class Exception: |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 72 | """Proposed base class for all exceptions.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 73 | def __init__(self, *args): |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 74 | self.args = args |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 75 | |
| 76 | def __str__(self): |
| 77 | if not self.args: |
| 78 | return '' |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 79 | elif len(self.args) == 1: |
| 80 | return str(self.args[0]) |
| 81 | else: |
| 82 | return str(self.args) |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 83 | |
| 84 | def __getitem__(self, i): |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 85 | return self.args[i] |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 86 | |
| 87 | class StandardError(Exception): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 88 | """Base class for all standard Python exceptions.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 89 | pass |
| 90 | |
| 91 | class SyntaxError(StandardError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 92 | """Invalid syntax.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 93 | filename = lineno = offset = text = None |
| 94 | msg = "" |
| 95 | def __init__(self, *args): |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 96 | self.args = args |
| 97 | if len(self.args) >= 1: |
| 98 | self.msg = self.args[0] |
| 99 | if len(self.args) == 2: |
| 100 | info = self.args[1] |
| 101 | try: |
| 102 | self.filename, self.lineno, self.offset, self.text = info |
| 103 | except: |
| 104 | pass |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 105 | def __str__(self): |
| 106 | return str(self.msg) |
| 107 | |
Guido van Rossum | e03c050 | 1998-08-12 02:38:11 +0000 | [diff] [blame] | 108 | class EnvironmentError(StandardError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 109 | """Base class for I/O related errors.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 110 | def __init__(self, *args): |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 111 | self.args = args |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 112 | self.errno = None |
| 113 | self.strerror = None |
Guido van Rossum | e03c050 | 1998-08-12 02:38:11 +0000 | [diff] [blame] | 114 | self.filename = None |
| 115 | if len(args) == 3: |
| 116 | # open() errors give third argument which is the filename. BUT, |
| 117 | # so common in-place unpacking doesn't break, e.g.: |
| 118 | # |
| 119 | # except IOError, (errno, strerror): |
| 120 | # |
| 121 | # we hack args so that it only contains two items. This also |
| 122 | # means we need our own __str__() which prints out the filename |
| 123 | # when it was supplied. |
| 124 | self.errno, self.strerror, self.filename = args |
| 125 | self.args = args[0:2] |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 126 | if len(args) == 2: |
| 127 | # common case: PyErr_SetFromErrno() |
Guido van Rossum | e03c050 | 1998-08-12 02:38:11 +0000 | [diff] [blame] | 128 | self.errno, self.strerror = args |
| 129 | |
| 130 | def __str__(self): |
| 131 | if self.filename is not None: |
| 132 | return '[Errno %s] %s: %s' % (self.errno, self.strerror, |
| 133 | repr(self.filename)) |
| 134 | elif self.errno and self.strerror: |
| 135 | return '[Errno %s] %s' % (self.errno, self.strerror) |
| 136 | else: |
| 137 | return StandardError.__str__(self) |
| 138 | |
| 139 | class IOError(EnvironmentError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 140 | """I/O operation failed.""" |
Guido van Rossum | e03c050 | 1998-08-12 02:38:11 +0000 | [diff] [blame] | 141 | pass |
| 142 | |
| 143 | class OSError(EnvironmentError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 144 | """OS system call failed.""" |
Guido van Rossum | e03c050 | 1998-08-12 02:38:11 +0000 | [diff] [blame] | 145 | pass |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 146 | |
Guido van Rossum | aad6761 | 2000-05-08 17:31:04 +0000 | [diff] [blame] | 147 | class WindowsError(OSError): |
| 148 | """MS-Windows OS system call failed.""" |
| 149 | pass |
| 150 | |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 151 | class RuntimeError(StandardError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 152 | """Unspecified run-time error.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 153 | pass |
| 154 | |
Guido van Rossum | 7ea1d97 | 1998-12-22 13:50:33 +0000 | [diff] [blame] | 155 | class NotImplementedError(RuntimeError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 156 | """Method or function hasn't been implemented yet.""" |
Guido van Rossum | 7ea1d97 | 1998-12-22 13:50:33 +0000 | [diff] [blame] | 157 | pass |
| 158 | |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 159 | class SystemError(StandardError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 160 | """Internal error in the Python interpreter. |
| 161 | |
| 162 | Please report this to the Python maintainer, along with the traceback, |
| 163 | the Python version, and the hardware/OS platform and version.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 164 | pass |
| 165 | |
| 166 | class EOFError(StandardError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 167 | """Read beyond end of file.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 168 | pass |
| 169 | |
| 170 | class ImportError(StandardError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 171 | """Import can't find module, or can't find name in module.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 172 | pass |
| 173 | |
| 174 | class TypeError(StandardError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 175 | """Inappropriate argument type.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 176 | pass |
| 177 | |
| 178 | class ValueError(StandardError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 179 | """Inappropriate argument value (of correct type).""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 180 | pass |
| 181 | |
| 182 | class KeyboardInterrupt(StandardError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 183 | """Program interrupted by user.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 184 | pass |
| 185 | |
| 186 | class AssertionError(StandardError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 187 | """Assertion failed.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 188 | pass |
| 189 | |
| 190 | class ArithmeticError(StandardError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 191 | """Base class for arithmetic errors.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 192 | pass |
| 193 | |
| 194 | class OverflowError(ArithmeticError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 195 | """Result too large to be represented.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 196 | pass |
| 197 | |
| 198 | class FloatingPointError(ArithmeticError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 199 | """Floating point operation failed.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 200 | pass |
| 201 | |
| 202 | class ZeroDivisionError(ArithmeticError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 203 | """Second argument to a division or modulo operation was zero.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 204 | pass |
| 205 | |
| 206 | class LookupError(StandardError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 207 | """Base class for lookup errors.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 208 | pass |
| 209 | |
| 210 | class IndexError(LookupError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 211 | """Sequence index out of range.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 212 | pass |
| 213 | |
| 214 | class KeyError(LookupError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 215 | """Mapping key not found.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 216 | pass |
| 217 | |
| 218 | class AttributeError(StandardError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 219 | """Attribute not found.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 220 | pass |
| 221 | |
| 222 | class NameError(StandardError): |
Guido van Rossum | aad6761 | 2000-05-08 17:31:04 +0000 | [diff] [blame] | 223 | """Name not found globally.""" |
| 224 | pass |
| 225 | |
| 226 | class UnboundLocalError(NameError): |
| 227 | """Local name referenced but not bound to a value.""" |
| 228 | pass |
| 229 | |
| 230 | class UnicodeError(ValueError): |
| 231 | """Unicode related error.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 232 | pass |
| 233 | |
| 234 | class MemoryError(StandardError): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 235 | """Out of memory.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 236 | pass |
| 237 | |
| 238 | class SystemExit(Exception): |
Guido van Rossum | 3e0d319 | 1999-01-25 21:57:29 +0000 | [diff] [blame] | 239 | """Request to exit from the interpreter.""" |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 240 | def __init__(self, *args): |
Guido van Rossum | 548703a | 1998-03-26 22:14:20 +0000 | [diff] [blame] | 241 | self.args = args |
Guido van Rossum | a11cccc | 1997-10-06 20:19:59 +0000 | [diff] [blame] | 242 | if len(args) == 0: |
| 243 | self.code = None |
| 244 | elif len(args) == 1: |
| 245 | self.code = args[0] |
| 246 | else: |
| 247 | self.code = args |