Completed
Pull Request — master (#1373)
by Abdeali
01:53
created

coalib.output.ConfWriter.__init__()   B

Complexity

Conditions 1

Size

Total Lines 26

Duplication

Lines 0
Ratio 0 %
Metric Value
cc 1
dl 0
loc 26
rs 8.8571
1
from itertools import chain
2
from pyprint.ClosableObject import ClosableObject
3
4
from coalib.settings.Section import Section
5
6
7
class ConfWriter(ClosableObject):
8
9
    def __init__(self,
10
                 file_name,
11
                 key_value_delimiters=('=',),
12
                 comment_seperators=('#',),
13
                 key_delimiters=(',', ' '),
14
                 section_name_surroundings=None,
15
                 section_override_delimiters=(".",),
16
                 unsavable_keys=("save",)):
17
        section_name_surroundings = section_name_surroundings or {"[": "]"}
18
        ClosableObject.__init__(self)
19
        self.__file_name = file_name
20
        self.__file = open(self.__file_name, "w")
21
        self.__key_value_delimiters = key_value_delimiters
22
        self.__comment_seperators = comment_seperators
23
        self.__key_delimiters = key_delimiters
24
        self.__section_name_surroundings = section_name_surroundings
25
        self.__section_override_delimiters = section_override_delimiters
26
        self.__unsavable_keys = unsavable_keys
27
        self.__wrote_newline = True
28
        self.__closed = False
29
30
        self.__key_delimiter = self.__key_delimiters[0]
31
        self.__key_value_delimiter = self.__key_value_delimiters[0]
32
        (self.__section_name_surrounding_beg,
33
         self.__section_name_surrounding_end) = (
34
            tuple(self.__section_name_surroundings.items())[0])
35
36
37
    def _close(self):
38
        self.__file.close()
39
40
    def write_sections(self, sections):
41
        assert not self.__closed
42
43
        self.__wrote_newline = True
44
        for section in sections:
45
            self.write_section(sections[section])
46
47
    def write_section(self, section):
48
        assert not self.__closed
49
50
        if not isinstance(section, Section):
51
            raise TypeError
52
53
        self.__write_section_name(section.name)
54
55
        keys = []
56
        val = None
57
        section_iter = section.__iter__(ignore_defaults=True)
58
        try:
59
            while True:
60
                setting = section[next(section_iter)]
61
                if (str(setting) == val and
62
                    not self.is_comment(setting.key) and
63
                    (
64
                        (setting.key not in self.__unsavable_keys) or
65
                        (not setting.from_cli))):
66
                    keys.append(setting.key)
67
                elif ((setting.key not in self.__unsavable_keys) or
68
                      (not setting.from_cli)):
69
                    self.__write_key_val(keys, val)
70
                    keys = [setting.key]
71
                    val = str(setting)
72
        except StopIteration:
73
            self.__write_key_val(keys, val)
74
75
    def __write_section_name(self, name):
76
        assert not self.__closed
77
78
        if not self.__wrote_newline:
79
            self.__file.write("\n")
80
81
        self.__file.write(self.__section_name_surrounding_beg + name +
82
                          self.__section_name_surrounding_end + '\n')
83
        self.__wrote_newline = False
84
85
    def __write_key_val(self, keys, val):
86
        assert not self.__closed
87
88
        if keys == []:
89
            return
90
91
        if all(self.is_comment(key) for key in keys):
92
            self.__file.write(val + "\n")
93
            self.__wrote_newline = val == ""
94
            return
95
96
        # Add escape characters as appropriate
97
        keys = [key.replace('\\', '\\\\') for key in keys]
98
        for delim in chain(self.__key_value_delimiters,
99
                           self.__comment_seperators,
100
                           self.__key_delimiters,
101
                           self.__section_override_delimiters):
102
            keys = [key.replace(delim, '\\' + delim) for key in keys]
103
104
        val = val.replace('\\', '\\\\')
105
        for delim in self.__comment_seperators:
106
            val = val.replace(delim, '\\' + delim)
107
108
        self.__file.write((self.__key_delimiter + " ").join(keys) + " " +
109
                          self.__key_value_delimiter + " " + val + "\n")
110
        self.__wrote_newline = False
111
112
    @staticmethod
113
    def is_comment(key):
114
        return key.lower().startswith("comment")
115