Hydro-Quebec-API-Wrapper 3.2.0__tar.gz → 4.0.0__tar.gz

{hydro_quebec_api_wrapper-3.2.0 → hydro_quebec_api_wrapper-4.0.0}/.gitlab-ci.yml

@@ -31,7 +31,7 @@ test:
   stage: test
   tags:
    - hydroqc
-  image: registry.gitlab.com/hydroqc/hydroqc-base-container/3.12@sha256:b66812346075aabc0ee6cf452d734c28589bbe97a82c179b0a95d3a95c04ad41
+  image: registry.gitlab.com/hydroqc/hydroqc-base-container/3.12@sha256:d8985672e512080c541beeab0da37aa166a41b24ab9f0cf86bed4944cd743fae
   script:
     - tox -e pylint,flake8,pydocstyle,typing,black,deps-conflict --parallel auto
     - cat mypy-txt-report/index.txt
@@ -70,7 +70,7 @@ test:
   # Run on shared runners to lighten the load on the private runners
   # tags:
   # - hydroqc
-  image: registry.gitlab.com/hydroqc/hydroqc-base-container/3.12@sha256:b66812346075aabc0ee6cf452d734c28589bbe97a82c179b0a95d3a95c04ad41
+  image: registry.gitlab.com/hydroqc/hydroqc-base-container/3.12@sha256:d8985672e512080c541beeab0da37aa166a41b24ab9f0cf86bed4944cd743fae
   script:
     - >
       OUTPUT=$(curl
@@ -257,7 +257,7 @@ private_tests_done:
   stage: private_tests_done
   tags:
     - hydroqc
-  image: registry.gitlab.com/hydroqc/hydroqc-base-container/3.12@sha256:b66812346075aabc0ee6cf452d734c28589bbe97a82c179b0a95d3a95c04ad41
+  image: registry.gitlab.com/hydroqc/hydroqc-base-container/3.12@sha256:d8985672e512080c541beeab0da37aa166a41b24ab9f0cf86bed4944cd743fae
   script:
     #- apt-get update && apt-get install --no-install-recommends -y python3.10 python3-venv python3-pip --no-install-recommends git
     - echo "Private Tests done"
@@ -299,7 +299,7 @@ package:
   stage: test
   tags:
     - hydroqc
-  image: registry.gitlab.com/hydroqc/hydroqc-base-container/3.12@sha256:b66812346075aabc0ee6cf452d734c28589bbe97a82c179b0a95d3a95c04ad41
+  image: registry.gitlab.com/hydroqc/hydroqc-base-container/3.12@sha256:d8985672e512080c541beeab0da37aa166a41b24ab9f0cf86bed4944cd743fae
   script:
     # Build a package with a version based on the commmit short sha
     - pip install --upgrade pip
@@ -329,7 +329,7 @@ promote2pypi:
   stage: pypi
   tags:
     - hydroqc
-  image: registry.gitlab.com/hydroqc/hydroqc-base-container/3.12@sha256:b66812346075aabc0ee6cf452d734c28589bbe97a82c179b0a95d3a95c04ad41
+  image: registry.gitlab.com/hydroqc/hydroqc-base-container/3.12@sha256:d8985672e512080c541beeab0da37aa166a41b24ab9f0cf86bed4944cd743fae
   script:
     # TODO: try to pull the good package from gitlab pypi repo
     #       then change the version (promote)

{hydro_quebec_api_wrapper-3.2.0 → hydro_quebec_api_wrapper-4.0.0}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.6.0
+  rev: v5.0.0
   hooks:
   - id: trailing-whitespace
   - id: end-of-file-fixer
@@ -16,13 +16,13 @@ repos:
   - id: check-ast
 
 - repo: https://github.com/psf/black
-  rev: 24.4.2
+  rev: 24.10.0
   hooks:
   - id: black
     language_version: python3
 
 - repo: https://github.com/PyCQA/flake8/
-  rev: 7.0.0
+  rev: 7.1.1
   hooks:
   - id: flake8
     additional_dependencies: [flake8-docstrings]
@@ -35,12 +35,12 @@ repos:
     #    additional_dependencies: [toml]
 
 - repo: https://github.com/PyCQA/doc8
-  rev: v1.1.1
+  rev: v1.1.2
   hooks:
   - id: doc8
 
 - repo: https://github.com/pre-commit/mirrors-mypy
-  rev: v1.10.0
+  rev: v1.14.1
   hooks:
   - id: mypy
     args: [--strict, --pretty, --show-error-codes]
@@ -49,6 +49,7 @@ repos:
       - "types-PyYAML==6.0.12.20240311"
       - "types-python-dateutil==2.9.0.20240316"
       - "pytest-stub==1.1.0"
-      - "aiohttp==3.9.5"
+      - "aiohttp==3.10.10"
       - "aiocache==0.12.2"
       - "pkce==1.0.3"
+      - "pytest-asyncio==0.25.0"

{hydro_quebec_api_wrapper-3.2.0 → hydro_quebec_api_wrapper-4.0.0}/Hydro_Quebec_API_Wrapper.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Hydro-Quebec-API-Wrapper
-Version: 3.2.0
+Version: 4.0.0
 Summary: A wrapper library to access hydro quebec API and more
 Home-page: https://hydroqc.ca
 Author-email: Hydroqc Team <info@hydroqc.ca>
@@ -15,10 +15,10 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiohttp==3.9.5
+Requires-Dist: aiohttp==3.10.10
 Requires-Dist: python-dateutil==2.9.0.post0
-Requires-Dist: pytz==2024.1
-Requires-Dist: aiocache==0.12.2
+Requires-Dist: pytz==2024.2
+Requires-Dist: aiocache==0.12.3
 Requires-Dist: pkce==1.0.3
 
 # HydroQC - Hydro Quebec API wrapper

{hydro_quebec_api_wrapper-3.2.0 → hydro_quebec_api_wrapper-4.0.0}/Hydro_Quebec_API_Wrapper.egg-info/SOURCES.txt

@@ -46,6 +46,7 @@ hydroqc/customer.py
 hydroqc/diagnostic.py
 hydroqc/error.py
 hydroqc/logger.py
+hydroqc/public_client.py
 hydroqc/py.typed
 hydroqc/timerange.py
 hydroqc/utils.py
@@ -65,6 +66,9 @@ hydroqc/hydro_api/cache.py
 hydroqc/hydro_api/client.py
 hydroqc/hydro_api/consts.py
 hydroqc/peak/__init__.py
+hydroqc/peak/basepeak.py
+hydroqc/peak/basepeakhandler.py
+hydroqc/peak/consts.py
 hydroqc/peak/cpc/__init__.py
 hydroqc/peak/cpc/consts.py
 hydroqc/peak/cpc/handler.py

hydro_quebec_api_wrapper-4.0.0/Hydro_Quebec_API_Wrapper.egg-info/requires.txt

@@ -0,0 +1,5 @@
+aiohttp==3.10.10
+python-dateutil==2.9.0.post0
+pytz==2024.2
+aiocache==0.12.3
+pkce==1.0.3

{hydro_quebec_api_wrapper-3.2.0 → hydro_quebec_api_wrapper-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Hydro-Quebec-API-Wrapper
-Version: 3.2.0
+Version: 4.0.0
 Summary: A wrapper library to access hydro quebec API and more
 Home-page: https://hydroqc.ca
 Author-email: Hydroqc Team <info@hydroqc.ca>
@@ -15,10 +15,10 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiohttp==3.9.5
+Requires-Dist: aiohttp==3.10.10
 Requires-Dist: python-dateutil==2.9.0.post0
-Requires-Dist: pytz==2024.1
-Requires-Dist: aiocache==0.12.2
+Requires-Dist: pytz==2024.2
+Requires-Dist: aiocache==0.12.3
 Requires-Dist: pkce==1.0.3
 
 # HydroQC - Hydro Quebec API wrapper

hydro_quebec_api_wrapper-4.0.0/conflict_test_requirements.txt

@@ -0,0 +1 @@
+mqtt-hass-base==4.4.0

{hydro_quebec_api_wrapper-3.2.0 → hydro_quebec_api_wrapper-4.0.0}/hydroqc/diagnostic.py

@@ -20,6 +20,7 @@ from dateutil.relativedelta import relativedelta
 from hydroqc.contract import ContractDCPC, ContractDPC, ContractM
 from hydroqc.error import HydroQcError
 from hydroqc.logger import get_logger
+from hydroqc.public_client import PublicClient
 from hydroqc.webuser import WebUser
 
 LOG_LEVEL = (
@@ -39,10 +40,12 @@ class Diagnostic:
         """Contructor."""
         # Get base settings
         self.diagnostic_folder = cli_settings.output_folder
+        self.diagnostic_folder_public = os.path.join(self.diagnostic_folder, "public")
         # Prepare output folder
         if os.path.exists(self.diagnostic_folder):
             shutil.rmtree(self.diagnostic_folder)
         os.makedirs(self.diagnostic_folder)
+        os.makedirs(self.diagnostic_folder_public)
         # Prepare logger
         self._log_file = os.path.join(self.diagnostic_folder, "diagnostic.log")
         log_level = cli_settings.log_level
@@ -51,6 +54,7 @@ class Diagnostic:
         file_handler.setFormatter(self.logger.handlers[0].formatter)
         file_handler.setLevel(self.logger.level)
         self.logger.addHandler(file_handler)
+        self.logger_public = self.logger.getChild("public")
         http_log_level = cli_settings.http_log_level
 
         # Get settings
@@ -69,6 +73,15 @@ class Diagnostic:
             log_file=self._log_file,
             diag_folder=self.diagnostic_folder,
         )
+        self.public_client = PublicClient(
+            rate_code="DPC",
+            # rate_option_code="CPC",
+            verify_ssl=True,
+            log_level=log_level,
+            http_log_level=http_log_level,
+            log_file=self._log_file,
+            diag_folder=self.diagnostic_folder_public,
+        )
 
     def zip(self) -> None:
         """Archive all generated files."""
@@ -87,6 +100,11 @@ class Diagnostic:
         """Get diagnostic http ID."""
         return self.webuser._hydro_client._diag_id
 
+    @property
+    def public_diag_id(self) -> int:
+        """Get diagnostic http ID."""
+        return self.public_client._hydro_client._diag_id
+
     async def run(self) -> None:  # pylint: disable=too-many-statements
         """Run diagnostic."""
         today = datetime.date.today()
@@ -94,6 +112,24 @@ class Diagnostic:
         day_2 = today - datetime.timedelta(days=2)
 
         try:
+            self.logger_public.info(
+                "%02d - Checking HQ portal status", self.public_diag_id
+            )
+            hq_status = await self.public_client.check_hq_portal_status()
+            self.logger_public.info(
+                "%02d - HQ portal available: %s", self.public_diag_id - 1, hq_status
+            )
+
+            self.logger_public.info(
+                "%02d - Fetch peak using open data", self.public_diag_id
+            )
+            await self.public_client.fetch_peak_data()
+            self.logger_public.info(
+                "%02d - Peak found: %s",
+                self.public_diag_id - 1,
+                len(self.public_client.peaks),
+            )
+
             self.logger.info("%02d - Checking HQ portal status", self.diag_id)
             hq_status = await self.webuser.check_hq_portal_status()
             self.logger.info(
@@ -267,6 +303,10 @@ class Diagnostic:
                 await contract_dcpc.peak_handler.refresh_data()
                 self.logger.info("%02d - Got cpc data", self.diag_id - 1)
 
+                self.logger.info("%02d - Trying to get opn data", self.diag_id)
+                await contract_dcpc.peak_handler.refresh_open_data()
+                self.logger.info("%02d - Got open data", self.diag_id - 1)
+
             # DCP/FlexD
             elif self.contract.rate == "DPC":
                 self.logger.info("%02d - Trying to get flexD data", self.diag_id)
@@ -289,6 +329,10 @@ class Diagnostic:
                 await contract_dpc.peak_handler.refresh_data()
                 self.logger.info("%02d - Got flexD data", self.diag_id - 1)
 
+                self.logger.info("%02d - Trying to get opn data", self.diag_id)
+                await contract_dcpc.peak_handler.refresh_open_data()
+                self.logger.info("%02d - Got open data", self.diag_id - 1)
+
             # DT
             if self.contract.rate == "DT":
                 low_price = contract_dpc.cp_lower_price_consumption
@@ -330,6 +374,9 @@ class Diagnostic:
             traceback.print_exception(exp, file=fhtb)
             fhtb.seek(0)
             self.logger.error(fhtb.read())
+        finally:
+            await self.webuser.close_session()
+            await self.public_client.close_session()
 
 
 def parse_args() -> argparse.Namespace:
@@ -380,14 +427,10 @@ def main() -> None:
     """Run diagnostic."""
     cli_settings = parse_args()
 
-    loop = asyncio.get_event_loop()
     diag = Diagnostic(cli_settings)
 
     # Fetch data
-    loop.run_until_complete(diag.run())
-    close_fut = asyncio.gather(diag.webuser.close_session())
-    loop.run_until_complete(close_fut)
-    loop.close()
+    asyncio.run(diag.run())
     # zip
     diag.zip()
 

{hydro_quebec_api_wrapper-3.2.0 → hydro_quebec_api_wrapper-4.0.0}/hydroqc/hydro_api/client.py

@@ -14,11 +14,11 @@ from datetime import date, datetime, timedelta
 from importlib.metadata import PackageNotFoundError, version
 from io import StringIO
 from json import dumps as json_dumps
-from typing import Any
-from pkce import generate_pkce_pair
+from typing import Any, cast
 
 import aiohttp
 import yarl
+from pkce import generate_pkce_pair
 
 from hydroqc.error import HydroQcError, HydroQcHTTPError
 from hydroqc.hydro_api.cache import CCached
@@ -43,6 +43,7 @@ from hydroqc.hydro_api.consts import (
     HOURLY_CONSUMPTION_API_URL,
     IS_HYDRO_PORTAL_UP_URL,
     MONTHLY_DATA_URL,
+    OPEN_DATA_PEAK_URL,
     OUTAGES,
     PERIOD_DATA_URL,
     PORTRAIT_URL,
@@ -67,6 +68,8 @@ from hydroqc.types import (
     InfoAccountTyping,
     ListAccountsContractsTyping,
     ListContractsTyping,
+    OpenDataPeakEvent,
+    OpenDataPeakEventOffer,
     OutageListTyping,
     PeriodDataTyping,
 )
@@ -76,6 +79,8 @@ from hydroqc.utils import EST_TIMEZONE
 class HydroClient:
     """HydroQc HTTP Client."""
 
+    _cookie_jar: aiohttp.CookieJar
+
     def __init__(
         self,
         username: str,
@@ -91,7 +96,6 @@ class HydroClient:
         self.password: str = password
         self._timeout: int = timeout
         self._session: aiohttp.ClientSession | None = session
-        self._cookie_jar: aiohttp.CookieJar = aiohttp.CookieJar()
         self._verify_ssl: bool = verify_ssl
 
         # OAuth handling variables
@@ -119,7 +123,7 @@ class HydroClient:
         self.refresh_token = ""
         self.refresh_token_expiry = datetime.now()
         self.web_session_expiry = datetime.now()
-        self._cookie_jar = aiohttp.CookieJar()
+        # self._cookie_jar = aiohttp.CookieJar()
         self._selected_customer = ""
         self._selected_contract = ""
 
@@ -234,16 +238,20 @@ class HydroClient:
             self._logger.debug("JSON received : ", data)
             raise HydroQcHTTPError("Bad JSON format") from exp
 
-    def get_token_data(self) -> IDTokenTyping:
+    def get_token_data(self) -> IDTokenTyping | None:
         """Decode id token data."""
+        if not self._id_token:
+            return None
         raw_token_data = self._id_token.split(".")[1]
         # In some cases padding get lost, adding it to avoid issues with base64 decode
         raw_token_data += "=" * ((4 - len(raw_token_data) % 4) % 4)
         token_data: IDTokenTyping = self._load_json(base64.b64decode(raw_token_data))
         return token_data
 
-    def _get_httpsession(self) -> None:
+    async def _get_httpsession(self) -> None:
         """Set http session."""
+        if not hasattr(self, "_cookie_jar"):
+            self._cookie_jar = aiohttp.CookieJar()
         if self._session is None:
             self._logger.debug("Creating new http session")
             self._session = aiohttp.ClientSession(
@@ -276,7 +284,7 @@ class HydroClient:
     async def check_portal_status(self) -> bool:
         """Check if Hydro Quebec portal is UP."""
         # Get http session
-        self._get_httpsession()
+        await self._get_httpsession()
         self._logger.info("Checking if the Hydro Quebec portal is UP")
         api_call_response = await self.http_request(
             IS_HYDRO_PORTAL_UP_URL,
@@ -301,7 +309,7 @@ class HydroClient:
         code_verifier, code_challenge = generate_pkce_pair()
 
         # Get http session
-        self._get_httpsession()
+        await self._get_httpsession()
 
         url = f"{AUTHORIZE_URL}"
         headers = {
@@ -912,3 +920,27 @@ class HydroClient:
             return content
         data_csv: Iterator[Any] = csv.reader(content, delimiter=";")
         return data_csv
+
+    @CCached(ttl=300)
+    async def get_open_data_peaks(
+        self,
+        offer: OpenDataPeakEventOffer | None = None,
+    ) -> list[OpenDataPeakEvent]:
+        """Get the list of peak event from open data url."""
+        await self._get_httpsession()
+        res = await self.http_request(OPEN_DATA_PEAK_URL, "get")
+        content = await res.text()
+        try:
+            raw_res_json = json.loads(content)
+        except json.JSONDecodeError:
+            # Try to clean up json removing comments
+            cleaned_json = ""
+            res_text = await res.text()
+            for line in res_text.splitlines():
+                if not line.startswith("/") and not line.startswith("#"):
+                    cleaned_json += line
+            raw_res_json = json.loads(cleaned_json)
+        res_json = cast(list[OpenDataPeakEvent], raw_res_json.get("evenements", []))
+        if not offer:
+            return res_json
+        return [e for e in res_json if e["offre"] == offer]

{hydro_quebec_api_wrapper-3.2.0 → hydro_quebec_api_wrapper-4.0.0}/hydroqc/hydro_api/consts.py

@@ -15,6 +15,7 @@ HOST_SERVICES = "https://services-cl.solutions.hydroquebec.com"
 # HOST_SPRING = "https://cl-ec-lsw.solutions.hydroquebec.com"
 HOST_RB_SOL = "https://rb.solutions.hydroquebec.com"
 HOST_OUTAGES = "https://services-bs.solutions.hydroquebec.com"
+HOST_OPEN_DATA = "https://donnees.solutions.hydroquebec.com"
 
 # Azure B2C
 AZB2C_TENANT_ID = "32bf9b91-0a36-4385-b231-d9a8fa3b05ab"
@@ -47,6 +48,11 @@ SECURITY_URL = f"{HOST_SESSION}/config/security.json"
 SESSION_REFRESH_URL = f"{HOST_SESSION}/oauth2/callback/silent-refresh"
 LOGIN_URL_6 = f"{HOST_SERVICES}/wsapi/web/prive/api/v3_0/conversion/codeAcces"
 
+# OPEN DATA PEAK URL
+OPEN_DATA_PEAK_URL = (
+    f"{HOST_OPEN_DATA}/donnees-ouvertes/data/json/pointeshivernales.json"
+)
+
 # Initialization uri
 RELATION_URL = f"{HOST_SERVICES}/wsapi/web/prive/api/v1_0/relations"
 

hydro_quebec_api_wrapper-4.0.0/hydroqc/peak/basepeak.py

@@ -0,0 +1,67 @@
+"""Base Peak module."""
+
+import datetime
+
+from hydroqc.error import HydroQcCPCPeakError
+from hydroqc.timerange import TimeRange
+from hydroqc.utils import EST_TIMEZONE
+
+
+class BasePeak(TimeRange):
+    """Base peak class."""
+
+    _start_date: datetime.datetime
+    _end_date: datetime.datetime
+
+    def __init__(self, start_date: datetime.datetime, end_date: datetime.datetime):
+        """Build base peak."""
+        if not start_date.tzinfo:
+            self._start_date = start_date.astimezone(EST_TIMEZONE)
+        else:
+            self._start_date = start_date
+        if not end_date.tzinfo:
+            self._end_date = end_date.astimezone(EST_TIMEZONE)
+        else:
+            self._end_date = end_date
+
+        super().__init__(self.start_date, self.end_date, is_critical=False)
+
+    @property
+    def is_morning(self) -> bool:
+        """Return True if it's a morning peak."""
+        return self._start_date.hour < 12
+
+    @property
+    def is_evening(self) -> bool:
+        """Return True if it's a evening peak."""
+        return self._start_date.hour > 12
+
+    @property
+    def day(self) -> datetime.date:
+        """Get the day, without time, of the peak."""
+        return self._start_date.date()
+
+    @property
+    def date(self) -> datetime.date:
+        """DEPRECATED - Get the day, without time, of the peak."""
+        return self.day
+
+    @property
+    def start_date(self) -> datetime.datetime:
+        """Get the start date of the peak."""
+        return self._start_date
+
+    @property
+    def end_date(self) -> datetime.datetime:
+        """Get the end date of the peak."""
+        return self._end_date
+
+    @property
+    def morning_evening(self) -> str:
+        """Return evening or morning peak value."""
+        if self.is_morning:
+            return "morning"
+        if self.is_evening:
+            return "evening"
+        msg = "Can not determine if is morning or evening peak"
+        raise HydroQcCPCPeakError(msg)