Source code for lmi.scripts.common.errors

# Copyright (C) 2013-2014 Red Hat, Inc. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
#    this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# The views and conclusions contained in the software and documentation are
# those of the authors and should not be interpreted as representing official
# policies, either expressed or implied, of the FreeBSD Project.
#
# Authors: Michal Minar <miminar@redhat.com>
#
"""
Module with predefined exceptions for use in scripts.
"""

[docs]class LmiError(Exception): """ The base Lmi scripts error. All the other exceptions inherit from it. """ pass
[docs]class LmiFailed(LmiError): """ Raised, when operation on remote host failes. It's supposed to be used especially in command libraries. """ pass
[docs]class LmiUnexpectedResult(LmiError): """ Raised, when command's associated function returns something unexpected. """ def __init__(self, command_class, expected, result): LmiError.__init__(self, 'Got unexpected result from associated function of' ' "%s.%s", expected "%s", got: "%s".' % (command_class.__module__, command_class.__name__, expected, repr(result)))
[docs]class LmiInvalidOptions(LmiError): """ Raised in :py:meth:`~.command.endpoint.LmiEndPointCommand.verify_options` method if the options given are not valid. """ pass
[docs]class LmiCommandNotFound(LmiError): """ Raised, when user requests not registered command. """ def __init__(self, cmd_name): LmiError.__init__(self, 'No such command "%s".' % cmd_name)
[docs]class LmiNoConnections(LmiError): """ Raised, when no connection to remote hosts could be made. """ pass
[docs]class LmiCommandImportError(LmiError): """ Exception raised when command can not be imported. """ def __init__(self, cmd_name, cmd_path, reason): LmiError.__init__(self, 'Failed to import command "%s" (%s): %s' % ( cmd_name, cmd_path, reason))
[docs]class LmiCommandError(LmiError): """ Generic exception related to command declaration. """ def __init__(self, module_name, class_name, msg): LmiError.__init__(self, 'Wrong declaration of command "%s": %s' % ( ".".join([module_name, class_name]) if module_name else class_name , msg))
[docs]class LmiCommandInvalidName(LmiCommandError): """ Raised, when command gets invalid name. """ def __init__(self, module_name, class_name, cmd_name): LmiCommandError.__init__(self, module_name, class_name, 'Invalid command name "%s".' % cmd_name)
[docs]class LmiCommandMissingCallable(LmiCommandError): """ Raised, when command declaration is missing callable object. """ def __init__(self, module_name, class_name): LmiCommandError.__init__(self, module_name, class_name, 'Missing CALLABLE property.')
[docs]class LmiCommandInvalidProperty(LmiCommandError): """ Raised, when any command property contains unexpected value. """ pass
[docs]class LmiImportCallableFailed(LmiCommandInvalidProperty): """ Raised, when callable object of command could not be imported. """ def __init__(self, module_name, class_name, callable_prop): LmiCommandInvalidProperty.__init__(self, module_name, class_name, 'Failed to import callable "%s".' % callable_prop)
[docs]class LmiCommandInvalidCallable(LmiCommandInvalidProperty): """ Raised, when given callback is not callable. """ def __init__(self, module_name, class_name, msg): LmiCommandInvalidProperty.__init__(self, module_name, class_name, msg)
[docs]class LmiTerminate(Exception): """ Raised to cleanly terminate interavtive shell. """ def __init__(self, exit_code=0): Exception.__init__(self, exit_code)