Cleanup, cleanup, everybody everywhere

Author: balloob

custom_components/matter_experimental/__init__.py

@@ -2,16 +2,15 @@
 from __future__ import annotations
 
 import asyncio
-import async_timeout
 
-import voluptuous as vol
+import async_timeout
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import EVENT_HOMEASSISTANT_STOP
 from homeassistant.core import Event, HomeAssistant, ServiceCall, callback
 from homeassistant.exceptions import ConfigEntryNotReady, HomeAssistantError
 from homeassistant.helpers import device_registry as dr
 from homeassistant.helpers.service import async_register_admin_service
-from homeassistant.helpers.start import async_at_start
+import voluptuous as vol
 
 from matter_server.client.exceptions import CannotConnect, FailedCommand
 from matter_server.client.matter import Matter

custom_components/matter_experimental/adapter.py

@@ -1,20 +1,21 @@
 """Matter to HA adapter."""
 from __future__ import annotations
+
+from abc import abstractmethod
 import asyncio
+import json
 import logging
-from abc import abstractmethod
 from typing import TYPE_CHECKING, Callable
-import json
 
 import aiohttp
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_URL, Platform
 from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import HomeAssistantError
+from homeassistant.helpers import device_registry as dr
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
-from homeassistant.helpers.storage import Store
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
-from homeassistant.helpers import device_registry as dr
+from homeassistant.helpers.storage import Store
 
 from matter_server.client.adapter import AbstractMatterAdapter
 from matter_server.common.json_utils import CHIPJSONDecoder, CHIPJSONEncoder

custom_components/matter_experimental/config_flow.py

@@ -4,13 +4,13 @@
 import logging
 from typing import Any
 
-import voluptuous as vol
 from homeassistant import config_entries
 from homeassistant.const import CONF_URL
 from homeassistant.core import HomeAssistant
 from homeassistant.data_entry_flow import FlowResult
 from homeassistant.exceptions import HomeAssistantError
 from homeassistant.helpers import aiohttp_client
+import voluptuous as vol
 
 from matter_server.client.client import Client
 

custom_components/matter_experimental/device_platform.py

@@ -1,11 +1,12 @@
 from __future__ import annotations
+
 from typing import TYPE_CHECKING
 
 from homeassistant.const import Platform
 
 from .device_platform_helper import DeviceMapping
-from .switch import DEVICE_ENTITY as SWITCH_DEVICE_ENTITY
 from .light import DEVICE_ENTITY as LIGHT_DEVICE_ENTITY
+from .switch import DEVICE_ENTITY as SWITCH_DEVICE_ENTITY
 
 if TYPE_CHECKING:
     from matter_server.client.model import device as matter_devices

custom_components/matter_experimental/device_platform_helper.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Callable
 

custom_components/matter_experimental/light.py

@@ -3,19 +3,19 @@
 
 from typing import TYPE_CHECKING, Any
 
-from homeassistant.const import Platform
-from homeassistant.components.light import LightEntity, ColorMode, ATTR_BRIGHTNESS
+from homeassistant.components.light import ATTR_BRIGHTNESS, ColorMode, LightEntity
 from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import Platform
 from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from homeassistant.util import percentage
 
-from matter_server.vendor.chip.clusters import Objects as clusters
 from matter_server.client.model import device as matter_devices
+from matter_server.vendor.chip.clusters import Objects as clusters
 
 from .const import DOMAIN
-from .entity import MatterEntity
 from .device_platform_helper import DeviceMapping
+from .entity import MatterEntity
 
 if TYPE_CHECKING:
     from matter_server.client.matter import Matter

custom_components/matter_experimental/switch.py

@@ -3,22 +3,22 @@
 
 from typing import TYPE_CHECKING, Any
 
-from homeassistant.const import Platform
 from homeassistant.components.switch import (
+    SwitchDeviceClass,
     SwitchEntity,
     SwitchEntityDescription,
-    SwitchDeviceClass,
 )
 from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import Platform
 from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
-from matter_server.vendor.chip.clusters import Objects as clusters
 from matter_server.client.model import device as matter_devices
+from matter_server.vendor.chip.clusters import Objects as clusters
 
 from .const import DOMAIN
-from .entity import MatterEntity
 from .device_platform_helper import DeviceMapping
+from .entity import MatterEntity
 
 if TYPE_CHECKING:
     from matter_server.client.matter import Matter

matter_server/client/adapter.py

@@ -1,8 +1,8 @@
 """Matter adapter."""
 from __future__ import annotations
 
-import logging
 from abc import abstractmethod
+import logging
 from typing import Callable
 
 import aiohttp

matter_server/client/client.py

@@ -2,18 +2,18 @@
 from __future__ import annotations
 
 import asyncio
-import json
-import logging
-import pprint
-import uuid
 from collections import defaultdict
 from copy import deepcopy
 from dataclasses import asdict, is_dataclass
 from datetime import datetime
 from functools import partial
+import json
+import logging
 from operator import itemgetter
+import pprint
 from types import TracebackType
 from typing import Any, DefaultDict, Dict, List, cast
+import uuid
 
 from aiohttp import ClientSession, ClientWebSocketResponse, WSMsgType, client_exceptions
 
@@ -124,7 +124,7 @@ async def async_send_command(
             self._result_futures.pop(message.messageId)
 
     async def async_send_command_no_wait(
-        self, message: CommandMessage, require_schema: int | None = None
+        self, command: str, args: dict[str, Any], require_schema: int | None = None
     ) -> None:
         """Send a command without waiting for the response."""
         if require_schema is not None and require_schema > self.schema_version:

matter_server/client/model/device.py

@@ -6,6 +6,7 @@
 
 if TYPE_CHECKING:
     from .node import MatterNode
+    from .subscription import Subscription
 
 DEVICE_TYPES = {}
 
@@ -136,18 +137,21 @@ async def subscribe_updates(
         self._on_update_listener = subscriber
 
         reporting_timing_params = (0, 10)
-        subscription = await self.node.matter.client.driver.device_controller.Read(
-            self.node.node_id,
-            attributes=[
-                (self.endpoint_id, attribute) for attribute in subscribe_attributes
-            ],
-            reportInterval=reporting_timing_params,
+        subscription: Subscription = (
+            await self.node.matter.client.driver.device_controller.Read(
+                self.node.node_id,
+                attributes=[
+                    (self.endpoint_id, attribute) for attribute in subscribe_attributes
+                ],
+                reportInterval=reporting_timing_params,
+            )
         )
         subscription.handler = self._receive_event
 
-        async def unsubscribe() -> None:
+        def unsubscribe() -> None:
             self._on_update_listener = None
             subscription.handler = None
+
             # TODO actually unsubscribe
 
         return unsubscribe

matter_server/client/model/device_controller.py

@@ -247,13 +247,13 @@ async def Read(
         return subscription
 
     def receive_event(self, event):
-        subscriptionId = event["subscriptionId"]
-        if subscriptionId not in self.subscriptions:
+        subscription_id = event["subscriptionId"]
+        if subscription_id not in self.subscriptions:
             _LOGGER.warning(
-                f"No Subscription object for Subscription Id 0x{subscriptionId:X} present."
+                f"No Subscription object for Subscription Id 0x{subscription_id:X} present."
             )
             return
-        subscription = self.subscriptions[subscriptionId]
+        subscription = self.subscriptions[subscription_id]
         if not subscription.handler:
             _LOGGER.debug("No Subscription handler.")
             return

matter_server/client/model/subscription.py

@@ -2,8 +2,8 @@
 
 
 class Subscription:
-    subscriptionId: int
+    subscription_id: int
     handler: Callable[[dict], None]
 
-    def __init__(self, subscriptionId):
-        self.subscriptionId = subscriptionId
+    def __init__(self, subscription_id):
+        self.subscription_id = subscription_id

matter_server/common/json_utils.py

@@ -1,9 +1,9 @@
 import base64
 import copy
-import json
-import sys
 from dataclasses import asdict, fields, is_dataclass
 from enum import Enum
+import json
+import sys
 from types import ModuleType
 
 import matter_server.common.model

matter_server/server/__main__.py

@@ -1,8 +1,8 @@
 import asyncio
 import logging
 import os
-import sys
 from pathlib import Path
+import sys
 
 import coloredlogs
 

matter_server/server/active_connection.py

@@ -1,15 +1,17 @@
 from __future__ import annotations
 
 import asyncio
+from concurrent import futures
 from contextlib import suppress
+from functools import partial
 import json
 import typing
 from typing import TYPE_CHECKING, Coroutine, Final
-from concurrent import futures
 
 from aiohttp import WSCloseCode, WSMsgType, web
 from chip.exceptions import ChipStackError
 
+from ..backports.enum import StrEnum
 from ..common.json_utils import CHIPJSONDecoder, CHIPJSONEncoder
 from ..common.model.message import (
     CommandMessage,
@@ -18,12 +20,12 @@
     SuccessResultMessage,
 )
 from ..common.model.version import VersionInfo
-from ..backports.enum import StrEnum
 
 if TYPE_CHECKING:
-    from .server import MatterServer
     from chip.clusters import Attribute, ClusterObjects
 
+    from .server import MatterServer
+
 MAX_PENDING_MSG = 512
 CANCELLATION_ERRORS: Final = (asyncio.CancelledError, futures.CancelledError)
 
@@ -42,6 +44,9 @@ class DeviceControllerCommands(StrEnum):
     SET_THREAD_OPERATIONAL_DATASET = "SetThreadOperationalDataset"
     SET_WIFI_CREDENTIALS = "SetWiFiCredentials"
 
+    # Custom commands
+    UNSUBSCRIBE = "Unsubscribe"
+
 
 PROTOCOL = {
     InstanceCommands.DEVICE_CONTROLLER: {
@@ -178,7 +183,12 @@ def _handle_message(self, msg: CommandMessage):
             self._send_message(ErrorResultMessage(msg.messageId, "Unknown error"))
 
     def _handle_device_controller_message(self, msg: CommandMessage, command: str):
-        if command == "Read" and msg.args.get("reportInterval") is not None:
+        if command == DeviceControllerCommands.UNSUBSCRIBE:
+            method = partial(self._handle_device_controller_unsubscribe_message, msg)
+        elif (
+            command == DeviceControllerCommands.READ
+            and msg.args.get("reportInterval") is not None
+        ):
             method = self._handle_device_controller_subscribe_message
         else:
             method = getattr(self.server.stack.device_controller, command)
@@ -307,13 +317,25 @@ def subscription_callback(
         self._subscriptions[subscription_id] = subscription
         return subscription_id
 
+    def _handle_device_controller_unsubscribe_message(
+        self, msg: CommandMessage, subscription_id: int
+    ):
+        """Unsubscribe."""
+        subscription = self._subscriptions.pop(subscription_id, None)
+        if subscription is None:
+            self._send_message(ErrorResultMessage(msg.messageId, "not_found"))
+            return
+
+        subscription.shutdown()
+        self._send_message(SuccessResultMessage(msg.messageId, None))
+
     async def _handle_coroutine_command(self, msg: CommandMessage, action: Coroutine):
         try:
             result = await action
         except ChipStackError as ex:
             self._send_message(ErrorResultMessage(msg.messageId, str(ex)))
         except Exception:
             self.logger.exception("Error handling message: %s", msg.data)
-            self._send_message(ErrorResultMessage(msg.messageId, "Unknown error"))
+            self._send_message(ErrorResultMessage(msg.messageId, "unknown_error"))
 
         self._send_message(SuccessResultMessage(msg.messageId, result))

matter_server/server/matter_stack.py

@@ -2,12 +2,12 @@
 import logging
 import typing
 
-import chip.logging
-import chip.native
 from chip.ChipDeviceCtrl import ChipDeviceController
 from chip.ChipStack import ChipStack
-from chip.clusters import Attribute, ClusterObjects
 from chip.FabricAdmin import FabricAdmin
+from chip.clusters import Attribute, ClusterObjects
+import chip.logging
+import chip.native
 
 _LOGGER = logging.getLogger(__name__)
 

matter_server/server/server.py

@@ -2,8 +2,8 @@
 
 import asyncio
 import logging
-import weakref
 from typing import TYPE_CHECKING
+import weakref
 
 from aiohttp import web
 

pyproject.toml

@@ -24,3 +24,25 @@ good-names = [
     "Run",
     "ip",
 ]
+
+[tool.isort]
+# https://github.com/PyCQA/isort/wiki/isort-Settings
+profile = "black"
+# will group `import x` and `from x import` of the same module.
+force_sort_within_sections = true
+src_paths = [
+  "custom_components",
+  "matter_server/client",
+  "matter_server/common",
+  "matter_server/server",
+  "matter_server/backports",
+]
+known_first_party = [
+    "custom_components",
+    "matter_server",
+    "tests",
+]
+forced_separate = [
+    "tests",
+]
+combine_as_imports = true