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

{hydro_quebec_api_wrapper-4.1.0 → hydro_quebec_api_wrapper-4.2.1}/.gitlab-ci.yml

@@ -314,6 +314,9 @@ package:
     # Disable if it's a tag pipeline
     - if: "$CI_COMMIT_TAG"
       when: never
+    # Disable if it's a scheduled pipeline
+    - if: "$CI_PIPELINE_SOURCE == 'schedule'"
+      when: never
     # Enabled for main branch
     - if: "$CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH"
       when: on_success

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

@@ -16,7 +16,7 @@ repos:
   - id: check-ast
 
 - repo: https://github.com/psf/black
-  rev: 25.9.0
+  rev: 25.11.0
   hooks:
   - id: black
     language_version: python3
@@ -47,9 +47,9 @@ 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"
       - "pkce==1.0.3"
-      - "pytest-asyncio==1.2.0"
+      - "pytest-asyncio==1.3.0"

{hydro_quebec_api_wrapper-4.1.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.1.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.1.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.1.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.1.0 → hydro_quebec_api_wrapper-4.2.1}/hydroqc/contract/contract_dpc.py

@@ -1,7 +1,8 @@
 """Hydroquebec contract module."""
 
 from collections.abc import Callable
-from datetime import date
+from datetime import date, datetime
+from enum import Enum
 
 from hydroqc.contract.common import check_period_data_present
 from hydroqc.contract.contract_residential import ContractResidential
@@ -10,12 +11,21 @@ from hydroqc.peak.dpc.handler import DPCPeakHandler
 from hydroqc.types import DPCDataTyping
 
 
+class WinterState(str, Enum):
+    """Winter period state."""
+
+    CURRENT = "C"  # Current/Active (within winter period)
+    FINISHED = "F"  # Finished (past winter period)
+
+
 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
@@ -26,6 +36,20 @@ def check_dpc_data_present(
                 "Maybe you did a rate change recently. "
                 "This message should disappear at the beginning of the next bill period."
             )
+            return None
+
+        # Check if winter period data is available
+        if (
+            "periodesHiver" not in contract._dpc_data
+            or not contract._dpc_data.get("periodesHiver")
+            or len(contract._dpc_data["periodesHiver"]) == 0
+        ):
+            contract._logger.info(
+                "DPC data is empty or incomplete. "
+                "This may occur outside the winter period or during a rate transition."
+            )
+            return None
+
         return method(contract)
 
     return wrapper
@@ -86,6 +110,19 @@ class ContractDPC(ContractResidential):
         )
         return self._dpc_data
 
+    def _get_dpc_field(self, field_name: str) -> str | float | int:
+        """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 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
     def cp_lower_price_consumption(self) -> float:
@@ -111,44 +148,69 @@ class ContractDPC(ContractResidential):
     @check_dpc_data_present
     def last_update_date(self) -> date:
         """DPC data last update."""
-        return date.fromisoformat(self._dpc_data["results"][0]["dateDernMaj"])
+        date_str = str(self._get_dpc_field("dateMaj"))
+        # Handle ISO format with timezone
+        if "T" in date_str:
+            return date.fromisoformat(date_str.split("T", maxsplit=1)[0])
+        return date.fromisoformat(date_str)
 
     @property
     @check_dpc_data_present
     def critical_called_hours(self) -> int:
         """Get number of critical hours."""
-        return int(self._dpc_data["results"][0]["hrsCritiquesAppelees"])
+        return int(self._get_dpc_field("hrsCritiquesAppelees"))
 
     @property
     @check_dpc_data_present
     def max_critical_called_hours(self) -> int:
         """Get max number of critical hours."""
-        return int(self._dpc_data["results"][0]["hrsCritiquesAppeleesMax"])
+        return int(self._get_dpc_field("hrsCritiquesAppeleesMax"))
 
     @property
     @check_dpc_data_present
-    def amount_saved_vs_base_rate(self) -> float:
-        """Amount saved or not versus the base rate."""
-        return self._dpc_data["results"][0]["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
     def winter_total_days(self) -> int:
-        """Get number of winter days."""
-        return self._dpc_data["results"][0]["nbJoursTotauxHiver"]
+        """Get number of winter days (calculated from period dates)."""
+        winter = self._dpc_data["periodesHiver"][0]
+        start = datetime.fromisoformat(winter["dateDebut"].replace("Z", "+00:00"))
+        end = datetime.fromisoformat(winter["dateFin"].replace("Z", "+00:00"))
+        return (end - start).days
 
     @property
     @check_dpc_data_present
     def winter_total_days_last_update(self) -> int:
-        """Get number of days since winter starts."""
-        return self._dpc_data["results"][0]["nbJoursDernMaj"]
+        """Get number of days since winter starts (calculated from dates)."""
+        winter = self._dpc_data["periodesHiver"][0]
+        start = datetime.fromisoformat(winter["dateDebut"].replace("Z", "+00:00"))
+        update = datetime.fromisoformat(winter["dateMaj"].replace("Z", "+00:00"))
+        return (update - start).days
 
     @property
     @check_dpc_data_present
-    def winter_state(self) -> str:
-        """Get winter state.
+    def winter_state(self) -> WinterState:
+        """Get winter state (computed from dates).
 
-        C: started
-        ?: ???????
+        Returns:
+            WinterState.CURRENT: Within winter period
+            WinterState.FINISHED: Past winter period
         """
-        return self._dpc_data["results"][0]["etatHiver"]
+        winter = self._dpc_data["periodesHiver"][0]
+        now = datetime.now(
+            datetime.fromisoformat(winter["dateDebut"].replace("Z", "+00:00")).tzinfo
+        )
+        start = datetime.fromisoformat(winter["dateDebut"].replace("Z", "+00:00"))
+        end = datetime.fromisoformat(winter["dateFin"].replace("Z", "+00:00"))
+        if start <= now <= end:
+            return WinterState.CURRENT
+        return WinterState.FINISHED

{hydro_quebec_api_wrapper-4.1.0 → hydro_quebec_api_wrapper-4.2.1}/hydroqc/hydro_api/client.py

@@ -862,12 +862,16 @@ class HydroClient:
     ) -> DPCDataTyping:
         """Fetch FlexD data of the current year.
 
-        API URL: https://cl-ec-spring.hydroquebec.com/portail/fr/group/clientele/
-        portrait-de-consommation/resourceObtenirDonneesMoisHiverFlex
+        API URL: https://services-cl.solutions.hydroquebec.com/wsapi/web/prive/api/
+        v3_0/tarificationDynamique/tarifPointeCritique
 
         """
         await self._select_contract(applicant_id, customer_id, contract_id)
-        api_call_response = await self.http_request(FLEXD_DATA_URL, "get")
+        headers = await self._get_customer_http_headers(applicant_id, customer_id)
+        params = {"noContrat": contract_id}
+        api_call_response = await self.http_request(
+            FLEXD_DATA_URL, "get", params=params, headers=headers
+        )
         # We can not use res.json() because the response header are not application/json
         data: DPCDataTyping = self._load_json(await api_call_response.text())
         return data

{hydro_quebec_api_wrapper-4.1.0 → hydro_quebec_api_wrapper-4.2.1}/hydroqc/hydro_api/consts.py

@@ -57,8 +57,8 @@ OPEN_DATA_PEAK_URL = (
 RELATION_URL = f"{HOST_SERVICES}/wsapi/web/prive/api/v1_0/relations"
 
 FLEXD_DATA_URL = (
-    f"{HOST_SERVICES}/lsw/portail/fr/group/clientele/portrait-de-consommation/"
-    "resourceObtenirDonneesMoisHiverFlex"
+    f"{HOST_SERVICES}/wsapi/web/prive/api/v3_0/"
+    "tarificationDynamique/tarifPointeCritique"
 )
 FLEXD_PEAK_URL = f"{HOST_SERVICES}/conso/portraitweb/api/v3_0/conso"
 CONSO_CSV_URL = (

{hydro_quebec_api_wrapper-4.1.0 → hydro_quebec_api_wrapper-4.2.1}/hydroqc/types/__init__.py

@@ -17,13 +17,13 @@ from hydroqc.types.consump import (
     ConsumpDailyTyping,
     ConsumpHourlyTyping,
     ConsumpMonthlyTyping,
-    DPCDataTyping,
     DPCPeakDataTyping,
     DPCPeakListDataTyping,
-    DTDataTyping,
 )
 from hydroqc.types.contract import ContractTyping, ListContractsTyping
 from hydroqc.types.cpc import CPCDataTyping, CriticalPeakDataTyping, PeriodDataTyping
+from hydroqc.types.dpc import DPCDataTyping
+from hydroqc.types.dt import DTDataTyping
 from hydroqc.types.outage import (
     OutageCause,
     OutageCode,

{hydro_quebec_api_wrapper-4.1.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
@@ -169,23 +173,6 @@ class DPCDataResultsTyping(TypedDict, total=True):
     etatHiver: str
 
 
-class DPCDataTyping(TypedDict, total=True):
-    """FlexD data json output format."""
-
-    success: bool
-    results: list[DPCDataResultsTyping]
-
-
-DTDataResultsTyping = DPCDataResultsTyping
-
-
-class DTDataTyping(TypedDict, total=True):
-    """FlexD data json output format."""
-
-    success: bool
-    results: list[DTDataResultsTyping]
-
-
 class DPCPeakDataTyping(TypedDict, total=True):
     """DPC Peak data json output format."""
 

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

@@ -4,25 +4,46 @@
 from typing import TypedDict
 
 
-class DPCDataResultsTyping(TypedDict, total=True):
-    """FlexD data json sub output 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
-    dateDernMaj: str
+    dateMaj: str
     hrsCritiquesAppelees: str
     hrsCritiquesAppeleesMax: str
     montantEconPerteVSTarifBase: float
-    nbJoursTotauxHiver: int
-    nbJoursDernMaj: int
-    etatHiver: str
 
 
-class DPCDataTyping(TypedDict, total=True):
-    """FlexD data json output format."""
+class DPCEvenementPointeTyping(TypedDict, total=True):
+    """FlexD peak event data (API v3_0 format)."""
+
+    dateEvenement: str
+    heureDebut: str
+    heureFin: str
+    consoReelle: float
+    codeConso: str
+    indFacture: bool
+
+
+class DPCEvenementsPointeWrapperTyping(TypedDict, total=True):
+    """FlexD peak events wrapper (API v3_0 format)."""
+
+    dateDebutPeriodeHiver: str
+    dateFinPeriodeHiver: str
+    evenementsPointe: list[DPCEvenementPointeTyping]
+
+
+class DPCDataTyping(TypedDict, total=False):
+    """FlexD data json output format (API v3_0)."""
 
-    success: bool
-    results: list[DPCDataResultsTyping]
+    dateTestAffichageWeb: str
+    periodesHiver: list[DPCPeriodeHiverTyping]
+    evenementsPointe: list[DPCEvenementsPointeWrapperTyping]
 
 
 class DPCPeakDataTyping(TypedDict, total=True):

hydro_quebec_api_wrapper-4.2.1/hydroqc/types/dt.py

@@ -0,0 +1,29 @@
+"""Hydroqc custom types."""
+
+# pylint: disable=invalid-name
+from typing import TypedDict
+
+
+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
+    dateDernMaj: str
+    hrsCritiquesAppelee: str
+    hrsCritiquesAppeleesMax: str
+    montantEconPerteVSTarifBase: float
+    nbJoursTotauxHiver: int
+    nbJoursDernMaj: int
+    etatHiver: str
+
+
+class DTDataTyping(TypedDict, total=True):
+    """FlexD data json output format."""
+
+    success: bool
+    results: list[DTDataResultsTyping]

{hydro_quebec_api_wrapper-4.1.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.2.0
-black==25.9.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

hydro_quebec_api_wrapper-4.1.0/hydroqc/types/dt.py

@@ -1,15 +0,0 @@
-"""Hydroqc custom types."""
-
-# pylint: disable=invalid-name
-from typing import TypedDict
-
-from hydroqc.types.dpc import DPCDataResultsTyping
-
-DTDataResultsTyping = DPCDataResultsTyping
-
-
-class DTDataTyping(TypedDict, total=True):
-    """FlexD data json output format."""
-
-    success: bool
-    results: list[DTDataResultsTyping]