summaryrefslogtreecommitdiff
path: root/kvmd/yamlconf/dumper.py
blob: 263c5d39851b716a31bcb30306fa43bda88eaeaa (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
# ========================================================================== #
#                                                                            #
#    KVMD - The main PiKVM daemon.                                           #
#                                                                            #
#    Copyright (C) 2018-2024  Maxim Devaev <[email protected]>               #
#                                                                            #
#    This program is free software: you can redistribute it and/or modify    #
#    it under the terms of the GNU General Public License as published by    #
#    the Free Software Foundation, either version 3 of the License, or       #
#    (at your option) any later version.                                     #
#                                                                            #
#    This program 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 General Public License for more details.                            #
#                                                                            #
#    You should have received a copy of the GNU General Public License       #
#    along with this program.  If not, see <https://www.gnu.org/licenses/>.  #
#                                                                            #
# ========================================================================== #


import textwrap

from typing import Generator
from typing import Any

import yaml

from .. import tools

from . import Section


# =====
def make_config_dump(config: Section, indent: int=4) -> str:
    return "\n".join(_inner_make_dump(config, indent))


def _inner_make_dump(config: Section, indent: int, _level: int=0) -> Generator[str, None, None]:
    for (key, value) in tools.sorted_kvs(config):
        if isinstance(value, Section):
            prefix = " " * indent * _level
            yield f"{prefix}{key}:"
            yield from _inner_make_dump(value, indent, _level + 1)
            yield ""
        else:
            default = config._get_default(key)  # pylint: disable=protected-access
            comment = config._get_help(key)  # pylint: disable=protected-access
            if default == value:
                yield _make_yaml_kv(key, value, indent, _level, comment=comment)
            else:
                yield _make_yaml_kv(key, default, indent, _level, comment=comment, commented=True)
                yield _make_yaml_kv(key, value, indent, _level)


def _make_yaml_kv(key: str, value: Any, indent: int, level: int, comment: str="", commented: bool=False) -> str:
    text = yaml.dump(value, indent=indent, allow_unicode=True)
    text = text.replace("\n...\n", "").strip()
    if (
        isinstance(value, dict) and text[0] != "{"
        or isinstance(value, list) and text[0] != "["
    ):
        text = "\n" + textwrap.indent(text, prefix=" " * indent)
    else:
        text = " " + text

    prefix = " " * indent * level
    if commented:
        prefix = prefix + "# "
    text = textwrap.indent(f"{key}:{text}", prefix=prefix)

    if comment:
        lines = text.split("\n")
        lines[0] += "  # " + comment
        text = "\n".join(lines)
    return text