Make progress class contain and Ouput instance
[snf-image-creator] / 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, title, bar_type='default'):
95             self.output.output("%s..." % title, False)
96
97         def goto(self, dest):
98             pass
99
100         def next(self):
101             pass
102
103         def success(self, result):
104             self.output.success(result)
105
106     def progress_generator(self, message):
107         def generator(n):
108             progressbar = self.Progress(message, 'default')
109             progressbar.max = n
110
111             for _ in range(n):
112                 yield
113                 progressbar.next()
114
115             progressbar.success('done')
116             yield
117         return generator
118
119
120 class Output_wth_colors(Output):
121     def error(self, msg, new_line=True):
122         error(msg, new_line)
123
124     def warn(self, msg, new_line=True):
125         warn(msg, new_line)
126
127     def success(self, msg, new_line=True):
128         success(msg, new_line)
129
130
131 class Output_wth_progress(Output_wth_colors):
132     class _Progress(Bar):
133         MESSAGE_LENGTH = 30
134
135         template = {
136             'default': '%(index)d/%(max)d',
137             'percent': '%(percent)d%%',
138             'b': '%(index)d/%(max)d B',
139             'kb': '%(index)d/%(max)d KB',
140             'mb': '%(index)d/%(max)d MB'
141         }
142
143         def __init__(self, title, bar_type='default'):
144             super(Output_wth_progress._Progress, self).__init__()
145             self.title = title
146             self.fill = '#'
147             self.bar_prefix = ' ['
148             self.bar_suffix = '] '
149             self.message = ("%s:" % self.title).ljust(self.MESSAGE_LENGTH)
150             self.suffix = self.template[bar_type]
151
152         def success(self, result):
153             self.output.output("\r%s... \033[K" % self.title, False)
154             self.output.success(result)
155
156
157 class Silent(Output):
158     def warn(self, msg, new_line=True):
159         pass
160
161     def success(self, msg, new_line=True):
162         pass
163
164     def output(self, msg='', new_line=True):
165         pass
166
167
168 class Silent_wth_colors(Silent):
169     def error(self, msg, new_line=True):
170         error(msg, new_line)
171
172 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :