Switch to ruff in tests and precommit (#786)

.pre-commit-config.yaml

@@ -1,4 +1,10 @@
 repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.292
+    hooks:
+      - id: ruff
+        files: ^(scripts|test|zwave_js_server)/.+\.py$
+        args: [--fix, --exit-non-zero-on-fix]
   - repo: https://github.com/psf/black-pre-commit-mirror
     rev: 23.9.1
     hooks:
@@ -17,11 +23,6 @@ repos:
     hooks:
       - id: pydocstyle
         files: ^(zwave_js_server|test)/.+\.py$
-  - repo: https://github.com/pycqa/flake8
-    rev: 6.1.0
-    hooks:
-      - id: flake8
-        files: ^((zwave_js_server|test)/.+)?[^/]+\.py$
   - repo: local
     hooks:
       - id: mypy
@@ -33,7 +34,7 @@ repos:
         files: ^(zwave_js_server)/.+\.py$
       - id: pylint
         name: pylint
-        entry: scripts/run-in-env.sh pylint -j 0 --ignore-missing-annotations=y
+        entry: scripts/run-in-env.sh pylint -j 0
         language: script
         types: [python]
         files: ^zwave_js_server/.+\.py$

pyproject.toml

@@ -0,0 +1,50 @@
+[tool.ruff]
+select = [
+    "D",
+    "E",
+    "F",
+    "G",
+    "I",
+    "PLC",
+    "PLE",
+    "PLR",
+    "PLW",
+    "UP",
+    "W",
+]
+ignore = [
+    "D202",
+    "D212",
+    "D203",
+    "D213",
+    "E501",
+    "PLR0911", # Too many return statements ({returns} > {max_returns})
+    "PLR0912", # Too many branches ({branches} > {max_branches})
+    "PLR0913", # Too many arguments to function call ({c_args} > {max_args})
+    "PLR0915", # Too many statements ({statements} > {max_statements})
+    "PLR2004",  # Magic value used in comparison, consider replacing {value} with a constant variable
+    "PLW2901", # Outer {outer_kind} variable {name} overwritten by inner {inner_kind} target
+    "UP006", # keep type annotation style as is
+    "UP007", # keep type annotation style as is
+]
+exclude = [
+    ".venv",
+    ".git",
+    ".tox",
+    "docs",
+    "venv",
+    "bin",
+    "lib",
+    "deps",
+    "build",
+]
+line-length = 88
+
+[tool.ruff.isort]
+force-sort-within-sections = true
+known-first-party = [
+    "zwave_js_server",
+]
+combine-as-imports = true
+split-on-trailing-comma = false
+case-sensitive = true

requirements_lint.txt

@@ -1,7 +1,6 @@
 black==23.9.1
-flake8==6.1.0
 mypy==1.5.1
-pydocstyle==6.3.0
 pylint==3.0.1
 pylint-strict-informational==0.1
 pre-commit==3.5.0
+ruff==0.0.292

scripts/generate_multilevel_sensor_constants.py

@@ -2,12 +2,13 @@
 """Script to generate Multilevel Sensor CC constants."""
 from __future__ import annotations
 
+from collections import defaultdict
+from collections.abc import Callable, Mapping
 import json
 import pathlib
 import re
 import subprocess
-from collections import defaultdict
-from collections.abc import Callable, Mapping
+import sys
 
 import requests
 from slugify import slugify
@@ -271,7 +272,7 @@ def generate_int_enum_base_class(class_name: str, docstring: str) -> list[str]:
         is not None
     ):
         print("Repo is dirty and needs to be committed!")
-        exit(1)
+        sys.exit(1)
 else:
     print(
         "Could not run `git diff --stat` on repo, please run it to determine whether "

scripts/generate_notification_constants.py

@@ -2,11 +2,12 @@
 """Script to generate Notification CC constants."""
 from __future__ import annotations
 
+from collections.abc import Callable, Mapping
 import json
 import pathlib
 import re
 import subprocess
-from collections.abc import Callable, Mapping
+import sys
 
 import requests
 from slugify import slugify
@@ -308,7 +309,7 @@ def generate_int_enum_base_class(class_name: str, docstring: str) -> list[str]:
         is not None
     ):
         print("Repo is dirty and needs to be committed!")
