code.grnet.gr Git - snf-image-creator/blob - image_creator/output/cli.py

   1 # Copyright 2012 GRNET S.A. All rights reserved.
   2 #
   3 # Redistribution and use in source and binary forms, with or
   4 # without modification, are permitted provided that the following
   5 # conditions are met:
   6 #
   7 #   1. Redistributions of source code must retain the above
   8 #      copyright notice, this list of conditions and the following
   9 #      disclaimer.
  10 #
  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.
  15 #
  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.
  28 #
  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.
  33
  34 """Normal Command-line interface output"""
  35
  36 from image_creator.output import Output
  37
  38 import sys
  39 from colors import red, green, yellow
  40 from progress.bar import Bar
  41
  42
  43 def output(msg, new_line, decorate, stream):
  44     nl = "\n" if new_line else ' '
  45     stream.write(decorate(msg) + nl)
  46
  47
  48 def error(msg, new_line, colored, stream):
  49     color = red if colored else lambda x: x
  50     output("Error: %s" % msg, new_line, color, stream)
  51
  52
  53 def warn(msg, new_line, colored, stream):
  54     color = yellow if colored else lambda x: x
  55     output("Warning: %s" % msg, new_line, color, stream)
  56
  57
  58 def success(msg, new_line, colored, stream):
  59     color = green if colored else lambda x: x
  60     output(msg, new_line, color, stream)
  61
  62
  63 def clear(stream):
  64     #clear the page
  65     if stream.isatty():
  66         stream.write('\033[H\033[2J')
  67
  68
  69 class SilentOutput(Output):
  70     """Silent Output class. Only Errors are printed"""
  71     pass
  72
  73
  74 class SimpleOutput(Output):
  75     """Print messages but not progress bars. Progress bars are treated as
  76     output messages. The user gets informed when the action begins and when it
  77     ends, but no progress is shown in between."""
  78     def __init__(self, colored=True, stream=None):
  79         self.colored = colored
  80         self.stream = sys.stderr if stream is None else stream
  81
  82     def error(self, msg, new_line=True):
  83         """Print an error"""
  84         error(msg, new_line, self.colored, self.stream)
  85
  86     def warn(self, msg, new_line=True):
  87         """Print a warning"""
  88         warn(msg, new_line, self.colored, self.stream)
  89
  90     def success(self, msg, new_line=True):
  91         """Print msg after an action is completed"""
  92         success(msg, new_line, self.colored, self.stream)
  93
  94     def output(self, msg='', new_line=True):
  95         """Print msg as normal program output"""
  96         output(msg, new_line, lambda x: x, self.stream)
  97
  98     def clear(self):
  99         """Clear the screen"""
 100         clear(self.stream)
 101
 102
 103 class OutputWthProgress(SimpleOutput):
 104     """Output class with progress."""
 105     class _Progress(Bar):
 106         MESSAGE_LENGTH = 30
 107
 108         template = {
 109             'default': '%(index)d/%(max)d',
 110             'percent': '%(percent)d%%',
 111             'b': '%(index)d/%(max)d B',
 112             'kb': '%(index)d/%(max)d KB',
 113             'mb': '%(index)d/%(max)d MB'
 114         }
 115
 116         def __init__(self, size, title, bar_type='default'):
 117             """Create a Progress bar"""
 118             self.hide_cursor = False
 119             super(OutputWthProgress._Progress, self).__init__()
 120             self.title = title
 121             self.fill = '#'
 122             self.bar_prefix = ' ['
 123             self.bar_suffix = '] '
 124             self.message = ("%s:" % self.title).ljust(self.MESSAGE_LENGTH)
 125             self.suffix = self.template[bar_type]
 126             self.max = size
 127
 128             # print empty progress bar
 129             self.start()
 130
 131         def success(self, result):
 132             """Print result after progress has finished"""
 133             self.output.output("\r%s ...\033[K" % self.title, False)
 134             self.output.success(result)
 135
 136 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :