blob: e943f7b18830a665a2893ed6899217127bc3f2fb [file] [log] [blame]
Guido van Rossuma11cccc1997-10-06 20:19:59 +00001"""Class based built-in exception hierarchy.
2
Guido van Rossum64e736b1998-10-02 01:23:47 +00003New with Python 1.5, all standard built-in exceptions are now class objects by
4default. This gives Python's exception handling mechanism a more
5object-oriented feel. Traditionally they were string objects. Python will
6fallback to string based exceptions if the interpreter is invoked with the -X
7option, or if some failure occurs during class exception initialization (in
8this case a warning will be printed).
Guido van Rossuma11cccc1997-10-06 20:19:59 +00009
Guido van Rossum64e736b1998-10-02 01:23:47 +000010Most existing code should continue to work with class based exceptions. Some
11tricky uses of IOError may break, but the most common uses should work.
Guido van Rossuma11cccc1997-10-06 20:19:59 +000012
Guido van Rossum64e736b1998-10-02 01:23:47 +000013Here is a rundown of the class hierarchy. You can change this by editing this
Guido van Rossum9a744a91999-04-08 20:27:54 +000014file, but it isn't recommended because the old string based exceptions won't
15be kept in sync. The class names described here are expected to be found by
16the bltinmodule.c file. If you add classes here, you must modify
17bltinmodule.c or the exceptions won't be available in the __builtin__ module,
18nor will they be accessible from C.
Guido van Rossuma11cccc1997-10-06 20:19:59 +000019
Guido van Rossum7ea1d971998-12-22 13:50:33 +000020The classes with a `*' are new since Python 1.5. They are defined as tuples
Guido van Rossum64e736b1998-10-02 01:23:47 +000021containing the derived exceptions when string-based exceptions are used. If
22you define your own class based exceptions, they should be derived from
23Exception.
Guido van Rossuma11cccc1997-10-06 20:19:59 +000024
25Exception(*)
26 |
Guido van Rossum9a744a91999-04-08 20:27:54 +000027 +-- SystemExit
Guido van Rossuma11cccc1997-10-06 20:19:59 +000028 +-- StandardError(*)
29 |
Guido van Rossuma11cccc1997-10-06 20:19:59 +000030 +-- KeyboardInterrupt
31 +-- ImportError
Guido van Rossum64e736b1998-10-02 01:23:47 +000032 +-- EnvironmentError(*)
33 | |
34 | +-- IOError
35 | +-- OSError(*)
36 |
Guido van Rossuma11cccc1997-10-06 20:19:59 +000037 +-- EOFError
38 +-- RuntimeError
Guido van Rossum7ea1d971998-12-22 13:50:33 +000039 | |
40 | +-- NotImplementedError(*)
41 |
Guido van Rossuma11cccc1997-10-06 20:19:59 +000042 +-- NameError
43 +-- AttributeError
44 +-- SyntaxError
45 +-- TypeError
46 +-- AssertionError
47 +-- LookupError(*)
48 | |
49 | +-- IndexError
50 | +-- KeyError
51 |
52 +-- ArithmeticError(*)
53 | |
54 | +-- OverflowError
55 | +-- ZeroDivisionError
56 | +-- FloatingPointError
57 |
58 +-- ValueError
59 +-- SystemError
60 +-- MemoryError
61"""
62
63class Exception:
Guido van Rossum3e0d3191999-01-25 21:57:29 +000064 """Proposed base class for all exceptions."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +000065 def __init__(self, *args):
Guido van Rossum548703a1998-03-26 22:14:20 +000066 self.args = args
Guido van Rossuma11cccc1997-10-06 20:19:59 +000067
68 def __str__(self):
69 if not self.args:
70 return ''
Guido van Rossum548703a1998-03-26 22:14:20 +000071 elif len(self.args) == 1:
72 return str(self.args[0])
73 else:
74 return str(self.args)
Guido van Rossuma11cccc1997-10-06 20:19:59 +000075
76 def __getitem__(self, i):
Guido van Rossum548703a1998-03-26 22:14:20 +000077 return self.args[i]
Guido van Rossuma11cccc1997-10-06 20:19:59 +000078
79class StandardError(Exception):
Guido van Rossum3e0d3191999-01-25 21:57:29 +000080 """Base class for all standard Python exceptions."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +000081 pass
82
83class SyntaxError(StandardError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +000084 """Invalid syntax."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +000085 filename = lineno = offset = text = None
86 msg = ""
87 def __init__(self, *args):
Guido van Rossum548703a1998-03-26 22:14:20 +000088 self.args = args
89 if len(self.args) >= 1:
90 self.msg = self.args[0]
91 if len(self.args) == 2:
92 info = self.args[1]
93 try:
94 self.filename, self.lineno, self.offset, self.text = info
95 except:
96 pass
Guido van Rossuma11cccc1997-10-06 20:19:59 +000097 def __str__(self):
98 return str(self.msg)
99
Guido van Rossume03c0501998-08-12 02:38:11 +0000100class EnvironmentError(StandardError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000101 """Base class for I/O related errors."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000102 def __init__(self, *args):
Guido van Rossum548703a1998-03-26 22:14:20 +0000103 self.args = args
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000104 self.errno = None
105 self.strerror = None
Guido van Rossume03c0501998-08-12 02:38:11 +0000106 self.filename = None
107 if len(args) == 3:
108 # open() errors give third argument which is the filename. BUT,
109 # so common in-place unpacking doesn't break, e.g.:
110 #
111 # except IOError, (errno, strerror):
112 #
113 # we hack args so that it only contains two items. This also
114 # means we need our own __str__() which prints out the filename
115 # when it was supplied.
116 self.errno, self.strerror, self.filename = args
117 self.args = args[0:2]
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000118 if len(args) == 2:
119 # common case: PyErr_SetFromErrno()
Guido van Rossume03c0501998-08-12 02:38:11 +0000120 self.errno, self.strerror = args
121
122 def __str__(self):
123 if self.filename is not None:
124 return '[Errno %s] %s: %s' % (self.errno, self.strerror,
125 repr(self.filename))
126 elif self.errno and self.strerror:
127 return '[Errno %s] %s' % (self.errno, self.strerror)
128 else:
129 return StandardError.__str__(self)
130
131class IOError(EnvironmentError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000132 """I/O operation failed."""
Guido van Rossume03c0501998-08-12 02:38:11 +0000133 pass
134
135class OSError(EnvironmentError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000136 """OS system call failed."""
Guido van Rossume03c0501998-08-12 02:38:11 +0000137 pass
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000138
139class RuntimeError(StandardError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000140 """Unspecified run-time error."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000141 pass
142
Guido van Rossum7ea1d971998-12-22 13:50:33 +0000143class NotImplementedError(RuntimeError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000144 """Method or function hasn't been implemented yet."""
Guido van Rossum7ea1d971998-12-22 13:50:33 +0000145 pass
146
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000147class SystemError(StandardError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000148 """Internal error in the Python interpreter.
149
150 Please report this to the Python maintainer, along with the traceback,
151 the Python version, and the hardware/OS platform and version."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000152 pass
153
154class EOFError(StandardError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000155 """Read beyond end of file."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000156 pass
157
158class ImportError(StandardError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000159 """Import can't find module, or can't find name in module."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000160 pass
161
162class TypeError(StandardError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000163 """Inappropriate argument type."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000164 pass
165
166class ValueError(StandardError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000167 """Inappropriate argument value (of correct type)."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000168 pass
169
170class KeyboardInterrupt(StandardError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000171 """Program interrupted by user."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000172 pass
173
174class AssertionError(StandardError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000175 """Assertion failed."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000176 pass
177
178class ArithmeticError(StandardError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000179 """Base class for arithmetic errors."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000180 pass
181
182class OverflowError(ArithmeticError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000183 """Result too large to be represented."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000184 pass
185
186class FloatingPointError(ArithmeticError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000187 """Floating point operation failed."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000188 pass
189
190class ZeroDivisionError(ArithmeticError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000191 """Second argument to a division or modulo operation was zero."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000192 pass
193
194class LookupError(StandardError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000195 """Base class for lookup errors."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000196 pass
197
198class IndexError(LookupError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000199 """Sequence index out of range."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000200 pass
201
202class KeyError(LookupError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000203 """Mapping key not found."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000204 pass
205
206class AttributeError(StandardError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000207 """Attribute not found."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000208 pass
209
210class NameError(StandardError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000211 """Name not found locally or globally."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000212 pass
213
214class MemoryError(StandardError):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000215 """Out of memory."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000216 pass
217
218class SystemExit(Exception):
Guido van Rossum3e0d3191999-01-25 21:57:29 +0000219 """Request to exit from the interpreter."""
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000220 def __init__(self, *args):
Guido van Rossum548703a1998-03-26 22:14:20 +0000221 self.args = args
Guido van Rossuma11cccc1997-10-06 20:19:59 +0000222 if len(args) == 0:
223 self.code = None
224 elif len(args) == 1:
225 self.code = args[0]
226 else:
227 self.code = args