🚧 Move to ruff and PySide6.

Author: DanielAtCosmicDNA

.gitignore

@@ -108,4 +108,4 @@ ENV/
 *.crt
 plover_websocket_server_config.json
 
-.pytest_cache/
+.pytest_cache/

.pre-commit-config.yaml

@@ -1,40 +1,36 @@
-# .pre-commit-config.yaml
-
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.2
+    rev: v3.20.0
     hooks:
-    -   id: pyupgrade
+      - id: pyupgrade
+
   - repo: https://github.com/MarcoGorelli/absolufy-imports
-    rev: v0.3.0
-    hooks:
-    - id: absolufy-imports
-  - repo: https://github.com/ambv/black
-    rev: 24.3.0
+    rev: v0.3.1
     hooks:
-      - id: black
-        language_version: python3.11
-  - repo: https://github.com/pycqa/flake8
-    rev: 7.0.0  # pick a git hash / tag to point to
-    hooks:
-      - id: flake8
+      - id: absolufy-imports
+
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
+        exclude: ^src/pattern_identifier\.egg-info/
       - id: end-of-file-fixer
+        exclude: ^src/pattern_identifier\.egg-info/
       - id: check-yaml
-  - repo: https://github.com/pycqa/isort
-    rev: 5.13.2
-    hooks:
-      - id: isort
-        args: ["--profile", "black"]
-        name: isort (python)
+
   - repo: https://github.com/PyCQA/bandit
-    rev: '1.7.8'
+    rev: "1.8.3"
+    hooks:
+      - id: bandit
+        args: ["--exclude", ".tox,.eggs,tests"]
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.11.13" # Use the latest version
     hooks:
-    - id: bandit
-      args: ["--exclude", ".tox,.eggs,tests"]
+      - id: ruff
+        args: ["--fix", "--exit-non-zero-on-fix"]
+      - id: ruff-format
+        # args: ["--check"] # Use --check in CI if you only want to verify
   - repo: local
     hooks:
       - id: pytest-check

plover_websocket_server/config.py

@@ -2,7 +2,8 @@
 
 from copy import deepcopy
 from json import dump, load
-from re import compile
+from pathlib import Path
+from re import compile as re_compile
 
 from nacl.encoding import HexEncoder
 from nacl.public import PrivateKey
@@ -19,6 +20,7 @@ class ServerConfig:
     Attributes:
         host: The host address for the server to run on.
         port: The port for the server to run on.
+
     """
 
     host: str
@@ -32,10 +34,11 @@ def __init__(self, file_path: str) -> None:
 
         Raises:
             IOError: Errored when loading the server configuration file.
-        """
 
