commodutil 3.7.0__tar.gz → 3.7.2__tar.gz

{commodutil-3.7.0 → commodutil-3.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commodutil
-Version: 3.7.0
+Version: 3.7.2
 Summary: common commodity/oil analytics utils
 Author-email: aeorxc <author@example.com>
 Project-URL: Homepage, https://dev.azure.com/RWEST-MFI-TE/Oil/_git/commodutil

{commodutil-3.7.0 → commodutil-3.7.2}/commodutil/convfactors.py

@@ -33,6 +33,24 @@ ureg.define("megatonne = 1e6 metric_ton = Mt")
 # normalize_unit helper already maps 'MMBTU' -> 'MMBtu').
 ureg.define("million_british_thermal_unit = 1e6 Btu = MMBtu")
 
+# Case-insensitive aliases for the most-quoted energy / power units.
+# Pint is case-sensitive by default, so `ureg('mmbtu')` or `ureg('mw')` raise
+# UndefinedUnitError even though `MMBtu` / `MW` work. Callers (Power Query, ad-hoc
+# scripts, copy-pasted Platts symbols) very commonly use the lowercase / all-caps
+# / underscored forms, so register them explicitly here.
+#
+# Energy: MMBtu + therm + Btu spellings (MMBtu is defined above; therm + Btu are
+# in pint's defaults). `million_btu` is the long-form alias.
+ureg.define("@alias million_british_thermal_unit = mmbtu = MMBTU = million_btu")
+ureg.define("@alias therm = Therm = THERM")
+ureg.define("@alias british_thermal_unit = btu")
+# Power / energy: MW and MWh are SI-prefix forms of `watt` / `watt_hour`, so they
+# cannot be aliased via `@alias`. Register lowercase / all-caps spellings as
+# standalone units with the same magnitude.
+ureg.define("mw = 1e6 watt")
+ureg.define("mwh = 1e6 watt * hour")
+ureg.define("MWH = 1e6 watt * hour")
+
 
 @dataclass
 class Commodity:

{commodutil-3.7.0 → commodutil-3.7.2}/commodutil.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commodutil
-Version: 3.7.0
+Version: 3.7.2
 Summary: common commodity/oil analytics utils
 Author-email: aeorxc <author@example.com>
 Project-URL: Homepage, https://dev.azure.com/RWEST-MFI-TE/Oil/_git/commodutil

{commodutil-3.7.0 → commodutil-3.7.2}/tests/test_conv.py

@@ -340,6 +340,53 @@ class TestUtils:
         result = convfactors.convert(simple_series, "bbl/day", "bbl/month")
         assert result.iloc[0] == pytest.approx(3043.75, abs=0.1)
 
+    def test_case_insensitive_energy_aliases(self):
+        """Lowercase / all-caps / long-form spellings of MMBtu, therm, Btu resolve."""
+        from commodutil.convfactors import ureg
+
+        # MMBtu and its aliases all resolve to the same base magnitude
+        canonical_mmbtu = (1 * ureg("MMBtu")).to_base_units().magnitude
+        for alias in ("mmbtu", "MMBTU", "million_btu"):
+            mag = (1 * ureg(alias)).to_base_units().magnitude
+            assert mag == pytest.approx(canonical_mmbtu), (
+                f"{alias} should resolve to MMBtu (got {mag} vs {canonical_mmbtu})"
+            )
+
+        # therm + Therm + THERM
+        canonical_therm = (1 * ureg("therm")).to_base_units().magnitude
+        for alias in ("Therm", "THERM"):
+            mag = (1 * ureg(alias)).to_base_units().magnitude
+            assert mag == pytest.approx(canonical_therm)
+
+        # Btu + btu + BTU
+        canonical_btu = (1 * ureg("Btu")).to_base_units().magnitude
+        for alias in ("btu", "BTU"):
+            mag = (1 * ureg(alias)).to_base_units().magnitude
+            assert mag == pytest.approx(canonical_btu)
+
+        # Sanity: 1 MMBtu = 1e6 Btu
+        assert canonical_mmbtu == pytest.approx(1e6 * canonical_btu)
+
+    def test_case_insensitive_power_aliases(self):
+        """Lowercase / all-caps spellings of MW and MWh resolve."""
+        from commodutil.convfactors import ureg
+
+        # MW and mw
+        canonical_mw = (1 * ureg("MW")).to_base_units().magnitude
+        assert (1 * ureg("mw")).to_base_units().magnitude == pytest.approx(canonical_mw)
+
+        # MWh, mwh, MWH
+        canonical_mwh = (1 * ureg("MWh")).to_base_units().magnitude
+        for alias in ("mwh", "MWH"):
+            mag = (1 * ureg(alias)).to_base_units().magnitude
+            assert mag == pytest.approx(canonical_mwh), (
+                f"{alias} should resolve to MWh (got {mag} vs {canonical_mwh})"
+            )
+
+        # Sanity: 1 MWh = 3.6 GJ
+        assert (1 * ureg("MWh")).to("GJ").magnitude == pytest.approx(3.6)
+        assert (1 * ureg("mwh")).to("GJ").magnitude == pytest.approx(3.6)
+
     def test_caching_and_properties(self):
         """Test caching and property methods"""
         from commodutil.convfactors import converter