Hydro-Quebec-API-Wrapper 4.2.0__tar.gz → 4.2.1__tar.gz

{hydro_quebec_api_wrapper-4.2.0 → hydro_quebec_api_wrapper-4.2.1}/.pre-commit-config.yaml

@@ -47,7 +47,7 @@ repos:
     additional_dependencies:
       - "types-pytz==2025.2.0.20251108"
       - "types-PyYAML==6.0.12.20250915"
-      - "types-python-dateutil==2.9.0.20251108"
+      - "types-python-dateutil==2.9.0.20251115"
       - "pytest-stub==1.1.0"
       - "aiohttp==3.13.2"
       - "aiocache==0.12.3"

{hydro_quebec_api_wrapper-4.2.0 → hydro_quebec_api_wrapper-4.2.1}/Hydro_Quebec_API_Wrapper.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Hydro-Quebec-API-Wrapper
-Version: 4.2.0
+Version: 4.2.1
 Summary: A wrapper library to access hydro quebec API and more
 Home-page: https://hydroqc.ca
 Author-email: Hydroqc Team <info@hydroqc.ca>

{hydro_quebec_api_wrapper-4.2.0 → hydro_quebec_api_wrapper-4.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Hydro-Quebec-API-Wrapper
-Version: 4.2.0
+Version: 4.2.1
 Summary: A wrapper library to access hydro quebec API and more
 Home-page: https://hydroqc.ca
 Author-email: Hydroqc Team <info@hydroqc.ca>

{hydro_quebec_api_wrapper-4.2.0 → hydro_quebec_api_wrapper-4.2.1}/hydroqc/contract/contract_dpc.py

@@ -19,11 +19,13 @@ class WinterState(str, Enum):
 
 
 def check_dpc_data_present(
-    method: Callable[..., None | str | bool | float | date],
-) -> Callable[..., None | str | bool | float | date]:
+    method: Callable[..., None | str | bool | float | int | date | WinterState],
+) -> Callable[..., None | str | bool | float | int | date | WinterState]:
     """Check if contractDPC's data are present."""
 
-    def wrapper(contract: "ContractDPC") -> None | str | bool | float | date:
+    def wrapper(
+        contract: "ContractDPC",
+    ) -> None | str | bool | float | int | date | WinterState:
         if not hasattr(contract, "_dpc_data"):
             contract._logger.warning("You need to call get_dpc_data method first")
             return None
@@ -109,11 +111,17 @@ class ContractDPC(ContractResidential):
         return self._dpc_data
 
     def _get_dpc_field(self, field_name: str) -> str | float | int:
-        """Get DPC field from periodesHiver data."""
+        """Get DPC field from periodesHiver data.
+
+        Raises:
+            KeyError: If the required field is not present in the API response.
+        """
         winter_period = self._dpc_data["periodesHiver"][0]
-        if field_name in winter_period:
-            return winter_period[field_name]  # type: ignore
-        raise KeyError(f"Field {field_name} not found in DPC data")
+        if field_name not in winter_period:
+            raise KeyError(
+                f"Required field '{field_name}' not found in DPC periodesHiver data"
+            )
+        return winter_period[field_name]  # type: ignore
 
     @property
     @check_period_data_present
@@ -160,9 +168,15 @@ class ContractDPC(ContractResidential):
 
     @property
     @check_dpc_data_present
-    def amount_saved_vs_base_rate(self) -> float:
-        """Amount saved or not versus the base rate."""
-        return float(self._get_dpc_field("montantEconPerteVSTarifBase"))
+    def amount_saved_vs_base_rate(self) -> float | None:
+        """Amount saved or not versus the base rate.
+
+        Returns None if comparison data is not yet available (e.g., first year on Flex D).
+        """
+        try:
+            return float(self._get_dpc_field("montantEconPerteVSTarifBase"))
+        except KeyError:
+            return None
 
     @property
     @check_dpc_data_present

{hydro_quebec_api_wrapper-4.2.0 → hydro_quebec_api_wrapper-4.2.1}/hydroqc/types/consump.py

@@ -155,8 +155,12 @@ class ConsumpAnnualTyping(TypedDict, total=True):
     results: list[ConsumpAnnualResultsTyping]
 
 
-class DPCDataResultsTyping(TypedDict, total=True):
-    """FlexD data json sub output format."""
+class DPCDataResultsTyping(TypedDict, total=False):
+    """FlexD data json sub output format.
+
+    Note: montantEconPerteVSTarifBase may not be available in the first year of Flex D
+    as it requires comparison data from previous Rate D billing.
+    """
 
     dateDebut: str
     dateFin: str

{hydro_quebec_api_wrapper-4.2.0 → hydro_quebec_api_wrapper-4.2.1}/hydroqc/types/dpc.py

@@ -4,8 +4,12 @@
 from typing import TypedDict
 
 
-class DPCPeriodeHiverTyping(TypedDict, total=True):
-    """FlexD winter period data (API v3_0 format)."""
+class DPCPeriodeHiverTyping(TypedDict, total=False):
+    """FlexD winter period data (API v3_0 format).
+
+    Note: montantEconPerteVSTarifBase may not be available in the first year of Flex D
+    as it requires comparison data from previous Rate D billing.
+    """
 
     dateDebut: str
     dateFin: str

{hydro_quebec_api_wrapper-4.2.0 → hydro_quebec_api_wrapper-4.2.1}/hydroqc/types/dt.py

@@ -4,8 +4,12 @@
 from typing import TypedDict
 
 
-class DTDataResultsTyping(TypedDict, total=True):
-    """DT winter period data (legacy format)."""
+class DTDataResultsTyping(TypedDict, total=False):
+    """DT winter period data (legacy format).
+
+    Note: montantEconPerteVSTarifBase may not be available when comparison
+    data from previous billing is unavailable.
+    """
 
     dateDebut: str
     dateFin: str

{hydro_quebec_api_wrapper-4.2.0 → hydro_quebec_api_wrapper-4.2.1}/test_requirements.txt

@@ -1,14 +1,14 @@
 flake8==7.3.0
 pydocstyle==6.3.0
 parameterized==0.9.0
-pylint==4.0.2
-pytest==8.4.2
+pylint==4.0.3
+pytest==9.0.1
 pytest-cov==7.0.0
 pytest-asyncio==1.3.0
 black==25.11.0
 mypy==1.18.2
 types-pytz==2025.2.0.20251108
 types-PyYAML==6.0.12.20250915
-types-python-dateutil==2.9.0.20251108
+types-python-dateutil==2.9.0.20251115
 pyright==1.1.407
 lxml==6.0.2