code.grnet.gr Git - snf-image-creator/blob - image_creator/output/__init__.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
  35 class Output(object):
  36     """A class for printing program output"""
  37     def error(self, msg, new_line=True):
  38         """Print an error"""
  39         pass
  40
  41     def warn(self, msg, new_line=True):
  42         """Print a warning"""
  43         pass
  44
  45     def success(self, msg, new_line=True):
  46         """Print msg after an action is completed"""
  47         pass
  48
  49     def output(self, msg='', new_line=True):
  50         """Print normal program output"""
  51         pass
  52
  53     def cleanup(self):
  54         """Cleanup this output class"""
  55         pass
  56
  57     def clear(self):
  58         """Clear the screen"""
  59         pass
  60
  61     def _get_progress(self):
  62         """Returns a new Progress object"""
  63         progress = self._Progress
  64         progress.output = self
  65         return progress
  66
  67     Progress = property(_get_progress)
  68
  69     class _Progress(object):
  70         """Internal progress bar class"""
  71         def __init__(self, size, title, bar_type='default'):
  72             self.size = size
  73             self.bar_type = bar_type
  74             self.output.output("%s ..." % title, False)
  75
  76         def goto(self, dest):
  77             """Move progress to a specific position"""
  78             pass
  79
  80         def next(self):
  81             """Move progress a step forward"""
  82             pass
  83
  84         def success(self, result):
  85             """Print a msg after an action is completed successfully"""
  86             self.output.success(result)
  87
  88     def progress_generator(self, message):
  89         """A python generator for the progress bar class"""
  90         def generator(n):
  91             progressbar = self.Progress(n, message)
  92
  93             for _ in range(n):
  94                 yield
  95                 progressbar.next()
  96
  97             progressbar.success('done')
  98             yield
  99         return generator
 100
 101 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :