leneda-client 0.4.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

leneda/client.py

@@ -8,13 +8,15 @@ energy consumption and production data for electricity and gas.
 import json
 import logging
 from datetime import datetime, timedelta
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Awaitable, Callable, Dict, List, Optional, Union
 
-import requests
+import aiohttp
+from aiohttp import ClientResponseError, ClientTimeout
 
-from .exceptions import ForbiddenException, UnauthorizedException
+from .exceptions import ForbiddenException, MeteringPointNotFoundException, UnauthorizedException
 from .models import (
     AggregatedMeteringData,
+    AuthenticationProbeResult,
     MeteringData,
 )
 from .obis_codes import ObisCode
@@ -27,8 +29,15 @@ class LenedaClient:
     """Client for the Leneda API."""
 
     BASE_URL = "https://api.leneda.lu/api"
+    DEFAULT_TIMEOUT = ClientTimeout(total=30)  # 30 seconds total timeout
 
-    def __init__(self, api_key: str, energy_id: str, debug: bool = False):
+    def __init__(
+        self,
+        api_key: str,
+        energy_id: str,
+        debug: bool = False,
+        timeout: Optional[ClientTimeout] = None,
+    ):
         """
         Initialize the Leneda API client.
 
@@ -36,9 +45,11 @@ class LenedaClient:
             api_key: Your Leneda API key
             energy_id: Your Energy ID
             debug: Enable debug logging
+            timeout: Optional timeout settings for requests
         """
         self.api_key = api_key
         self.energy_id = energy_id
