Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Re-assign exception from within a python __exit__ block

From within an __exit__ block in a custom cursor class I want to catch an exception so I can in turn throw a more specific exception. What is the proper way to do this?

class Cursor:
    def __enter__(self):
        ...

    def __exit__(self, ex_type, ex_val, tb):
        if ex_type == VagueThirdPartyError:
            # get new more specific error based on error code in ex_val and
            # return that one in its place.
            return False # ?
        else:
            return False

Raising the specific exception within the __exit__ block seems like a hack, but maybe I'm over thinking it.

like image 281
jpredham Avatar asked Mar 11 '13 16:03

jpredham


People also ask

What does __ exit __ do in Python?

__exit__ in Python Context manager is used for managing resources used by the program. After completion of usage, we have to release memory and terminate connections between files.

What should __ exit __ return?

__exit__() documentation: If an exception is supplied, and the method wishes to suppress the exception (i.e., prevent it from being propagated), it should return a true value. Otherwise, the exception will be processed normally upon exit from this method.

What does __ enter __ do in Python?

__enter__ and [__exit__] both are methods that are invoked on entry to and exit from the body of "the with statement" (PEP 343) and implementation of both is called context manager. the with statement is intend to hiding flow control of try finally clause and make the code inscrutable.


1 Answers

The proper procedure is to raise the new exception inside of the __exit__ handler.

You should not raise the exception that was passed in though; to allow for context manager chaining, in that case you should just return a falsey value from the handler. Raising your own exceptions is however perfectly fine.

Note that it is better to use the identity test is to verify the type of the passed-in exception:

def __exit__(self, ex_type, ex_val, tb):
    if ex_type is VagueThirdPartyError:
        if ex_val.args[0] == 'foobar':
            raise SpecificException('Foobarred!')

        # Not raising a new exception, but surpressing the current one:
        if ex_val.args[0] == 'eggs-and-ham':
            # ignore this exception
            return True

        if ex_val.args[0] == 'baz':
            # re-raise this exception
            return False

    # No else required, the function exits and `None` is  returned

You could also use issubclass(ex_type, VagueThirdPartyError) to allow for subclasses of the specific exception.

like image 157
Martijn Pieters Avatar answered Sep 17 '22 15:09

Martijn Pieters