Add basic pre-commit checks (#197)

Author: ArturoGuerra

.gitignore

@@ -165,3 +165,6 @@ cython_debug/
 .DS_Store
 credentials/
 venv39/
+
+# ruff
+.ruff_cache/

.pre-commit-config.yaml

@@ -0,0 +1,50 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/psf/black
+    rev: 23.1.0
+    hooks:
+      - id: black
+        args:
+           - --quiet
+        files: ^(matter_server|scripts)/.+\.py$
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.2
+    hooks:
+      - id: codespell
+        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
+#        name: mypy
+#        entry: mypy
+#        types: [python]
+#        language: script
+#        files: ^(matter_server)/.+\.py$
+#        require_serial: true
+#      - id: pylint
+#        name: pylint
+#        entry: pylint -j 0
+#        types: [python]
+#        language: script
+#        files: ^(matter_server)/.+\.py$
+#        require_serial: true

README.md

@@ -39,7 +39,7 @@ The server runs a Matter Controller and includes all logic for storing node info
 
 ### Test devices
 
-Now that the Matter Specification is offically released in its 1.0 version, devices will be available in stores from 2023 that actually have Matter support or least manufacturers run a beta program which you can join to run Matter firmware on your device. Please refer to the documentation of your device if its already Matter enabled out of the box or you need to enable some special firmware(mode).
+Now that the Matter Specification is officially released in its 1.0 version, devices will be available in stores from 2023 that actually have Matter support or least manufacturers run a beta program which you can join to run Matter firmware on your device. Please refer to the documentation of your device if its already Matter enabled out of the box or you need to enable some special firmware(mode).
 
 Besides that it is possible to run Matter firmware on common microcontrollers such as the ESP32 and there is even a whole device emulator available which runs on a regular desktop OS. To make things easier we've prepared a [special page](https://nabucasa.github.io/matter-example-apps) where you can quickly try out running the Matter example apps on ESP32.
 
@@ -76,7 +76,7 @@ Inform the controller about the Thread credentials it needs to use when commissi
 
 **Commission with code**
 Commission a new device. For WiFi or Thread based devices, the credentials need to be set upfront, otherwise commisisoning will fail.
-The controller will use bluetooth for the commissioning of wireless devices. If the machine running the Python Matter Server controller lacks bluetooth support, comissioning will only work for devices already connected to the network (by cable or another controller).
+The controller will use bluetooth for the commissioning of wireless devices. If the machine running the Python Matter Server controller lacks bluetooth support, commissioning will only work for devices already connected to the network (by cable or another controller).
 
 ```
   {

matter_server/common/helpers/util.py

@@ -41,8 +41,8 @@
 
 try:
     # python 3.10
-    from types import NoneType, UnionType  # type: ignore[attr-defined]
-except:  # noqa
+    from types import NoneType, UnionType  # type:ignore[attr-defined]
+except ImportError:  # noqa
     # older python version
     NoneType = type(None)
     UnionType = type(Union)

matter_server/common/models/node.py

@@ -189,7 +189,7 @@ def _get_attr_value(attr_name: str) -> str:
             return attr_name[:1].lower() + attr_name[1:]
 
         # instantiate a Cluster object from the properties
-        # TODO: find another way to do this without loosing the individual cluster attributes
+        # TODO: find another way to do this without losing the individual cluster attributes
         # pylint: disable=import-outside-toplevel
         from ..helpers.util import dataclass_from_dict
 

matter_server/server/client_handler.py

@@ -42,7 +42,8 @@ class WebSocketLogAdapter(logging.LoggerAdapter):
 
     def process(self, msg: str, kwargs: Any) -> tuple[str, Any]:
         """Add connid to websocket log messages."""
-        return f'[{self.extra["connid"]}] {msg}', kwargs
+        assert self.extra is not None
+        return f"[{self.extra['connid']}] {msg}", kwargs
 
 
 class WebsocketClientHandler:

matter_server/server/device_controller.py

@@ -443,7 +443,7 @@ def _parse_attributes_from_read_result(
         result = {}
         for endpoint, cluster_dict in attributes.items():
             # read result output is in format {endpoint: {ClusterClass: {AttributeClass: value}}}
-            # we parse this to our own much more useable format
+            # we parse this to our own much more usable format
             for cluster_cls, attr_dict in cluster_dict.items():
                 for attr_cls, attr_value in attr_dict.items():
                     if attr_cls == Attribute.DataVersion: