Statistics
| Branch: | Tag: | Revision:

root / image_creator / output / __init__.py @ 12c97404

History | View | Annotate | Download (3.6 kB)

1
# -*- coding: utf-8 -*-
2
#
3
# Copyright 2012 GRNET S.A. All rights reserved.
4
#
5
# Redistribution and use in source and binary forms, with or
6
# without modification, are permitted provided that the following
7
# conditions are met:
8
#
9
#   1. Redistributions of source code must retain the above
10
#      copyright notice, this list of conditions and the following
11
#      disclaimer.
12
#
13
#   2. Redistributions in binary form must reproduce the above
14
#      copyright notice, this list of conditions and the following
15
#      disclaimer in the documentation and/or other materials
16
#      provided with the distribution.
17
#
18
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
19
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
22
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
25
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29
# POSSIBILITY OF SUCH DAMAGE.
30
#
31
# The views and conclusions contained in the software and
32
# documentation are those of the authors and should not be
33
# interpreted as representing official policies, either expressed
34
# or implied, of GRNET S.A.
35

    
36
"""This package is intended to provide output classes for printing messages and
37
progress bars. The user can change the output behaviour of the program by
38
subclassing the Output class and assigning the derived one as the output class
39
of the various parts of the image-creator package.
40
"""
41

    
42

    
43
class Output(object):
44
    """A class for printing program output"""
45
    def error(self, msg, new_line=True):
46
        """Print an error"""
47
        pass
48

    
49
    def warn(self, msg, new_line=True):
50
        """Print a warning"""
51
        pass
52

    
53
    def success(self, msg, new_line=True):
54
        """Print msg after an action is completed"""
55
        pass
56

    
57
    def output(self, msg='', new_line=True):
58
        """Print normal program output"""
59
        pass
60

    
61
    def cleanup(self):
62
        """Cleanup this output class"""
63
        pass
64

    
65
    def clear(self):
66
        """Clear the screen"""
67
        pass
68

    
69
    def _get_progress(self):
70
        """Returns a new Progress object"""
71
        progress = self._Progress
72
        progress.output = self
73
        return progress
74

    
75
    Progress = property(_get_progress)
76

    
77
    class _Progress(object):
78
        """Internal progress bar class"""
79
        def __init__(self, size, title, bar_type='default'):
80
            self.size = size
81
            self.bar_type = bar_type
82
            self.output.output("%s ..." % title, False)
83

    
84
        def goto(self, dest):
85
            """Move progress to a specific position"""
86
            pass
87

    
88
        def next(self):
89
            """Move progress a step forward"""
90
            pass
91

    
92
        def success(self, result):
93
            """Print a msg after an action is completed successfully"""
94
            self.output.success(result)
95

    
96
    def progress_generator(self, message):
97
        """A python generator for the progress bar class"""
98
        def generator(n):
99
            progressbar = self.Progress(n, message)
100

    
101
            for _ in range(n):
102
                yield
103
                progressbar.next()
104

    
105
            progressbar.success('done')
106
            yield
107
        return generator
108

    
109
# vim: set sta sts=4 shiftwidth=4 sw=4 et ai :