+        """
+        file_path_obj = Path(file_path)
         try:
-            with open(file_path, encoding="utf-8") as config_file:
+            with file_path_obj.open(encoding="utf-8") as config_file:
                 data: dict = load(config_file)
         except FileNotFoundError:
             data = {}
@@ -78,16 +81,13 @@ def __init__(self, file_path: str) -> None:
         # Save the updated data to the config file
         if loaded_data != data:
             log.info("Saving the updated data to the config file...")
-            with open(file_path, "w", encoding="utf-8") as config_file:
+            with file_path_obj.open("w", encoding="utf-8") as config_file:
                 dump(data, config_file, indent=2)
 
         # Assign values to class attributes
         self.host = data["host"]
         self.port = data["port"]
-        self.remotes = [
-            compile(remote["pattern"]) if "pattern" in remote else remote
-            for remote in data["remotes"]
-        ]
-        self.ssl = data.get("ssl", None)
+        self.remotes = [re_compile(remote["pattern"]) if "pattern" in remote else remote for remote in data["remotes"]]
+        self.ssl = data.get("ssl")
         self.private_key = private_key
         self.public_key = public_key

plover_websocket_server/listens.py

@@ -1,4 +1,4 @@
-from asyncio import Task, create_task, gather
+from asyncio import create_task, gather
 from asyncio.futures import Future
 
 from plover import log
@@ -22,11 +22,13 @@ def stop_listening(self) -> None:
 
 class RawListens:
     def __get__(self, obj: Listens, objtype=None):
+        """Descriptor getter for accessing the status value."""
         value = obj._status
         # log.debug(f'Accessing status giving {value}')
         return value
 
     def __set__(self, obj: Listens, value):
+        """Descriptor setter for updating the status value and notifying listeners."""
         # log.debug(f'Updating status to {value}')
         obj._status = value
         if len(obj._listeners):

plover_websocket_server/manager.py

@@ -1,10 +1,9 @@
 """The middleman between Plover and the server."""
 
-import os
 from datetime import datetime
 from json import loads
 from operator import itemgetter
-from typing import List
+from pathlib import Path
 
 from aiohttp.web import WebSocketResponse
 from jsonpickle import encode
@@ -23,28 +22,25 @@
     ERROR_NO_SERVER,
     ERROR_SERVER_RUNNING,
 )
-from plover_websocket_server.server import EngineServer, ServerStatus
-from plover_websocket_server.websocket.server import WebSocketServer
+from plover_websocket_server.websocket.server import ServerStatus, WebSocketServer
 
 SERVER_CONFIG_FILE = "plover_websocket_server_config.json"
 
 
 class EngineServerManager:
     """Manages a server that exposes the Plover engine."""
 
-    _server: EngineServer
+    _server: WebSocketServer
     _tape_model: TapeModel
 
     def __init__(self, engine: StenoEngine, test_mode: bool = False) -> None:
         self._server = None
         self._engine: StenoEngine = engine
-        self._config_path: str = os.path.join(CONFIG_DIR, SERVER_CONFIG_FILE)
+        self._config_path = Path(CONFIG_DIR).joinpath(SERVER_CONFIG_FILE)
         if self.get_server_status() != ServerStatus.Stopped:
             raise AssertionError(ERROR_SERVER_RUNNING)
 
-        self._config = ServerConfig(
-            self._config_path
-        )  # reload the configuration when the server is restarted
+        self._config = ServerConfig(self._config_path)  # reload the configuration when the server is restarted
 
         self._server = WebSocketServer(
             self._config.host,
@@ -66,6 +62,7 @@ def start(self) -> None:
         Raises:
             AssertionError: The server failed to start.
             IOError: The server failed to start.
+
         """
         self._server.start()
 
@@ -78,8 +75,8 @@ def raw_stop(self) -> None:
 
         Raises:
             AssertionError: The server failed to stop.
-        """
 
+        """
         if self.get_server_status() != ServerStatus.Running:
             raise AssertionError(ERROR_NO_SERVER)
 
@@ -97,8 +94,8 @@ def stop(self) -> None:
 
         Raises:
             AssertionError: The server failed to stop.
-        """
 
+        """
         self.raw_stop()
         log.info("Joining server thread...")
         self._server.join()
@@ -116,8 +113,8 @@ def get_server_status(self) -> ServerStatus:
 
         Returns:
             The status of the server.
-        """
 
+        """
         return self._server.listened.status if self._server else ServerStatus.Stopped
 
     def join(self) -> None:
@@ -157,9 +154,7 @@ async def _on_message(self, data: dict) -> None:
                         from plover.steno import Stroke
                         from plover.translation import Translation, _mapping_to_macro
 
-                        stroke = Stroke(
-                            []
-                        )  # required, because otherwise Plover will try to merge the outlines together
+                        stroke = Stroke([])  # required, because otherwise Plover will try to merge the outlines together
                         # and the outline [] (instead of [Stroke([])]) can be merged to anything
                         macro = _mapping_to_macro(mapping, stroke)
                         if macro is not None:
@@ -181,7 +176,6 @@ async def _on_message(self, data: dict) -> None:
 
     def _connect_hooks(self):
         """Creates hooks into all of Plover's events."""
-
         if not self._engine:
             raise AssertionError(ERROR_MISSING_ENGINE)
 
@@ -194,7 +188,6 @@ def _connect_hooks(self):
 
     def _disconnect_hooks(self):
         """Removes hooks from all of Plover's events."""
