chellow 1759823276.0.0__tar.gz → 1761056531.0.0__tar.gz

{chellow-1759823276.0.0 → chellow-1761056531.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: chellow
-Version: 1759823276.0.0
+Version: 1761056531.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-1761056531.0.0/VERSION

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

{chellow-1759823276.0.0 → chellow-1761056531.0.0}/chellow/dloads.py

@@ -91,7 +91,7 @@ class DloadFile:
 def open_file(base, user, mode="r", newline=None, is_zip=False):
     global download_id
 
-    base = base.replace("/", "").replace(" ", "")
+    base = "".join(x if (x.isalnum() or x in "_.") else "_" for x in base)
     try:
         lock.acquire()
         if len(list(download_path.iterdir())) == 0:
@@ -108,7 +108,7 @@ def open_file(base, user, mode="r", newline=None, is_zip=False):
             un = user.proxy_username
         else:
             un = user.email_address
-        uname = un.replace("@", "").replace(".", "").replace("\\", "")
+        uname = "".join(x if (x.isalnum() or x in "_") else "_" for x in un)
 
     names = tuple("_".join((serial, v, uname, base)) for v in ("RUNNING", "FINISHED"))
     running_name, finished_name = tuple(download_path / name for name in names)

{chellow-1759823276.0.0 → chellow-1761056531.0.0}/chellow/e/lcc.py

@@ -46,7 +46,7 @@ def run_import(sess, log, set_progress):
     s = requests.Session()
     s.verify = False
 
-    for mod_name in ("chellow.e.cfd",):
+    for mod_name in ("chellow.e.cfd", "chellow.e.rab"):
         mod = import_module(mod_name)
         mod.lcc_import(sess, log, set_progress, s)
 

chellow-1761056531.0.0/chellow/e/rab.py

@@ -0,0 +1,75 @@
+from datetime import datetime as Datetime
+from decimal import Decimal
+
+
+from sqlalchemy import select
+
+from chellow.e.lcc import api_records
+from chellow.models import Contract, RateScript
+from chellow.utils import ct_datetime, to_ct, to_utc
+
+
+def hh(data_source):
+    try:
+        rab_cache = data_source.caches["rab"]
+    except KeyError:
+        rab_cache = data_source.caches["rab"] = {}
+
+    for h in data_source.hh_data:
+        try:
+            h["rab"] = rab_cache[h["start-date"]]
+        except KeyError:
+            h_start = h["start-date"]
+            rate_str = data_source.non_core_rate("rab_forecast_ilr_tra", h_start)[
+                "record"
+            ]["Interim_Levy_Rate_GBP_MWh"]
+            if rate_str == "":
+                base_rate_dec = Decimal("0")
+            else:
+                base_rate_dec = Decimal(rate_str) / Decimal(1000)
+
+            base_rate = float(base_rate_dec)
+
+            h["rab"] = rab_cache[h_start] = {
+                "interim": base_rate,
+            }
+
+
+def lcc_import(sess, log, set_progress, s):
+    import_forecast_ilr_tra(sess, log, set_progress, s)
+
+
+def _parse_date(date_str):
+    return to_utc(to_ct(Datetime.strptime(date_str[:10], "%Y-%m-%d")))
+
+
+def import_forecast_ilr_tra(sess, log, set_progress, s):
+    log("Starting to check for new LCC RAB Forecast ILR TRA")
+
+    contract_name = "rab_forecast_ilr_tra"
+    contract = Contract.find_non_core_by_name(sess, contract_name)
+    if contract is None:
+        contract = Contract.insert_non_core(
+            sess, contract_name, "", {}, to_utc(ct_datetime(1996, 4, 1)), None, {}
+        )
+
+    for record in api_records(log, s, "1231fbb3-93ee-4a33-87a9-f15bb377346d"):
+        period_start_str = record["Month"]
+        if len(period_start_str) == 0:
+            continue
+        period_start = _parse_date(period_start_str)
+
+        rs = sess.execute(
+            select(RateScript).where(
+                RateScript.contract == contract,
+                RateScript.start_date == period_start,
+            )
+        ).scalar_one_or_none()
+        if rs is None:
+            rs = contract.insert_rate_script(sess, period_start, {})
+
+        rs_script = rs.make_script()
+        rs_script["record"] = record
+        rs.update(rs_script)
+        sess.commit()
+    log("Finished LCC RAB Forecast ILR TRA")

{chellow-1759823276.0.0 → chellow-1761056531.0.0}/chellow/e/views.py

@@ -381,7 +381,7 @@ def channel_snags_get():
         total_snags_q = total_snags_q.where(Era.dc_contract == contract)
         snags_q = snags_q.where(Era.dc_contract == contract)
 
-    total_snags = g.sess.execute(total_snags_q)
+    total_snags = g.sess.scalars(total_snags_q).one()
 
     snag_groups = []
     prev_snag = None

{chellow-1759823276.0.0 → chellow-1761056531.0.0}/chellow/reports/report_247.py

@@ -1116,10 +1116,7 @@ def do_post(sess):
                 exp_mpan_core if imp_mpan_core is None else imp_mpan_core
             ]
 
