1 # Copyright 2011 GRNET S.A. All rights reserved.
3 # Redistribution and use in source and binary forms, with or
4 # without modification, are permitted provided that the following
7 # 1. Redistributions of source code must retain the above
8 # copyright notice, this list of conditions and the following
11 # 2. Redistributions in binary form must reproduce the above
12 # copyright notice, this list of conditions and the following
13 # disclaimer in the documentation and/or other materials
14 # provided with the distribution.
16 # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
17 # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
20 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 # POSSIBILITY OF SUCH DAMAGE.
29 # The views and conclusions contained in the software and
30 # documentation are those of the authors and should not be
31 # interpreted as representing official policies, either expressed
32 # or implied, of GRNET S.A.
34 from kamaki.logger import get_logger
36 log = get_logger('kamaki.cli')
39 class CLIError(Exception):
41 def __init__(self, message, details=[], importance=0):
43 @message is the main message of the Error
44 @detauls is a list of previous errors
45 @importance of the output for the user
46 Suggested values: 0, 1, 2, 3
48 message += '' if message and message[-1] == '\n' else '\n'
49 super(CLIError, self).__init__(message)
50 self.details = list(details) if isinstance(details, list)\
51 else [] if details is None else ['%s' % details]
53 self.importance = int(importance)
58 class CLISyntaxError(CLIError):
59 def __init__(self, message='Syntax Error', details=[], importance=1):
60 super(CLISyntaxError, self).__init__(message, details, importance)
63 class CLIUnknownCommand(CLIError):
64 def __init__(self, message='Unknown Command', details=[], importance=1):
65 super(CLIUnknownCommand, self).__init__(message, details, importance)
68 class CLICmdSpecError(CLIError):
70 self, message='Command Specification Error',
71 details=[], importance=0):
72 super(CLICmdSpecError, self).__init__(message, details, importance)
75 class CLICmdIncompleteError(CLICmdSpecError):
77 self, message='Incomplete Command Error',
78 details=[], importance=1):
79 super(CLICmdSpecError, self).__init__(message, details, importance)
82 def raiseCLIError(err, message='', importance=0, details=[]):
84 :param err: (Exception) the original error message, if None, a new
85 CLIError is born which is conceptually bind to raiser
87 :param message: (str) a custom error message that overrides err's
89 :param importance: (int) instruction to called application (e.g. for
90 coloring printed error messages)
92 :param details: (list) various information on the error
94 :raises CLIError: it is the purpose of this method
96 from traceback import format_stack
98 stack = ['%s' % type(err)] if err else ['<kamaki.cli.errors.CLIError>']
99 stack += format_stack()
101 stack = [e for e in stack if e != stack[1]]
103 log.debug('\n < '.join(stack))
105 details = ['%s' % details] if not isinstance(details, list)\
107 details += getattr(err, 'details', [])
111 origerr = origerr if origerr else '%s' % type(err)
115 message = '%s' % (message if message else origerr)
118 status = err.status or err.errno
119 except AttributeError:
122 if origerr not in details + [message]:
123 details.append(origerr)
125 message += '' if message and message[-1] == '\n' else '\n'
127 message = '(%s) %s' % (err.status, message)
129 status = int(err.status)
131 raise CLIError(message, details, importance)
132 importance = importance if importance else status // 100
133 importance = getattr(err, 'importance', importance)
134 raise CLIError(message, details, importance)