chore: migrate from isort/black/pylint to ruff

Author: cryptk

.pre-commit-config.yaml

@@ -19,36 +19,39 @@ repos:
             -   id: trailing-whitespace
     -   repo: https://github.com/astral-sh/uv-pre-commit
         # uv version.
-        rev: 0.9.5
+        rev: 0.9.8
         hooks:
         - id: uv-lock
     -   repo: https://github.com/codespell-project/codespell
         rev: v2.4.1
         hooks:
             -   id: codespell
                 exclude: uv.lock
-    -   repo: https://github.com/charliermarsh/ruff-pre-commit
-        rev: v0.14.1
+    -   repo: https://github.com/astral-sh/ruff-pre-commit
+        # Ruff version
+        rev: v0.14.4
         hooks:
+            # Run the linter
             - id: ruff-check
               args: [ --fix ]
+            #  Run the formatter
             - id: ruff-format
-    -   repo: https://github.com/PyCQA/isort
-        rev: 7.0.0
-        hooks:
-            -   id: isort
-    -   repo: https://github.com/psf/black
-        rev: 25.9.0
-        hooks:
-            -   id: black
-    -   repo: local
-        hooks:
-            -   id: pylint
-                name: pylint
-                entry: uv run pylint
-                language: system
-                types: [python]
-                require_serial: true
+    # -   repo: https://github.com/PyCQA/isort  # Replacing isort with ruff
+    #     rev: 7.0.0
+    #     hooks:
+    #         -   id: isort
+    # -   repo: https://github.com/psf/black  # Replacing black with ruff
+    #     rev: 25.9.0
+    #     hooks:
+    #         -   id: black
+    # -   repo: local  # Replacing pylint with ruff
+    #     hooks:
+    #         -   id: pylint
+    #             name: pylint
+    #             entry: uv run pylint
+    #             language: system
+    #             types: [python]
+    #             require_serial: true
     -   repo: https://github.com/pre-commit/mirrors-mypy
         rev: v1.18.2
         hooks:

.vscode/extensions.json

@@ -1,8 +1,8 @@
 {
   "recommendations": [
       "ms-python.python",
-      "ms-python.black-formatter",
       "ms-python.mypy-type-checker",
-      "njpwerner.autodocstring"
+      "njpwerner.autodocstring",
+      "charliermarsh.ruff"
   ]
 }

.vscode/settings.json

@@ -11,7 +11,7 @@
   "mypy-type-checker.importStrategy": "fromEnvironment",
   "python.analysis.typeCheckingMode": "basic",
   "[python]": {
-    "editor.defaultFormatter": "ms-python.black-formatter",
+    "editor.defaultFormatter": "charliermarsh.ruff",
     "editor.formatOnSave": true
   }
 }

pyomnilogic_local/__init__.py

@@ -1,3 +1,5 @@
+"""PyOmniLogic-Local: A Python library for interacting with Hayward OmniLogic Local API."""
+
 from __future__ import annotations
 
 from .collections import EffectsCollection, LightEffectsCollection
@@ -12,9 +14,9 @@
 __all__ = [
     "EffectsCollection",
     "LightEffectsCollection",
+    "OmniConnectionError",
+    "OmniEquipmentNotInitializedError",
+    "OmniEquipmentNotReadyError",
     "OmniLogic",
     "OmniLogicLocalError",
-    "OmniEquipmentNotReadyError",
-    "OmniEquipmentNotInitializedError",
-    "OmniConnectionError",
 ]

pyomnilogic_local/_base.py

@@ -1,25 +1,22 @@
 from __future__ import annotations
 
 import logging
-from typing import TYPE_CHECKING, Generic, TypeVar, cast
+from typing import TYPE_CHECKING, cast
 
-from pyomnilogic_local.api.api import OmniLogicAPI
-from pyomnilogic_local.models import MSPEquipmentType, Telemetry
+from pyomnilogic_local.models import MSPEquipmentType
 from pyomnilogic_local.models.telemetry import TelemetryType
 from pyomnilogic_local.omnitypes import BackyardState
 
 if TYPE_CHECKING:
+    from pyomnilogic_local.api.api import OmniLogicAPI
+    from pyomnilogic_local.models import Telemetry
     from pyomnilogic_local.omnilogic import OmniLogic
 