-        if "compression" in request.values:
-            compression = req_bool("compression")
-        else:
-            compression = True
+        compression = req_bool("compression")
 
         user = g.user
 

chellow-1761056531.0.0/chellow/reports/report_channel_snags.py

@@ -0,0 +1,288 @@
+import csv
+import sys
+import threading
+import traceback
+
+from dateutil.relativedelta import relativedelta
+
+from flask import g, redirect, render_template
+
+from sqlalchemy.orm import joinedload
+from sqlalchemy.sql.expression import false, select, true
+
+from werkzeug.exceptions import BadRequest
+
+from chellow.dloads import open_file
+from chellow.models import (
+    Channel,
+    Contract,
+    Era,
+    Party,
+    RSession,
+    Site,
+    SiteEra,
+    Snag,
+    Supply,
+    User,
+)
+from chellow.utils import (
+    csv_make_val,
+    hh_before,
+    req_bool,
+    req_int,
+    req_int_none,
+    req_str,
+    utc_datetime_now,
+)
+
+
+def _make_rows(
+    sess,
+    now,
+    contract,
+    days_hidden,
+    is_ignored,
+    show_settlement,
+    only_ongoing,
+    days_long_hidden,
+    limit=None,
+):
+    cutoff_date = now - relativedelta(days=days_hidden)
+    q = (
+        select(Snag, Channel, Era, Supply, SiteEra, Site, Contract)
+        .join(Channel, Snag.channel_id == Channel.id)
+        .join(Era, Channel.era_id == Era.id)
+        .join(Supply, Era.supply_id == Supply.id)
+        .join(SiteEra, Era.site_eras)
+        .join(Site, SiteEra.site_id == Site.id)
+        .join(Contract, Era.dc_contract_id == Contract.id)
+        .where(
+            SiteEra.is_physical == true(),
+            Snag.start_date < cutoff_date,
+        )
+        .order_by(
+            Site.code,
+            Supply.id,
+            Channel.imp_related,
+            Channel.channel_type,
+            Snag.description,
+            Snag.start_date,
+            Snag.id,
+        )
+        .options(joinedload(Era.dc_contract))
+    )
+    if contract is not None:
+        q = q.where(Era.dc_contract == contract)
+
+    if not is_ignored:
+        q = q.where(Snag.is_ignored == false())
+
+    if show_settlement == "yes":
+        q = q.join(Party, Supply.dno_id == Party.id).where(Party.dno_code != "99")
+    elif show_settlement == "no":
+        q = q.join(Party, Supply.dno_id == Party.id).where(Party.dno_code == "99")
+    elif show_settlement == "both":
+        pass
+    else:
+        raise BadRequest("show_settlement must be 'yes', 'no' or 'both'.")
+
+    snag_groups = []
+    prev_snag = None
+    for snag, channel, era, supply, site_era, site, contract in sess.execute(q):
+        snag_start = snag.start_date
+        snag_finish = snag.finish_date
+
+        if snag_finish is None:
+            duration = now - snag_start
+            age_of_snag = None
+        else:
+            duration = snag_finish - snag_start
+            if hh_before(cutoff_date, snag_finish):
+                age_of_snag = None
+            else:
+                delta = now - snag_finish
+                age_of_snag = delta.days
+
+        if only_ongoing and age_of_snag is not None:
+            continue
+
+        if days_long_hidden is not None and duration < days_long_hidden:
+            continue
+
+        if (
+            prev_snag is None
+            or channel.era != prev_snag.channel.era
+            or snag.start_date != prev_snag.start_date
+            or snag.finish_date != prev_snag.finish_date
+            or snag.description != prev_snag.description
+        ):
+            if limit is not None and len(snag_groups) > limit:
+                break
+
+            snag_group = {
+                "snags": [],
+                "site": site,
+                "era": era,
+                "supply": supply,
+                "description": snag.description,
+                "start_date": snag.start_date,
+                "finish_date": snag.finish_date,
+                "contract": contract,
+                "contract_name": contract.name,
+                "hidden_days": days_hidden,
+                "chellow_id": snag.id,
+                "imp_mpan_core": era.imp_mpan_core,
+                "exp_mpan_core": era.exp_mpan_core,
+                "site_code": site.code,
+                "site_name": site.name,
+                "snag_description": snag.description,
+                "channel_type": channel.channel_type,
+                "is_ignored": snag.is_ignored,
+                "days_since_finished": age_of_snag,
+                "duration": duration.days,
+            }
+            snag_groups.append(snag_group)
+        snag_group["snags"].append(snag)
+        prev_snag = snag
+
+    def make_key(item):
+        return item["duration"]
+
+    snag_groups.sort(key=make_key, reverse=True)
+    return snag_groups
+
+
+def content(
+    contract_id,
+    days_hidden,
+    is_ignored,
+    user_id,
+    only_ongoing,
+    show_settlement,
+    days_long_hidden,
+):
+    f = writer = None
+    try:
+        with RSession() as sess:
+            user = User.get_by_id(sess, user_id)
+            if contract_id is None:
+                contract = None
+                namef = "all"
+            else:
+                contract = Contract.get_dc_by_id(sess, contract_id)
+                namef = contract.name
+
+            f = open_file(f"channel_snags_{namef}.csv", user, mode="w", newline="")
+            writer = csv.writer(f, lineterminator="\n")
+            titles = (
+                "contract",
+                "hidden_days",
+                "chellow_ids",
+                "imp_mpan_core",
+                "exp_mpan_core",
+                "site_code",
+                "site_name",
+                "snag_description",
+                "channel_types",
+                "start_date",
+                "finish_date",
+                "is_ignored",
+                "days_since_finished",
+                "duration",
+            )
+            writer.writerow(titles)
+
+            now = utc_datetime_now()
+            for snag_group in _make_rows(
+                sess,
+                now,
+                contract,
+                days_hidden,
+                is_ignored,
+                show_settlement,
+                only_ongoing,
+                days_long_hidden,
+            ):
+
+                vals = {
+                    "contract": snag_group["contract"].name,
+                    "hidden_days": days_hidden,
+                    "chellow_ids": [snag.id for snag in snag_group["snags"]],
+                    "imp_mpan_core": snag_group["imp_mpan_core"],
+                    "exp_mpan_core": snag_group["exp_mpan_core"],
+                    "site": snag_group["site"],
+                    "site_code": snag_group["site"].code,
+                    "site_name": snag_group["site"].name,
+                    "snag_description": snag_group["description"],
+                    "channel_types": [
+                        f"{s.channel.imp_related}_{s.channel.channel_type}"
+                        for s in snag_group["snags"]
+                    ],
+                    "start_date": snag_group["start_date"],
+                    "finish_date": snag_group["finish_date"],
+                    "is_ignored": snag_group["is_ignored"],
+                    "days_since_finished": snag_group["days_since_finished"],
+                    "duration": snag_group["duration"],
+                }
+
+                writer.writerow(csv_make_val(vals[t]) for t in titles)
+    except BaseException:
+        msg = traceback.format_exc()
+        sys.stderr.write(msg)
+        writer.writerow([msg])
+    finally:
+        if f is not None:
+            f.close()
+
+
+LIMIT = 200
+
+
+def do_get(sess):
+    contract_id = req_int_none("dc_contract_id")
+    days_hidden = req_int("days_hidden")
+    is_ignored = req_bool("is_ignored")
+    only_ongoing = req_bool("only_ongoing")
+    show_settlement = req_str("show_settlement")
+    as_csv = req_bool("as_csv")
+    days_long_hidden = req_int_none("days_long_hidden")
+
+    if as_csv:
+        args = (
+            contract_id,
+            days_hidden,
+            is_ignored,
+            g.user.id,
+            only_ongoing,
+            show_settlement,
+        )
+        threading.Thread(target=content, args=args).start()
+        return redirect("/downloads", 303)
+    else:
+        if contract_id is None:
+            contract = None
+        else:
+            contract = Contract.get_dc_by_id(sess, contract_id)
+        now = utc_datetime_now()
+        snag_groups = _make_rows(
+            sess,
+            now,
+            contract,
+            days_hidden,
+            is_ignored,
+            show_settlement,
+            only_ongoing,
+            days_long_hidden,
+            limit=LIMIT,
+        )
+        return render_template(
+            "reports/channel_snags.html",
+            contract=contract,
+            limit=LIMIT,
+            snag_groups=snag_groups,
+            days_hidden=days_hidden,
+            is_ignored=is_ignored,
+            only_ongoing=only_ongoing,
+            show_settlement=show_settlement,
+            days_long_hidden=days_long_hidden,
+        )

