e-data 1.2.10__tar.gz → 1.2.12__tar.gz

{e-data-1.2.10/e_data.egg-info → e-data-1.2.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: e-data
-Version: 1.2.10
+Version: 1.2.12
 Summary: Python library for managing spanish energy data from various web providers
 Home-page: https://github.com/uvejota/python-edata
 Author: VMG

{e-data-1.2.10 → e-data-1.2.12/e_data.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: e-data
-Version: 1.2.10
+Version: 1.2.12
 Summary: Python library for managing spanish energy data from various web providers
 Home-page: https://github.com/uvejota/python-edata
 Author: VMG

{e-data-1.2.10 → e-data-1.2.12}/edata/definitions.py

@@ -2,8 +2,7 @@
 
 import voluptuous as vol
 import datetime as dt
-from collections.abc import Iterable
-from typing import TypedDict, _TypedDictMeta
+from typing import TypedDict
 
 ATTRIBUTES = {
     "cups": None,
@@ -56,12 +55,24 @@ ATTRIBUTES = {
     "max_power_90perc_kW": "kW",
 }
 
-
+# Energy term with taxes
 DEFAULT_BILLING_ENERGY_FORMULA = "electricity_tax * iva_tax * kwh_eur * kwh"
+
+# Power term with taxes
 DEFAULT_BILLING_POWER_FORMULA = "electricity_tax * iva_tax * (p1_kw * (p1_kw_year_eur + market_kw_year_eur) + p2_kw * p2_kw_year_eur) / 365 / 24"
+
+# Others term with taxes
 DEFAULT_BILLING_OTHERS_FORMULA = "iva_tax * meter_month_eur / 30 / 24"
+
+# Surplus term with taxes
 DEFAULT_BILLING_SURPLUS_FORMULA = (
-    "electricity_tax * iva_tax * [surplus_kwh, kwh]|min * surplus_kwh_eur"
+    "electricity_tax * iva_tax * surplus_kwh * surplus_kwh_eur"
+)
+
+# Sum energy and power terms, and substract surplus until 0.
+# An alternative would be "[(energy_term + power_term - surplus_term), 0]|max + others_term"
+DEFAULT_BILLING_MAIN_FORMULA = (
+    "[(energy_term - surplus_term), 0]|max + power_term + others_term"
 )
 
 
@@ -113,8 +124,8 @@ ContractSchema = vol.Schema(
         vol.Required("date_end"): dt.datetime,
         vol.Required("marketer"): str,
         vol.Required("distributorCode"): str,
-        vol.Required("power_p1"): vol.Union(float, None),
-        vol.Required("power_p2"): vol.Union(float, None),
+        vol.Required("power_p1"): vol.Union(vol.Coerce(float), None),
+        vol.Required("power_p2"): vol.Union(vol.Coerce(float), None),
     }
 )
 
@@ -218,6 +229,7 @@ PricingRulesSchema = vol.Schema(
         vol.Optional("power_formula", default=DEFAULT_BILLING_POWER_FORMULA): str,
         vol.Optional("others_formula", default=DEFAULT_BILLING_OTHERS_FORMULA): str,
         vol.Optional("surplus_formula", default=DEFAULT_BILLING_SURPLUS_FORMULA): str,
+        vol.Optional("main_formula", default=DEFAULT_BILLING_MAIN_FORMULA): str,
         vol.Optional("cycle_start_day", default=1): vol.Range(1, 30),
     }
 )

{e-data-1.2.10 → e-data-1.2.12}/edata/helpers.py

@@ -58,6 +58,7 @@ class EdataHelper:
         self._date_from = datetime(1970, 1, 1)
         self._date_to = datetime.today()
         self._must_dump = True
+        self._incremental_update = True
 
         if data is not None:
             data = check_storage_integrity(data)
@@ -107,10 +108,12 @@ class EdataHelper:
         self,
         date_from: datetime = datetime(1970, 1, 1),
         date_to: datetime = datetime.today(),
+        incremental_update: bool = True,
     ):
         """Synchronous update."""
         self._date_from = date_from
         self._date_to = date_to
+        self._incremental_update = incremental_update
 
         # update datadis resources
         self.update_datadis(self._cups, date_from, date_to)
@@ -423,10 +426,12 @@ class EdataHelper:
     def process_consumptions(self):
         """Process consumptions data."""
         if len(self.data["consumptions"]) > 0:
-            try:
-                new_data_from = self.data["consumptions_monthly_sum"][-1]["datetime"]
-            except Exception:
-                new_data_from = self._date_from
+            new_data_from = self._date_from
+            if self._incremental_update:
+                with contextlib.suppress(Exception):
+                    new_data_from = self.data["consumptions_monthly_sum"][-1][
+                        "datetime"
+                    ]
 
             proc = ConsumptionProcessor(
                 {
@@ -624,10 +629,10 @@ class EdataHelper:
     def process_cost(self):
         """Process costs."""
         if self.enable_billing:
-            try:
-                new_data_from = self.data["cost_monthly_sum"][-1]["datetime"]
-            except Exception:
-                new_data_from = self._date_from
+            new_data_from = self._date_from
+            if self._incremental_update:
+                with contextlib.suppress(Exception):
+                    new_data_from = self.data["cost_monthly_sum"][-1]["datetime"]
 
             proc = BillingProcessor(
                 BillingInput(

{e-data-1.2.10 → e-data-1.2.12}/edata/processors/base.py

@@ -1,4 +1,4 @@
-"""Base definitions for processors"""
+"""Base definitions for processors."""
 
 from abc import ABC, abstractmethod
 from copy import deepcopy
@@ -6,11 +6,11 @@ from typing import Any
 
 
 class Processor(ABC):
-    """A base class for data processors"""
+    """A base class for data processors."""
 
     _LABEL = "Processor"
 
-    def __init__(self, input_data: Any, auto: bool = True):
+    def __init__(self, input_data: Any, auto: bool = True) -> None:
         """Init method."""
         self._input = deepcopy(input_data)
         self._output = None
@@ -19,7 +19,7 @@ class Processor(ABC):
 
     @abstractmethod
     def do_process(self):
-        """The processing method."""
+        """Process method."""
 
     @property
     def output(self):

{e-data-1.2.10 → e-data-1.2.12}/edata/processors/billing.py

@@ -1,10 +1,11 @@
 """Billing data processors."""
 
-import logging
+import contextlib
 from datetime import datetime, timedelta
+import logging
 from typing import Optional, TypedDict
-from jinja2 import Environment
 
+from jinja2 import Environment
 import voluptuous
 
 from ..definitions import (
@@ -20,7 +21,6 @@ from ..definitions import (
 )
 from ..processors import utils
 from ..processors.base import Processor
-import contextlib
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -46,7 +46,7 @@ class BillingProcessor(Processor):
     """A billing processor for edata."""
 
     def do_process(self):
-        """Main method for the BillingProcessor."""
+        """Process billing and get hourly/daily/monthly metrics."""
         self._output = BillingOutput(hourly=[], daily=[], monthly=[])
 
         _schema = voluptuous.Schema(
@@ -103,6 +103,9 @@ class BillingProcessor(Processor):
         surplus_expr = env.compile_expression(
             f'({self._input["rules"]["surplus_formula"]})|float|round(3)'
         )
+        main_expr = env.compile_expression(
+            f'({self._input["rules"]["main_formula"]})|float|round(3)'
+        )
 
         _data = sorted([_data[x] for x in _data], key=lambda x: x["datetime"])
         hourly = []
@@ -147,15 +150,6 @@ class BillingProcessor(Processor):
                 value_eur=0,
                 delta_h=1,
             )
-
-            new_item["value_eur"] = round(
-                new_item["energy_term"]
-                + new_item["power_term"]
-                + new_item["others_term"]
-                - new_item["surplus_term"],
-                3,
-            )
-
             hourly.append(new_item)
 
         self._output["hourly"] = hourly
@@ -186,8 +180,8 @@ class BillingProcessor(Processor):
                 self._output["daily"][-1]["power_term"] += hour["power_term"]
                 self._output["daily"][-1]["others_term"] += hour["others_term"]
                 self._output["daily"][-1]["surplus_term"] += hour["surplus_term"]
-                self._output["daily"][-1]["value_eur"] += hour["value_eur"]
                 self._output["daily"][-1]["delta_h"] += hour["delta_h"]
+                self._output["daily"][-1]["value_eur"] += hour["value_eur"]
 
             if last_month_dt is None or curr_month_dt != last_month_dt:
                 self._output["monthly"].append(
@@ -218,4 +212,4 @@ class BillingProcessor(Processor):
                 cost["power_term"] = round(cost["power_term"], 3)
                 cost["others_term"] = round(cost["others_term"], 3)
                 cost["surplus_term"] = round(cost["surplus_term"], 3)
-                cost["value_eur"] = round(cost["value_eur"], 3)
+                cost["value_eur"] = round(main_expr(**cost, **self._input["rules"]), 3)

{e-data-1.2.10 → e-data-1.2.12}/setup.py

@@ -20,7 +20,7 @@ URL = "https://github.com/uvejota/python-edata"
 EMAIL = "vmayorg@outlook.es"
 AUTHOR = "VMG"
 REQUIRES_PYTHON = ">=3.6.0"
-VERSION = "1.2.10"
+VERSION = "1.2.12"
 
 # What packages are required for this module to be executed?
 REQUIRED = [