-        exit(1)
+        sys.exit(1)
 else:
     print(
         "Could not run `git diff --stat` on repo, please run it to determine whether "

scripts/run_mock_server.py

@@ -3,10 +3,10 @@
 
 import argparse
 import asyncio
-import json
-import logging
 from collections import defaultdict
 from collections.abc import Hashable
+import json
+import logging
 from typing import Any
 
 from aiohttp import WSMsgType, web, web_request
@@ -28,12 +28,15 @@ class HashableDict(dict):
     """Dictionary that can be used as a key in a dictionary."""
 
     def __key(self) -> tuple:
+        """Return key representation of HashableDict."""
         return tuple((k, self[k]) for k in sorted(self))
 
     def __hash__(self) -> int:  # type: ignore
+        """Return hash representation of HashableDict."""
         return hash(self.__key())
 
     def __eq__(self, other: Any) -> bool:
+        """Return whether HashableDict is equal to other."""
         # pylint: disable=protected-access
         return isinstance(other, HashableDict) and self.__key() == other.__key()
 
@@ -292,14 +295,14 @@ def main() -> None:
     """Run main entrypoint."""
     args = get_args()
 
-    with open(args.network_state_path, "r", encoding="utf8") as fp:
+    with open(args.network_state_path, encoding="utf8") as fp:
         network_state_dump: list[dict] = json.load(fp)
 
     events_to_replay = []
     command_results: defaultdict[HashableDict, list] = defaultdict(list)
 
     if args.combined_replay_dump_path:
-        with open(args.combined_replay_dump_path, "r", encoding="utf8") as fp:
+        with open(args.combined_replay_dump_path, encoding="utf8") as fp:
             records: list[dict] = json.load(fp)
 
             for record in records:
@@ -313,7 +316,7 @@ def main() -> None:
                     add_command_result(command_results, record)
 
     if args.events_to_replay_path:
-        with open(args.events_to_replay_path, "r", encoding="utf8") as fp:
+        with open(args.events_to_replay_path, encoding="utf8") as fp:
             records = json.load(fp)
             if (
                 bad_record := next(
@@ -331,7 +334,7 @@ def main() -> None:
             events_to_replay.extend([record["event_msg"] for record in records])
 
     if args.command_results_path:
-        with open(args.command_results_path, "r", encoding="utf8") as fp:
+        with open(args.command_results_path, encoding="utf8") as fp:
             records = json.load(fp)
             if (
                 bad_record := next(

setup.cfg

@@ -1,26 +1,3 @@
-[flake8]
-exclude = .venv,.git,.tox,docs,venv,bin,lib,deps,build
-# To work with Black
-max-line-length = 88
-# E501: line too long
-# W503: Line break occurred before a binary operator
-# E203: Whitespace before ':'
-# D202 No blank lines allowed after function docstring
-# W504 line break after binary operator
-ignore =
-    E501,
-    W503,
-    E203,
-    D202,
-    W504
-
-[isort]
-multi_line_output = 3
-include_trailing_comma = True
-force_grid_wrap = 0
-use_parentheses = True
-line_length = 88
-
 [mypy]
 plugins = pydantic.mypy
 follow_imports = skip
@@ -39,8 +16,5 @@ warn_unused_configs = true
 [mypy-test.*,]
 ignore_errors = true
 
-[pydocstyle]
-add-ignore = D202
-
 [tool:pytest]
 asyncio_mode = auto

test/conftest.py

@@ -1,13 +1,13 @@
 """Provide common pytest fixtures."""
 import asyncio
-import json
 from collections import deque
 from copy import deepcopy
+import json
 from unittest.mock import AsyncMock, Mock, patch
 
-import pytest
 from aiohttp import ClientSession, ClientWebSocketResponse
 from aiohttp.http_websocket import WSMessage, WSMsgType
+import pytest
 
 from zwave_js_server.client import Client
 from zwave_js_server.model.controller import Controller

test/model/test_controller.py

@@ -1,6 +1,6 @@
 """Test the controller model."""
-import json
 from copy import deepcopy
+import json
 from unittest.mock import patch
 
 import pytest
@@ -21,8 +21,10 @@
 )
 from zwave_js_server.event import Event
 from zwave_js_server.exceptions import RepeaterRssiErrorReceived, RssiErrorReceived
-from zwave_js_server.model import association as association_pkg
-from zwave_js_server.model import controller as controller_pkg
+from zwave_js_server.model import (
+    association as association_pkg,
+    controller as controller_pkg,
+)
 from zwave_js_server.model.controller.firmware import ControllerFirmwareUpdateStatus
 from zwave_js_server.model.controller.rebuild_routes import (
     RebuildRoutesOptions,
@@ -183,7 +185,7 @@ def test_controller_mods():
 
 
 def test_controller_status():
-    """ "Test controller status functionality."""
+    """Test controller status functionality."""
     state = json.loads(load_fixture("basic_dump.txt").split("\n")[0])["result"]["state"]
     state["controller"]["status"] = 0
 
@@ -425,7 +427,8 @@ async def test_begin_inclusion_errors(controller, uuid4, mock_command):
             InclusionStrategy.SECURITY_S0, dsk="test"
         )
 
-    # Test that Security S2 Inclusion Strategy doesn't support providing `force_security`
+    # Test that Security S2 Inclusion Strategy doesn't support providing
+    # `force_security`
     with pytest.raises(ValueError):
         await controller.async_begin_inclusion(
             InclusionStrategy.SECURITY_S2, force_security=True
@@ -1845,7 +1848,8 @@ async def test_get_available_firmware_updates(multisensor_6, uuid4, mock_command
         {"command": "controller.get_available_firmware_updates"},
         {"updates": [FIRMWARE_UPDATE_INFO]},
     )
-    updates = await multisensor_6.client.driver.controller.async_get_available_firmware_updates(
+    controller = multisensor_6.client.driver.controller
+    updates = await controller.async_get_available_firmware_updates(
         multisensor_6, "test"
     )
     assert len(updates) == 1

test/model/test_driver.py

@@ -5,9 +5,11 @@
 
 from zwave_js_server.const import LogLevel
 from zwave_js_server.event import Event
-from zwave_js_server.model import driver as driver_pkg
-from zwave_js_server.model import log_config as log_config_pkg
-from zwave_js_server.model import log_message as log_message_pkg
+from zwave_js_server.model import (
+    driver as driver_pkg,
+    log_config as log_config_pkg,
+    log_message as log_message_pkg,
+)
 
 from .. import load_fixture
 

test/model/test_node.py

@@ -1,8 +1,8 @@
 """Test the node model."""
 import asyncio
-import json
 from copy import deepcopy
 from datetime import datetime, timezone
+import json
 from typing import Any
 from unittest.mock import AsyncMock, patch
 
@@ -34,8 +34,7 @@
     RssiErrorReceived,
     UnwriteableValue,
 )
-from zwave_js_server.model import endpoint as endpoint_pkg
-from zwave_js_server.model import node as node_pkg
+from zwave_js_server.model import endpoint as endpoint_pkg, node as node_pkg
 from zwave_js_server.model.node.firmware import (
     NodeFirmwareUpdateInfo,
     NodeFirmwareUpdateStatus,
@@ -183,7 +182,7 @@ def test_from_state(client):
 
 
 async def test_highest_security_value(lock_schlage_be469, ring_keypad):
-    """Test the highest_security_class property"""
+    """Test the highest_security_class property."""
     assert lock_schlage_be469.highest_security_class == SecurityClass.S0_LEGACY
     assert ring_keypad.highest_security_class is None
 
@@ -238,7 +237,8 @@ async def test_device_config(
         "controller being inoperable or otherwise unavailable.)"
     )
     assert device_config.metadata.manual == (
-        "https://products.z-wavealliance.org/ProductManual/File?folder=&filename=MarketCertificationFiles/2479/ZP3111-5_R2_20170316.pdf"
+        "https://products.z-wavealliance.org/ProductManual/File?folder=&filename="
+        "MarketCertificationFiles/2479/ZP3111-5_R2_20170316.pdf"
     )
     assert device_config.metadata.wakeup is None
     assert device_config.metadata.comments == [{"level": "info", "text": "test"}]

test/test_client.py

@@ -1,13 +1,13 @@
 """Test the client."""
 import asyncio
-import logging
 from datetime import datetime
+import logging
 from unittest.mock import Mock, patch
 
-import pytest
 from aiohttp.client_exceptions import ClientError, WSServerHandshakeError
 from aiohttp.client_reqrep import ClientResponse, RequestInfo
 from aiohttp.http_websocket import WSMsgType
+import pytest
 
 from zwave_js_server.client import LOGGER, Client
 from zwave_js_server.const import MAX_SERVER_SCHEMA_VERSION, LogLevel, __version__

test/test_version.py

@@ -23,7 +23,7 @@ async def test_get_server_version(client_session, ws_client, url, version_data):
 async def test_missing_server_schema_version(
     client_session, ws_client, url, version_data
 ):
-    """test missing schema version processed as schema version 0."""
+    """Test missing schema version processed as schema version 0."""
     del version_data["minSchemaVersion"]
     del version_data["maxSchemaVersion"]
     ws_client.receive_json.return_value = version_data

tox.ini

@@ -18,9 +18,8 @@ basepython = python3
 ignore_errors = True
 commands =
   black --check ./
-  flake8 zwave_js_server test
+  ruff check zwave_js_server scripts test
   pylint zwave_js_server
-  pydocstyle zwave_js_server test
 deps =
   -rrequirements.txt
   -rrequirements_lint.txt