python-mytnb 0.5.0__tar.gz → 0.5.2__tar.gz

{python_mytnb-0.5.0 → python_mytnb-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-mytnb
-Version: 0.5.0
+Version: 0.5.2
 Summary: Python library to interface with the myTNB API (Tenaga Nasional Berhad)
 Project-URL: Repository, https://github.com/danieyal/python-mytnb
 License-Expression: MIT

{python_mytnb-0.5.0 → python_mytnb-0.5.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "python-mytnb"
-version = "0.5.0"
+version = "0.5.2"
 description = "Python library to interface with the myTNB API (Tenaga Nasional Berhad)"
 readme = "README.md"
 license = "MIT"

{python_mytnb-0.5.0 → python_mytnb-0.5.2}/src/mytnb/models.py

@@ -267,6 +267,32 @@ class AccountUsage(BaseModel):
                 return m.numeric_value
         return None
 
+    @property
+    def average_usage_kwh(self) -> Optional[float]:
+        """Average daily consumption (kWh) across available daily readings.
+
+        Computed from ``by_day`` rather than a usage metric: the API's
+        ``AVERAGEUSAGE`` metric is a percentage comparison against the previous
+        bill period (e.g. "20% — More than the last bill period"), not a kWh
+        value. Days with no recorded consumption are excluded: both missing
+        readings and zero-usage days (such as the current, still-partial day).
+        Returns None when there is no usable daily data.
+        """
+        values: list[float] = []
+        for week in self.by_day:
+            for day in week.days:
+                if day.is_missing_reading:
+                    continue
+                try:
+                    consumption = day.consumption_kwh
+                except (ValueError, TypeError):
+                    continue
+                if consumption > 0:
+                    values.append(consumption)
+        if not values:
+            return None
+        return round(sum(values) / len(values), 2)
+
     @property
     def current_cost_rm(self) -> Optional[float]:
         for m in self.cost_metrics:

{python_mytnb-0.5.0 → python_mytnb-0.5.2}/tests/test_models.py

@@ -88,12 +88,15 @@ FULL_API_RESPONSE = {
     "OtherUsageMetrics": {
         "Usage": [
             USAGE_METRIC_DATA,
+            # Real API shape: AVERAGEUSAGE is a percentage comparison vs the last
+            # bill period, not a kWh average (that's why average_usage_kwh is
+            # computed from by_day instead of read from this metric).
             {
-                "Key": "AVGUSAGE",
+                "Key": "AVERAGEUSAGE",
                 "Title": "Avg Usage",
-                "SubTitle": "daily",
-                "Value": "15.6",
-                "ValueUnit": "kWh",
+                "SubTitle": "More than the last bill period",
+                "Value": "20%",
+                "ValueUnit": "",
             },
         ],
         "Cost": [
@@ -244,6 +247,38 @@ class TestAccountUsage:
         usage = AccountUsage.from_api_response(FULL_API_RESPONSE)
         assert usage.current_usage_kwh == 234.5
 
+    def test_average_usage_kwh(self):
+        # Computed from by_day (mean of daily consumption), not a usage metric.
+        usage = AccountUsage.from_api_response(FULL_API_RESPONSE)
+        assert usage.average_usage_kwh == 8.5
+
+    def test_average_usage_kwh_multiple_days(self):
+        data = {
+            "ByDay": [
+                {
+                    "Range": "Week 1",
+                    "Days": [
+                        # Two valid days that count toward the average.
+                        {"Date": "2026-06-01", "Year": "2026", "Month": "06",
+                         "Day": "01", "Consumption": "10", "Amount": "2.7"},
+                        {"Date": "2026-06-02", "Year": "2026", "Month": "06",
+                         "Day": "02", "Consumption": "20", "Amount": "5.4"},
+                        # Excluded via the missing-reading flag (high value would
+                        # skew the mean if the filter regressed).
+                        {"Date": "2026-06-03", "Year": "2026", "Month": "06",
+                         "Day": "03", "Consumption": "99", "Amount": "26.7",
+                         "IsMissingReading": True},
+                        # Excluded via zero consumption (the current partial day),
+                        # independently of the missing-reading flag.
+                        {"Date": "2026-06-04", "Year": "2026", "Month": "06",
+                         "Day": "04", "Consumption": "0", "Amount": "0"},
+                    ],
+                }
+            ],
+        }
+        usage = AccountUsage.from_api_response(data)
+        assert usage.average_usage_kwh == 15.0  # mean(10, 20)
+
     def test_current_cost_rm(self):
         usage = AccountUsage.from_api_response(FULL_API_RESPONSE)
         assert usage.current_cost_rm == 87.60
@@ -280,6 +315,7 @@ class TestAccountUsage:
     def test_empty_response(self):
         usage = AccountUsage.from_api_response({})
         assert usage.current_usage_kwh is None
+        assert usage.average_usage_kwh is None
         assert usage.current_cost_rm is None
         assert usage.projected_cost_rm is None
         assert usage.by_month is None
@@ -291,6 +327,7 @@ class TestAccountUsage:
         }
         usage = AccountUsage.from_api_response(data)
         assert usage.current_usage_kwh is None
+        assert usage.average_usage_kwh is None
         assert usage.current_cost_rm is None
 
 

{python_mytnb-0.5.0 → python_mytnb-0.5.2}/uv.lock

@@ -600,7 +600,7 @@ wheels = [
 
 [[package]]
 name = "python-mytnb"
-version = "0.4.0"
+version = "0.5.2"
 source = { editable = "." }
 dependencies = [
     { name = "cryptography" },