myelectricaldatapy 2.2.8__tar.gz → 2.3.0__tar.gz

{myelectricaldatapy-2.2.8 → myelectricaldatapy-2.3.0}/.github/workflows/release.yml

@@ -25,11 +25,3 @@ jobs:
           draft: false
           prerelease: ${{ contains(github.ref_name, '-') }}
           token: ${{ secrets.GITHUB_TOKEN }}
-  publish:
-    needs: release
-    permissions:
-      contents: write
-      packages: write
-      id-token: write
-    if: ${{ ! contains(github.ref_name, '-') }}
-    uses: ./.github/workflows/python-publish.yml

{myelectricaldatapy-2.2.8 → myelectricaldatapy-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: myelectricaldatapy
-Version: 2.2.8
+Version: 2.3.0
 Summary: Fetch Linky data from myelectricaldata.fr
 Author-email: Cyr-ius <cyr-ius@ipocus.net>
 License-Expression: GPL-3.0-or-later
@@ -21,7 +21,6 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiohttp>=3.8.1
 Requires-Dist: pandas>=2.0.2
-Requires-Dist: voluptuous>=0.13.1
 Provides-Extra: dev
 Requires-Dist: prek; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
@@ -76,6 +75,30 @@ $ python setup.py install
 - async_load (start: datetime, end: datetime) Return None - Load Data in power_Data attribute
 - async_refresh Return None - Refresh power_Data , tempo_day and ecowatt attributes.
 
+## Timezone
+
+Enedis/RTE APIs return naive timestamps that represent local wall-clock time. This
+library needs to know which timezone that is in order to compute things like
+off-peak hours or hourly statistics correctly.
+
+By default it falls back to the timezone of the host machine running the code
+(`/etc/localtime`), but that has no reason to match the timezone your
+application is actually configured for (e.g. Home Assistant's
+`hass.config.time_zone`). Pass it explicitly to avoid a fixed-offset shift in
+the reported times:
+
+```python
+api = EnedisByPDL(token=TOKEN, pdl=PDL, timezone=ZoneInfo("Europe/Paris"))
+```
+
+Alternatively, set it once globally for every instance:
+
+```python
+from myelectricaldatapy import set_local_timezone
+
+set_local_timezone(ZoneInfo("Europe/Paris"))
+```
+
 ## Get started
 
 ```python

{myelectricaldatapy-2.2.8 → myelectricaldatapy-2.3.0}/README.md

@@ -41,6 +41,30 @@ $ python setup.py install
 - async_load (start: datetime, end: datetime) Return None - Load Data in power_Data attribute
 - async_refresh Return None - Refresh power_Data , tempo_day and ecowatt attributes.
 
+## Timezone
+
+Enedis/RTE APIs return naive timestamps that represent local wall-clock time. This
+library needs to know which timezone that is in order to compute things like
+off-peak hours or hourly statistics correctly.
+
+By default it falls back to the timezone of the host machine running the code
+(`/etc/localtime`), but that has no reason to match the timezone your
+application is actually configured for (e.g. Home Assistant's
+`hass.config.time_zone`). Pass it explicitly to avoid a fixed-offset shift in
+the reported times:
+
+```python
+api = EnedisByPDL(token=TOKEN, pdl=PDL, timezone=ZoneInfo("Europe/Paris"))
+```
+
+Alternatively, set it once globally for every instance:
+
+```python
+from myelectricaldatapy import set_local_timezone
+
+set_local_timezone(ZoneInfo("Europe/Paris"))
+```
+
 ## Get started
 
 ```python

myelectricaldatapy-2.3.0/myelectricaldatapy/__init__.py

@@ -0,0 +1,48 @@
+"""myelectricaldatapy package."""
+
+from .api import Enedis
+from .const import *
+from .exceptions import (
+    EnedisException,
+    HttpRequestError,
+    LimitReached,
+    TimeoutExceededError,
+)
+from .mypdl import EnedisByPDL, FormatError, validate_cumsum, validate_prices
+from .types import (
+    ConsumptionCollect,
+    Cum,
+    EnergyCollect,
+    Mode,
+    Prices,
+    ProductionCollect,
+    Service,
+    StandardPrice,
+    Subscription,
+    TempoPrice,
+)
+from .tz import get_local_timezone, set_local_timezone
+
+__all__ = [
+    "ConsumptionCollect",
+    "Cum",
+    "Enedis",
+    "EnedisByPDL",
+    "EnedisException",
+    "EnergyCollect",
+    "FormatError",
+    "HttpRequestError",
+    "LimitReached",
+    "Mode",
+    "Prices",
+    "ProductionCollect",
+    "Service",
+    "StandardPrice",
+    "Subscription",
+    "TempoPrice",
+    "TimeoutExceededError",
+    "get_local_timezone",
+    "set_local_timezone",
+    "validate_cumsum",
+    "validate_prices",
+]

{myelectricaldatapy-2.2.8 → myelectricaldatapy-2.3.0}/myelectricaldatapy/analytics.py

@@ -1,23 +1,25 @@
 """Class for analytics."""
 
-from datetime import datetime as dt, timedelta
+from datetime import datetime as dt, timedelta, tzinfo as _tzinfo
 import re
 from typing import Any
 
 import pandas as pd
 
 from .const import ATTR_OFFPEAK, ATTR_STANDARD, TEMPO_DAYS
-from .tz import LOCAL_TIMEZONE
+from .tz import get_local_timezone
 
 
 class EnedisAnalytics:
     """Data analytics."""
 
-    local_timezone = LOCAL_TIMEZONE
-
-    def __init__(self, data: Any) -> None:
+    def __init__(self, data: Any, timezone: _tzinfo | None = None) -> None:
         """Initialize Dataframe."""
         self.df = pd.DataFrame(data)
+        # Resolved per instance (not at import/class-definition time) so a
+        # timezone set later via tz.set_local_timezone(), or passed here
+        # explicitly, is honored.
+        self.local_timezone = timezone or get_local_timezone()
 
     def get_data_analytics(
         self,

{myelectricaldatapy-2.2.8 → myelectricaldatapy-2.3.0}/myelectricaldatapy/api.py

@@ -9,9 +9,10 @@ from typing import Any
 from aiohttp import ClientSession
 
 from .auth import EnedisAuth
-from .const import DAILY_CONSUM, DAILY_PROD, DETAIL_CONSUM, DETAIL_PROD, TIMEOUT
+from .const import DAILY_CONSUM, DAILY_PROD, DETAIL_CONSUM, DETAIL_PROD
 from .exceptions import EnedisException
-from .tz import LOCAL_TIMEZONE, as_local, local_now
+from .types import Service
+from .tz import as_local, get_local_timezone, local_now
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -20,7 +21,7 @@ class Enedis:
     """Enedis API."""
 
     def __init__(
-        self, token: str, session: ClientSession | None = None, timeout: int = TIMEOUT
+        self, token: str, session: ClientSession | None = None, timeout: int = 30
     ) -> None:
         """Initialize."""
         session = session or ClientSession()
@@ -30,15 +31,9 @@ class Enedis:
         self.last_access: date | None = None
 
     async def async_fetch_datas(
-        self, service: str, pdl: str, start: dt | None = None, end: dt | None = None
+        self, service: Service, pdl: str, start: dt | None = None, end: dt | None = None
     ) -> Any:
-        """Retrieve date from service.
-
-        service:    contracts, identity, contact, addresses,
-                    daily_consumption_max_power,
-                    daily_consumption, daily_production,
-                    consumption_load_curve, production_load_curve
-        """
+        """Retrieve date from service."""
         self.last_access = local_now()
         path_range = ""
         if start and end:
@@ -126,16 +121,17 @@ class Enedis:
         if await self.async_has_offpeak(pdl) is True:
             # Off-peak windows are defined in local wall-clock time, so a
             # start given in another timezone must be converted first.
-            start_time = as_local(start).astimezone(LOCAL_TIMEZONE).time()
+            local_timezone = get_local_timezone()
+            start_time = as_local(start).astimezone(local_timezone).time()
             for range_time in self.offpeaks:
                 starting = (
                     dt.strptime(range_time[0], "%HH%M")
-                    .replace(tzinfo=LOCAL_TIMEZONE)
+                    .replace(tzinfo=local_timezone)
                     .time()
                 )
                 ending = (
                     dt.strptime(range_time[1], "%HH%M")
-                    .replace(tzinfo=LOCAL_TIMEZONE)
+                    .replace(tzinfo=local_timezone)
                     .time()
                 )
                 if starting < start_time <= ending:
@@ -168,7 +164,9 @@ class Enedis:
             "daily_consumption_max_power", pdl, start, end
         )
 
-    async def _async_get_details(self, mode: str, pdl: str, start: dt, end: dt) -> Any:
+    async def _async_get_details(
+        self, service: Service, pdl: str, start: dt, end: dt
+    ) -> Any:
         """Get production details. (max: 7 days)."""
         data = None
         response: dict[str, Any] | None = None
@@ -177,7 +175,7 @@ class Enedis:
             start, end = interval
             try:
                 if raise_error is False:
-                    response = await self.async_fetch_datas(mode, pdl, start, end)
+                    response = await self.async_fetch_datas(service, pdl, start, end)
             except EnedisException as error:
                 raise_error = True
                 response = None

{myelectricaldatapy-2.2.8 → myelectricaldatapy-2.3.0}/myelectricaldatapy/auth.py

@@ -1,6 +1,7 @@
 """Class for Enedis Authentication (http://www.myelectricaldata.fr)."""
 
 import asyncio
+from collections.abc import Mapping
 import json
 import logging
 import socket
@@ -8,7 +9,6 @@ from typing import Any
 
 from aiohttp import ClientError, ClientResponseError, ClientSession
 
-from .const import TIMEOUT, URL
 from .exceptions import (
     EnedisException,
     HttpRequestError,
@@ -17,14 +17,13 @@ from .exceptions import (
 )
 
 _LOGGER = logging.getLogger(__name__)
+URL = "https://myelectricaldata.fr"
 
 
 class EnedisAuth:
     """Class for Enedis Auth API."""
 
-    def __init__(
-        self, session: ClientSession, token: str, timeout: int = TIMEOUT
-    ) -> None:
+    def __init__(self, session: ClientSession, token: str, timeout: int = 30) -> None:
         """Init."""
         self.token = token
         self.timeout = timeout
@@ -50,7 +49,8 @@ class EnedisAuth:
             ) from error
         except ClientResponseError as error:
             message = contents.decode("utf8")
-            if "application/json" in (error.headers or {}).get("Content-Type", ""):
+            headers: Mapping[str, str] = error.headers or {}
+            if "application/json" in headers.get("Content-Type", ""):
                 msg = json.loads(message)
                 if error.status == 409:
                     raise LimitReached(msg.get("detail", msg))

myelectricaldatapy-2.3.0/myelectricaldatapy/const.py

@@ -0,0 +1,25 @@
+"""Constants."""
+
+from typing import Final
+
+ATTR_CUM_PRICE = "cum_price"
+ATTR_CUM_VALUE = "cum_value"
+ATTR_END = "end"
+ATTR_FN = "function"
+ATTR_HPHC = "hphc"
+ATTR_INTERVALS = "intervals"
+ATTR_OFFPEAK = "offpeak"
+ATTR_PRICE: Final = "price"
+ATTR_PRICES = "prices"
+ATTR_STANDARD = "standard"
+ATTR_START = "start"
+ATTR_TEMPO = "tempo"
+TEMPO_DAYS = ("blue", "white", "red")
+SUBSCRIPTIONS = (ATTR_STANDARD, ATTR_HPHC, ATTR_TEMPO)
+DEFAULT_SUBSCRIPTION = ATTR_STANDARD
+CONSUMPTION: Final = "consumption"
+DAILY_CONSUM: Final = "daily_consumption"
+DAILY_PROD: Final = "daily_production"
+DETAIL_CONSUM: Final = "consumption_load_curve"
+DETAIL_PROD: Final = "production_load_curve"
+PRODUCTION: Final = "production"