code.grnet.gr Git - snf-image-creator/blob - image_creator/output/composite.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
  37 class CompositeOutput(Output):
  38     """This class can be used to composite different outputs into a single one
  39
  40     You may create an instance of this class and then add other output
  41     instances to it. Executing a method on this instance will cause the
  42     execution of the same method in each output instance that has been added to
  43     this one.
  44     """
  45
  46     def __init__(self, outputs=[]):
  47         """Add initial output instances"""
  48         self._outputs = outputs
  49
  50     def add(self, output):
  51         """Add another output instance"""
  52         self._outputs.append(output)
  53
  54     def remove(self, output):
  55         """Remove an output instance"""
  56         self._outputs.remove(output)
  57
  58     def error(self, msg, new_line=True):
  59         """Call the error method of each of the output instances"""
  60         for out in self._outputs:
  61             out.error(msg, new_line)
  62
  63     def warn(self, msg, new_line=True):
  64         """Call the warn method of each of the output instances"""
  65         for out in self._outputs:
  66             out.warn(msg, new_line)
  67
  68     def success(self, msg, new_line=True):
  69         """Call the success method of each of the output instances"""
  70         for out in self._outputs:
  71             out.success(msg, new_line)
  72
  73     def output(self, msg='', new_line=True):
  74         """Call the output method of each of the output instances"""
  75         for out in self._outputs:
  76             out.output(msg, new_line)
  77
  78     def cleanup(self):
  79         """Call the cleanup method of each of the output instances"""
  80         for out in self._outputs:
  81             out.cleanup()
  82
  83     def clear(self):
  84         """Call the clear method of each of the output instances"""
  85         for out in self._outputs:
  86             out.clear()
  87
  88     class _Progress(object):
  89         """Class used to composite different Progress objects"""
  90
  91         def __init__(self, size, title, bar_type='default'):
  92             """Create a progress on each of the added output instances"""
  93             self._progresses = []
  94             for out in self.output._outputs:
  95                 self._progresses.append(out.Progress(size, title, bar_type))
  96
  97         def goto(self, dest):
  98             """Call the goto method of each of the progress instances"""
  99             for progress in self._progresses:
 100                 progress.goto(dest)
 101
 102         def next(self):
 103             """Call the next method of each of the progress instances"""
 104             for progress in self._progresses:
 105                 progress.next()
 106
 107         def success(self, result):
 108             """Call the success method of each of the progress instances"""
 109             for progress in self._progresses:
 110                 progress.success(result)
 111
 112 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :