errors.rst 14.7 KB
Newer Older
1
.. _tut-errors:
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

*********************
Errors and Exceptions
*********************

Until now error messages haven't been more than mentioned, but if you have tried
out the examples you have probably seen some.  There are (at least) two
distinguishable kinds of errors: *syntax errors* and *exceptions*.


.. _tut-syntaxerrors:

Syntax Errors
=============

Syntax errors, also known as parsing errors, are perhaps the most common kind of
complaint you get while you are still learning Python::

20
   >>> while True print('Hello world')
21
     File "<stdin>", line 1
22
       while True print('Hello world')
23 24 25 26 27 28
                      ^
   SyntaxError: invalid syntax

The parser repeats the offending line and displays a little 'arrow' pointing at
the earliest point in the line where the error was detected.  The error is
caused by (or at least detected at) the token *preceding* the arrow: in the
29
example, the error is detected at the function :func:`print`, since a colon
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
(``':'``) is missing before it.  File name and line number are printed so you
know where to look in case the input came from a script.


.. _tut-exceptions:

Exceptions
==========

Even if a statement or expression is syntactically correct, it may cause an
error when an attempt is made to execute it. Errors detected during execution
are called *exceptions* and are not unconditionally fatal: you will soon learn
how to handle them in Python programs.  Most exceptions are not handled by
programs, however, and result in error messages as shown here::

   >>> 10 * (1/0)
   Traceback (most recent call last):
47
     File "<stdin>", line 1, in <module>
48
   ZeroDivisionError: division by zero
49 50
   >>> 4 + spam*3
   Traceback (most recent call last):
51
     File "<stdin>", line 1, in <module>
52 53 54
   NameError: name 'spam' is not defined
   >>> '2' + 2
   Traceback (most recent call last):
55
     File "<stdin>", line 1, in <module>
56
   TypeError: Can't convert 'int' object to str implicitly
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

The last line of the error message indicates what happened. Exceptions come in
different types, and the type is printed as part of the message: the types in
the example are :exc:`ZeroDivisionError`, :exc:`NameError` and :exc:`TypeError`.
The string printed as the exception type is the name of the built-in exception
that occurred.  This is true for all built-in exceptions, but need not be true
for user-defined exceptions (although it is a useful convention). Standard
exception names are built-in identifiers (not reserved keywords).

The rest of the line provides detail based on the type of exception and what
caused it.

The preceding part of the error message shows the context where the exception
happened, in the form of a stack traceback. In general it contains a stack
traceback listing source lines; however, it will not display lines read from
standard input.

:ref:`bltin-exceptions` lists the built-in exceptions and their meanings.


.. _tut-handling:

Handling Exceptions
===================

It is possible to write programs that handle selected exceptions. Look at the
following example, which asks the user for input until a valid integer has been
entered, but allows the user to interrupt the program (using :kbd:`Control-C` or
whatever the operating system supports); note that a user-generated interruption
is signalled by raising the :exc:`KeyboardInterrupt` exception. ::

   >>> while True:
   ...     try:
90
   ...         x = int(input("Please enter a number: "))
91 92
   ...         break
   ...     except ValueError:
93
   ...         print("Oops!  That was no valid number.  Try again...")
94
   ...
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116

The :keyword:`try` statement works as follows.

* First, the *try clause* (the statement(s) between the :keyword:`try` and
  :keyword:`except` keywords) is executed.

* If no exception occurs, the *except clause* is skipped and execution of the
  :keyword:`try` statement is finished.

* If an exception occurs during execution of the try clause, the rest of the
  clause is skipped.  Then if its type matches the exception named after the
  :keyword:`except` keyword, the except clause is executed, and then execution
  continues after the :keyword:`try` statement.

* If an exception occurs which does not match the exception named in the except
  clause, it is passed on to outer :keyword:`try` statements; if no handler is
  found, it is an *unhandled exception* and execution stops with a message as
  shown above.

A :keyword:`try` statement may have more than one except clause, to specify
handlers for different exceptions.  At most one handler will be executed.
Handlers only handle exceptions that occur in the corresponding try clause, not
117
in other handlers of the same :keyword:`!try` statement.  An except clause may
118
name multiple exceptions as a parenthesized tuple, for example::
119

120
   ... except (RuntimeError, TypeError, NameError):
121 122
   ...     pass

123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
A class in an :keyword:`except` clause is compatible with an exception if it is
the same class or a base class thereof (but not the other way around --- an
except clause listing a derived class is not compatible with a base class).  For
example, the following code will print B, C, D in that order::

   class B(Exception):
       pass

   class C(B):
       pass

   class D(C):
       pass

   for cls in [B, C, D]:
       try:
           raise cls()
       except D:
           print("D")
       except C:
           print("C")
       except B:
           print("B")

Note that if the except clauses were reversed (with ``except B`` first), it
would have printed B, B, B --- the first matching except clause is triggered.

150 151 152 153 154 155 156 157 158 159 160
The last except clause may omit the exception name(s), to serve as a wildcard.
Use this with extreme caution, since it is easy to mask a real programming error
in this way!  It can also be used to print an error message and then re-raise
the exception (allowing a caller to handle the exception as well)::

   import sys

   try:
       f = open('myfile.txt')
       s = f.readline()
       i = int(s.strip())
161 162
   except OSError as err:
       print("OS error: {0}".format(err))
163
   except ValueError:
164
       print("Could not convert data to an integer.")
165
   except:
166
       print("Unexpected error:", sys.exc_info()[0])
167 168 169 170 171 172 173 174 175 176
       raise

The :keyword:`try` ... :keyword:`except` statement has an optional *else
clause*, which, when present, must follow all except clauses.  It is useful for
code that must be executed if the try clause does not raise an exception.  For
example::

   for arg in sys.argv[1:]:
       try:
           f = open(arg, 'r')
177
       except OSError:
178
           print('cannot open', arg)
179
       else:
180
           print(arg, 'has', len(f.readlines()), 'lines')
181 182
           f.close()

183
The use of the :keyword:`!else` clause is better than adding additional code to
184
the :keyword:`try` clause because it avoids accidentally catching an exception
185 186
that wasn't raised by the code being protected by the :keyword:`!try` ...
:keyword:`!except` statement.
187 188 189 190 191

When an exception occurs, it may have an associated value, also known as the
exception's *argument*. The presence and type of the argument depend on the
exception type.

192 193
The except clause may specify a variable after the exception name.  The
variable is bound to an exception instance with the arguments stored in
194
``instance.args``.  For convenience, the exception instance defines
195 196 197
:meth:`__str__` so the arguments can be printed directly without having to
reference ``.args``.  One may also instantiate an exception first before
raising it and add any attributes to it as desired. ::
198 199

   >>> try:
200
   ...     raise Exception('spam', 'eggs')
201
   ... except Exception as inst:
202 203 204 205 206 207 208
   ...     print(type(inst))    # the exception instance
   ...     print(inst.args)     # arguments stored in .args
   ...     print(inst)          # __str__ allows args to be printed directly,
   ...                          # but may be overridden in exception subclasses
   ...     x, y = inst.args     # unpack args
   ...     print('x =', x)
   ...     print('y =', y)
209
   ...
210
   <class 'Exception'>
211 212 213 214 215
   ('spam', 'eggs')
   ('spam', 'eggs')
   x = spam
   y = eggs

216
If an exception has arguments, they are printed as the last part ('detail') of
217 218 219 220 221 222 223 224
the message for unhandled exceptions.

Exception handlers don't just handle exceptions if they occur immediately in the
try clause, but also if they occur inside functions that are called (even
indirectly) in the try clause. For example::

   >>> def this_fails():
   ...     x = 1/0
225
   ...
226 227
   >>> try:
   ...     this_fails()
228 229
   ... except ZeroDivisionError as err:
   ...     print('Handling run-time error:', err)
230
   ...
231
   Handling run-time error: division by zero
232 233 234 235 236 237 238 239 240 241


.. _tut-raising:

Raising Exceptions
==================

The :keyword:`raise` statement allows the programmer to force a specified
exception to occur. For example::

242
   >>> raise NameError('HiThere')
243
   Traceback (most recent call last):
244
     File "<stdin>", line 1, in <module>
245 246
   NameError: HiThere

247 248
The sole argument to :keyword:`raise` indicates the exception to be raised.
This must be either an exception instance or an exception class (a class that
249 250 251 252
derives from :class:`Exception`).  If an exception class is passed, it will
be implicitly instantiated by calling its constructor with no arguments::

   raise ValueError  # shorthand for 'raise ValueError()'
253 254 255 256 257 258

If you need to determine whether an exception was raised but don't intend to
handle it, a simpler form of the :keyword:`raise` statement allows you to
re-raise the exception::

   >>> try:
259
   ...     raise NameError('HiThere')
260
   ... except NameError:
261
   ...     print('An exception flew by!')
262 263 264 265
   ...     raise
   ...
   An exception flew by!
   Traceback (most recent call last):
266
     File "<stdin>", line 2, in <module>
267 268 269 270 271 272 273 274
   NameError: HiThere


.. _tut-userexceptions:

User-defined Exceptions
=======================

