code.grnet.gr Git - snf-image-creator/blob - image_creator/output.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 import sys
  35 from progress.bar import Bar
  36 from colors import red, green, yellow
  37
  38
  39 def error(msg, new_line=True, color=True):
  40     nl = "\n" if new_line else ''
  41     if color:
  42         sys.stderr.write(red('Error: %s' % msg) + nl)
  43     else:
  44         sys.stderr.write('Error: %s' % msg + nl)
  45
  46
  47 def warn(msg, new_line=True, color=True):
  48     nl = "\n" if new_line else ''
  49     if color:
  50         sys.stderr.write(yellow("Warning: %s" % msg) + nl)
  51     else:
  52         sys.stderr.write("Warning: %s" % msg + nl)
  53
  54
  55 def success(msg, new_line=True, color=True):
  56     nl = "\n" if new_line else ''
  57     if color:
  58         sys.stdout.write(green(msg) + nl)
  59     else:
  60         sys.stdout.write(msg + nl)
  61     if not nl:
  62         sys.stdout.flush()
  63
  64
  65 def output(msg='', new_line=True):
  66     nl = "\n" if new_line else ''
  67     sys.stdout.write(msg + nl)
  68     if not nl:
  69         sys.stdout.flush()
  70
  71
  72 class Output(object):
  73
  74     def error(self, msg, new_line=True):
  75         error(msg, new_line, False)
  76
  77     def warn(self, msg, new_line=True):
  78         warn(msg, new_line, False)
  79
  80     def success(self, msg, new_line=True):
  81         success(msg, new_line, False)
  82
  83     def output(self, msg='', new_line=True):
  84         output(msg, new_line)
  85
  86     def _get_progress(self):
  87         progress = self._Progress
  88         progress.output = self
  89         return progress
  90
  91     Progress = property(_get_progress)
  92
  93     class _Progress(object):
  94         def __init__(self, size, title, bar_type='default'):
  95             self.output.output("%s..." % title, False)
  96             self.size = size
  97
  98         def goto(self, dest):
  99             pass
 100
 101         def next(self):
 102             pass
 103
 104         def success(self, result):
 105             self.output.success(result)
 106
 107     def progress_generator(self, message):
 108         def generator(n):
 109             progressbar = self.Progress(message, 'default')
 110             progressbar.max = n
 111
 112             for _ in range(n):
 113                 yield
 114                 progressbar.next()
 115
 116             progressbar.success('done')
 117             yield
 118         return generator
 119
 120
 121 class Output_wth_colors(Output):
 122     def error(self, msg, new_line=True):
 123         error(msg, new_line)
 124
 125     def warn(self, msg, new_line=True):
 126         warn(msg, new_line)
 127
 128     def success(self, msg, new_line=True):
 129         success(msg, new_line)
 130
 131
 132 class Output_wth_progress(Output_wth_colors):
 133     class _Progress(Bar):
 134         MESSAGE_LENGTH = 30
 135
 136         template = {
 137             'default': '%(index)d/%(max)d',
 138             'percent': '%(percent)d%%',
 139             'b': '%(index)d/%(max)d B',
 140             'kb': '%(index)d/%(max)d KB',
 141             'mb': '%(index)d/%(max)d MB'
 142         }
 143
 144         def __init__(self, size, title, bar_type='default'):
 145             super(Output_wth_progress._Progress, self).__init__()
 146             self.title = title
 147             self.fill = '#'
 148             self.bar_prefix = ' ['
 149             self.bar_suffix = '] '
 150             self.message = ("%s:" % self.title).ljust(self.MESSAGE_LENGTH)
 151             self.suffix = self.template[bar_type]
 152             self.max = size
 153
 154             # print empty progress bar workaround
 155             self.goto(1)
 156
 157         def success(self, result):
 158             self.output.output("\r%s... \033[K" % self.title, False)
 159             self.output.success(result)
 160
 161
 162 class Silent(Output):
 163     def warn(self, msg, new_line=True):
 164         pass
 165
 166     def success(self, msg, new_line=True):
 167         pass
 168
 169     def output(self, msg='', new_line=True):
 170         pass
 171
 172
 173 class Silent_wth_colors(Silent):
 174     def error(self, msg, new_line=True):
 175         error(msg, new_line)
 176
 177 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :