commodutil 4.0.0__tar.gz → 4.1.0__tar.gz

{commodutil-4.0.0 → commodutil-4.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commodutil
-Version: 4.0.0
+Version: 4.1.0
 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-4.0.0 → commodutil-4.1.0}/commodutil/__init__.py

@@ -25,16 +25,17 @@ _LAZY_EXPORTS = {
     "ALIASES": "commodutil.convfactors",
     "COMMODITIES": "commodutil.convfactors",
     "Commodity": "commodutil.convfactors",
-    "FRACTIONAL_TO_MAJOR": "commodutil.convfactors",
-    "VALID_CURRENCY_TOKENS": "commodutil.convfactors",
     "convert": "commodutil.convfactors",
     "convert_price": "commodutil.convfactors",
     "convfactor": "commodutil.convfactors",
-    "fractional_to_major": "commodutil.convfactors",
-    "is_fractional_currency": "commodutil.convfactors",
     "list_commodities": "commodutil.convfactors",
     "list_units": "commodutil.convfactors",
-    "split_currency_unit": "commodutil.convfactors",
+    # standards.currency (stdlib-only -- cheap, no pint)
+    "FRACTIONAL_TO_MAJOR": "commodutil.standards.currency",
+    "VALID_CURRENCY_TOKENS": "commodutil.standards.currency",
+    "fractional_to_major": "commodutil.standards.currency",
+    "is_fractional_currency": "commodutil.standards.currency",
+    "split_currency_unit": "commodutil.standards.currency",
     # dates
     "curmon": "commodutil.dates",
     "curmonyear": "commodutil.dates",

{commodutil-4.0.0 → commodutil-4.1.0}/commodutil/convfactors.py

@@ -240,8 +240,8 @@ class CommodityConverter:
             convert(series, 'kt/month', 'bbl/day', commodity='gasoline')
         """
         # Normalize and parse units to handle daily/monthly rates
-        from_unit = self._normalize_unit(from_unit)
-        to_unit = self._normalize_unit(to_unit)
+        from_unit = _to_pint_token(from_unit)
+        to_unit = _to_pint_token(to_unit)
         from_rate = self._parse_rate_unit(from_unit)
         to_rate = self._parse_rate_unit(to_unit)
 
@@ -273,8 +273,8 @@ class CommodityConverter:
         self, value: float, from_unit: str, to_unit: str, commodity: Optional[str]
     ) -> float:
         """Convert a scalar value across mass/volume/energy using commodity context when needed."""
-        from_unit = self._normalize_unit(from_unit)
-        to_unit = self._normalize_unit(to_unit)
+        from_unit = _to_pint_token(from_unit)
+        to_unit = _to_pint_token(to_unit)
         qty = value * self.ureg(from_unit)
 
         # Try direct conversion first
@@ -404,10 +404,10 @@ class CommodityConverter:
         """Parse units like 'bbl/day' or 'kt/month'."""
         if "/" in unit:
             base, period = unit.split("/", 1)
-            base = self._normalize_unit(base)
+            base = _to_pint_token(base)
             period = period.strip().lower().rstrip("s")  # day(s), month(s), year(s)
             return {"base": base, "period": period}
-        return {"base": self._normalize_unit(unit), "period": None}
+        return {"base": _to_pint_token(unit), "period": None}
 
     def _rate_factor_scalar(
         self, from_period: Optional[str], to_period: Optional[str]
@@ -469,15 +469,6 @@ class CommodityConverter:
         except DimensionalityError:
             return False
 
-    def _normalize_unit(self, unit: str) -> str:
-        """Normalize a unit string into a pint-parseable token.
-
-        Thin shim around :func:`commodutil.standards.units.to_pint_token`.
-        Kept as a bound method because it has six internal call sites and
-        is exercised by the public test surface (``converter._normalize_unit``).
-        """
-        return _to_pint_token(unit)
-
     @property
     def available_commodities(self) -> list:
         """List all available commodities"""
@@ -545,28 +536,14 @@ def convfactor(from_unit: str, to_unit: str, commodity: Optional[str] = None) ->
 
 # ---- Currency-aware price conversion helpers ----
 #
-# Vocabulary moved to commodutil.standards.currency (2026-05) so it's
-# importable without dragging in pint / pandas. convfactors still owns the
-# integrated unit + currency `convert_price` math (which depends on the
-# pint registry above). Names are re-exported for backwards compatibility —
-# `from commodutil.convfactors import VALID_CURRENCY_TOKENS` still works.
+# Currency vocabulary lives in commodutil.standards.currency (importable
+# without dragging in pint / pandas). convfactors owns only the integrated
+# unit + currency `convert_price` math (which depends on the pint registry
+# above) and reads currency vocabulary directly from _currency. Callers
+# wanting currency vocabulary should import from commodutil.standards.currency.
 
 from commodutil.standards import currency as _currency
 
-_FRACTIONAL_CURRENCY_DIVISORS = _currency.FRACTIONAL_CURRENCY_DIVISORS
-_FRACTIONAL_TO_MAJOR = _currency.FRACTIONAL_TO_MAJOR
-_VALID_CURRENCY_TOKENS = _currency.VALID_CURRENCY_TOKENS
-
-# Public re-exports — preserve every existing public symbol so that
-# `from commodutil.convfactors import VALID_CURRENCY_TOKENS, fractional_to_major, ...`
-# continues to resolve for downstream packages (pyoilprice etc.).
-VALID_CURRENCY_TOKENS = _VALID_CURRENCY_TOKENS
-FRACTIONAL_TO_MAJOR = _FRACTIONAL_TO_MAJOR
-fractional_to_major = _currency.fractional_to_major
-is_fractional_currency = _currency.is_fractional_currency
-split_currency_unit = _currency.split_currency_unit
-_split_currency_unit = split_currency_unit
-
 
 def convert_price(
     value: Union[float, pd.Series],
@@ -626,15 +603,17 @@ def convert_price(
         fx_series = pd.Series([1.07, 1.08, 1.06], index=p.index)
         convert_price(p, 'EUR/MWh', 'USD/MMBtu', fx=fx_series)
     """
-    from_ccy, from_bare_unit = split_currency_unit(from_unit)
-    to_ccy, to_bare_unit = split_currency_unit(to_unit)
+    from_ccy, from_bare_unit = _currency.split_currency_unit(from_unit)
+    to_ccy, to_bare_unit = _currency.split_currency_unit(to_unit)
 
     # Resolve the underlying "major" currency on each side for same-base detection
     # (e.g. USc and USD share major USD — pure scale, no FX needed).
-    from_major = _FRACTIONAL_TO_MAJOR.get(
+    from_major = _currency.FRACTIONAL_TO_MAJOR.get(
         from_ccy, from_ccy.upper() if from_ccy else ""
     )
-    to_major = _FRACTIONAL_TO_MAJOR.get(to_ccy, to_ccy.upper() if to_ccy else "")
+    to_major = _currency.FRACTIONAL_TO_MAJOR.get(
+        to_ccy, to_ccy.upper() if to_ccy else ""
+    )
     # Treat '$' as 'USD' for the purpose of major-currency comparison.
     if from_major == "$":
         from_major = "USD"
@@ -663,8 +642,8 @@ def convert_price(
     # needed even though the literal currency tokens differ. Handle BEFORE the
     # `fx is None` raise below.
     if same_base_fractional:
-        from_div = _FRACTIONAL_CURRENCY_DIVISORS.get(from_ccy, 1.0)
-        to_div = _FRACTIONAL_CURRENCY_DIVISORS.get(to_ccy, 1.0)
+        from_div = _currency.FRACTIONAL_CURRENCY_DIVISORS.get(from_ccy, 1.0)
+        to_div = _currency.FRACTIONAL_CURRENCY_DIVISORS.get(to_ccy, 1.0)
         # value is in source-currency units; divide by from_div to get majors,
         # multiply by to_div to get target-currency units.
         return unit_converted * (to_div / from_div)
@@ -680,7 +659,7 @@ def convert_price(
             f"(source currency '{from_ccy}' is non-USD)"
         )
 
-    fractional_divisor = _FRACTIONAL_CURRENCY_DIVISORS.get(from_ccy, 1.0)
+    fractional_divisor = _currency.FRACTIONAL_CURRENCY_DIVISORS.get(from_ccy, 1.0)
 
     if isinstance(unit_converted, pd.Series) and isinstance(fx, pd.Series):
         target_idx = unit_converted.index
@@ -752,7 +731,7 @@ def list_commodities():
 def list_units():
     """List common units"""
     # Return normalized forms to avoid encoding issues
-    return [converter._normalize_unit(u) for u in converter.available_units]
+    return [_to_pint_token(u) for u in converter.available_units]
 
 
 # Example usage

{commodutil-4.0.0 → commodutil-4.1.0}/commodutil.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commodutil
-Version: 4.0.0
+Version: 4.1.0
 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-4.0.0 → commodutil-4.1.0}/tests/test_conv.py

@@ -217,21 +217,21 @@ class TestUtils:
         )  # 7450 bbl/kt / 30.4375 days/month
 
     def test_normalize_unit(self):
-        """Test unit normalization"""
-        from commodutil.convfactors import converter
+        """Test unit normalization (delegates to standards.units.to_pint_token)."""
+        from commodutil.standards.units import to_pint_token
 
         # Test cubic meter variations
-        assert converter._normalize_unit("m³") == "m^3"
-        assert converter._normalize_unit("m**3") == "m^3"
-        assert converter._normalize_unit("cubic_meter") == "m^3"
-        assert converter._normalize_unit("CUBIC_METER") == "m^3"
+        assert to_pint_token("m³") == "m^3"
+        assert to_pint_token("m**3") == "m^3"
+        assert to_pint_token("cubic_meter") == "m^3"
+        assert to_pint_token("CUBIC_METER") == "m^3"
 
         # Test energy unit normalization
-        assert converter._normalize_unit("BTU") == "Btu"
-        assert converter._normalize_unit("MMBTU") == "MMBtu"
+        assert to_pint_token("BTU") == "Btu"
+        assert to_pint_token("MMBTU") == "MMBtu"
 
         # Test whitespace handling
-        assert converter._normalize_unit("  bbl  ") == "bbl"
+        assert to_pint_token("  bbl  ") == "bbl"
 
     def test_commodity_properties(self):
         """Test commodity property access and helper functions"""

{commodutil-4.0.0 → commodutil-4.1.0}/tests/test_standards_currency.py

@@ -134,22 +134,33 @@ def test_currency_map_known_entries():
     assert CURRENCY_MAP["canadian dollars"] == "CAD"
 
 
-# ---- Legacy import-path regression tests ----
-
-
-def test_legacy_imports_from_convfactors():
-    """Downstream callers must still be able to import the moved names from
-    commodutil.convfactors (backwards-compat re-exports)."""
-    from commodutil.convfactors import (
-        FRACTIONAL_TO_MAJOR as cf_FRACTIONAL_TO_MAJOR,
-        VALID_CURRENCY_TOKENS as cf_VALID_CURRENCY_TOKENS,
-        fractional_to_major as cf_fractional_to_major,
-        is_fractional_currency as cf_is_fractional_currency,
-        split_currency_unit as cf_split_currency_unit,
+# ---- Shim-removal regression guard ----
+
+
+def test_legacy_convfactors_currency_shims_are_gone():
+    """The 4.0 standards consolidation kept temporary back-compat re-exports
+    of the currency vocabulary on commodutil.convfactors. They were removed
+    in 4.1 after an in-repo consumer sweep across the stack confirmed zero
+    live downstream callers. This test is a positive guard against
+    accidental re-introduction of the shims -- importing any of these names
+    from commodutil.convfactors must fail. The canonical home is
+    commodutil.standards.currency.
+    """
+    import pytest
+
+    import commodutil.convfactors as cf
+
+    legacy_names = (
+        "VALID_CURRENCY_TOKENS",
+        "FRACTIONAL_TO_MAJOR",
+        "fractional_to_major",
+        "is_fractional_currency",
+        "split_currency_unit",
+        "_split_currency_unit",
+        "_FRACTIONAL_CURRENCY_DIVISORS",
+        "_FRACTIONAL_TO_MAJOR",
+        "_VALID_CURRENCY_TOKENS",
     )
-
-    assert cf_VALID_CURRENCY_TOKENS is VALID_CURRENCY_TOKENS
-    assert cf_FRACTIONAL_TO_MAJOR is FRACTIONAL_TO_MAJOR
-    assert cf_is_fractional_currency("USc") is True
-    assert cf_fractional_to_major("GBp") == "GBP"
-    assert cf_split_currency_unit("EUR/MWh") == ("EUR", "MWh")
+    for name in legacy_names:
+        with pytest.raises(AttributeError):
+            getattr(cf, name)

{commodutil-4.0.0 → commodutil-4.1.0}/tests/test_standards_units.py

@@ -129,26 +129,6 @@ def test_to_pint_token_exposed_via_standards_facade():
     assert to_pint_token("m³") == "m^3"
 
 
-def test_converter_normalize_unit_delegates_to_to_pint_token():
-    """CommodityConverter._normalize_unit is a thin shim around the
-    standalone normaliser. Regression guard against accidental drift."""
-    from commodutil.convfactors import converter
-    from commodutil.standards.units import to_pint_token
-
-    for sample in [
-        "m³",
-        "m**3",
-        "cubic_meter",
-        "CUBIC_METER",
-        "BTU",
-        "MMBTU",
-        "  bbl  ",
-        "m3/day",
-        None,
-    ]:
-        assert converter._normalize_unit(sample) == to_pint_token(sample)
-
-
 def test_unit_map_parity_with_curvemetadata():
     """Regression guard: UNIT_MAP must match curvemetadata's previous local
     copy byte-for-byte until curvemetadata's re-export PR lands. Skipped if