Add to_settings_dict() complementing from_settings_dict()

to_settings_dict() complements the new from_settings_dict():
The key names provided are exactly as documented in these tables:
https://networkmanager.dev/docs/api/latest/nm-settings-dbus.html

Extend tests/async/test_get_settings.py to test to_settings_dict().

Contrary to dataclasses.asdict(), it provides the orignal dbus keys,
e.g. with numerical prefixes like "802-11-", dashes, and "id"/"type".

Author: Bernhard Kaindl

sdbus_async/networkmanager/__init__.py

@@ -250,6 +250,7 @@
     NetworkManagerSetting,
     NetworkManagerSettingsDomain,
     NetworkManagerConnectionProperties,
+    SettingsDict,
 )
 
 DEVICE_TYPE_TO_CLASS = {
@@ -479,4 +480,5 @@
     'NetworkManagerSetting',
     'NetworkManagerSettingsDomain',
     'NetworkManagerConnectionProperties',
+    'SettingsDict',
 )

sdbus_async/networkmanager/settings/base.py

@@ -10,7 +10,11 @@
 
 class NetworkManagerSettingsMixin:
     def to_dbus(self) -> NetworkManagerSettingsDomain:
-        """TODO: Add proper docstring"""
+        """Return a dbus dictionary for NetworkManager to add/update profiles
+
+        The key names provided are exactly as documented in these tables:
+        https://networkmanager.dev/docs/api/latest/nm-settings-dbus.html
+        """
         new_dict: NetworkManagerSettingsDomain = {}
 
         for x in fields(self):
@@ -27,6 +31,36 @@ def to_dbus(self) -> NetworkManagerSettingsDomain:
 
         return new_dict
 
+    def to_settings_dict(self, defaults: bool = False) -> Dict[str, Any]:
+        """Return a simple dictionary using the same key names like the dbus
+        dict from to_dbus(), but without the dbus signatures returned by it.
+
+        The key names provided are exactly as documented in these tables:
+        https://networkmanager.dev/docs/api/latest/nm-settings-dbus.html
+
+        Contrary to dataclasses.asdict(), it provides the orignal dbus keys,
+        e.g. with numerical prefixes like "802-11-", dashes, and "id"/"type".
+
+        In addition, it can be selected if defaults shall be omitted in output,
+        like NetworkConnectionSettings.get_settings() omits default values:
+
+        Because of this, all NetworkManager clients which read profiles have
+        to have hard-coded knowledge of these defaults. By this omission, they
+        are part of the stable API: They can be relied upon to never change.
+        Omitting the defaults makes the typical output really small for review.
+        """
+        new_dict = {}
+        for x in fields(self):
+            value = getattr(self, x.name)
+            if value in [None, {}, []]:
+                continue
+            if not defaults and value == x.default:
+                continue
+            if x.metadata['dbus_type'] == 'aa{sv}':
+                value = [x.to_settings_dict(defaults) for x in value]
+            new_dict[x.metadata['dbus_name']] = value
+        return new_dict
+
     @classmethod
     def _unpack_variant(cls, key: str, signature: str, value: Any) -> Any:
         if signature == 'aa{sv}':

sdbus_async/networkmanager/settings/profile.py

@@ -51,7 +51,7 @@
 from .wireless import WirelessSettings
 from .wireless_security import WirelessSecuritySettings
 from .wpan import WpanSettings
-from ..types import NetworkManagerConnectionProperties
+from ..types import NetworkManagerConnectionProperties, SettingsDict
 
 
 @dataclass
@@ -344,6 +344,27 @@ def to_dbus(self) -> NetworkManagerConnectionProperties:
 
         return new_dict
 
+    def to_settings_dict(self, defaults: bool = False) -> SettingsDict:
+        """Return a simple dictionary using the same key names like the dbus
+        dict from to_dbus(), but without the dbus signatures returned by it.
+
+        Contrary to dataclasses.asdict(), it provides the orignal dbus keys,
+        e.g. with numerical prefixes like "802-11-", dashes, and "id"/"type".
+
+        The key names provided are exactly as documented in these tables:
+        https://networkmanager.dev/docs/api/latest/nm-settings-dbus.html
+
+        param defaults: Whether properies with default values are returned.
+        """
+        new_dict = {}
+        for x in fields(self):
+            settings_class = getattr(self, x.name)
+            if settings_class:
+                settingsdomain_dict = settings_class.to_settings_dict(defaults)
+                if settingsdomain_dict != {}:
+                    new_dict[x.metadata['dbus_name']] = settingsdomain_dict
+        return new_dict
+
     @property
     def dbus_name_to_settings_class(self) -> Dict[str, str]:
         return {f.metadata['dbus_name']: f.name
@@ -368,7 +389,7 @@ def from_dbus(cls, dbus_dict: NetworkManagerConnectionProperties
 
     @classmethod
     def from_settings_dict(
-        cls, settings_dict: Dict[str, Dict[str, Any]]
+        cls, settings_dict: SettingsDict
     ) -> ConnectionProfile:
         """Return a ConnectionProfile created from a simple settings dict
         A simple settings dict uses the same keys as from_dbus() and to_dbus()

sdbus_async/networkmanager/types.py

@@ -27,3 +27,6 @@
 
 # All settings and properites of a connection, e.g. returned by get_settings()
 NetworkManagerConnectionProperties = Dict[str, NetworkManagerSettingsDomain]
+
+# All settings and properites of a connection, but without dbus signatures
+SettingsDict = Dict[str, Dict[str, Any]]

tests/async/test_get_settings.py

@@ -83,12 +83,34 @@ async def test_autoconnect_true_not_returned_by_networkmanager() -> None:
     assert "autoconnect" not in profile_from_manager["connection"]
 
 
+def test_autoconnect_true_returned_by_settings_dict_when_requested() -> None:
+    """to_settings_dict(defaults=True) returns autoconnect=True (is default)"""
+    profile_from_dbus_dict = profile_with_autoconnect_set_to(True)
+    settings_dict = profile_from_dbus_dict.to_settings_dict(defaults=True)
+    assert settings_dict["connection"]["autoconnect"] is True
+
+
+def test_autoconnect_true_not_returned_by_to_settings_dict() -> None:
+    """to_settings_dict(defaults=False) does not return autoconnect=True"""
+
+    # Like checked by test_autoconnect_true_not_returned_by_networkmanager()
+    # above (which checks that get_settings) does not return autoconnect=True
+    # (because it is the default), test the same for .to_settings_dict():
+    profile_from_dbus_dict = profile_with_autoconnect_set_to(True)
+    settings_dict = profile_from_dbus_dict.to_settings_dict(defaults=False)
+
+    # Assert that networkmanager did not return autoconnect (default is True)
+    assert "autoconnect" not in settings_dict["connection"]
+
+
 async def check_to_settings_dict_profile_eqal_to_from_settings_dict() -> None:
     """Async main function to run all tests when not run by pytest"""
     """The tests can be run by pytest (and from IDEs by running this module)"""
     set_sdbus_default_bus()
     await test_autoconnect_false_returned_by_networkmanager()
     await test_autoconnect_true_not_returned_by_networkmanager()
+    test_autoconnect_true_returned_by_settings_dict_when_requested()
+    test_autoconnect_true_not_returned_by_to_settings_dict()
 
 
 if __name__ == "__main__":