Hydro-Quebec-API-Wrapper 4.2.2__tar.gz → 4.2.4__tar.gz

{hydro_quebec_api_wrapper-4.2.2 → hydro_quebec_api_wrapper-4.2.4}/.pre-commit-config.yaml

@@ -40,7 +40,7 @@ repos:
   - id: doc8
 
 - repo: https://github.com/pre-commit/mirrors-mypy
-  rev: v1.18.2
+  rev: v1.19.0
   hooks:
   - id: mypy
     args: [--strict, --pretty, --show-error-codes]

{hydro_quebec_api_wrapper-4.2.2 → hydro_quebec_api_wrapper-4.2.4}/Hydro_Quebec_API_Wrapper.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Hydro-Quebec-API-Wrapper
-Version: 4.2.2
+Version: 4.2.4
 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.2 → hydro_quebec_api_wrapper-4.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Hydro-Quebec-API-Wrapper
-Version: 4.2.2
+Version: 4.2.4
 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.2 → hydro_quebec_api_wrapper-4.2.4}/hydroqc/contract/contract_dpc.py

@@ -21,7 +21,10 @@ class WinterState(str, Enum):
 def check_dpc_data_present(
     method: Callable[..., None | str | bool | float | int | date | WinterState],
 ) -> Callable[..., None | str | bool | float | int | date | WinterState]:
-    """Check if contractDPC's data are present."""
+    """Check if contractDPC's data are present.
+
+    Returns None if data is not available or incomplete.
+    """
 
     def wrapper(
         contract: "ContractDPC",
@@ -110,19 +113,6 @@ 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:
@@ -148,7 +138,7 @@ class ContractDPC(ContractResidential):
     @check_dpc_data_present
     def last_update_date(self) -> date:
         """DPC data last update."""
-        date_str = str(self._get_dpc_field("dateMaj"))
+        date_str = str(self._dpc_data["periodesHiver"][0]["dateMaj"])
         # Handle ISO format with timezone
         if "T" in date_str:
             return date.fromisoformat(date_str.split("T", maxsplit=1)[0])
@@ -157,14 +147,17 @@ class ContractDPC(ContractResidential):
     @property
     @check_dpc_data_present
     def critical_called_hours(self) -> int:
-        """Get number of critical hours."""
-        return int(self._get_dpc_field("hrsCritiquesAppelees"))
+        """Get number of critical hours.
+
+        Returns 0 for current ongoing winter period where hours haven't been called yet.
+        """
+        return int(self._dpc_data["periodesHiver"][0].get("hrsCritiquesAppelees", 0))
 
     @property
     @check_dpc_data_present
     def max_critical_called_hours(self) -> int:
         """Get max number of critical hours."""
-        return int(self._get_dpc_field("hrsCritiquesAppeleesMax"))
+        return int(self._dpc_data["periodesHiver"][0]["hrsCritiquesAppeleesMax"])
 
     @property
     @check_dpc_data_present
@@ -173,10 +166,12 @@ class ContractDPC(ContractResidential):
 
         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:
+        if (
+            self._dpc_data["periodesHiver"][0].get("montantEconPerteVSTarifBase")
+            is None
+        ):
             return None
+        return float(self._dpc_data["periodesHiver"][0]["montantEconPerteVSTarifBase"])
 
     @property
     @check_dpc_data_present
@@ -190,11 +185,14 @@ class ContractDPC(ContractResidential):
     @property
     @check_dpc_data_present
     def winter_total_days_last_update(self) -> int:
-        """Get number of days since winter starts (calculated from dates)."""
+        """Get number of days since winter starts (calculated from dates).
+
+        Returns 0 if last update is before winter start (pre-season setup).
+        """
         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
+        return max(0, (update - start).days)
 
     @property
     @check_dpc_data_present

{hydro_quebec_api_wrapper-4.2.2 → hydro_quebec_api_wrapper-4.2.4}/hydroqc/hydro_api/client.py

@@ -1,5 +1,6 @@
 """HydroQc Client Module."""
 
+import asyncio
 import base64
 import csv
 import json
@@ -7,7 +8,6 @@ import logging
 import os
 import platform
 import re
-import ssl
 import uuid
 from collections.abc import Iterator
 from datetime import date, datetime, timedelta
@@ -114,6 +114,8 @@ class HydroClient:
         self.guid: str = str(uuid.uuid1())
         self._logger: logging.Logger = get_logger("httpclient", log_level)
         self._logger.debug("HydroQc initialized")
+        # Cache for blocking operations (initialized lazily)
+        self._cached_version: str | None = None
         self.reset()
 
     def reset(self) -> None:
@@ -128,20 +130,27 @@ class HydroClient:
         self._selected_customer = ""
         self._selected_contract = ""
 
-    @property
-    def user_agent(self) -> str:
+    async def _get_user_agent(self) -> str:
         """Get http client user_agent."""
-        try:
-            hydroqc_version = version("Hydro_Quebec_API_Wrapper")
-        except PackageNotFoundError:
-            # package is not installed
-            self._logger.warning(
-                "Python package `Hydro_Quebec_API_Wrapper` is not installed. "
-                "Install it using pip"
-            )
-            hydroqc_version = "unkwown"
+        if self._cached_version is None:
+            # Run blocking version lookup in executor to avoid blocking event loop
+            loop = asyncio.get_event_loop()
+            try:
+                self._cached_version = await loop.run_in_executor(
+                    None, version, "Hydro_Quebec_API_Wrapper"
+                )
+            except PackageNotFoundError:
+                # package is not installed
+                self._logger.warning(
+                    "Python package `Hydro_Quebec_API_Wrapper` is not installed. "
+                    "Install it using pip"
+                )
+                self._cached_version = "unkwown"
         os_name = platform.system()
-        return f"Hydroqc/{hydroqc_version} (dev@hydroqc.ca; https://gitlab.com/hydroqc) {os_name}"
+        return (
+            f"Hydroqc/{self._cached_version} "
+            f"(dev@hydroqc.ca; https://gitlab.com/hydroqc) {os_name}"
+        )
 
     async def http_request(
         self,
@@ -163,15 +172,10 @@ class HydroClient:
             data = {}
         if headers is None:
             headers = {}
-        headers["User-Agent"] = self.user_agent
+        headers["User-Agent"] = await self._get_user_agent()
         if verify_ssl is None:
             verify_ssl = self._verify_ssl
 
-        ssl_context: ssl.SSLContext | None = None
-        if verify_ssl:
-            ssl_context = ssl.create_default_context()
-            ssl_context.set_ciphers("DEFAULT")  # Needed for python3.10
-
         # Query Diagnostic
         if self._diag_folder is not None:
             cleaned_url = url.replace("/", "_").replace(":", "").split("#", 1)[0]
@@ -205,7 +209,7 @@ class HydroClient:
             params=params,
             data=data,
             allow_redirects=allow_redirects,
-            ssl=ssl_context,
+            ssl=verify_ssl,
             headers=headers,
         )
 

{hydro_quebec_api_wrapper-4.2.2 → hydro_quebec_api_wrapper-4.2.4}/test_requirements.txt

@@ -6,7 +6,7 @@ pytest==9.0.1
 pytest-cov==7.0.0
 pytest-asyncio==1.3.0
 black==25.11.0
-mypy==1.18.2
+mypy==1.19.0
 types-pytz==2025.2.0.20251108
 types-PyYAML==6.0.12.20250915
 types-python-dateutil==2.9.0.20251115