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):
  40     nl = "\n" if new_line else ''
  41     sys.stderr.write(red('Error: %s' % msg) + nl)
  42
  43
  44 def warn(msg, new_line=True):
  45     nl = "\n" if new_line else ''
  46     sys.stderr.write(yellow("Warning: %s" % msg) + nl)
  47
  48
  49 def success(msg, new_line=True):
  50     nl = "\n" if new_line else ''
  51     sys.stdout.write(green(msg) + nl)
  52     if not nl:
  53         sys.stdout.flush()
  54
  55
  56 def output(msg='', new_line=True):
  57     nl = "\n" if new_line else ''
  58     sys.stdout.write(msg + nl)
  59     if not nl:
  60         sys.stdout.flush()
  61
  62
  63 class Output(object):
  64     def error(self, msg, new_line=True):
  65         error(msg, new_line)
  66
  67     def warn(self, msg, new_line=True):
  68         warn(msg, new_line)
  69
  70     def success(self, msg, new_line=True):
  71         success(msg, new_line)
  72
  73     def output(self, msg='', new_line=True):
  74         output(msg, new_line)
  75
  76     class Progress(object):
  77         def __init__(self, title, bar_type='default'):
  78             output("%s..." % title, False)
  79
  80         def goto(self, dest):
  81             pass
  82
  83         def next(self):
  84             pass
  85
  86         def success(self, result):
  87             sucess(result)
  88
  89     def progress_gen(self, message):
  90
  91         progress = getattr(self, 'Progress')
  92
  93         def generator(n):
  94             progressbar = progress(message, 'default')
  95
  96             for _ in range(n):
  97                 yield
  98                 progressbar.next()
  99
 100             progressbar.success('done')
 101             yield
 102         return generator
 103
 104
 105 class Output_with_progress(Output):
 106     class Progress(Bar):
 107         MESSAGE_LENGTH = 30
 108
 109         template = {
 110             'default': '%(index)d/%(max)d',
 111             'percent': '%(percent)d%%',
 112             'b': '%(index)d/%(max)d B',
 113             'kb': '%(index)d/%(max)d KB',
 114             'mb': '%(index)d/%(max)d MB'
 115         }
 116
 117         def __init__(self, title, bar_type='default'):
 118             super(Output_with_progress.Progress, self).__init__()
 119             self.title = title
 120             self.fill = '#'
 121             self.bar_prefix = ' ['
 122             self.bar_suffix = '] '
 123             self.message = ("%s:" % self.title).ljust(self.MESSAGE_LENGTH)
 124             self.suffix = self.template[bar_type]
 125
 126         def success(self, result):
 127             output("\r%s... \033[K" % self.title, False)
 128             success(result)
 129
 130
 131 class Silent(Output):
 132     def warn(self, msg, new_line=True):
 133         pass
 134
 135     def success(self, msg, new_line=True):
 136         pass
 137
 138     def output(self, msg='', new_line=True):
 139         pass
 140
 141     class Progress(Output.Progress):
 142         def __init__(self, title, bar_type):
 143             pass
 144
 145         def success(self, result):
 146             pass
 147
 148 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :