Fix all lint issues (#245)

Author: marcelveldt

.github/workflows/test.yml

@@ -25,18 +25,10 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install -y libgirepository1.0-dev
-          python -m pip install --upgrade pip
-          pip install -e .[server] -r requirements-test.txt
-      - name: Flake8
-        run: flake8 scripts/ matter_server/
-      - name: Black
-        run: black --check scripts/ matter_server/
-      - name: isort
-        run: isort --check scripts/ matter_server/
-      - name: pylint
-        run: pylint matter_server/
-      - name: mypy
-        run: mypy matter_server/
+          python -m pip install --upgrade pip build setuptools
+          pip install .[server] .[test]
+      - name: Lint/test with pre-commit
+        run: pre-commit run --all-files
 
   test:
     runs-on: ubuntu-latest
@@ -59,7 +51,7 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install -y libgirepository1.0-dev
-          python -m pip install --upgrade pip
-          pip install -e .[server] -r requirements-test.txt
+          python -m pip install --upgrade pip build setuptools
+          pip install .[server] .[test]
       - name: Pytest
         run: pytest --durations 10 --cov-report term-missing --cov=matter_server --cov-report=xml tests/server/

.pre-commit-config.yaml

@@ -1,6 +1,20 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: no-commit-to-branch
+        args:
+          - --branch=main
+      - id: debug-statements
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: 'v0.0.259'
+    hooks:
+      - id: ruff
+        files: ^(matter_server|scripts)/.+\.py$
   - repo: https://github.com/psf/black
     rev: 23.1.0
     hooks:
@@ -15,23 +29,6 @@ repos:
         args: []
         exclude_types: [csv, json]
         exclude: ^tests/fixtures/
-  - repo: https://github.com/PyCQA/flake8
-    rev: 6.0.0
-    hooks:
-      - id: flake8
-        files: ^(matter_server|scripts)/.+\.py$
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-        files: ^(matter_server|scripts)/.+\.py$
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
-    hooks:
-      - id: no-commit-to-branch
-        args:
-          - --branch=main
-      - id: trailing-whitespace
   - repo: local
     hooks:
       - id: mypy

matter_server/client/client.py

@@ -3,16 +3,16 @@
 
 import asyncio
 import logging
-from types import TracebackType
-from typing import TYPE_CHECKING, Any, Callable, Dict, Final, Optional, cast
 import uuid
+from collections.abc import Callable
+from types import TracebackType
+from typing import TYPE_CHECKING, Any, Final, cast
 
 from aiohttp import ClientSession
 
 from matter_server.common.errors import ERROR_MAP
-
-from ..common.helpers.util import dataclass_from_dict, dataclass_to_dict
-from ..common.models import (
+from matter_server.common.helpers.util import dataclass_from_dict, dataclass_to_dict
+from matter_server.common.models import (
     APICommand,
     CommandMessage,
     ErrorResultMessage,
@@ -25,6 +25,7 @@
     ServerInfoMessage,
     SuccessResultMessage,
 )
+
 from .connection import MatterClientConnection
 from .exceptions import ConnectionClosed, InvalidServerVersion, InvalidState
 from .models.node import MatterNode
@@ -42,8 +43,8 @@ def __init__(self, ws_server_url: str, aiohttp_session: ClientSession):
         """Initialize the Client class."""
         self.connection = MatterClientConnection(ws_server_url, aiohttp_session)
         self.logger = logging.getLogger(__package__)
-        self._nodes: Dict[int, MatterNode] = {}
-        self._result_futures: Dict[str, asyncio.Future] = {}
+        self._nodes: dict[int, MatterNode] = {}
+        self._result_futures: dict[str, asyncio.Future] = {}
         self._subscribers: dict[str, list[Callable[[EventType, Any], None]]] = {}
         self._stop_called: bool = False
         self._loop: asyncio.AbstractEventLoop | None = None
@@ -56,9 +57,9 @@ def server_info(self) -> ServerInfoMessage | None:
     def subscribe(
         self,
         callback: Callable[[EventType, Any], None],
-        event_filter: Optional[EventType] = None,
-        node_filter: Optional[int] = None,
-        attr_path_filter: Optional[str] = None,
+        event_filter: EventType | None = None,
+        node_filter: int | None = None,
+        attr_path_filter: str | None = None,
     ) -> Callable[[], None]:
         """
         Subscribe to node and server events.
@@ -70,16 +71,10 @@ def subscribe(
         # for fast lookups we create a key based on the filters, allowing
         # a "catch all" with a wildcard (*).
         _event_filter: str
-        if event_filter is None:
-            _event_filter = SUB_WILDCARD
-        else:
-            _event_filter = event_filter.value
+        _event_filter = SUB_WILDCARD if event_filter is None else event_filter.value
 
         _node_filter: str
-        if node_filter is None:
-            _node_filter = SUB_WILDCARD
-        else:
-            _node_filter = str(node_filter)
+        _node_filter = SUB_WILDCARD if node_filter is None else str(node_filter)
 
         if attr_path_filter is None:
             attr_path_filter = SUB_WILDCARD
@@ -123,9 +118,7 @@ async def commission_on_network(self, setup_pin_code: int) -> MatterNodeData:
 
     async def set_wifi_credentials(self, ssid: str, credentials: str) -> None:
         """Set WiFi credentials for commissioning to a (new) device."""
-        await self.send_command(
-            APICommand.SET_WIFI_CREDENTIALS, ssid=ssid, credentials=credentials
-        )
+        await self.send_command(APICommand.SET_WIFI_CREDENTIALS, ssid=ssid, credentials=credentials)
 
     async def set_thread_operational_dataset(self, dataset: str) -> None:
         """Set Thread Operational dataset in the stack."""
@@ -137,7 +130,7 @@ async def open_commissioning_window(
         timeout: int = 300,
         iteration: int = 1000,
         option: int = 0,
-        discriminator: Optional[int] = None,
+        discriminator: int | None = None,
     ) -> int:
         """
         Open a commissioning window to commission a device present on this controller to another.
@@ -230,10 +223,7 @@ async def send_command_no_wait(
         if not self.server_info:
             raise InvalidState("Not connected")
 
-        if (
-            require_schema is not None
-            and require_schema > self.server_info.schema_version
-        ):
+        if require_schema is not None and require_schema > self.server_info.schema_version:
             raise InvalidServerVersion(
                 "Command not available due to incompatible server version. Update the Matter "
                 f"Server to a version that supports at least api schema {require_schema}."
@@ -268,15 +258,10 @@ async def start_listening(self, init_ready: asyncio.Event | None = None) -> None
                 message_id=uuid.uuid4().hex, command=APICommand.START_LISTENING
             )
             await self.connection.send_message(message)
-            nodes_msg = cast(
-                SuccessResultMessage, await self.connection.receive_message_or_raise()
-            )
+            nodes_msg = cast(SuccessResultMessage, await self.connection.receive_message_or_raise())
             # a full dump of all nodes will be the result of the start_listening command
             # create MatterNode objects from the basic MatterNodeData objects
-            nodes = [
-                MatterNode(dataclass_from_dict(MatterNodeData, x))
-                for x in nodes_msg.result
-            ]
+            nodes = [MatterNode(dataclass_from_dict(MatterNodeData, x)) for x in nodes_msg.result]
             self._nodes = {node.node_id: node for node in nodes}
             # once we've hit this point we're all set
             self.logger.info("Matter client initialized.")
@@ -373,8 +358,8 @@ def _signal_event(
         self,
         event: EventType,
         data: Any = None,
-        node_id: Optional[int] = None,
-        attribute_path: Optional[str] = None,
+        node_id: int | None = None,
+        attribute_path: str | None = None,
     ) -> None:
         """Signal event to all subscribers."""
         # instead of iterating all subscribers we iterate over subscription keys
@@ -390,7 +375,7 @@ def _signal_event(
                     for callback in self._subscribers.get(key, []):
                         callback(event, data)
 
-    async def __aenter__(self) -> "MatterClient":
+    async def __aenter__(self) -> MatterClient:
         """Initialize and connect the Matter Websocket client."""
         await self.connect()
         return self

matter_server/client/connection.py

@@ -4,15 +4,15 @@
 import asyncio
 import logging
 import pprint
-from typing import Any, Callable, Dict, Final, cast
+from collections.abc import Callable
+from typing import Any, Final, cast
 
 from aiohttp import ClientSession, ClientWebSocketResponse, WSMsgType, client_exceptions
 
+from matter_server.common.const import SCHEMA_VERSION
+from matter_server.common.helpers.json import json_dumps, json_loads
 from matter_server.common.helpers.util import dataclass_from_dict
-
-from ..common.const import SCHEMA_VERSION
-from ..common.helpers.json import json_dumps, json_loads
-from ..common.models import (
+from matter_server.common.models import (
     CommandMessage,
     ErrorResultMessage,
     EventMessage,
@@ -21,6 +21,7 @@
     ServerInfoMessage,
     SuccessResultMessage,
 )
+
 from .exceptions import (
     CannotConnect,
     ConnectionClosed,
@@ -50,8 +51,8 @@ def __init__(
         self.server_info: ServerInfoMessage | None = None
         self._aiohttp_session = aiohttp_session
         self._ws_client: ClientWebSocketResponse | None = None
-        self._nodes: Dict[int, MatterNode] = {}
-        self._result_futures: Dict[str, asyncio.Future] = {}
+        self._nodes: dict[int, MatterNode] = {}
+        self._result_futures: dict[str, asyncio.Future] = {}
         self._subscribers: dict[str, list[Callable[[EventType, Any], None]]] = {}
 
     @property

matter_server/client/models/device_types.py

@@ -8,9 +8,9 @@
 
 import typing
 
-from chip.clusters import Objects as all_clusters
+from chip.clusters import Objects as all_clusters  # noqa: N813
 
-ALL_TYPES: dict[int, type["DeviceType"]] = {}
+ALL_TYPES: dict[int, type[DeviceType]] = {}
 
 
 class DeviceType:

matter_server/client/models/node.py

@@ -16,6 +16,8 @@
 
 from .device_types import (
     ALL_TYPES as DEVICE_TYPES,
+)
+from .device_types import (
     Aggregator,
     BridgedDevice,
     DeviceType,
@@ -142,9 +144,7 @@ def has_attribute(
             # allow sending None for Cluster to auto resolve it from the Attribute
             cluster = attribute.cluster_id
         cluster_id = cluster if isinstance(cluster, int) else cluster.id
-        attribute_id = (
-            attribute if isinstance(attribute, int) else attribute.attribute_id
-        )
+        attribute_id = attribute if isinstance(attribute, int) else attribute.attribute_id
         # the fastest way to check this is just by checking the AttributePath in the raw data...
         attr_path = create_attribute_path(self.endpoint_id, cluster_id, attribute_id)
         return attr_path in self.node.node_data.attributes
@@ -165,12 +165,10 @@ def set_attribute_value(self, attribute_path: str, attribute_value: Any) -> None
             self.clusters[cluster_id] = cluster_instance
 
         # unpack cluster attribute, using the descriptor
-        attribute_class: Clusters.ClusterAttributeDescriptor = ALL_ATTRIBUTES[
-            cluster_id
-        ][attribute_id]
-        attribute_name, attribute_type = get_object_params(
-            cluster_class.descriptor, attribute_id
-        )
+        attribute_class: Clusters.ClusterAttributeDescriptor = ALL_ATTRIBUTES[cluster_id][
+            attribute_id
+        ]
+        attribute_name, attribute_type = get_object_params(cluster_class.descriptor, attribute_id)
 
         # we only set the value at cluster instance level and we leave
         # the underlying Attributes classproperty alone
@@ -251,20 +249,15 @@ def get_attribute_value(
         """Return Matter Cluster Attribute value for given parameters."""
         return self.endpoints[endpoint].get_attribute_value(cluster, attribute)
 
-    def has_cluster(
-        self, cluster: type[_CLUSTER_T] | int, endpoint: int | None = None
-    ) -> bool:
+    def has_cluster(self, cluster: type[_CLUSTER_T] | int, endpoint: int | None = None) -> bool:
         """Check if node has a specific cluster on any of the endpoints."""
         return any(
             x
             for x in self.endpoints.values()
-            if x.has_cluster(cluster)
-            and (endpoint is None or x.endpoint_id == endpoint)
+            if x.has_cluster(cluster) and (endpoint is None or x.endpoint_id == endpoint)
         )
 
-    def get_cluster(
-        self, endpoint: int, cluster: type[_CLUSTER_T] | int
-    ) -> _CLUSTER_T | None:
+    def get_cluster(self, endpoint: int, cluster: type[_CLUSTER_T] | int) -> _CLUSTER_T | None:
         """
         Get a Cluster object containing all attributes.
 
@@ -300,9 +293,7 @@ def update(self, node_data: MatterNodeData) -> None:
                     endpoint_id=endpoint_id, attributes_data=attributes_data, node=self
                 )
         # lookup if this is a bridge device
-        self._is_bridge_device = any(
-            Aggregator in x.device_types for x in self.endpoints.values()
-        )
+        self._is_bridge_device = any(Aggregator in x.device_types for x in self.endpoints.values())
         # composed devices reference to other endpoints through the partsList attribute
         # create a mapping table to quickly map this
         for endpoint in self.endpoints.values():

matter_server/common/errors.py

@@ -1,8 +1,6 @@
 """Matter Exceptions."""
 from __future__ import annotations
 
-from typing import Type
-
 # mapping from error_code to Exception class
 ERROR_MAP: dict[int, type] = {}
 
@@ -78,6 +76,6 @@ class InvalidCommand(MatterError):
     error_code = 9
 
 
-def exception_from_error_code(error_code: int) -> Type[MatterError]:
+def exception_from_error_code(error_code: int) -> type[MatterError]:
     """Return correct Exception class from error_code."""
     return ERROR_MAP.get(error_code, MatterError)

matter_server/common/helpers/api.py

@@ -1,9 +1,10 @@
 """Several helpers for the WebSockets API."""
 from __future__ import annotations
 
-from dataclasses import MISSING, dataclass
 import inspect
-from typing import Any, Callable, Coroutine, TypeVar, get_type_hints
+from collections.abc import Callable, Coroutine
+from dataclasses import MISSING, dataclass
+from typing import Any, TypeVar, get_type_hints
 
 from matter_server.common.helpers.util import parse_value
 
@@ -22,7 +23,7 @@ class APICommandHandler:
     @classmethod
     def parse(
         cls, command: str, func: Callable[..., Coroutine[Any, Any, Any]]
-    ) -> "APICommandHandler":
+    ) -> APICommandHandler:
         """Parse APICommandHandler by providing a function."""
         return APICommandHandler(
             command=command,
@@ -60,9 +61,6 @@ def parse_arguments(
     # parse arguments to correct type
     for name, param in func_sig.parameters.items():
         value = args.get(name)
-        if param.default is inspect.Parameter.empty:
-            default = MISSING
-        else:
-            default = param.default
+        default = MISSING if param.default is inspect.Parameter.empty else param.default
         final_args[name] = parse_value(name, value, func_types[name], default)
     return final_args