Start on new settings classes generator based on Jinja2

Old one was very hard to understand.

New one works with `tools/generate-docs-nm-settings-docs-gir.py` from
NetworkManager source code.

However, there are several problems with that script that
need upstream to fix it.

Author: igo95862

tools/generate-settings-dataclasses-jinja.py

@@ -0,0 +1,190 @@
+#!/usr/bin/env python
+# SPDX-License-Identifier: LGPL-2.1-or-later
+from __future__ import annotations
+from argparse import ArgumentParser
+from pathlib import Path
+from xml.etree.ElementTree import parse, Element
+
+from typing import List, Optional
+from jinja2 import Environment
+import builtins
+import keyword
+
+dbus_to_python_extra_typing_imports = {
+    "as": ("List", ),
+    "au": ("List", ),
+    "a{ss}": ("Dict", ),
+    "aa{sv}": ("List", "Tuple", "Any"),
+    "aau": ("List", ),
+    "aay": ("List", )
+}
+
+dbus_to_python_type_map = {
+    "b": "bool",
+    "s": "str",
+    "i": "int",
+    "u": "int",
+    "t": "int",
+    "x": "int",
+    "y": "int",
+    "as": "List[str]",
+    "au": "List[int]",
+    "ay": "bytes",
+    "a{ss}": "Dict[str, str]",
+    "aa{sv}": "List[Tuple[str, Any]]",
+    "aau": "List[List[int]]",
+    "aay": "List[bytes]",
+    # Legacy types:
+    "a(ayuay)": "array of legacy IPv6 address struct",
+    "a(ayuayu)": "array of legacy IPv6 route struct",
+}
+
+dbus_name_type_map = {
+    'array of array of uint32': 'aau',
+    'array of byte array': 'aay',
+    'array of legacy IPv6 address struct': 'a(ayuay)',
+    'array of legacy IPv6 route struct': 'a(ayuayu)',
+    'array of string': 'as',
+    'array of uint32': 'au',
+    'array of vardict': 'aa{sv}',
+    "array of 'a{sv}'": 'aa{sv}',  # wireguard.peers uses this, fix NM upstream
+    'boolean': 'b',
+    'byte': 'y',
+    'byte array': 'ay',
+    'dict of string to string': 'a{ss}',
+    'int32': 'i',
+    'int64': 'x',
+    'string': 's',
+    'uint32': 'u',
+    'uint64': 't',
+}
+
+python_name_replacements = {
+    'type': 'connection_type',
+    'id': 'pretty_id',
+}
+
+
+def must_replace_name(name: str) -> bool:
+    return (keyword.iskeyword(name)
+            or keyword.issoftkeyword(name)
+            or hasattr(builtins, name))
+
+
+class NmSettingPropertyIntrospection:
+    def __init__(self, name: str,
+                 description: str,
+                 name_upper: str,
+                 dbus_type: str,
+                 python_type: str,
+                 parent: NmSettingsIntrospection,
+                 default: Optional[str] = None,
+                 ) -> None:
+        self.name = name
+        self.description = description
+        self.name_upper = name_upper
+        self.python_name = name_upper.lower()
+        self.dbus_type = dbus_type
+        self.python_type = python_type
+        self.default = default
+
+        if must_replace_name(self.python_name):
+            self.python_name = (f"{parent.name_upper.lower()}"
+                                f"_{self.python_name}")
+
+        extra_typing = dbus_to_python_extra_typing_imports.get(dbus_type)
+        if extra_typing is not None:
+            parent.typing_imports.update(extra_typing)
+
+
+class NmSettingsIntrospection:
+    def __init__(self, name: str, description: str, name_upper: str,
+                 ) -> None:
+        self.name = name
+        self.description = description
+        self.name_upper = name_upper
+        self.python_class_name = name.capitalize() + 'Settings'
+
+        self.typing_imports = {'Optional'}
+
+        self.properties: List[NmSettingPropertyIntrospection] = []
+
+
+def convert_property(node: Element,
+                     parent: NmSettingsIntrospection
+                     ) -> NmSettingPropertyIntrospection:
+    options = node.attrib
+
+    unconverted_type = options.pop('type')
+    try:
+        dbus_type = dbus_name_type_map[unconverted_type]
+    except KeyError:
+        dbus_type = dbus_name_type_map[unconverted_type.split('(')[1][:-1]]
+
+    options['dbus_type'] = dbus_type
+    options['python_type'] = dbus_to_python_type_map[dbus_type]
+
+    return NmSettingPropertyIntrospection(**options, parent=parent)
+
+
+def generate_introspection(root: Element) -> List[NmSettingsIntrospection]:
+    settings_introspection: List[NmSettingsIntrospection] = []
+    for setting_node in root:
+        setting = NmSettingsIntrospection(**setting_node.attrib)
+        setting.properties.extend(
+          (convert_property(x, setting) for x in setting_node)
+        )
+
+        settings_introspection.append(setting)
+
+    return settings_introspection
+
+
+setttngs_template_str = """# SPDX-License-Identifier: LGPL-2.1-or-later
+# This file was generated by tools/generate-settings-dataclasses-jinja.py,
+# if possible, please make changes by also updating the script.
+from __future__ import annotations
+from dataclasses import dataclass, field
+from typing import {{ setting.typing_imports|sort|join(', ') }}
+from .base import NetworkManagerSettingsMixin
+
+
+@dataclass
+class {{ setting.python_class_name }}(NetworkManagerSettingsMixin):
+    \"""{{ setting.description }}\"""
+{% for property in setting.properties %}
+    {{ property.python_name }}: Optional[{{ property.python_type }}] = field(
+        metadata={
+            'dbus_name': '{{ property.name }}',
+            'dbus_type': '{{ property.dbus_type }}',
+        },
+        default=None,
+    ){% endfor %}
+
+"""
+
+jinja_env = Environment()
+settings_template = jinja_env.from_string(setttngs_template_str)
+
+
+def main(settings_xml_path: Path) -> None:
+    tree = parse(settings_xml_path)
+    introspection = generate_introspection(tree.getroot())
+
+    settings_dir = Path('sdbus_async/networkmanager/settings/')
+    for setting in introspection:
+        setting_py_file = settings_dir / (setting.name_upper.lower() + '.py')
+        with open(setting_py_file, mode='w') as f:
+            f.write(settings_template.render(setting=setting))
+
+
+if __name__ == '__main__':
+    arg_parser = ArgumentParser()
+    arg_parser.add_argument(
+        'nm_settings_xml',
+        type=Path,
+        default=Path('man/nm-settings-docs-dbus.xml'),
+    )
+    args = arg_parser.parse_args()
+
+    main(args.nm_settings_xml)