python-omnilogic-local 0.25.2__tar.gz → 0.27.0__tar.gz

{python_omnilogic_local-0.25.2 → python_omnilogic_local-0.27.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-omnilogic-local
-Version: 0.25.2
+Version: 0.27.0
 Summary: A library for local control of Hayward OmniHub/OmniLogic pool controllers using their local API
 Author: Chris Jowett, djtimca, garionphx
 Author-email: Chris Jowett <421501+cryptk@users.noreply.github.com>

python_omnilogic_local-0.27.0/pyomnilogic_local/api/mock_api.py

@@ -0,0 +1,124 @@
+"""Mock API for simulation mode — loads data from a local JSON file instead of a live controller."""
+
+from __future__ import annotations
+
+import json
+import logging
+from pathlib import Path
+from typing import Any, Literal, TypedDict, overload
+
+from pyomnilogic_local.models.mspconfig import MSPConfig
+from pyomnilogic_local.models.telemetry import Telemetry
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class SimData(TypedDict):
+    telemetry: str
+    msp_config: str
+    filepath: str
+
+
+class OmniLogicMockAPI:
+    """Drop-in replacement for OmniLogicAPI that serves pre-recorded data from one or more JSON files.
+
+    Each JSON file must contain the simulation data at the paths:
+        - ``.data.telemetry``  — raw XML telemetry string
+        - ``.data.msp_config`` — raw XML MSP config string
+
+    When multiple files are provided the class maintains a round-robin pointer into the
+    list.  Whether the pointer advances after each call is controlled by two attributes:
+
+    - ``increment_on_mspconfig`` (default ``False``) — advance after ``async_get_mspconfig``
+    - ``increment_on_telemetry`` (default ``True``)  — advance after ``async_get_telemetry``
+
+    Any API call other than ``async_get_telemetry`` or ``async_get_mspconfig`` is silently
+    absorbed and logged at INFO level; no network traffic is generated.
+    """
+
+    def __init__(self, filepath: str) -> None:
+        """Load simulation data from *filepath*.
+
+        Args:
+            filepath: Comma-separated path(s) to JSON simulation data file(s).
+                A single path with no commas is treated as a one-element list.
+
+        Raises:
+            FileNotFoundError: If any file does not exist.
+            KeyError: If the expected JSON structure is not present in a file.
+        """
+        paths = filepath.split(",")
+
+        self._sim_data: list[SimData] = []
+        for fp in paths:
+            path = Path(fp)
+            if not path.exists():
+                msg = f"Simulation data file not found: {fp}"
+                raise FileNotFoundError(msg)
+            data = json.loads(path.read_text(encoding="utf-8"))
+            data["data"]["filepath"] = fp
+            self._sim_data.append(data["data"])
+
+        self._index = 0
+        self.increment_on_mspconfig = False
+        self.increment_on_telemetry = True
+
+        _LOGGER.warning(
+            "Running in simulation mode using data from %s. No API calls will be made to the OmniLogic controller.",
+            paths,
+        )
+
+    @overload
+    async def async_get_mspconfig(self, raw: Literal[True]) -> str: ...
+    @overload
+    async def async_get_mspconfig(self, raw: Literal[False]) -> MSPConfig: ...
+    @overload
+    async def async_get_mspconfig(self) -> MSPConfig: ...
+    async def async_get_mspconfig(self, raw: bool = False) -> MSPConfig | str:
+        """Return the pre-loaded MSP config from the current simulation file."""
+        data = self._sim_data[self._index]
+        if self.increment_on_mspconfig:
+            _LOGGER.debug(
+                "Advancing simulation file index from %s to %s, filepath: %s",
+                self._index,
+                (self._index + 1) % len(self._sim_data),
+                data["filepath"],
+            )
+            self._index = (self._index + 1) % len(self._sim_data)
+        if raw:
+            return data["msp_config"]
+        return MSPConfig.load_xml(data["msp_config"])
+
+    @overload
+    async def async_get_telemetry(self, raw: Literal[True]) -> str: ...
+    @overload
+    async def async_get_telemetry(self, raw: Literal[False]) -> Telemetry: ...
+    @overload
+    async def async_get_telemetry(self) -> Telemetry: ...
+    async def async_get_telemetry(self, raw: bool = False) -> Telemetry | str:
+        """Return the pre-loaded telemetry from the current simulation file."""
+        data = self._sim_data[self._index]
+        if self.increment_on_telemetry:
+            _LOGGER.debug(
+                "Advancing simulation file index from %s to %s, filepath: %s",
+                self._index,
+                (self._index + 1) % len(self._sim_data),
+                data["filepath"],
+            )
+            self._index = (self._index + 1) % len(self._sim_data)
+        if raw:
+            return data["telemetry"]
+        return Telemetry.load_xml(data["telemetry"])
+
+    def __getattr__(self, name: str) -> Any:
+        """Return a no-op async callable for any API method not explicitly implemented."""
+
+        async def _noop(*args: Any, **kwargs: Any) -> None:
+            _LOGGER.info(
+                "Simulation mode: ignoring call to %s (args=%s, kwargs=%s)",
+                name,
+                args,
+                kwargs,
+            )
+
+        return _noop

{python_omnilogic_local-0.25.2 → python_omnilogic_local-0.27.0}/pyomnilogic_local/models/filter_diagnostics.py

@@ -1,8 +1,10 @@
 from __future__ import annotations
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field, PrivateAttr, ValidationError
 from xmltodict import parse as xml_parse
 
+from pyomnilogic_local.models.exceptions import OmniParsingError
+
 # Example Filter Diagnostics XML:
 #
 # <?xml version="1.0" encoding="UTF-8" ?>
@@ -46,6 +48,7 @@ class FilterDiagnosticsParameters(BaseModel):
 
 class FilterDiagnostics(BaseModel):
     model_config = ConfigDict(from_attributes=True)
+    _raw: str = PrivateAttr(default="")
 
     name: str = Field(alias="Name")
     parameters: list[FilterDiagnosticsParameter] = Field(alias="Parameters")
@@ -64,4 +67,11 @@ class FilterDiagnostics(BaseModel):
         # The XML nests the Parameter entries under a Parameters entry, this is annoying to work with.  Here we are adjusting the data to
         # remove that extra level in the data
         data["Response"]["Parameters"] = data["Response"]["Parameters"]["Parameter"]
-        return FilterDiagnostics.model_validate(data["Response"])
+        try:
+            instance = FilterDiagnostics.model_validate(data["Response"])
+            instance._raw = xml
+        except ValidationError as exc:
+            msg = f"Failed to parse Filter Diagnostics: {exc}"
+            raise OmniParsingError(msg) from exc
+        else:
+            return instance

{python_omnilogic_local-0.25.2 → python_omnilogic_local-0.27.0}/pyomnilogic_local/models/leadmessage.py

@@ -40,4 +40,4 @@ class LeadMessage(BaseModel):
                 if name := param.get("name"):
                     result[name] = int(param.text) if param.text else 0
             return result
-        return data
+        return data  # type: ignore[no-any-return]

{python_omnilogic_local-0.25.2 → python_omnilogic_local-0.27.0}/pyomnilogic_local/models/mspconfig.py

@@ -9,6 +9,7 @@ from pydantic import (
     BaseModel,
     ConfigDict,
     Field,
+    PrivateAttr,
     ValidationError,
     computed_field,
     model_validator,
@@ -410,6 +411,7 @@ type MSPConfigType = MSPSystem | MSPEquipmentType
 
 class MSPConfig(BaseModel):
     model_config = ConfigDict(from_attributes=True)
+    _raw: str = PrivateAttr(default="")
 
     system: MSPSystem = Field(alias="System")
     backyard: MSPBackyard = Field(alias="Backyard")
@@ -459,7 +461,10 @@ class MSPConfig(BaseModel):
             ),
         )
         try:
-            return MSPConfig.model_validate(data["MSPConfig"], from_attributes=True)
+            instance = MSPConfig.model_validate(data["MSPConfig"], from_attributes=True)
+            instance._raw = xml
         except ValidationError as exc:
             msg = f"Failed to parse MSP Configuration: {exc}"
             raise OmniParsingError(msg) from exc
+        else:
+            return instance

{python_omnilogic_local-0.25.2 → python_omnilogic_local-0.27.0}/pyomnilogic_local/models/telemetry.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 
 from typing import Any, SupportsInt, cast, overload
 
-from pydantic import BaseModel, ConfigDict, Field, ValidationError, computed_field
+from pydantic import BaseModel, ConfigDict, Field, PrivateAttr, ValidationError, computed_field
 from xmltodict import parse as xml_parse
 
 from pyomnilogic_local.omnitypes import (
@@ -492,6 +492,7 @@ class Telemetry(BaseModel):
     """
 
     model_config = ConfigDict(from_attributes=True)
+    _raw: str = PrivateAttr(default="")
 
     version: str = Field(alias="@version")
     backyard: TelemetryBackyard = Field(alias="Backyard")
@@ -525,7 +526,7 @@ class Telemetry(BaseModel):
 
             try:
                 newvalue = int(value)
-            except (ValueError, TypeError):
+            except ValueError, TypeError:
                 newvalue = value
 
             return key, newvalue
@@ -552,10 +553,13 @@ class Telemetry(BaseModel):
             ),
         )
         try:
-            return Telemetry.model_validate(data["STATUS"])
+            instance = Telemetry.model_validate(data["STATUS"])
+            instance._raw = xml
         except ValidationError as exc:
             msg = f"Failed to parse Telemetry: {exc}"
             raise OmniParsingError(msg) from exc
+        else:
+            return instance
 
     def get_telem_by_systemid(self, system_id: int) -> TelemetryType | None:
         for field_name, value in self:

{python_omnilogic_local-0.25.2 → python_omnilogic_local-0.27.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-omnilogic-local"
-version = "0.25.2"
+version = "0.27.0"
 description = "A library for local control of Hayward OmniHub/OmniLogic pool controllers using their local API"
 readme = "README.md"
 requires-python = ">=3.14.2"
@@ -43,14 +43,9 @@ dev = [
 
 [tool.mypy]
 python_version = "3.14"
-plugins = [
-    "pydantic.mypy"
-]
-# follow_imports = "silent"
+plugins = ["pydantic.mypy"]
+follow_imports = "normal"
 strict = true
-ignore_missing_imports = true
-disallow_subclassing_any = false
-warn_return_any = false
 
 [tool.ruff]
 line-length = 140

python_omnilogic_local-0.25.2/pyomnilogic_local/api/mock_api.py

@@ -1,88 +0,0 @@
-"""Mock API for simulation mode — loads data from a local JSON file instead of a live controller."""
-
-from __future__ import annotations
-
-import json
-import logging
-from pathlib import Path
-from typing import Any, Literal, overload
-
-from pyomnilogic_local.models.mspconfig import MSPConfig
-from pyomnilogic_local.models.telemetry import Telemetry
-
-_LOGGER = logging.getLogger(__name__)
-
-
-class OmniLogicMockAPI:
-    """Drop-in replacement for OmniLogicAPI that serves pre-recorded data from a JSON file.
-
-    The JSON file must contain the simulation data at the paths:
-        - ``.data.telemetry``  — raw XML telemetry string
-        - ``.data.msp_config`` — raw XML MSP config string
-
-    Any API call other than ``async_get_telemetry`` or ``async_get_mspconfig`` is silently
-    absorbed and logged at INFO level; no network traffic is generated.
-    """
-
-    def __init__(self, filepath: str) -> None:
-        """Load simulation data from *filepath*.
-
-        Args:
-            filepath: Path to the JSON simulation data file.
-
-        Raises:
-            FileNotFoundError: If the file does not exist at *filepath*.
-            KeyError: If the expected JSON structure is not present in the file.
-        """
-        path = Path(filepath)
-        if not path.exists():
-            msg = f"Simulation data file not found: {filepath}"
-            raise FileNotFoundError(msg)
-
-        data = json.loads(path.read_text(encoding="utf-8"))
-        sim_data: dict[str, Any] = data["data"]
-
-        self._mspconfig = sim_data["msp_config"]
-        self._telemetry = sim_data["telemetry"]
-
-        _LOGGER.warning(
-            "Running in simulation mode using data from '%s'. No API calls will be made to the OmniLogic controller.",
-            filepath,
-        )
-
-    @overload
-    async def async_get_mspconfig(self, raw: Literal[True]) -> str: ...
-    @overload
-    async def async_get_mspconfig(self, raw: Literal[False]) -> MSPConfig: ...
-    @overload
-    async def async_get_mspconfig(self) -> MSPConfig: ...
-    async def async_get_mspconfig(self, raw: bool = False) -> MSPConfig | str:
-        """Return the pre-loaded MSP config from the simulation file."""
-        if raw:
-            return self._mspconfig
-        return MSPConfig.load_xml(self._mspconfig)
-
-    @overload
-    async def async_get_telemetry(self, raw: Literal[True]) -> str: ...
-    @overload
-    async def async_get_telemetry(self, raw: Literal[False]) -> Telemetry: ...
-    @overload
-    async def async_get_telemetry(self) -> Telemetry: ...
-    async def async_get_telemetry(self, raw: bool = False) -> Telemetry | str:
-        """Return the pre-loaded telemetry from the simulation file."""
-        if raw:
-            return self._telemetry
-        return Telemetry.load_xml(self._telemetry)
-
-    def __getattr__(self, name: str) -> Any:
-        """Return a no-op async callable for any API method not explicitly implemented."""
-
-        async def _noop(*args: Any, **kwargs: Any) -> None:
-            _LOGGER.info(
-                "Simulation mode: ignoring call to %s (args=%s, kwargs=%s)",
-                name,
-                args,
-                kwargs,
-            )
-
-        return _noop