chellow-1761056531.0.0/chellow/templates/e/channel_snags.html

@@ -0,0 +1,61 @@
+{% extends "base.html" %}
+
+{% block title %}
+	» DC Contracts » 
+	{% if contract %}
+		{{contract.name}} »
+	{% endif %}
+	Channel Snags
+{% endblock %}
+
+{% block inside_head %}
+	<style>
+		#snags.htmx-swapping {
+			opacity: 0;
+			transition: opacity 1s ease-out;
+		}
+	</style>
+{% endblock %}
+
+{% block nav %}
+	<a href="/e/dc_contracts">DC Contracts</a> &raquo; 
+	{% if contract %}
+		<a href="/e/dc_contracts/{{contract.id}}">{{contract.name}}</a> &raquo;
+	{% endif %}
+ 	Channel Snags
+{% endblock %}
+
+{% block content %}
+	<form hx-get="/reports/channel_snags" hx-params="*" hx-include="this" hx-trigger="load, change"
+			hx-target="#snags" hx-swap="outerHTML swap:1s">
+		<fieldset>
+			<legend>Filters</legend>	
+			<input type="hidden" name="dc_contract_id" value="{{contract.id}}">
+			<label>Hide snags &lt; days old</label>
+			{{input_text('days_hidden', initial='5', size=3, maxlength=3)}}
+			<label>Include ignored snags</label> {{input_checkbox('is_ignored', False)}} 
+
+			<label>Only show ongoing snags</label>
+			{{input_checkbox('only_ongoing', initial=True)}} 
+
+			<fieldset>
+
+				<label>Show settlement only</label>
+				{{input_radio('show_settlement', 'yes', initial=False)}} 
+
+				<label>Show non-settlement only</label>
+				{{input_radio('show_settlement', 'no', initial=False)}} 
+
+				<label>Show both</label>
+				{{input_radio('show_settlement', 'both', initial=True)}} 
+
+			</fieldset>
+
+			<label>Hide snags &lt; days long</label>
+			{{input_text('days_long_hidden', initial='', size=3, maxlength=3)}}
+
+		</fieldset>
+	</form>
+
+	<div id="snags"></div>
+{% endblock %}

