Merge branch 'settings-helper'

Thank you @bernhardkaindl

Author: igo95862

examples/async/list-connections-async.py

@@ -19,6 +19,7 @@
 # | ipv6: method: disabled
 import asyncio
 import sdbus
+import pprint
 from sdbus_async.networkmanager import (
     NetworkManagerSettings,
     NetworkConnectionSettings,
@@ -29,33 +30,30 @@
 async def list_connection_profiles_async() -> None:
     networkmanager_settings = NetworkManagerSettings()
     connections_paths: List[str] = await networkmanager_settings.connections
-    for connection_path in connections_paths:
-        connection_settings = NetworkConnectionSettings(connection_path)
-        settings = await connection_settings.get_settings()
-        connection = settings["connection"]
-
-        # Skip connection profiles for bridges and wireless networks
-        if connection["type"][1] in ("bridge", "802-11-wireless"):
-            continue
-
-        print("-------------------------------------------------------------")
-        print("name:", connection["id"][1])
-        print("uuid:", connection["uuid"][1])
-        print("type:", connection["type"][1])
-        if "interface-name" in connection:
-            print("      interface-name:", connection["interface-name"][1])
-
-        if "ipv4" in settings:
-            ipv4 = settings["ipv4"]
-            print("ipv4: method:", ipv4["method"][1])
-            if "address-data" in ipv4:
-                for a in ipv4["address-data"][1]:
-                    print(f'      ipaddr: {a["address"][1]}/{a["prefix"][1]}')
-            if "route-metric" in ipv4:
-                print(f'      route-metric: {ipv4["route-metric"][1]}')
-
-        if "ipv6" in settings:
-            print("ipv6: method:", settings["ipv6"]["method"][1])
+    for dbus_connection_path in connections_paths:
+        await print_connection_profile(dbus_connection_path)
+
+
+async def print_connection_profile(connection_path: str) -> None:
+    connectionsettings_service = NetworkConnectionSettings(connection_path)
+    profile = await connectionsettings_service.connection_profile()
+    connection = profile.connection
+    print("-------------------------------------------------------------")
+    print("name:", connection.connection_id)
+    print("uuid:", connection.uuid)
+    print("type:", connection.connection_type)
+    if connection.interface_name:
+        print("      interface-name:", connection.interface_name)
+    if profile.ipv4:
+        print("ipv4: method:", profile.ipv4.method)
+        if profile.ipv4.address_data:
+            for address in profile.ipv4.address_data:
+                print(f'      ipaddr: {address.address}/{address.prefix}')
+        if profile.ipv4.route_metric:
+            print(f'      route-metric: {profile.ipv4.route_metric}')
+    if profile.ipv6:
+        print("ipv6: method:", profile.ipv6.method)
+    pprint.pprint(profile.to_settings_dict(), sort_dicts=False)
 
 
 if __name__ == "__main__":

examples/async/update-connection-async.py

@@ -3,12 +3,21 @@
 #
 # Update a property of a connection profile, looked up by connection id
 #
+# This version uses connection_manager.connection_profile().to_settings_dict()
+# to retrieve the connection profile from NetworkManager as a settings dict.
+#
+# It then updates it dynamically using the given arguments:
+# The default is to set ipv4.dns-search to ["domain1.com", "domain2.com"].
+#
+# The dynamically updated dict is then used to update connection profile of NM.
+#
 # The IPv4 settings of connections profiles are documented here:
 # https://networkmanager.dev/docs/api/latest/settings-ipv4.html
 #
 import asyncio
 import sdbus
 from functools import partial
+from sdbus_async.networkmanager import ConnectionProfile
 from sdbus_async.networkmanager import NetworkManagerSettings
 from sdbus_async.networkmanager import NetworkConnectionSettings
 from pprint import pprint
@@ -17,24 +26,34 @@
 
 async def update_connection_async(args: Dict[str, Any]) -> None:
     """Update the settings for [key][entry] of the 1st matching connection"""
+
+    # Get the connection path of the connection(s) with the recieved id
     fn = NetworkManagerSettings().get_connections_by_id(args["connection_id"])
     connection_paths = await fn
-    settings_domain, setting = args["connection_setting"]
-    if connection_paths:
-        connection_settings = NetworkConnectionSettings(connection_paths[0])
-        properties = await connection_settings.get_settings()
-        # For compatibility with old tools, NM adds and prefers them, delete:
-        properties["ipv4"].pop("addresses")  # -> Use ["ipv4"]["address-data"]
-        properties["ipv4"].pop("routes")  # ----> Use ["ipv4"]["route-data"]
+    if not connection_paths:
+        print(f"No connection {id}, create with add-wifi-psk-connection-async")
+        return
+
+    # Get the profile settings of the first connecttion with given id
+    connection_manager = NetworkConnectionSettings(connection_paths[0])
+    existing_connection_profile = await connection_manager.connection_profile()
+    settings = existing_connection_profile.to_settings_dict()
+
+    # Update the given setting's property using the given value
+    setting, property = args["connection_setting"]
+    settings[setting][property] = args["value"]
+
+    # Get a new ConnectionProfile with the change incorporated
+    new_connection_profile = ConnectionProfile.from_settings_dict(settings)
+
+    # Update the new ConnectionProfile in NetworkManager's configuration
+    await connection_manager.update(new_connection_profile.to_dbus())
 
-        # Update the setting's value in the given configuration group:
-        properties[settings_domain][setting] = args["value"]
-        await connection_settings.update(properties)
+    print(f'Updated {new_connection_profile.connection.uuid}.{setting}:')
+    partial(pprint, sort_dicts=False)(settings)
 
-        print(f'Updated {properties["connection"]["uuid"]}.{settings_domain}:')
-        partial(pprint, sort_dicts=False)(properties[settings_domain])
-    else:
-        print(f"No connection matching {id}")
+    # Restore the previous connection profile:
+    await connection_manager.update(existing_connection_profile.to_dbus())
 
 
 if __name__ == "__main__":
@@ -43,7 +62,6 @@ async def update_connection_async(args: Dict[str, Any]) -> None:
         # Set MyConnectionExample.ipv4.dns-search to "domain1.com,domain2.com":
         "connection_id": "MyConnectionExample",
         "connection_setting": ("ipv4", "dns-search"),
-        # "as" is the so-called DBus signature, it means "array of strings":
-        "value": ("as", ["domain1.com", "domain2.com"]),
+        "value": ["domain1.com", "domain2.com"],
     }
     asyncio.run(update_connection_async(args))

pytest.ini

@@ -0,0 +1,17 @@
+[pytest]
+#
+# Newer version of pytest-asyncio issue a DeprecationWarning unless
+# asyncio_mode is specified. This is because it is planned to change
+# the legacy default of automatically decorating async fixtures from
+# automatc to strict (only all functions and fixtures have to be marked).
+#
+# But only very recent versions of pytest-asyncio versions support
+# the asyncio_mode configuration setting and then issue a config warning,
+# which can't be filtered.
+#
+# Thus, filter the Deprecationwarning of pytest-asyncio for some time
+# until all users can be assumed to use the latest pytest-asyncio.
+#
+filterwarnings =
+    ignore:The 'asyncio_mode' default value will change to 'strict' in future, please explicitly use 'asyncio_mode=strict' or 'asyncio_mode=auto' in pytest configuration file.:DeprecationWarning
+