-
         self._server.data.stop_listening()
         if not self._engine:
             raise AssertionError(ERROR_MISSING_ENGINE)
@@ -211,6 +204,7 @@ def _on_stroked(self, stroke: Stroke):
 
         Args:
             stroke: The stroke that was just performed.
+
         """
         stroke_json = encode(stroke, unpicklable=False)
         paper = self._tape_model._paper_format(stroke)
@@ -223,14 +217,14 @@ def _on_stroked(self, stroke: Stroke):
         }
         self._server.queue_message(data)
 
-    def _on_translated(self, old: List[_Action], new: List[_Action]):
+    def _on_translated(self, old: list[_Action], new: list[_Action]):
         """Broadcasts when a new translation occurs.
 
         Args:
             old: A list of the previous actions for the current translation.
             new: A list of the new actions for the current translation.
-        """
 
+        """
         old_json = encode(old, unpicklable=False)
         new_json = encode(new, unpicklable=False)
 
@@ -244,8 +238,8 @@ def _on_machine_state_changed(self, machine_type: str, machine_state: str):
             machine_type: The name of the active machine.
             machine_state: The new machine state. This should be one of the
                 state constants listed in plover.machine.base.
-        """
 
+        """
         data = {
             "machine_state_changed": {
                 "machine_type": machine_type,
@@ -259,8 +253,8 @@ def _on_output_changed(self, enabled: bool):
 
         Args:
             enabled: If the output is now enabled or not.
-        """
 
+        """
         data = {"output_changed": enabled}
         self._server.queue_message(data)
 
@@ -270,8 +264,8 @@ def _on_config_changed(self, config_update: Config):
         Args:
             config_update: An object containing the full configuration or a
                 part of the configuration that was updated.
-        """
 
+        """
         config_json = encode(config_update, unpicklable=False)
 
         data = {"config_changed": loads(config_json)}
@@ -282,8 +276,8 @@ def _on_dictionaries_loaded(self, dictionaries: StenoDictionaryCollection):
 
         Args:
             dictionaries: A collection of the dictionaries that loaded.
-        """
 
+        """
         data = {"dictionaries_loaded": "0"}
         self._server.queue_message(data)
 
@@ -292,8 +286,8 @@ def _on_send_string(self, text: str):
 
         Args:
             text: The string that was output.
-        """
 
+        """
         data = {"send_string": text}
         self._server.queue_message(data)
 
@@ -302,8 +296,8 @@ def _on_send_backspaces(self, count: int):
 
         Args:
             count: The number of backspaces that were output.
-        """
 
+        """
         data = {"send_backspaces": count}
         self._server.queue_message(data)
 
@@ -314,38 +308,33 @@ def _on_send_key_combination(self, combination: str):
             combination: A string representing a sequence of key combinations.
                 Keys are represented by their names based on the OS-specific
                 keyboard implementations in plover.oslayer.
-        """
 
+        """
         data = {"send_key_combination": combination}
         self._server.queue_message(data)
 
     def _on_add_translation(self):
         """Broadcasts when the add translation tool is opened via a command."""
-
         data = {"add_translation": True}
         self._server.queue_message(data)
 
     def _on_focus(self):
         """Broadcasts when the main window is focused via a command."""
-
         data = {"focus": True}
         self._server.queue_message(data)
 
     def _on_configure(self):
         """Broadcasts when the configuration tool is opened via a command."""
-
         data = {"configure": True}
         self._server.queue_message(data)
 
     def _on_lookup(self):
         """Broadcasts when the lookup tool is opened via a command."""
-
         data = {"lookup": True}
         self._server.queue_message(data)
 
     def _on_suggestions(self):
         """Broadcasts when the suggestions tool is opened via a command."""
-
         data = {"suggestions": True}
         self._server.queue_message(data)
 
@@ -354,6 +343,5 @@ def _on_quit(self):
 
         Can be either a full quit or a restart.
         """
-
         data = {"quit": True}
         self._server.queue_message(data)