-# Define type variables for generic equipment types
-MSPConfigT = TypeVar("MSPConfigT", bound=MSPEquipmentType)
-TelemetryT = TypeVar("TelemetryT", bound=TelemetryType | None)
-
 
 _LOGGER = logging.getLogger(__name__)
 
 
-class OmniEquipment(Generic[MSPConfigT, TelemetryT]):
+class OmniEquipment[MSPConfigT: MSPEquipmentType, TelemetryT: TelemetryType | None]:
     """Base class for all OmniLogic equipment.
 
     This is an abstract base class that provides common functionality for all equipment
@@ -77,7 +74,7 @@ def __init__(self, omni: OmniLogic, mspconfig: MSPConfigT, telemetry: Telemetry
     @property
     def _api(self) -> OmniLogicAPI:
         """Access the OmniLogic API through the parent controller."""
-        return self._omni._api  # pylint: disable=protected-access
+        return self._omni._api
 
     @property
     def bow_id(self) -> int | None:
@@ -113,13 +110,11 @@ def is_ready(self) -> bool:
         """
         # Check if backyard state allows equipment operations
         backyard_state = self._omni.backyard.telemetry.state
-        if backyard_state in (
+        return backyard_state not in (
             BackyardState.SERVICE_MODE,
             BackyardState.CONFIG_MODE,
             BackyardState.TIMED_SERVICE_MODE,
-        ):
-            return False
-        return True
+        )
 
     def update(self, mspconfig: MSPConfigT, telemetry: Telemetry | None) -> None:
         """Update both the configuration and telemetry data for the equipment."""
@@ -130,14 +125,17 @@ def update(self, mspconfig: MSPConfigT, telemetry: Telemetry | None) -> None:
         self._update_equipment(mspconfig, telemetry)
 
     def _update_equipment(self, mspconfig: MSPConfigT, telemetry: Telemetry | None) -> None:
-        """Hook to allow classes to trigger updates of sub-equipment."""
+        """Allow a class to trigger updates of sub-equipment.
+
+        This method can be overridden by subclasses to update any child equipment.
+        """
 
     def update_config(self, mspconfig: MSPConfigT) -> None:
         """Update the configuration data for the equipment."""
         try:
             # If the Equipment has subdevices, we don't store those as part of this device's config
             # They will get parsed and stored as their own equipment instances
-            self.mspconfig = cast(MSPConfigT, mspconfig.without_subdevices())
+            self.mspconfig = cast("MSPConfigT", mspconfig.without_subdevices())
         except AttributeError:
             self.mspconfig = mspconfig
 
@@ -148,9 +146,9 @@ def update_telemetry(self, telemetry: Telemetry) -> None:
         # Extract the specific telemetry for this equipment from the full telemetry object
         # Note: Some equipment (like sensors) don't have their own telemetry, so this may be None
         if (specific_telemetry := telemetry.get_telem_by_systemid(self.mspconfig.system_id)) is not None:
-            self.telemetry = cast(TelemetryT, specific_telemetry)
+            self.telemetry = cast("TelemetryT", specific_telemetry)
         else:
-            self.telemetry = cast(TelemetryT, None)
+            self.telemetry = cast("TelemetryT", None)
 
     def __repr__(self) -> str:
         """Return a string representation of the equipment for debugging.
@@ -162,8 +160,7 @@ def __repr__(self) -> str:
         parts = [f"system_id={self.system_id!r}", f"name={self.name!r}"]
 
         # Include state if the equipment has telemetry with a state attribute
-        if hasattr(self, "telemetry") and self.telemetry is not None:
-            if (state := getattr(self.telemetry, "state", None)) is not None:
-                parts.append(f"state={state!r}")
+        if (hasattr(self, "telemetry") and self.telemetry is not None) and ((state := getattr(self.telemetry, "state", None)) is not None):
+            parts.append(f"state={state!r}")
 
         return f"{class_name}({', '.join(parts)})"

pyomnilogic_local/api/__init__.py

@@ -1,3 +1,10 @@
+"""API module for interacting with Hayward OmniLogic pool controllers.
+
+This module provides the OmniLogicAPI class, which allows for local
+control and monitoring of Hayward OmniLogic and OmniHub pool controllers
+over a local network connection via the UDP XML API.
+"""
+
 from __future__ import annotations
 
 from .api import OmniLogicAPI

pyomnilogic_local/api/api.py

@@ -1,22 +1,19 @@
-# pylint: disable=too-many-positional-arguments
 from __future__ import annotations
 
 import asyncio
 import logging
 import xml.etree.ElementTree as ET
-from typing import Literal, overload
+from typing import TYPE_CHECKING, Literal, overload
 
 from pyomnilogic_local.models.filter_diagnostics import FilterDiagnostics
 from pyomnilogic_local.models.mspconfig import MSPConfig
 from pyomnilogic_local.models.telemetry import Telemetry
-
-from ..omnitypes import (
+from pyomnilogic_local.omnitypes import (
     ColorLogicBrightness,
     ColorLogicSpeed,
-    HeaterMode,
-    LightShows,
     MessageType,
 )
+
 from .constants import (
     DEFAULT_CONTROLLER_PORT,
     DEFAULT_RESPONSE_TIMEOUT,
@@ -27,9 +24,12 @@
     XML_ENCODING,
     XML_NAMESPACE,
 )
-from .exceptions import OmniValidationException
+from .exceptions import OmniValidationError
 from .protocol import OmniLogicProtocol
 
+if TYPE_CHECKING:
+    from pyomnilogic_local.omnitypes import HeaterMode, LightShows
+
 _LOGGER = logging.getLogger(__name__)
 
 
@@ -44,9 +44,11 @@ def _validate_temperature(temperature: int, param_name: str = "temperature") ->
         OmniValidationException: If temperature is out of range.
     """
     if not isinstance(temperature, int):
