chellow 1745313690.0.0__tar.gz → 1745911639.0.0__tar.gz

{chellow-1745313690.0.0 → chellow-1745911639.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: chellow
-Version: 1745313690.0.0
+Version: 1745911639.0.0
 Summary: Web Application for checking UK energy bills.
 Project-URL: Homepage, https://github.com/WessexWater/chellow
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)

chellow-1745911639.0.0/VERSION

@@ -0,0 +1 @@
+__version__ = "1745911639.0.0"

chellow-1745911639.0.0/chellow/gas/bill_parser_bgs_xlsx.py

@@ -0,0 +1,271 @@
+import csv
+from datetime import datetime as Datetime
+from decimal import Decimal, InvalidOperation
+from enum import Enum, auto
+from io import BytesIO
+
+from dateutil.relativedelta import relativedelta
+
+from openpyxl import load_workbook
+
+from werkzeug.exceptions import BadRequest
+
+from chellow.utils import to_ct, to_utc
+
+
+class Title(Enum):
+    CUSTOMER = auto()
+    PRODUCT = auto()
+    BROKER_NAME = auto()
+    ACCOUNT = auto()
+    MPRN = auto()
+    BILL = auto()
+    SUPPLY_ADDRESS = auto()
+    BILL_DATE = auto()
+    BILLING_PERIOD = auto()
+    CHARGE_TYPE = auto()
+    CHARGE_PERIOD_FROM = auto()
+    CHARGE_PERIOD_END = auto()
+    QUANTITY = auto()
+    QUNIT = auto()
+    CHARGE = auto()
+    CUNIT = auto()
+    TOTAL = auto()
+
+
+COLUMNS = {
+    Title.CUSTOMER: ["Customer"],
+    Title.PRODUCT: ["Product"],
+    Title.BROKER_NAME: ["Broker Name"],
+    Title.ACCOUNT: ["Account"],
+    Title.MPRN: ["MPRN"],
+    Title.BILL: ["Bill"],
+    Title.SUPPLY_ADDRESS: ["Supply Address"],
+    Title.BILL_DATE: ["Bill Date"],
+    Title.BILLING_PERIOD: ["Billing Period"],
+    Title.CHARGE_TYPE: ["Charge Type"],
+    Title.CHARGE_PERIOD_FROM: ["Charge Period From"],
+    Title.CHARGE_PERIOD_END: ["Charge Period End"],
+    Title.QUANTITY: ["Quantity"],
+    Title.QUNIT: ["QUnit"],
+    Title.CHARGE: ["Charge"],
+    Title.CUNIT: ["CUnit"],
+    Title.TOTAL: ["Total"],
+}
+
+
+def make_column_map(title_row):
+    titles = [cell.value for cell in title_row]
+    column_map = {}
+    for title, title_names in COLUMNS.items():
+        idx = None
+        for title_name in title_names:
+            try:
+                idx = titles.index(title_name)
+            except ValueError:
+                pass
+        if idx is None:
+            raise BadRequest(f"For the title {title} a column can't be found")
+
+        column_map[title] = idx + 1
+    return column_map
+
+
+def get_date_naive(sheet, row, col):
+    value = get_value(sheet, row, col)
+    if value in ("", None):
+        return None
+    elif not isinstance(value, Datetime):
+        raise BadRequest(
+            f"Problem reading {value} as a timestamp at row {row} col {col}."
+        )
+    return value
+
+
+def get_date(sheet, row, col_name):
+    dt = get_date_naive(sheet, row, col_name)
+    return None if dt is None else to_utc(to_ct(dt))
+
+
+def get_value(sheet, row, col):
+    try:
+        return sheet.cell(row=row, column=col).value
+    except IndexError:
+        raise BadRequest(
+            f"Can't find the cell at row {row} and col {col} on sheet {sheet}."
+        )
+
+
+def get_str(sheet, row, col):
+    value = get_value(sheet, row, col)
+    if value is None:
+        return None
+
+    return value.strip()
+
+
+def get_dec(sheet, row, col):
+    value = get_value(sheet, row, col)
+    if value in ("", None):
+        return None
+
+    try:
+        return Decimal(str(value))
+    except InvalidOperation as e:
+        raise BadRequest(
+            f"Problem parsing the number '{value}' at row {row} col {col}. {e}"
+        )
+
+
+def get_int(sheet, row, col):
+    value = get_value(sheet, row, col)
+    try:
+        return int(value)
+    except ValueError as e:
+        raise BadRequest(
+            f"Problem parsing the integer '{value}' at row {row} col {col}. {e}"
+        )
+
+
+"""
+def _bd_add(bd, el_name, val):
+    if el_name.split("-")[-1] in ("rate", "kva"):
+        if el_name not in bd:
+            bd[el_name] = set()
+        bd[el_name].add(val)
+    else:
+        if el_name not in bd:
+            bd[el_name] = 0
+        try:
+            bd[el_name] += val
+        except TypeError as e:
+            raise BadRequest(
+                f"Problem with element name {el_name} and value '{val}': {e}"
+            )
+"""
+
+ELEMENT_LOOKUP = {
+    "Management Fee": "admin_variable",
+    "LDZ Customer Capacity": "dn_customer_capacity_fixed",
+    "LDZ System Capacity": "dn_system_capacity_fixed",
+    "LDZ System Commodity": "dn_system_capacity",
+    "Metering Charges": "metering",
+    "NTS Exit Capacity (ECN)": "dn_ecn_fixed",
+    "NTS SO Exit": "so_exit_commodity",
+    "NTS TO Exit": "to_exit_commodity",
+    "Unidentified Gas": "ug",
+    "WAP": "wap",
+}
+
+QUNIT_LOOKUP = {
+    "kWh": "kwh",
+    "days": "days",
+}
+
+
+def _parse_row(bills, sheet, row, title_row):
+    column_map = make_column_map(title_row)
+    mprn = get_value(sheet, row, column_map[Title.MPRN])
+    reference = get_value(sheet, row, column_map[Title.BILL])
+    account = get_value(sheet, row, column_map[Title.ACCOUNT])
+    issue_date = get_date(sheet, row, column_map[Title.BILL_DATE])
+    start_date = get_date(sheet, row, column_map[Title.CHARGE_PERIOD_FROM])
+    finish_date = to_utc(
+        to_ct(get_date_naive(sheet, row, column_map[Title.CHARGE_PERIOD_END]))
+        + relativedelta(hours=23, minutes=30)
+    )
+
+    try:
+        mprn_values = bills[mprn]
+    except KeyError:
+        mprn_values = bills[mprn] = {}
+
+    try:
+        start_date_values = mprn_values[start_date]
+    except KeyError:
+        start_date_values = mprn_values[start_date] = {}
+
+    try:
+        bill = start_date_values[finish_date]
+    except KeyError:
+        bill = start_date_values[finish_date] = {
+            "bill_type_code": "N",
+            "mprn": mprn,
+            "reference": reference,
+            "account": account,
+            "issue_date": issue_date,
+            "start_date": start_date,
+            "finish_date": finish_date,
+            "kwh": Decimal("0"),
+            "net_gbp": Decimal("0.00"),
+            "vat_gbp": Decimal("0.00"),
+            "gross_gbp": Decimal("0.00"),
+            "breakdown": {},
+        }
+
+    bd = bill["breakdown"]
+    element_desc = get_value(sheet, row, column_map[Title.CHARGE_TYPE])
+    quantity = get_dec(sheet, row, column_map[Title.QUANTITY])
+    qunit = get_value(sheet, row, column_map[Title.QUNIT])
+    charge = get_dec(sheet, row, column_map[Title.CHARGE]) / Decimal("100")
+    total = get_dec(sheet, row, column_map[Title.TOTAL])
+    if element_desc.startswith("20% VAT on "):
+        bill["net_gbp"] += quantity
+        bill["vat_gbp"] += total
+        bill["gross_gbp"] += quantity + total
+    else:
+        element_name = ELEMENT_LOOKUP[element_desc]
+        if element_name == "admin_variable":
+            bill["kwh"] += quantity
+        bd[f"{element_name}_gbp"] = total
+        element_qunit = QUNIT_LOOKUP[qunit]
+        bd[f"{element_name}_{element_qunit}"] = quantity
+        bd[f"{element_name}_rate"] = charge
+
+
+def _make_raw_bills(sheet):
+    bills = {}
+    rows = tuple(sheet.rows)
+    title_row = rows[1]
+    for row_index, row in enumerate(rows[2:], start=3):
+        val = row[0].value
+        if val not in (None, ""):
+            try:
+                _parse_row(bills, sheet, row_index, title_row)
+            except BadRequest as e:
+                raise BadRequest(f"On row {row_index + 1}: {e.description}")
+    print("bills", bills)
+
+    raw_bills = []
+    for mprn, mprn_values in bills.items():
+        for period_stat, period_start_values in mprn_values.items():
+            for period_finish, bill in period_start_values.items():
+                raw_bills.append(bill)
+
+    return raw_bills
+
+
+class Parser:
+    def __init__(self, f):
+        self.book = load_workbook(BytesIO(f), data_only=True)
+        self.sheet = self.book.worksheets[0]
+
+        self.last_line = None
+        lines = (self._set_last_line(i, l) for i, l in enumerate(f))
+        self.reader = csv.reader(lines, skipinitialspace=True)
+        self._line_number = None
+        self._title_line = None
+
+    @property
+    def line_number(self):
+        return None if self._line_number is None else self._line_number + 1
+
+    def _set_last_line(self, i, line):
+        self._line_numer = i
+        self.last_line = line
+        if i == 0:
+            self._title_line = line
+        return line
+
+    def make_raw_bills(self):
+        return _make_raw_bills(self.sheet)

chellow-1745313690.0.0/VERSION

@@ -1 +0,0 @@
-__version__ = "1745313690.0.0"