tools/generate-settings-dataclasses.py: Fix bond.py, generate options.rst

Author: Bernhard Kaindl

docs/options.rst

@@ -0,0 +1,143 @@
+Network Manager settings
+========================
+
+.. autoclass:: sdbus_async.networkmanager.settings.ConnectionSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.Ipv4Settings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.Ipv6Settings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.AdslSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.BluetoothSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.BondSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.BondPortSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.BridgeSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.BridgePortSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.CdmaSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.DcbSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.EthernetSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.GsmSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.HostnameSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.Ieee8021XSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.InfinibandSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.IpTunnelSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.LowpanSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.MacsecSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.MacvlanSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.MatchSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.OlpcMeshSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.OvsBridgeSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.OvsDpdkSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.OvsExternalIdsSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.OvsInterfaceSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.OvsPatchSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.OvsPortSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.PppSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.PppoeSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.ProxySettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.SerialSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.TeamSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.TeamPortSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.TunSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.UserSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.VethSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.VlanSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.VpnSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.VrfSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.VxlanSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.WifiP2PSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.WimaxSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.WireguardSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.WirelessSettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.WirelessSecuritySettings
+    :members:
+
+.. autoclass:: sdbus_async.networkmanager.settings.WpanSettings
+    :members:

sdbus_async/networkmanager/settings/bond.py

@@ -20,7 +20,7 @@ class BondSettings(NetworkManagerSettingsMixin):
     name."""
     options: Optional[Dict[str, str]] = field(
         metadata={'dbus_name': 'options', 'dbus_type': 'a{ss}'},
-        default={'Mode': 'Balance-Rr'},
+        default=field(default_factory = lambda: {'mode': 'balance-rr'}),
     )
     """Dictionary of key/value pairs of bonding options.  Both keys and values
     must be strings. Option names must contain only alphanumeric characters (ie,

tools/generate-settings-dataclasses.py

@@ -2,6 +2,8 @@
 # Based on NetworkManager-1.39.2/tools/generate-docs-nm-settings-docs-merge.py
 # SPDX-License-Identifier: LGPL-2.1-or-later
 import collections
+import io
+import os
 import textwrap
 import xml.etree.ElementTree as ElementTree
 from argparse import ArgumentParser
@@ -216,34 +218,46 @@ def find_first_not_none(itr: List[Any]) -> Optional[Any]:
     return next((i for i in itr if i is not None), None)
 
 
+# Generate docs/options.rst, see:
+# https://github.com/python-sdbus/python-sdbus-networkmanager/pull/39#issuecomment-1186522147
+def open_options_rst() -> io.TextIOWrapper:
+    options_rst = open("docs/options.rst", "w")
+    options_rst.write("Network Manager settings\n========================\n")
+    return options_rst
+
+
+def append_sphinx_autoclass(options_rst: io.TextIOWrapper, classname: str) -> None:
+    classpath = f"sdbus_async.networkmanager.settings.{classname}"
+    options_rst.write(f"\n.. autoclass:: {classpath}\n    :members:\n")
+
+
 # The code quality of this function is poor(Sourcery says 5%), needs refactoring,
 # also see the rework in tools/generate-settings-dataclasses-jinja.py
 def main(settings_xml_path: Path) -> None:
+    options_rst = open_options_rst()
     gl_input_files = [settings_xml_path]
 
     xml_roots = [ElementTree.parse(f).getroot() for f in gl_input_files]
     assert all(root.tag == "nm-setting-docs" for root in xml_roots)
     settings_roots = [node_to_dict(root, "setting", "name")
                       for root in xml_roots]
 
-    root_node = ElementTree.Element("nm-setting-docs")
-
     # Generate the file header
     license = "SPDX-License-Identifier: LGPL-2.1-or-later"
-    script = ("This file was generated by "
-              "tools/generate-settings-dataclasses.py")
+    script = "This file was generated by tools/generate-settings-dataclasses.py"
     header = f"""# {license}\n# {script},
 # if possible, please make changes by also updating the script.\n"""
     i = open("sdbus_async/networkmanager/settings/__init__.py", mode="w")
-    p = open("sdbus_async/networkmanager/settings/profile.py", mode="r")
-    profile_py = open("sdbus_async/networkmanager/settings/profile.py").read()
+    profile_path = "sdbus_async/networkmanager/settings/profile.py"
+    profile_py = open(profile_path).read()
 
     # define start and end markers for generating part of settings/profile.py:
     start_string = "# start of the generated list of settings classes\n"
     start_index = profile_py.index(start_string) + len(start_string)
     end_string = "    # end of the generated list of settings classes\n"
     end_index = profile_py.index(end_string)
-    p = open("sdbus_async/networkmanager/settings/profile.py", mode="w")
+    profile_path_new = f"{profile_path}.new"
+    p = open(profile_path_new, mode="w")
 
     # write the file headers
     i.write(header)
@@ -296,7 +310,6 @@ def main(settings_xml_path: Path) -> None:
         f.write("\n\n")
 
         # Generate the settings_class and it's entry in profile.py:
-        setting_node = ElementTree.SubElement(root_node, "setting")
         if module != "connection":
             p.write(f"    {module}: Optional[{classname}] = field(\n")
             p.write(f"        metadata={{'dbus_name': '{settingname}',\n")
@@ -305,7 +318,7 @@ def main(settings_xml_path: Path) -> None:
             p.write("    )\n")
         f.write("@dataclass\n")
         f.write(f"class {classname}(NetworkManagerSettingsMixin):\n")
-        setting_node.set("name", settingname)
+        append_sphinx_autoclass(options_rst, classname)
 
         # generate the docstring of the new settings_class
         desc = node_get_attr(settings, "description")
@@ -316,8 +329,6 @@ def main(settings_xml_path: Path) -> None:
         for property in iter_keys_of_dicts(properties, key_fcn_property_name, f'{settingname}.'):
             property_name = property[len(settingname)+1:]
             properties_attrs = [p.get(property_name) for p in properties]
-            property_node = ElementTree.SubElement(setting_node, "property")
-            property_node.set("name", property_name)
             t = node_get_attr(properties_attrs, "type")
             attribute = property_name.replace('-', '_')
             for builtin in ["id", "type"]:
@@ -371,9 +382,13 @@ def main(settings_xml_path: Path) -> None:
                     f.write(line.replace(":@", ": ") + '\n')
                 default = node_get_attr(properties_attrs, "default")
                 if default in ["{}", "0", "-1"]:
-                    default = "None"
+                    default = None
                 if optional:
-                    f.write(f"        default={str(default).title()},\n")
+                    if dbustype == "a{ss}" and default:
+                        default = f"field(default_factory = lambda: {default})"
+                    else:
+                        default = str(default).title()  # FALSE -> False
+                    f.write(f"        default={default},\n")
                 f.write("    )\n")
 
                 # Generate docstrings for attributes: Not stored by python,
@@ -401,6 +416,7 @@ def main(settings_xml_path: Path) -> None:
         i.write(f"    '{cls}',\n")
     i.write(")\n")
     p.write(profile_py[end_index:])
+    os.rename(profile_path_new, profile_path)
 
 
 if __name__ == '__main__':