-        raise OmniValidationException(f"{param_name} must be an integer, got {type(temperature).__name__}")
+        msg = f"{param_name} must be an integer, got {type(temperature).__name__}"
+        raise OmniValidationError(msg)
     if not MIN_TEMPERATURE_F <= temperature <= MAX_TEMPERATURE_F:
-        raise OmniValidationException(f"{param_name} must be between {MIN_TEMPERATURE_F}°F and {MAX_TEMPERATURE_F}°F, got {temperature}°F")
+        msg = f"{param_name} must be between {MIN_TEMPERATURE_F}°F and {MAX_TEMPERATURE_F}°F, got {temperature}°F"
+        raise OmniValidationError(msg)
 
 
 def _validate_speed(speed: int, param_name: str = "speed") -> None:
@@ -60,9 +62,11 @@ def _validate_speed(speed: int, param_name: str = "speed") -> None:
         OmniValidationException: If speed is out of range.
     """
     if not isinstance(speed, int):
-        raise OmniValidationException(f"{param_name} must be an integer, got {type(speed).__name__}")
+        msg = f"{param_name} must be an integer, got {type(speed).__name__}"
+        raise OmniValidationError(msg)
     if not MIN_SPEED_PERCENT <= speed <= MAX_SPEED_PERCENT:
-        raise OmniValidationException(f"{param_name} must be between {MIN_SPEED_PERCENT} and {MAX_SPEED_PERCENT}, got {speed}")
+        msg = f"{param_name} must be between {MIN_SPEED_PERCENT} and {MAX_SPEED_PERCENT}, got {speed}"
+        raise OmniValidationError(msg)
 
 
 def _validate_id(id_value: int, param_name: str) -> None:
@@ -76,9 +80,11 @@ def _validate_id(id_value: int, param_name: str) -> None:
         OmniValidationException: If ID is invalid.
     """
     if not isinstance(id_value, int):
-        raise OmniValidationException(f"{param_name} must be an integer, got {type(id_value).__name__}")
+        msg = f"{param_name} must be an integer, got {type(id_value).__name__}"
+        raise OmniValidationError(msg)
     if id_value < 0:
-        raise OmniValidationException(f"{param_name} must be non-negative, got {id_value}")
+        msg = f"{param_name} must be non-negative, got {id_value}"
+        raise OmniValidationError(msg)
 
 
 class OmniLogicAPI:
@@ -96,11 +102,14 @@ def __init__(
             OmniValidationException: If parameters are invalid.
         """
         if not controller_ip:
-            raise OmniValidationException("controller_ip cannot be empty")
+            msg = "controller_ip cannot be empty"
+            raise OmniValidationError(msg)
         if not isinstance(controller_port, int) or controller_port <= 0 or controller_port > 65535:
-            raise OmniValidationException(f"controller_port must be between 1 and 65535, got {controller_port}")
+            msg = f"controller_port must be between 1 and 65535, got {controller_port}"
+            raise OmniValidationError(msg)
         if not isinstance(response_timeout, (int, float)) or response_timeout <= 0:
-            raise OmniValidationException(f"response_timeout must be positive, got {response_timeout}")
+            msg = f"response_timeout must be positive, got {response_timeout}"
+            raise OmniValidationError(msg)
 
         self.controller_ip = controller_ip
         self.controller_port = controller_port
@@ -179,6 +188,7 @@ async def async_get_filter_diagnostics(self, pool_id: int, equipment_id: int, ra
         Args:
             pool_id (int): The Pool/BodyOfWater ID that you want to address
             equipment_id (int): Which equipment_id within that Pool to address
+            raw (bool): Do not parse the response into a Pydantic model, just return the raw XML. Defaults to False.
 
         Returns:
             FilterDiagnostics|str: Either a parsed .models.mspconfig.FilterDiagnostics object or a str depending on arg raw
@@ -233,7 +243,7 @@ async def async_set_heater(
         equipment_id: int,
         temperature: int,
     ) -> None:
-        """Set the temperature for a heater on the Omni
+        """Set the temperature for a heater on the Omni.
 
         Args:
             pool_id (int): The Pool/BodyOfWater ID that you want to address
@@ -332,7 +342,7 @@ async def async_set_heater_enable(
         equipment_id: int,
         enabled: int | bool,
     ) -> None:
-        """async_set_heater_enable handles sending a SetHeaterEnable XML API call to the Hayward Omni pool controller
+        """Send a SetHeaterEnable XML API call to the Hayward Omni pool controller.
 
         Args:
             pool_id (int): The Pool/BodyOfWater ID that you want to address
@@ -381,11 +391,11 @@ async def async_set_equipment(
                 For Variable Speed Pumps, you can optionally provide an int from 0-100 to set the speed percentage with 0 being Off.
                 The interpretation of value depends on the piece of equipment being targeted.
             is_countdown_timer (bool, optional): For potential future use, included to be "API complete". Defaults to False.
-            startTimeHours (int, optional): For potential future use, included to be "API complete". Defaults to 0.
-            startTimeMinutes (int, optional): For potential future use, included to be "API complete". Defaults to 0.
-            endTimeHours (int, optional): For potential future use, included to be "API complete". Defaults to 0.
-            endTimeMinutes (int, optional): For potential future use, included to be "API complete". Defaults to 0.
-            daysActive (int, optional): For potential future use, included to be "API complete". Defaults to 0.
+            start_time_hours (int, optional): For potential future use, included to be "API complete". Defaults to 0.
+            start_time_minutes (int, optional): For potential future use, included to be "API complete". Defaults to 0.
+            end_time_hours (int, optional): For potential future use, included to be "API complete". Defaults to 0.
+            end_time_minutes (int, optional): For potential future use, included to be "API complete". Defaults to 0.
+            days_active (int, optional): For potential future use, included to be "API complete". Defaults to 0.
             recurring (bool, optional): For potential future use, included to be "API complete". Defaults to False.
         """
         body_element = ET.Element("Request", {"xmlns": XML_NAMESPACE})

pyomnilogic_local/api/exceptions.py

@@ -1,33 +1,33 @@
 from __future__ import annotations
 
 
-class OmniLogicException(Exception):
+class OmniLogicError(Exception):
     """Base exception for all OmniLogic errors."""
 
 
-class OmniProtocolException(OmniLogicException):
+class OmniProtocolError(OmniLogicError):
     """Protocol-level errors during communication with the OmniLogic controller."""
 
 
-class OmniTimeoutException(OmniProtocolException):
+class OmniTimeoutError(OmniProtocolError):
     """Timeout occurred while waiting for a response from the controller."""
 
 
-class OmniMessageFormatException(OmniProtocolException):
+class OmniMessageFormatError(OmniProtocolError):
     """Received a malformed or invalid message from the controller."""
 
 
-class OmniFragmentationException(OmniProtocolException):
+class OmniFragmentationError(OmniProtocolError):
     """Error occurred during message fragmentation or reassembly."""
 
 
-class OmniConnectionException(OmniLogicException):
+class OmniConnectionError(OmniLogicError):
     """Network connection error occurred."""
 
 
-class OmniValidationException(OmniLogicException):
+class OmniValidationError(OmniLogicError):
     """Invalid parameter or configuration value provided."""
 
 
-class OmniCommandException(OmniLogicException):
+class OmniCommandError(OmniLogicError):
     """Error occurred while executing a command on the controller."""