chellow 1760028799.0.0__tar.gz → 1761297878.0.0__tar.gz

{chellow-1760028799.0.0 → chellow-1761297878.0.0}/PKG-INFO

@@ -1,30 +1,28 @@
 Metadata-Version: 2.4
 Name: chellow
-Version: 1760028799.0.0
+Version: 1761297878.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)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.11
-Requires-Dist: flask-restx==1.3.0
-Requires-Dist: flask==3.1.1
-Requires-Dist: jsonschema==4.17.3
+Requires-Dist: flask-restx==1.3.2
+Requires-Dist: flask==3.1.2
 Requires-Dist: odio==0.0.23
 Requires-Dist: openpyxl==3.1.5
-Requires-Dist: paramiko==3.4.1
-Requires-Dist: pep3143daemon==0.1.0
+Requires-Dist: paramiko==4.0.0
 Requires-Dist: pg8000==1.31.5
 Requires-Dist: pip>=9.0.1
-Requires-Dist: psutil==5.9.5
-Requires-Dist: pympler==1.0.1
-Requires-Dist: pypdf==6.0.0
+Requires-Dist: psutil==7.1.1
+Requires-Dist: pympler==1.1
+Requires-Dist: pypdf==6.1.3
 Requires-Dist: python-dateutil==2.8.2
-Requires-Dist: pytz==2022.6
-Requires-Dist: requests==2.32.4
-Requires-Dist: sqlalchemy==2.0.41
-Requires-Dist: waitress==3.0.1
-Requires-Dist: xlrd==2.0.1
+Requires-Dist: pytz==2025.2
+Requires-Dist: requests==2.32.5
+Requires-Dist: sqlalchemy==2.0.44
+Requires-Dist: waitress==3.0.2
+Requires-Dist: xlrd==2.0.2
 Requires-Dist: zish==0.1.12
 Description-Content-Type: text/markdown
 

chellow-1761297878.0.0/VERSION

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

{chellow-1760028799.0.0 → chellow-1761297878.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-1760028799.0.0 → chellow-1761297878.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
@@ -5711,7 +5711,7 @@ def supplier_contract_edit_delete(contract_id):
         contract = Contract.get_supplier_by_id(g.sess, contract_id)
         contract.delete(g.sess)
         g.sess.commit()
-        return chellow_redirect("/supplier_contracts", 303)
+        return hx_redirect("/supplier_contracts", 303)
     except BadRequest as e:
         g.sess.rollback()
         description = e.description
@@ -5882,25 +5882,39 @@ def supplier_rate_script_edit_get(rate_script_id):
     )
 
 
+@e.route("/supplier_rate_scripts/<int:rate_script_id>/edit", methods=["DELETE"])
+def supplier_rate_script_edit_delete(rate_script_id):
+    try:
+        rate_script = RateScript.get_supplier_by_id(g.sess, rate_script_id)
+        contract = rate_script.contract
+        contract.delete_rate_script(g.sess, rate_script)
+        g.sess.commit()
+        return hx_redirect(f"/supplier_contracts/{contract.id}", 303)
+    except BadRequest as e:
+        g.sess.rollback()
+        flash(e.description)
+        return make_response(
+            render_template(
+                "supplier_rate_script_edit.html", supplier_rate_script=rate_script
+            ),
+            400,
+        )
+
+
 @e.route("/supplier_rate_scripts/<int:rate_script_id>/edit", methods=["POST"])
 def supplier_rate_script_edit_post(rate_script_id):
     try:
         rate_script = RateScript.get_supplier_by_id(g.sess, rate_script_id)
         contract = rate_script.contract
-        if "delete" in request.values:
-            contract.delete_rate_script(g.sess, rate_script)
-            g.sess.commit()
-            return chellow_redirect(f"/supplier_contracts/{contract.id}", 303)
-        else:
-            script = req_zish("script")
-            start_date = req_date("start")
-            has_finished = req_bool("has_finished")
-            finish_date = req_date("finish") if has_finished else None
-            contract.update_rate_script(
-                g.sess, rate_script, start_date, finish_date, script
-            )
-            g.sess.commit()
-            return chellow_redirect(f"/supplier_rate_scripts/{rate_script.id}", 303)
+        script = req_zish("script")
+        start_date = req_date("start")
+        has_finished = req_bool("has_finished")
+        finish_date = req_date("finish") if has_finished else None
+        contract.update_rate_script(
+            g.sess, rate_script, start_date, finish_date, script
+        )
+        g.sess.commit()
+        return chellow_redirect(f"/supplier_rate_scripts/{rate_script.id}", 303)
     except BadRequest as e:
         g.sess.rollback()
         flash(e.description)

