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

leneda/client.py

@@ -12,7 +12,7 @@ from typing import Any, Dict, List, Optional, Union
 
 import requests
 
-from .exceptions import ForbiddenException, InvalidMeteringPointException, UnauthorizedException
+from .exceptions import ForbiddenException, UnauthorizedException
 from .models import (
     AggregatedMeteringData,
     MeteringData,
@@ -250,19 +250,24 @@ class LenedaClient:
 
         return response_data
 
-    def test_metering_point(self, metering_point_code: str) -> bool:
+    def probe_metering_point_obis_code(self, metering_point_code: str, obis_code: ObisCode) -> bool:
         """
-        Test if a metering point code is valid and accessible.
+        Probe if a metering point provides data for a specific OBIS code.
 
-        This method checks if a metering point code is valid by making a request
-        for aggregated metering data. If the unit property in the response is null,
-        it indicates that the metering point is invalid or not accessible.
+        NOTE: This method is essentially a best guess since the Leneda API does not provide a way to check
+        if a metering point provides data for a specific OBIS code or whether a metering point code is valid
+
+        This method checks if a metering point provides data for the specified OBIS code by making a request
+        for aggregated metering data. If the unit property in the response is null, it indicates that either:
+        - The metering point is invalid, or
+        - The metering point does not provide data for the specified OBIS code
 
         Args:
-            metering_point_code: The metering point code to test
+            metering_point_code: The metering point code to probe
+            obis_code: The OBIS code to check for data availability
 
         Returns:
-            bool: True if the metering point is valid and accessible, False otherwise
+            bool: True if the metering point provides data for the specified OBIS code, False otherwise
 
         Raises:
             UnauthorizedException: If the API returns a 401 status code
@@ -273,20 +278,43 @@ class LenedaClient:
         end_date = datetime.now()
         start_date = end_date - timedelta(weeks=4)
 
-        # Try to get aggregated data for electricity consumption
+        # Try to get aggregated data for the specified OBIS code
         result = self.get_aggregated_metering_data(
             metering_point_code=metering_point_code,
-            obis_code=ObisCode.ELEC_CONSUMPTION_ACTIVE,
+            obis_code=obis_code,
             start_date=start_date,
             end_date=end_date,
             aggregation_level="Month",
             transformation_mode="Accumulation",
         )
 
-        # If we get here and the unit is None, the metering point is invalid
-        if result.unit is None:
-            raise InvalidMeteringPointException(
-                f"Metering point {metering_point_code} is invalid or not accessible"
-            )
+        # 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]:
+        """
+        Get all OBIS codes that are supported by a given metering point.
+
+        NOTE: Please see the documentation of the probe_metering_point_obis_code method about best guess
+        behaviour. If this method returns an empty list, chances are high that the metering point code
+        is invalid or that the Energy ID has no access to it.
+
+        This method probes each OBIS code defined in the ObisCode enum to determine
+        which ones are supported by the specified metering point.
+
+        Args:
+            metering_point_code: The metering point code to check
 
-        return True
+        Returns:
+            List[ObisCode]: A list of OBIS codes that are supported by the metering point
+
+        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
+        """
+        return [
+            obis_code
+            for obis_code in ObisCode
+            if self.probe_metering_point_obis_code(metering_point_code, obis_code)
+        ]

leneda/exceptions.py

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

leneda/version.py

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: leneda-client
-Version: 0.3.0
+Version: 0.4.0
 Summary: Python client for the Leneda energy data platform
 Home-page: https://github.com/fedus/leneda-client
 Author: fedus

leneda_client-0.4.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+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,,

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

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

leneda_client-0.3.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-leneda/__init__.py,sha256=-BHIXBfTTbX6EKDHr2Bq7rPzsPNYrrkgs9AJqWJR_1Q,732
-leneda/client.py,sha256=X2seOTrUYLKuLxDJT6ryGdKfNelsOhVq7lenJjI3kmM,10825
-leneda/exceptions.py,sha256=a84T3uSDQsMiKyFUZTbJTAp3hELfI1GQDriqv6aMDb8,600
-leneda/models.py,sha256=jdU2cIZZDExUSiSfz9zaYjJepr0m3v_x5b1fyOaEI8Q,7930
-leneda/obis_codes.py,sha256=VfsJQN1U80eZ5g1bIteDCLkkmBQ0AIkkm_zNAeM1Dog,7507
-leneda/version.py,sha256=wtPxgfjm82dK-e3EK0shDP4_7DlFk8hkRkOIPd6mV58,50
-leneda_client-0.3.0.dist-info/licenses/LICENSE,sha256=nAhDs625lK6v8oLqjWCABKBKlwxVoRDFXQvoZPfOtKQ,1062
-leneda_client-0.3.0.dist-info/METADATA,sha256=RHArkKFQqY--FL7-RCwTUQTaJvMWLvdswIYbM-8Yr1U,3344
-leneda_client-0.3.0.dist-info/WHEEL,sha256=wXxTzcEDnjrTwFYjLPcsW_7_XihufBwmpiBeiXNBGEA,91
-leneda_client-0.3.0.dist-info/top_level.txt,sha256=PANScm25ep7WLjKiph0fhJPb8s_sa_uLHemnBpQBaJ8,7
-leneda_client-0.3.0.dist-info/RECORD,,