{chellow-1759823276.0.0 → chellow-1761056531.0.0}/chellow/templates/macros.html

@@ -124,13 +124,23 @@
 	</div>
 {%- endmacro -%}
 
-{%- macro input_checkbox(name, initial) %}
-	<input type="checkbox" name="{{ name }}" value="true"
+{%- macro input_checkbox(name, initial=False, value='true') %}
+	<input type="checkbox" name="{{ name }}" value="{{value}}"
 		{%- if request.values[name] -%}
-				{%- if request.values[name] == 'true' %} checked
+				{%- if request.values[name] == value %} checked
 				{%- endif -%}
 		{%- else -%}
-				{%- if initial == True %} checked{% endif -%}
+				{%- if initial %} checked{% endif -%}
+		{%- endif -%}>
+{%- endmacro -%}
+
+{%- macro input_radio(name, value, initial=False) %}
+	<input type="radio" name="{{ name }}" value="{{value}}"
+		{%- if request.values[name] -%}
+				{%- if request.values[name] == value %} checked
+				{%- endif -%}
+		{%- else -%}
+				{%- if initial %} checked{% endif -%}
 		{%- endif -%}>
 {%- endmacro -%}
 

chellow-1761056531.0.0/chellow/templates/reports/channel_snags.html

@@ -0,0 +1,91 @@
+{% extends "macros.html" %}
+
+{% block html %}
+	<table class="sticky" id="snags">
+		<caption>
+			Snags (truncated after 200)
+			<a href="/reports/channel_snags?dc_contract_id={{contract.id}}&amp;days_hidden={{days_hidden}}&amp;is_ignored={{is_ignored}}&amp;only_ongoing={{only_ongoing}}&amp;show_settlement={{show_settlement}}&amp;as_csv=true">Download as CSV</a>
+		</caption>
+		<thead>
+			<tr>
+				<th>View</th>
+				<th>Contract</th>
+				<th>Import MPAN Core</th>
+				<th>Export MPAN Core</th>
+				<th>Site</th>
+				<th>Description</th>
+				<th>Channels</th>
+				<th>Start Date</th>
+				<th>Finish Date</th>
+				<th>
+					<span title="Blank if the snag is ongoing (ie. if the finish date is 'ongoing' or if it finished less than 'Days Hidden' ago).">Days Since Finished</span>
+				</th>
+				<th>Duration</th>
+				<th>Comm</th>
+			</tr>
+		</thead>
+		<tbody>
+			{% for snag_group in snag_groups %}
+				<tr>
+					<td>
+						<ul>
+							{% for snag in snag_group.snags %}
+								<li>
+									<a href="/e/channel_snags/{{snag.id}}">view</a>
+									[<a href="/e/channel_snags/{{snag.id}}/edit">edit</a>]
+									{% if snag.is_ignored %} ignored{% endif %}
+								</li>
+							{% endfor %}
+						</ul>
+					</td>
+					<td>
+						<a href="/e/dc_contracts/{{snag_group.contract.id}}">{{snag_group.contract.name}}</a>
+					</td>
+					<td>
+						{% if snag_group.era.imp_mpan_core %}
+							<a href="/e/supplies/{{snag_group.supply.id}}">{{snag_group.era.imp_mpan_core}}</a>
+						{% endif %}
+					</td>
+					<td>
+						{% if snag_group.era.exp_mpan_core %}
+							<a href="/e/supplies/{{snag_group.supply.id}}">{{snag_group.era.exp_mpan_core}}</a>
+						{% endif %}
+					</td>
+					<td>
+						<a href="/sites/{{snag_group.site.id}}">{{snag_group.site.code}} {{snag_group.site.name}}</a>
+					</td>
+					<td>{{snag_group.description}}</td>
+					<td>
+						<ul>
+							{% for snag in snag_group.snags %}
+								<li>
+									{% if snag.channel.imp_related %}
+										Import
+									{% else %}
+										Export
+									{% endif %}
+									{{snag.channel.channel_type}}
+								</li>
+							{% endfor %}
+						</ul>
+					</td>
+					<td>
+						{{snag_group.start_date|hh_format}}
+					</td>
+					<td>
+						{{snag_group.finish_date|hh_format}}
+					</td>
+					<td>
+						{% if snag_group.days_since_finished %}
+							{{snag_group.days_since_finished}}
+						{% endif %}
+					</td>
+					<td>{{snag_group.duration}}</td>
+					<td>
+						<a href="/e/comms/{{snag_group.era.comm.id}}" title="{{snag_group.era.comm.description}}">{{snag_group.era.comm.code}}</a>
+					</td>
+				</tr>
+			{% endfor %}
+		</tbody>
+	</table>
+{% endblock %}

{chellow-1759823276.0.0 → chellow-1761056531.0.0}/chellow/utils.py

@@ -29,11 +29,15 @@ def req_str(name):
         raise BadRequest(f"The field {name} is required.")
 
 
-def req_bool(name):
+def req_strs(name):
     try:
-        return request.values[name] == "true"
+        return request.values.getlist(name)
     except KeyError:
-        return False
+        raise BadRequest(f"The field {name} is required.")
+
+
+def req_bool(name):
+    return name in request.values
 
 
 def req_int(name):
@@ -43,6 +47,13 @@ def req_int(name):
         raise BadRequest(f"Problem parsing the field {name} as an integer: {e}")
 
 
+def req_ints(name):
+    try:
+        return [int(v) for v in req_strs(name)]
+    except ValueError as e:
+        raise BadRequest(f"Problem parsing the field {name} as an integer: {e}")
+
+
 def req_int_none(name):
     val = req_str(name)
     if val == "":