Source code for simulations.utils.optionparser

""" An extension of optparse.OptionParser that has custom error and exit handling

Classes:

    :py:class:`OptionParser`
      the extension class of :py:class:`optparse.OptionParser`

"""

import optparse


[docs]class OptionParser(optparse.OptionParser):
    """ Overrides the error() and exit() methods to allow prevention of
        auto-exit

    New Methods:

        :py:meth:`~OptionParser.set_error_handler`
          sets an error handler instead of the default

        :py:meth:`~OptionParser.set_exit_handler`
          sets an exit handler instead of the default

    """

    def __init__(self, *args, **kwdargs):
        """ Delegates to optparse.OptionParser

        """
        optparse.OptionParser.__init__(self, *args, **kwdargs)

        self._errorhandler = None
        self._exithandler = None

[docs]    def set_error_handler(self, handler):
        """ Sets an error handling function

        Parameters:

            handler
              A function that takes an error message and does something with
              it.

        """

        self._errorhandler = handler

[docs]    def set_exit_handler(self, handler):
        """ Sets an exit handling function

        Parameters:

            handler
              A function that takes an exit code and error message and does
              something with it.

        """

        self._exithandler = handler

[docs]    def error(self, msg):
        """ Declares a user-defined error has occurred.

        Parameters:

            msg
              The error message string

        """

        if self._errorhandler is not None:
            return self._errorhandler(msg)
        else:
            return optparse.OptionParser.error(self, msg)

[docs]    def exit(self, code=0, msg=None):
        """ Exits the parser/program (the default calls sys.exit). Often called
            by OptionParser.error().

        Parameters:

            code
              The exit code

            msg
              The error message

        """

        if self._exithandler is not None:
            return self._exithandler(code, msg)
        else:
            return optparse.OptionParser.exit(self, code, msg)