summaryrefslogtreecommitdiff
path: root/python/vyos/base.py
blob: c1acfd0602f33da76e4f0dabe6242e7e6fee8ddb (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
# Copyright 2018-2023 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library.  If not, see <http://www.gnu.org/licenses/>.

from textwrap import fill


class BaseWarning:
    def __init__(self, header, message, **kwargs):
        self.message = message
        self.kwargs = kwargs
        if 'width' not in kwargs:
            self.width = 72
        if 'initial_indent' in kwargs:
            del self.kwargs['initial_indent']
        if 'subsequent_indent' in kwargs:
            del self.kwargs['subsequent_indent']
        self.textinitindent = header
        self.standardindent = ''

    def print(self):
        messages = self.message.split('\n')
        isfirstmessage = True
        initial_indent = self.textinitindent
        print('')
        for mes in messages:
            mes = fill(mes, initial_indent=initial_indent,
                       subsequent_indent=self.standardindent, **self.kwargs)
            if isfirstmessage:
                isfirstmessage = False
                initial_indent = self.standardindent
            print(f'{mes}')


class Warning():
    def __init__(self, message, **kwargs):
        self.BaseWarn = BaseWarning('WARNING: ', message, **kwargs)
        self.BaseWarn.print()


class DeprecationWarning():
    def __init__(self, message, **kwargs):
        # Reformat the message and trim it to 72 characters in length
        self.BaseWarn = BaseWarning('DEPRECATION WARNING: ', message, **kwargs)
        self.BaseWarn.print()


class ConfigError(Exception):
    def __init__(self, message):
        # Reformat the message and trim it to 72 characters in length
        message = fill(message, width=72)
        # Call the base class constructor with the parameters it needs
        super().__init__(message)