275 276
Programs may name their own exceptions by creating a new exception class (see
:ref:`tut-classes` for more about Python classes).  Exceptions should typically
277
be derived from the :exc:`Exception` class, either directly or indirectly.
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316

Exception classes can be defined which do anything any other class can do, but
are usually kept simple, often only offering a number of attributes that allow
information about the error to be extracted by handlers for the exception.  When
creating a module that can raise several distinct errors, a common practice is
to create a base class for exceptions defined by that module, and subclass that
to create specific exception classes for different error conditions::

   class Error(Exception):
       """Base class for exceptions in this module."""
       pass

   class InputError(Error):
       """Exception raised for errors in the input.

       Attributes:
           expression -- input expression in which the error occurred
           message -- explanation of the error
       """

       def __init__(self, expression, message):
           self.expression = expression
           self.message = message

   class TransitionError(Error):
       """Raised when an operation attempts a state transition that's not
       allowed.

       Attributes:
           previous -- state at beginning of transition
           next -- attempted new state
           message -- explanation of why the specific transition is not allowed
       """

       def __init__(self, previous, next, message):
           self.previous = previous
           self.next = next
           self.message = message

317
Most exceptions are defined with names that end in "Error", similar to the
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
naming of the standard exceptions.

Many standard modules define their own exceptions to report errors that may
occur in functions they define.  More information on classes is presented in
chapter :ref:`tut-classes`.


.. _tut-cleanup:

Defining Clean-up Actions
=========================

The :keyword:`try` statement has another optional clause which is intended to
define clean-up actions that must be executed under all circumstances.  For
example::

   >>> try:
   ...     raise KeyboardInterrupt
   ... finally:
337
   ...     print('Goodbye, world!')
338
   ...
339 340
   Goodbye, world!
   Traceback (most recent call last):
341
     File "<stdin>", line 2, in <module>
342 343 344 345
   KeyboardInterrupt

A *finally clause* is always executed before leaving the :keyword:`try`
statement, whether an exception has occurred or not. When an exception has
346 347 348 349 350
occurred in the :keyword:`!try` clause and has not been handled by an
:keyword:`except` clause (or it has occurred in an :keyword:`!except` or
:keyword:`!else` clause), it is re-raised after the :keyword:`finally` clause has
been executed.  The :keyword:`!finally` clause is also executed "on the way out"
when any other clause of the :keyword:`!try` statement is left via a
351
:keyword:`break`, :keyword:`continue` or :keyword:`return` statement.  A more
352
complicated example::
353 354 355 356 357

   >>> def divide(x, y):
   ...     try:
   ...         result = x / y
   ...     except ZeroDivisionError:
358
   ...         print("division by zero!")
359
   ...     else:
360
   ...         print("result is", result)
361
   ...     finally:
362
   ...         print("executing finally clause")
363 364
   ...
   >>> divide(2, 1)
365
   result is 2.0
366 367 368 369 370 371 372
   executing finally clause
   >>> divide(2, 0)
   division by zero!
   executing finally clause
   >>> divide("2", "1")
   executing finally clause
   Traceback (most recent call last):
373
     File "<stdin>", line 1, in <module>
374 375 376 377 378
     File "<stdin>", line 3, in divide
   TypeError: unsupported operand type(s) for /: 'str' and 'str'

As you can see, the :keyword:`finally` clause is executed in any event.  The
:exc:`TypeError` raised by dividing two strings is not handled by the
379
:keyword:`except` clause and therefore re-raised after the :keyword:`!finally`
380
clause has been executed.
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397

In real world applications, the :keyword:`finally` clause is useful for
releasing external resources (such as files or network connections), regardless
of whether the use of the resource was successful.


.. _tut-cleanup-with:

Predefined Clean-up Actions
===========================

Some objects define standard clean-up actions to be undertaken when the object
is no longer needed, regardless of whether or not the operation using the object
succeeded or failed. Look at the following example, which tries to open a file
and print its contents to the screen. ::

   for line in open("myfile.txt"):
398
       print(line, end="")
399 400

The problem with this code is that it leaves the file open for an indeterminate
401 402 403
amount of time after this part of the code has finished executing.
This is not an issue in simple scripts, but can be a problem for larger
applications. The :keyword:`with` statement allows objects like files to be
404
used in a way that ensures they are always cleaned up promptly and correctly. ::
405 406 407

   with open("myfile.txt") as f:
       for line in f:
408
           print(line, end="")
409 410

After the statement is executed, the file *f* is always closed, even if a
411 412
problem was encountered while processing the lines. Objects which, like files,
provide predefined clean-up actions will indicate this in their documentation.
413 414