summaryrefslogtreecommitdiffstats
path: root/opensteak/tools/opensteak/printer.py
blob: 98c5af54ebec7f4856d11713b9421d5bc29549e6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
#!/usr/bin/python3
# -*- coding: utf-8 -*-
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
# Authors:
# @author: David Blaisonneau <david.blaisonneau@orange.com>
# @author: Arnaud Morin <arnaud1.morin@orange.com>

import sys


class OpenSteakPrinter:
    """ Just a nice message printer """
    HEADER = '\033[95m'
    OKBLUE = '\033[94m'
    OKGREEN = '\033[92m'
    WARNING = '\033[93m'
    FAIL = '\033[91m'
    ENDC = '\033[0m'
    BOLD = '\033[1m'
    UNDERLINE = '\033[4m'

    TABSIZE = 4

    def header(self, msg):
        """ Function header
        Print a header for a block

        @param msg: The message to print in the header (limited to 78 chars)
        @return RETURN: None
        """
        print("""
#
# {}
#
""".format(msg[0:78]))

    def config(self, msg, name, value=None, indent=0):
        """ Function config
        Print a line with the value of a parameter

        @param msg: The message to print in the header (limited to 78 chars)
        @param name: The name of the prameter
        @param value: The value of the parameter
        @param indent: Tab size at the beginning of the line
        @return RETURN: None
        """
        ind = ' ' * indent * self.TABSIZE
        if value is None:
            print('{} - {} = {}'.format(ind, msg, name))
        elif value is False:
            print('{} [{}KO{}] {} > {} (NOT found)'.
                  format(ind, self.FAIL, self.ENDC, msg, name))
        else:
            print('{} [{}OK{}] {} > {} = {}'.
                  format(ind, self.OKGREEN, self.ENDC, msg, name, str(value)))

    def list(self, msg, indent=0):
        """ Function list
        Print a list item

        @param msg: The message to print in the header (limited to 78 chars)
        @param indent: Tab size at the beginning of the line
        @return RETURN: None
        """
        print(' ' * indent * self.TABSIZE, '-', msg)

    def list_id(self, dic, indent=0):
        """ Function list_id
        Print a list of dict items

        @param dic: The dict to print
        @param indent: Tab size at the beginning of the line
        @return RETURN: None
        """
        for (k, v) in dic.items():
            self.list("{}: {}".format(k, v), indent=indent)

    def status(self, res, msg, failed="", eol="\n", quit=True, indent=0):
        """ Function status
        Print status message
        - OK/KO if the result is a boolean
        - Else the result text

        @param res: The status to show
        @param msg: The message to show
        @param eol: End of line
        @param quit: Exit the system in case of failure
        @param indent: Tab size at the beginning of the line
        @return RETURN: None
        """
        ind = ' ' * indent * self.TABSIZE
        if res is True:
            msg = '{} [{}OK{}] {}'.format(ind, self.OKGREEN, self.ENDC, msg)
        elif res:
            msg = '{} [{}{}{}] {}'.format(ind, self.OKBLUE, res,
                                          self.ENDC, msg)
        else:
            msg = '{} [{}KO{}] {}'.format(ind, self.FAIL, self.ENDC, msg)
            if failed:
                msg += '\n > {}'.format(failed)
        msg = msg.ljust(140) + eol
        sys.stdout.write(msg)
        if res is False and quit is True:
            sys.exit(0)

    def ask_validation(self, prompt=None, resp=False):
        """ Function ask_validation
        Ask a validation message

        @param prompt: The question to ask ('Continue ?') if None
        @param resp: The default value (Default is False)
        @return RETURN: Trie or False
        """
        if prompt is None:
            prompt = 'Continue ?'
        if resp:
            prompt += ' [{}Y{}/n]: '.format(self.BOLD, self.ENDC)
        else:
            prompt += ' [y/{}N{}]: '.format(self.BOLD, self.ENDC)
        while True:
            ans = input(prompt)
            if not ans:
                ans = 'y' if resp else 'n'
            if ans not in ['y', 'Y', 'n', 'N']:
                print('please enter y or n.')
                continue
            if ans == 'y' or ans == 'Y':
                return True
            if ans == 'n' or ans == 'N':
                sys.exit(0)