chellow 1729755916.0.0__tar.gz → 1729849426.0.0__tar.gz

{chellow-1729755916.0.0 → chellow-1729849426.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: chellow
-Version: 1729755916.0.0
+Version: 1729849426.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-1729849426.0.0/VERSION

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

{chellow-1729755916.0.0 → chellow-1729849426.0.0}/chellow/gas/engine.py

@@ -76,8 +76,14 @@ def get_g_engine_cache(caches, name):
     try:
         return caches["g_engine"][name]
     except KeyError:
-        caches["g_engine"] = defaultdict(dict)
-        return caches["g_engine"][name]
+        try:
+            gcache = caches["g_engine"]
+        except KeyError:
+            gcache = caches["g_enine"] = {}
+
+        cache = gcache[name] = {}
+
+        return cache
 
 
 def g_contract_func(caches, contract, func_name):

{chellow-1729755916.0.0 → chellow-1729849426.0.0}/chellow/reports/report_g_monthly_duration.py

@@ -14,7 +14,7 @@ from werkzeug.exceptions import BadRequest
 import chellow.e.computer
 from chellow.dloads import open_file
 from chellow.e.computer import contract_func, forecast_date
-from chellow.gas.engine import GDataSource
+from chellow.gas.engine import GDataSource, g_rates
 from chellow.models import (
     GBill,
     GContract,
@@ -28,11 +28,13 @@ from chellow.models import (
     User,
 )
 from chellow.utils import (
+    PropDict,
     c_months_c,
     c_months_u,
     hh_format,
     hh_max,
     hh_min,
+    hh_range,
     make_val,
     req_bool,
     req_int,
@@ -162,6 +164,16 @@ def _process_era(
 
 def content(scenario_props, user_id, compression, now, base_name):
     report_context = {}
+    try:
+        eng = report_context["g_engine"]
+    except KeyError:
+        eng = report_context["g_engine"] = {}
+
+    try:
+        rss_cache = eng["rates"]
+    except KeyError:
+        rss_cache = eng["rates"] = {}
+
     try:
         with RSession() as sess:
             start_year = scenario_props["scenario_start_year"]
@@ -197,7 +209,7 @@ def content(scenario_props, user_id, compression, now, base_name):
             else:
                 forecast_from = to_utc(forecast_from)
 
-            sites = sess.query(Site).distinct().order_by(Site.code)
+            sites = select(Site).join(SiteGEra).distinct().order_by(Site.code)
 
             mprns = scenario_props.get("mprns")
             g_supply_ids = None
@@ -214,10 +226,7 @@ def content(scenario_props, user_id, compression, now, base_name):
                     base_name.append("mprns")
 
                 sites = (
-                    sites.join(SiteGEra)
-                    .join(GEra)
-                    .join(GSupply)
-                    .where(GSupply.id.in_(g_supply_ids))
+                    sites.join(GEra).join(GSupply).where(GSupply.id.in_(g_supply_ids))
                 )
 
             site_codes = scenario_props.get("site_codes")
@@ -229,6 +238,53 @@ def content(scenario_props, user_id, compression, now, base_name):
                     base_name.append("sitecodes")
                 sites = sites.where(Site.code.in_(site_codes))
 
+            for is_industry, rates_prop in (
+                (True, "industry_rates"),
+                (False, "supplier_rates"),
+            ):
+
+                for rate_script in scenario_props.get(rates_prop, []):
+                    g_contract_id = rate_script["g_contract_id"]
+                    try:
+                        i_cache = rss_cache[is_industry]
+                    except KeyError:
+                        i_cache = rss_cache[is_industry] = {}
+
+                    try:
+                        cont_cache = i_cache[g_contract_id]
+                    except KeyError:
+                        cont_cache = i_cache[g_contract_id] = {}
+
+                    try:
+                        rate_script_start = rate_script["start_date"]
+                    except KeyError:
+                        raise BadRequest(
+                            f"Problem in the scenario properties. Can't find the "
+                            f"'start_date' key of the contract {g_contract_id} in the "
+                            f"'{rates_prop}' map."
+                        )
+
+                    try:
+                        rate_script_finish = rate_script["finish_date"]
+                    except KeyError:
+                        raise BadRequest(
+                            f"Problem in the scenario properties. Can't find the "
+                            f"'finish_date' key of the contract {g_contract_id} in the "
+                            f"'{rates_prop}' map."
+                        )
+
+                    for dt in hh_range(
+                        report_context, rate_script_start, rate_script_finish
+                    ):
+                        g_rates(sess, report_context, g_contract_id, dt, is_industry)
+
+                    for dt in hh_range(
+                        report_context, rate_script_start, rate_script_finish
+                    ):
+                        storage = cont_cache[dt]._storage.copy()
+                        storage.update(rate_script["script"])
+                        cont_cache[dt] = PropDict("scenario properties", storage)
+
             user = User.get_by_id(sess, user_id)
             fname = "_".join(base_name) + ".ods"
             rf = open_file(fname, user, mode="wb")
@@ -279,7 +335,7 @@ def content(scenario_props, user_id, compression, now, base_name):
                 sess.query(GContract)
                 .join(GEra)
                 .join(GSupply)
-                .filter(
+                .where(
                     GEra.start_date <= finish_date,
                     or_(GEra.finish_date == null(), GEra.finish_date >= start_date),
                 )
@@ -318,9 +374,13 @@ def content(scenario_props, user_id, compression, now, base_name):
                     "billed_vat_gbp": 0,
                     "billed_gross_gbp": 0,
                 }
-                for site in sites.filter(
-                    GEra.start_date <= month_finish,
-                    or_(GEra.finish_date == null(), GEra.finish_date >= month_start),
+                for site in sess.scalars(
+                    sites.where(
+                        GEra.start_date <= month_finish,
+                        or_(
+                            GEra.finish_date == null(), GEra.finish_date >= month_start
+                        ),
+                    )
                 ):
                     linked_sites = {
                         s.code

{chellow-1729755916.0.0 → chellow-1729849426.0.0}/chellow/templates/base.html

@@ -72,7 +72,7 @@
 											>Edit Local Reports</a>
 									</li>
 									<li><a href="/e/site_snags" title="Site Snags">Site Snags</a></li>
-									<li><a href="/e/scenarios" title="Scenarios">Scenarios</a></li>
+									<li><a href="/scenarios" title="Scenarios">Scenarios</a></li>
 									<li><a href="/reports/batches">Batches</a></li>
 									<li><a href="/edi_viewer" title="EDI Viewer">EDI Viewer</a></li>
 									<li>

{chellow-1729755916.0.0 → chellow-1729849426.0.0}/chellow/templates/scenario.html

@@ -15,9 +15,9 @@
 			<legend>Run With Monthly Duration</legend>
 			<fieldset>
 				<input type="hidden" name="scenario_id" value="{{scenario.id}}">
-				<label>Months</label> {{input_text('months', '1', 2, 2)}}
+				<label>Months</label> {{input_text('months', initial=scenario_duration, size=2, maxlength=2)}}
 				<label>Finish Month</label>
-				{{input_date('finish', month_finish, resolution='month')}}
+				{{input_date('finish', scenario_finish_date, resolution='month')}}
 				<input type="submit" value="Run">
 			</fieldset>
 		</form>

{chellow-1729755916.0.0 → chellow-1729849426.0.0}/chellow/templates/scenario_add.html

@@ -5,11 +5,11 @@
 {% endblock %}
 
 {% block nav %}
-	<a href="/e/scenarios">Scenarios</a> &raquo; Add
+	<a href="/scenarios">Scenarios</a> &raquo; Add
 {% endblock %}
 
 {% block content %}
-	<form action="/e/scenarios/add" method="post">
+	<form action="/scenarios/add" method="post">
 		<fieldset>
 			<legend>Add a scenario</legend>	
 			<label>Name</label> {{input_text('name')}}

{chellow-1729755916.0.0 → chellow-1729849426.0.0}/chellow/templates/scenario_docs.html

@@ -224,11 +224,11 @@
       "XJJK4",
   ],
 
-  /* Rates */
+  /* Supplier Rates */
 
-  "rates": [
+  "supplier_rates": [
     {
-      "contract_id": 46,
+      "g_contract_id": 46,
       "start_date": 2014-10-01T00:00:00Z,
       "finish_date": 2015-05-01T00:00:00Z,
       "script": {
@@ -237,7 +237,7 @@
     },
 
     {
-      "contract_id": 3,
+      "g_contract_id": 3,
       "start_date": 2015-01-01T00:00:00Z,
       "finish_date": 2015-03-01T00:00:00Z,
       "script": {
@@ -246,8 +246,29 @@
     }
   ],
 
+  /* Industry Rates */
 
-  "era_maps": {
+  "industry_rates": [
+    {
+      "g_contract_id": 46,
+      "start_date": 2014-10-01T00:00:00Z,
+      "finish_date": 2015-05-01T00:00:00Z,
+      "script": {
+        "gbp_per_msp_kwh": 0.667
+      }
+    },
+
+    {
+      "g_contract_id": 3,
+      "start_date": 2015-01-01T00:00:00Z,
+      "finish_date": 2015-03-01T00:00:00Z,
+      "script": {
+        "gbp_per_gsp_kwh": 5.77
+      }
+    }
+  ],
+
+  "g_era_maps": {
     2012-09-01T00:00:00Z: {
 		},
   },

{chellow-1729755916.0.0 → chellow-1729849426.0.0}/test/reports/test_g_monthly_duration.py

@@ -279,3 +279,267 @@ def virtual_bill(ds):
     ]
 
     match_tables(expected, table)
+
+
+def test_scenario(mocker, sess, client):
+    vf = to_utc(ct_datetime(2000, 1, 1))
+    site_code = "22488"
+    site = Site.insert(sess, site_code, "Water Works")
+    g_dn = GDn.insert(sess, "EE", "East of England")
+    g_ldz = g_dn.insert_g_ldz(sess, "EA")
+    g_exit_zone = g_ldz.insert_g_exit_zone(sess, "EA1")
+    insert_g_units(sess)
+    g_unit_M3 = GUnit.get_by_code(sess, "M3")
+    participant = Participant.insert(sess, "CALB", "AK Industries")
+    market_role_Z = MarketRole.get_by_code(sess, "Z")
+    participant.insert_party(sess, market_role_Z, "None core", vf, None, None)
+    g_cv_rate_script = {
+        "cvs": {
+            "EA": {
+                1: {"applicable_at": utc_datetime(2020, 10, 3), "cv": 39.2000},
+            }
+        }
+    }
+    GContract.insert_industry(sess, "cv", "", {}, vf, None, g_cv_rate_script)
+    ug_rate_script = {
+        "ug_gbp_per_kwh": {"EA1": Decimal("40.1")},
+    }
+    GContract.insert_industry(sess, "ug", "", {}, vf, None, ug_rate_script)
+    ccl_rate_script = {
+        "ccl_gbp_per_kwh": Decimal("0.00525288"),
+    }
+    GContract.insert_industry(sess, "ccl", "", {}, vf, None, ccl_rate_script)
+    bank_holiday_rate_script = {"bank_holidays": []}
+    Contract.insert_non_core(
+        sess, "bank_holidays", "", {}, vf, None, bank_holiday_rate_script
+    )
+    charge_script = """
+import chellow.gas.ccl
+from chellow.gas.engine import g_rates
+from chellow.utils import reduce_bill_hhs
+
+
+def virtual_bill_titles():
+    return [
+        'units_consumed', 'correction_factor', 'unit_code', 'unit_factor',
+        'calorific_value', 'kwh', 'gas_rate', 'gas_gbp', 'ccl_rate',
+        'standing_rate', 'standing_gbp', 'net_gbp', 'vat_gbp', 'gross_gbp',
+        'problem']
+
+
+def virtual_bill(ds):
+    chellow.gas.ccl.vb(ds)
+    for hh in ds.hh_data:
+        start_date = hh['start_date']
+        bill_hh = ds.bill_hhs[start_date]
+        bill_hh['units_consumed'] = hh['units_consumed']
+        bill_hh['correction_factor'] = {hh['correction_factor']}
+        bill_hh['unit_code'] = {hh['unit_code']}
+        bill_hh['unit_factor'] = {hh['unit_factor']}
+        bill_hh['calorific_value'] = {hh['calorific_value']}
+        kwh = hh['kwh']
+        bill_hh['kwh'] = kwh
+        gas_rate = float(
+            g_rates(ds.sess, ds.caches, db_id, start_date, False)['gas_rate'])
+        bill_hh['gas_rate'] = {gas_rate}
+        bill_hh['gas_gbp'] = gas_rate * kwh
+        bill_hh['ccl_kwh'] = kwh
+        ccl_rate = hh['ccl']
+        bill_hh['ccl_rate'] = {ccl_rate}
+        bill_hh['ccl_kwh'] = kwh
+        bill_hh['ccl_gbp'] = kwh * ccl_rate
+        if hh['utc_is_month_end']:
+            standing_rate = float(
+                g_rates(
+                    ds.sess, ds.caches, db_id, start_date, False)['standing_rate'])
+            bill_hh['standing_rate'] = {standing_rate}
+            bill_hh['standing_gbp'] = standing_rate
+        if hh['utc_decimal_hour'] == 0:
+            pass
+
+        bill_hh['net_gbp'] = sum(
+            v for k, v in bill_hh.items() if k.endswith('gbp'))
+        bill_hh['vat_gbp'] = 0
+        bill_hh['gross_gbp'] = bill_hh['net_gbp'] + bill_hh['vat_gbp']
+
+    ds.bill = reduce_bill_hhs(ds.bill_hhs)
+"""
+    g_contract_rate_script = {
+        "gas_rate": 0.1,
+        "standing_rate": 0.1,
+    }
+    g_contract = GContract.insert(
+        sess, False, "Fusion 2020", charge_script, {}, vf, None, g_contract_rate_script
+    )
+    g_contract_id = g_contract.id
+    insert_g_reading_frequencies(sess)
+    g_reading_frequency_M = GReadingFrequency.get_by_code(sess, "M")
+    msn = "hgeu8rhg"
+    mprn = "87614362"
+    g_supply = site.insert_g_supply(
+        sess,
+        mprn,
+        "main",
+        g_exit_zone,
+        utc_datetime(2010, 1, 1),
+        None,
+        msn,
+        1,
+        g_unit_M3,
+        g_contract,
+        "d7gthekrg",
+        g_reading_frequency_M,
+        1,
+        1,
+    )
+    g_batch = g_contract.insert_g_batch(sess, "b1", "Jan batch")
+
+    breakdown = {"units_consumed": 771}
+    insert_bill_types(sess)
+    bill_type_N = BillType.get_by_code(sess, "N")
+    insert_g_read_types(sess)
+    g_read_type_A = GReadType.get_by_code(sess, "A")
+    g_bill = g_batch.insert_g_bill(
+        sess,
+        g_supply,
+        bill_type_N,
+        "55h883",
+        "dhgh883",
+        utc_datetime(2019, 4, 3),
+        utc_datetime(2015, 9, 1),
+        utc_datetime(2015, 9, 30, 22, 30),
+        Decimal("45"),
+        Decimal("12.40"),
+        Decimal("1.20"),
+        Decimal("14.52"),
+        "",
+        breakdown,
+    )
+    g_bill.insert_g_read(
+        sess,
+        msn,
+        g_unit_M3,
+        Decimal("1"),
+        Decimal("37"),
+        Decimal("90"),
+        utc_datetime(2015, 9, 1),
+        g_read_type_A,
+        Decimal("890"),
+        utc_datetime(2015, 9, 25),
+        g_read_type_A,
+    )
+    user = User.get_by_email_address(sess, "admin@example.com")
+    user_id = user.id
+    sess.commit()
+
+    mock_file = BytesIO()
+    mock_file.close = mocker.Mock()
+    mocker.patch(
+        "chellow.reports.report_g_monthly_duration.open_file",
+        return_value=mock_file,
+    )
+
+    compression = False
+    now = utc_datetime(2020, 9, 1)
+
+    scenario_props = {
+        "site_codes": [site_code],
+        "mprns": [mprn],
+        "scenario_duration": 1,
+        "scenario_start_year": 2015,
+        "scenario_start_month": 9,
+        "supplier_rates": [
+            {
+                "g_contract_id": g_contract_id,
+                "start_date": to_utc(ct_datetime(2015, 1, 1)),
+                "finish_date": to_utc(ct_datetime(2016, 1, 1)),
+                "script": {
+                    "gas_rate": 10,
+                    "standing_rate": 10,
+                },
+            }
+        ],
+    }
+    base_name = ["g_monthly_supply"]
+    content(scenario_props, user_id, compression, now, base_name)
+    sheet = odio.parse_spreadsheet(mock_file)
+    table = list(sheet.tables[1].rows)
+
+    expected = [
+        [
+            "creation_date",
+            "mprn",
+            "supply_name",
+            "exit_zone",
+            "msn",
+            "unit",
+            "contract",
+            "site_code",
+            "site_name",
+            "associated_site_codes",
+            "era-start",
+            "month",
+            "kwh",
+            "net_gbp",
+            "vat_gbp",
+            "gross_gbp",
+            "billed_kwh",
+            "billed_net_gbp",
+            "billed_vat_gbp",
+            "billed_gross_gbp",
+            "units_consumed",
+            "correction_factor",
+            "unit_code",
+            "unit_factor",
+            "calorific_value",
+            "kwh",
+            "gas_rate",
+            "gas_gbp",
+            "ccl_rate",
+            "standing_rate",
+            "standing_gbp",
+            "net_gbp",
+            "vat_gbp",
+            "gross_gbp",
+            "problem",
+        ],
+        [
+            Datetime(2020, 9, 1, 1),
+            "87614362",
+            "main",
+            "EA1",
+            "hgeu8rhg",
+            "M3",
+            "Fusion 2020",
+            "22488",
+            "Water Works",
+            None,
+            Datetime(2010, 1, 1, 0, 0),
+            Datetime(2015, 9, 30, 23, 30),
+            10888.888888888665,
+            108956.0869155567,
+            0.0,
+            108956.0869155567,
+            45.0,
+            12.4,
+            1.2,
+            14.52,
+            1000.0000000000156,
+            1.0,
+            "M3",
+            1.0,
+            39.2,
+            10888.888888888665,
+            10.0,
+            108888.88888888982,
+            0.00525288,
+            10.0,
+            10.0,
+            108956.0869155567,
+            0.0,
+            108956.0869155567,
+            None,
+        ],
+    ]
+
+    match_tables(expected, table)

chellow-1729755916.0.0/VERSION

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