+        self.timeout = timeout or self.DEFAULT_TIMEOUT
 
         # Set up headers for API requests
         self.headers = {
@@ -53,7 +64,7 @@ class LenedaClient:
             logger.setLevel(logging.DEBUG)
             logger.debug("Debug logging enabled for Leneda client")
 
-    def _make_request(
+    async def _make_request(
         self,
         method: str,
         endpoint: str,
@@ -75,7 +86,7 @@ class LenedaClient:
         Raises:
             UnauthorizedException: If the API returns a 401 status code
             ForbiddenException: If the API returns a 403 status code
-            requests.exceptions.RequestException: For other request errors
+            aiohttp.ClientError: For other request errors
             json.JSONDecodeError: If the response cannot be parsed as JSON
         """
         url = f"{self.BASE_URL}/{endpoint}"
@@ -88,52 +99,75 @@ class LenedaClient:
             logger.debug(f"Request data: {json.dumps(json_data, indent=2)}")
 
         try:
-            # Make the request
-            response = requests.request(
-                method=method, url=url, headers=self.headers, params=params, json=json_data
-            )
-
-            # Check for HTTP errors
-            if response.status_code == 401:
-                raise UnauthorizedException(
-                    "API authentication failed. Please check your API key and energy ID."
-                )
-            if response.status_code == 403:
-                raise ForbiddenException(
-                    "Access forbidden. This may be due to Leneda's geoblocking or other access restrictions."
-                )
-            response.raise_for_status()
-
-            # Parse the response
-            if response.content:
-                response_data = response.json()
-                logger.debug(f"Response status: {response.status_code}")
-                logger.debug(f"Response data: {json.dumps(response_data, indent=2)}")
-                return response_data
-            else:
-                logger.debug(f"Response status: {response.status_code} (no content)")
-                return {}
-
-        except requests.exceptions.HTTPError as e:
+            async with aiohttp.ClientSession(timeout=self.timeout) as session:
+                async with session.request(
+                    method=method, url=url, headers=self.headers, params=params, json=json_data
+                ) as response:
+                    # Check for HTTP errors
+                    if response.status == 401:
+                        raise UnauthorizedException(
+                            "API authentication failed. Please check your API key and energy ID."
+                        )
+                    if response.status == 403:
+                        raise ForbiddenException(
+                            "Access forbidden. This may be due to Leneda's geoblocking or other access restrictions."
+                        )
+                    response.raise_for_status()
+
+                    # Parse the response
+                    if response.content:
+                        response_data: dict = await response.json()
+                        logger.debug(f"Response status: {response.status}")
+                        logger.debug(f"Response data: {json.dumps(response_data, indent=2)}")
+                        return response_data
+                    else:
+                        logger.debug(f"Response status: {response.status} (no content)")
+                        return {}
+
+        except aiohttp.ClientError as e:
             # Handle HTTP errors
             logger.error(f"HTTP error: {e}")
-            if hasattr(e, "response") and e.response is not None:
-                logger.error(f"Response status: {e.response.status_code}")
-                logger.error(f"Response body: {e.response.text}")
-            raise
-
-        except requests.exceptions.RequestException as e:
-            # Handle other request errors
-            logger.error(f"Request error: {e}")
             raise
 
         except json.JSONDecodeError as e:
             # Handle JSON parsing errors
             logger.error(f"JSON decode error: {e}")
-            logger.error(f"Response text: {response.text}")
             raise
 
-    def get_metering_data(
+    async def _make_metering_request(
+        self, request_callable: Callable[..., Awaitable[dict[Any, Any]]], *args: Any, **kwargs: Any
+    ) -> dict[Any, Any]:
+        """
+        Make a request to a metering data endpoint with 404 error handling.
+
+        This wrapper around any request callable specifically handles 404 errors for metering data
+        endpoints by raising MeteringPointNotFoundException.
+
+        Args:
+            request_callable: The callable to execute (e.g., self._make_request)
+            *args: Arguments to pass to the callable
+            **kwargs: Keyword arguments to pass to the callable
+
+        Returns:
+            The JSON response from the API
+
+        Raises:
+            MeteringPointNotFoundException: If the API returns a 404 status code
+            UnauthorizedException: If the API returns a 401 status code
+            ForbiddenException: If the API returns a 403 status code
+            aiohttp.ClientError: For other request errors
+            json.JSONDecodeError: If the response cannot be parsed as JSON
+        """
+        try:
+            return await request_callable(*args, **kwargs)
+        except aiohttp.ClientResponseError as e:
+            if e.status == 404:
+                raise MeteringPointNotFoundException(
+                    "Metering point not found. The requested metering point may not exist or you may not have access to it."
+                )
+            raise
+
+    async def get_metering_data(
         self,
         metering_point_code: str,
         obis_code: ObisCode,
@@ -167,12 +201,14 @@ class LenedaClient:
         }
 
         # Make the request
-        response_data = self._make_request(method="GET", endpoint=endpoint, params=params)
+        response_data = await self._make_metering_request(
+            self._make_request, method="GET", endpoint=endpoint, params=params
+        )
 
         # Parse the response into a MeteringData object
         return MeteringData.from_dict(response_data)
 
-    def get_aggregated_metering_data(
+    async def get_aggregated_metering_data(
         self,
         metering_point_code: str,
         obis_code: ObisCode,
@@ -212,12 +248,14 @@ class LenedaClient:
         }
 
         # Make the request
-        response_data = self._make_request(method="GET", endpoint=endpoint, params=params)
+        response_data = await self._make_metering_request(
+            self._make_request, method="GET", endpoint=endpoint, params=params
+        )
 
         # Parse the response into an AggregatedMeteringData object
         return AggregatedMeteringData.from_dict(response_data)
 
-    def request_metering_data_access(
+    async def request_metering_data_access(
         self,
         from_energy_id: str,
         from_name: str,
@@ -246,11 +284,13 @@ class LenedaClient:
         }
 
         # Make the request
-        response_data = self._make_request(method="POST", endpoint=endpoint, json_data=data)
+        response_data = await self._make_request(method="POST", endpoint=endpoint, json_data=data)
 
         return response_data
 
-    def probe_metering_point_obis_code(self, metering_point_code: str, obis_code: ObisCode) -> bool:
+    async def probe_metering_point_obis_code(
+        self, metering_point_code: str, obis_code: ObisCode
+    ) -> bool:
         """
         Probe if a metering point provides data for a specific OBIS code.
 
@@ -272,14 +312,14 @@ class LenedaClient:
         Raises:
             UnauthorizedException: If the API returns a 401 status code
             ForbiddenException: If the API returns a 403 status code
-            requests.exceptions.RequestException: For other request errors
+            aiohttp.ClientError: For other request errors
         """
         # Use arbitrary time window
         end_date = datetime.now()
         start_date = end_date - timedelta(weeks=4)
 
         # Try to get aggregated data for the specified OBIS code
-        result = self.get_aggregated_metering_data(
+        result = await self.get_aggregated_metering_data(
             metering_point_code=metering_point_code,
             obis_code=obis_code,
             start_date=start_date,
@@ -291,7 +331,7 @@ class LenedaClient:
         # Return True if we got data (unit is not None), False otherwise
         return result.unit is not None
 
-    def get_supported_obis_codes(self, metering_point_code: str) -> List[ObisCode]:
+    async def get_supported_obis_codes(self, metering_point_code: str) -> List[ObisCode]:
         """
         Get all OBIS codes that are supported by a given metering point.
 
@@ -311,10 +351,48 @@ class LenedaClient:
         Raises:
             UnauthorizedException: If the API returns a 401 status code
             ForbiddenException: If the API returns a 403 status code
-            requests.exceptions.RequestException: For other request errors
+            aiohttp.ClientError: For other request errors
         """
-        return [
-            obis_code
-            for obis_code in ObisCode
-            if self.probe_metering_point_obis_code(metering_point_code, obis_code)
-        ]
+        supported_codes = []
+        for obis_code in ObisCode:
+            if await self.probe_metering_point_obis_code(metering_point_code, obis_code):
+                supported_codes.append(obis_code)
+        return supported_codes
+
+    async def probe_credentials(self) -> AuthenticationProbeResult:
+        """
+        Probe if credentials are valid.
+
+        NOTE: This is an experimental function, as the Leneda API does not provide a native way to verify credentials only.
+        Use with caution, may break or yield unexpected results.
+
+        This method attempts to verify authentication by making a request to the metering data access endpoint
+        with invalid parameters. If the API returns a 400 status code, it indicates that authentication is successful
+        but the request parameters are invalid. If it returns a 401 status code, authentication has failed.
+
+        We make a request with invalid parameters because we don't want to actually lodge a metering data access request,
+        we just want to verify that the credentials are valid.
+
+        Returns:
+            AuthenticationProbeResult: SUCCESS if authentication is valid, FAILURE if authentication failed,
+            or UNKNOWN if the result cannot be determined
+
+        Raises:
+            ForbiddenException: If the API returns a 403 status code
+        """
+        try:
+            await self.request_metering_data_access("", "", [], [])
+        except UnauthorizedException:
+            return AuthenticationProbeResult.FAILURE
+        except ClientResponseError as e:
+            # We expect a 400 response if authentication is successful and our request is invalid
+            if e.status == 400:
+                # Update the config entry with new token
+                return AuthenticationProbeResult.SUCCESS
+            return AuthenticationProbeResult.UNKNOWN
+        except ForbiddenException:
+            raise
+        except Exception:
+            return AuthenticationProbeResult.UNKNOWN
+
+        return AuthenticationProbeResult.UNKNOWN

leneda/exceptions.py

@@ -19,3 +19,9 @@ class ForbiddenException(LenedaException):
     """Raised when access is forbidden (403 Forbidden), typically due to geoblocking or other access restrictions."""
 
     pass
+
+
+class MeteringPointNotFoundException(LenedaException):
+    """Raised when a metering point is not found."""
+
+    pass

leneda/models.py

@@ -8,6 +8,7 @@ making it easier to work with the data in a type-safe manner.
 import logging
 from dataclasses import dataclass, field
 from datetime import datetime
+from enum import Enum
 from typing import Any, Dict, List
 
 from dateutil import parser
@@ -237,3 +238,11 @@ class AggregatedMeteringData:
             f"AggregatedMeteringData(unit={self.unit}, "
             f"items_count={len(self.aggregated_time_series)})"
         )
+
+
+class AuthenticationProbeResult(Enum):
+    """Result of an authentication probe."""
+
+    SUCCESS = "SUCCESS"
+    FAILURE = "FAILURE"
+    UNKNOWN = "UNKNOWN"

leneda/version.py

@@ -1,3 +1,3 @@
 """Version information."""
 
-__version__ = "0.4.0"
+__version__ = "0.6.0"

{leneda_client-0.4.0.dist-info → leneda_client-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: leneda-client
-Version: 0.4.0
+Version: 0.6.0
 Summary: Python client for the Leneda energy data platform
 Home-page: https://github.com/fedus/leneda-client
 Author: fedus
@@ -22,8 +22,9 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: requests>=2.25.0
+Requires-Dist: aiohttp>=3.9.0
 Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pytest-asyncio>=0.23.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -46,6 +47,9 @@ Dynamic: summary
 
 A Python client for interacting with the Leneda energy data platform API.
 
+PLEASE NOTE: As long as the library is in a version below 1.0.0, breaking changes
+may also be introduced between minor version bumps.
+
 ## Overview
 
 This client provides a simple interface to the Leneda API, which allows users to:

leneda_client-0.6.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+leneda/__init__.py,sha256=-BHIXBfTTbX6EKDHr2Bq7rPzsPNYrrkgs9AJqWJR_1Q,732
+leneda/client.py,sha256=v41E1jFqe5MLMAoSOCtSYm8ZYWJwXCo-rBmKwMpDjB4,15875
+leneda/exceptions.py,sha256=eyQpEYdLAU_BkXbZeldS6XgXeQJEIKp4dBeyzwlKOfA,580
+leneda/models.py,sha256=Dwn99_h9D7bKnBZY_3WJ5bwA6XyBliEYK6A9kBhKtmk,8111
+leneda/obis_codes.py,sha256=VfsJQN1U80eZ5g1bIteDCLkkmBQ0AIkkm_zNAeM1Dog,7507
+leneda/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+leneda/version.py,sha256=5C-KzeFwke_CL13dukzT7o-_j-Sv7xz_3L5EqVn3hI0,50
+leneda_client-0.6.0.dist-info/licenses/LICENSE,sha256=nAhDs625lK6v8oLqjWCABKBKlwxVoRDFXQvoZPfOtKQ,1062
+leneda_client-0.6.0.dist-info/METADATA,sha256=kVCSco-qeUMd6V0mr6RF02C4Ivb87VAW8hFNsSKfSyQ,3515
+leneda_client-0.6.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+leneda_client-0.6.0.dist-info/top_level.txt,sha256=PANScm25ep7WLjKiph0fhJPb8s_sa_uLHemnBpQBaJ8,7
+leneda_client-0.6.0.dist-info/RECORD,,

{leneda_client-0.4.0.dist-info → leneda_client-0.6.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.3.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

leneda_client-0.4.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-leneda/__init__.py,sha256=-BHIXBfTTbX6EKDHr2Bq7rPzsPNYrrkgs9AJqWJR_1Q,732
-leneda/client.py,sha256=RcANz6UweQ13fJHKwWP1V5dWnqSwcG4Ot9ws1grhZqQ,12250
-leneda/exceptions.py,sha256=q00gjI5VwXAMF2I1gXfQidZMzbCF6UOSo4i1Wnb-inU,460
-leneda/models.py,sha256=jdU2cIZZDExUSiSfz9zaYjJepr0m3v_x5b1fyOaEI8Q,7930
-leneda/obis_codes.py,sha256=VfsJQN1U80eZ5g1bIteDCLkkmBQ0AIkkm_zNAeM1Dog,7507
-leneda/version.py,sha256=e6aGg4sxTYiyshAbW98gDoekO-J6qYKpZNzhVZhaYUk,50
-leneda_client-0.4.0.dist-info/licenses/LICENSE,sha256=nAhDs625lK6v8oLqjWCABKBKlwxVoRDFXQvoZPfOtKQ,1062
-leneda_client-0.4.0.dist-info/METADATA,sha256=TGPWdTziOm6yt9HLE8GKtbDxUaU-N9GHcNH9vsAbdzw,3344
-leneda_client-0.4.0.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-leneda_client-0.4.0.dist-info/top_level.txt,sha256=PANScm25ep7WLjKiph0fhJPb8s_sa_uLHemnBpQBaJ8,7
-leneda_client-0.4.0.dist-info/RECORD,,