{chellow-1760028799.0.0 → chellow-1761297878.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-1761297878.0.0/chellow/reports/report_channel_snags.py

@@ -0,0 +1,294 @@
+import csv
+import sys
+import threading
+import traceback
+
+from dateutil.relativedelta import relativedelta
+
+from flask import g, redirect, render_template, request
+
+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_date,
+    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,
+    now,
+):
+    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)
+
+            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 "now_year" in request.values:
+        now = req_date("now")
+    else:
+        now = utc_datetime_now()
+
+    if as_csv:
+        args = (
+            contract_id,
+            days_hidden,
+            is_ignored,
+            g.user.id,
+            only_ongoing,
+            show_settlement,
+            now,
+        )
+        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-1761297878.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-1761297878.0.0/chellow/templates/e/supplier_contract_edit.html

@@ -0,0 +1,40 @@
+{% extends "base.html" %}
+
+{% block title %}
+	» Supplier Contracts » {{contract.name}}
+{% endblock %}
+
+{% block nav %}
+		<a href="/e/supplier_contracts">Supplier Contracts</a> &raquo; 
+		<a href="/e/supplier_contracts/{{contract.id}}">{{contract.name}}</a>
+		&raquo; Edit
+{% endblock %}
+
+{% block content %}
+
+	<form method="post">
+		<fieldset>
+			<legend>Update Contract</legend>	
+			<label>Party</label>
+			<select name="party_id">
+				{% for party in parties %}
+					{{ input_option('party_id', party.id, party.participant.code + ' : ' + party.name, contract.party.id) }}
+				{% endfor %}
+			</select>
+			<label>Name</label>
+			{{input_text('name', contract.name)}}
+			<label>Charge script</label>
+			{{input_textarea('charge_script', contract.charge_script, 40, 80, show_pos=True)}}
+			<label>Properties</label>
+			{{input_textarea('properties', contract.properties, 20, 80)}}
+			<input type="submit" value="Update">
+		</fieldset>
+	</form>
+
+	<form hx-delete="/e/supplier_contracts/{{contract.id}}/edit" hx-confirm="Are you sure you want to delete this contract?">
+		<fieldset>
+			<legend>Delete this contract</legend>	
+			<input type="submit" name="delete" value="Delete">
+		</fieldset>
+	</form>
+{% endblock %}

chellow-1761297878.0.0/chellow/templates/e/supplier_rate_script_edit.html

@@ -0,0 +1,50 @@
+{% extends "base.html" %}
+
+{% block title %}
+	» Supplier Contracts » {{supplier_rate_script.contract.name}} » 
+ 	Rate Scripts » {{supplier_rate_script.start_date|hh_format}} » Edit
+{% endblock %}
+
+{% block nav %}
+	<a href="/e/supplier_contracts">Supplier Contracts</a> &raquo; 
+	<a href="/e/supplier_contracts/{{supplier_rate_script.contract.id}}"
+		>{{supplier_rate_script.contract.name}}</a> &raquo; 
+	<a href="/e/supplier_rate_scripts/{{supplier_rate_script.id}}"
+		>Rate Script {{supplier_rate_script.start_date|hh_format}}</a> &raquo; Edit
+{% endblock %}
+
+{% block content %}
+	<form action="/e/supplier_rate_scripts/{{supplier_rate_script.id}}/edit" method="post">
+		<fieldset>
+			<legend>Update Rate Script</legend>	
+			<fieldset>
+				<legend>Start date</legend>
+				{{ input_date('start', supplier_rate_script.start_date) }}
+			</fieldset>
+			<fieldset>
+				<legend>Finish date</legend>
+				<label>
+					Ended?
+					{{input_checkbox('has_finished', supplier_rate_script.finish_date != None)}}
+				</label>
+				{{ input_date('finish', supplier_rate_script.finish_date) }}
+			</fieldset>
+			<label>Script</label>
+			{{ input_textarea(
+				'script', supplier_rate_script.script, 40, 80, show_pos=True) }}
+			<input type="submit" value="Update">
+		</fieldset>
+	</form>
+
+	{% if rate_script_example %}
+			<h4>Example</h4>
+			<pre>{{rate_script_example}}</pre>
+	{% endif %}
+
+	<form hx-delete="/e/supplier_rate_scripts/{{supplier_rate_script.id}}/edit" hx-confirm="Are you sure you want to delete this rate script?">
+		<fieldset>
+			<legend>Delete this Rate Script</legend>
+			<input type="submit" name="delete" value="Delete">
+		</fieldset>
+	</form>
+{% endblock %}

{chellow-1760028799.0.0 → chellow-1761297878.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 -%}