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 from image_creator.output import Output
  35
  36 import sys
  37 from colors import red, green, yellow
  38 from progress.bar import Bar
  39
  40
  41 def output(msg, new_line, decorate, stream):
  42     nl = "\n" if new_line else ' '
  43     stream.write(decorate(msg) + nl)
  44
  45
  46 def error(msg, new_line, colored, stream):
  47     color = red if colored else lambda x: x
  48     output("Error: %s" % msg, new_line, color, stream)
  49
  50
  51 def warn(msg, new_line, colored, stream):
  52     color = yellow if colored else lambda x: x
  53     output("Warning: %s" % msg, new_line, color, stream)
  54
  55
  56 def success(msg, new_line, colored, stream):
  57     color = green if colored else lambda x: x
  58     output(msg, new_line, color, stream)
  59
  60
  61 def clear(stream):
  62     #clear the page
  63     if stream.isatty():
  64         stream.write('\033[H\033[2J')
  65
  66
  67 class SilentOutput(Output):
  68     pass
  69
  70
  71 class SimpleOutput(Output):
  72     def __init__(self, colored=True, stream=None):
  73         self.colored = colored
  74         self.stream = sys.stderr if stream is None else stream
  75
  76     def error(self, msg, new_line=True):
  77         error(msg, new_line, self.colored, self.stream)
  78
  79     def warn(self, msg, new_line=True):
  80         warn(msg, new_line, self.colored, self.stream)
  81
  82     def success(self, msg, new_line=True):
  83         success(msg, new_line, self.colored, self.stream)
  84
  85     def output(self, msg='', new_line=True):
  86         output(msg, new_line, lambda x: x, self.stream)
  87
  88     def clear(self):
  89         clear(self.stream)
  90
  91
  92 class OutputWthProgress(SimpleOutput):
  93     class _Progress(Bar):
  94         MESSAGE_LENGTH = 30
  95
  96         template = {
  97             'default': '%(index)d/%(max)d',
  98             'percent': '%(percent)d%%',
  99             'b': '%(index)d/%(max)d B',
 100             'kb': '%(index)d/%(max)d KB',
 101             'mb': '%(index)d/%(max)d MB'
 102         }
 103
 104         def __init__(self, size, title, bar_type='default'):
 105             super(OutputWthProgress._Progress, self).__init__()
 106             self.title = title
 107             self.fill = '#'
 108             self.bar_prefix = ' ['
 109             self.bar_suffix = '] '
 110             self.message = ("%s:" % self.title).ljust(self.MESSAGE_LENGTH)
 111             self.suffix = self.template[bar_type]
 112             self.max = size
 113
 114             # print empty progress bar workaround
 115             self.goto(1)
 116
 117         def success(self, result):
 118             self.output.output("\r%s...\033[K" % self.title, False)
 119             self.output.success(result)
 120
 121 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :