Hydro-Quebec-API-Wrapper 4.2.0__py3-none-any.whl → 4.2.2__py3-none-any.whl

{hydro_quebec_api_wrapper-4.2.0.dist-info → hydro_quebec_api_wrapper-4.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Hydro-Quebec-API-Wrapper
-Version: 4.2.0
+Version: 4.2.2
 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.dist-info → hydro_quebec_api_wrapper-4.2.2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-hydro_quebec_api_wrapper-4.2.0.dist-info/licenses/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
+hydro_quebec_api_wrapper-4.2.2.dist-info/licenses/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
 hydroqc/__init__.py,sha256=sFhCh7-LWoISCQuAtdrLQOmj2x5wjHBGbAAPg4SN6Pc,40
 hydroqc/account.py,sha256=84PO2npB_VG8cEzGIbmXj9sD1whG8qynkiGd-yEYddM,3375
 hydroqc/consts.py,sha256=a9dWq5i6t5VedYosUbP8zIuG2q5TPw4ruT0jOaC8Yo8,209
@@ -15,7 +15,7 @@ hydroqc/contract/__init__.py,sha256=uqxjOgyhpKFd-n_umxdaW5FB_DkJJaettWnEFC0nRYc,
 hydroqc/contract/common.py,sha256=xVw9z_Yjqp95SGCPNAfJVABvgp_C-KM51VTBEU9wjeM,15705
 hydroqc/contract/contract_d.py,sha256=6jPYTCjFq8zonfbXPrEujDVz58n5RUEuq54VCGqph6o,856
 hydroqc/contract/contract_d_cpc.py,sha256=-Y2S4MkzAfsbf_L2jCKfU7OD-nbzgoEpyT3SWh0U0tQ,1418
-hydroqc/contract/contract_dpc.py,sha256=EF60N9Xl5K4XXPHAV6KtTK5SYVtQD8pKUzn_wATjKXg,7165
+hydroqc/contract/contract_dpc.py,sha256=JNWZqpALuw1kNQhZXN4ql8KiEU3OeJteHLU4d489pdA,7579
 hydroqc/contract/contract_dt.py,sha256=TSKf2oh-MlG8A42xVUCCyf7oezlWTFoyATF9xlQn2JE,1687
 hydroqc/contract/contract_m.py,sha256=2hSSb9Tw2eZu7PV1XicfTFKLCRiffq72NfOYiVz8QMk,2108
 hydroqc/contract/contract_m_gdp.py,sha256=y8seZHmjkkul0TZ5Epxuxc4g0JVbs9o8KjL_y1gIldU,801
@@ -40,14 +40,14 @@ hydroqc/peak/dpc/peak.py,sha256=clb1j6LaBndPo0qPlOxumGuUGYB4-_ob_s8UQa-m49o,1313
 hydroqc/types/__init__.py,sha256=INBHElvUfZTZV3w9ywyLa-d7GfpXy096FApAGkKOYwI,1502
 hydroqc/types/account.py,sha256=yXwqjU3lBG7cGt8RF0cyvNSxtBCaIoWgmtvsLisvQTY,3696
 hydroqc/types/common.py,sha256=s1DA48svkJGsNaNUVcpEhoYLjiUOpfQI8WQ5xN6Yfco,1365
-hydroqc/types/consump.py,sha256=uCQ5ZHs_Qts5iLe9Q14tDZKby4iTxBd1QewUMkr3B8I,5594
+hydroqc/types/consump.py,sha256=iNZ-Fyb4_ciWjLtYIosK4XRksMxArGxaMFuayFKhyRo,5753
 hydroqc/types/contract.py,sha256=OTi8c5CEces3vwwQLbPzo1jB7sgwOweS1imFPnJMML0,1657
 hydroqc/types/cpc.py,sha256=ghmtBTT1FKuqVodJJ0kCtUbYNTLCOrngxgcrzjJYvok,2116
-hydroqc/types/dpc.py,sha256=OgJr7xbJZ1N2qPOY8JvNfruI7zqxnL47nJE2D7cb50s,1822
-hydroqc/types/dt.py,sha256=8Ypeo3JP9uaoJ_PUZJiPOJ8L0fkGXmEUU5tqoeV1fMY,564
+hydroqc/types/dpc.py,sha256=mwA5T9fGcNTA-kb_f25wq2ALJCwa5lKABOS73L6znY0,1981
+hydroqc/types/dt.py,sha256=rEXDgNewhlOsRbso0Shlq69TvJFoT56EGYOAjTFZU80,693
 hydroqc/types/outage.py,sha256=XTsNyu8mmxUx44XWvOOUHKSoijp-lgbXwQroiqm9S0o,3932
-hydro_quebec_api_wrapper-4.2.0.dist-info/METADATA,sha256=33dDyFhsA5rjlC1e26nGMkNb4YMaVTGcLGWMkW0MQD0,7948
-hydro_quebec_api_wrapper-4.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-hydro_quebec_api_wrapper-4.2.0.dist-info/entry_points.txt,sha256=G2YKkCH9rFt2dXbFyHINBp4bmqY2HTEIaf7F1CwbC_k,57
-hydro_quebec_api_wrapper-4.2.0.dist-info/top_level.txt,sha256=YAcYLnu5YYkbxt1psUoBfo_opl-lAZKq0A7B3IN_P6M,8
-hydro_quebec_api_wrapper-4.2.0.dist-info/RECORD,,
+hydro_quebec_api_wrapper-4.2.2.dist-info/METADATA,sha256=pHB876NvBQYDH2R0wTvKQmTaMeyTTLmR5RLjm4InHRQ,7948
+hydro_quebec_api_wrapper-4.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+hydro_quebec_api_wrapper-4.2.2.dist-info/entry_points.txt,sha256=G2YKkCH9rFt2dXbFyHINBp4bmqY2HTEIaf7F1CwbC_k,57
+hydro_quebec_api_wrapper-4.2.2.dist-info/top_level.txt,sha256=YAcYLnu5YYkbxt1psUoBfo_opl-lAZKq0A7B3IN_P6M,8
+hydro_quebec_api_wrapper-4.2.2.dist-info/RECORD,,

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

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

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

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