commodutil 4.3.0__tar.gz → 4.3.2__tar.gz

{commodutil-4.3.0 → commodutil-4.3.2}/PKG-INFO

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

@@ -35,6 +35,7 @@ _LAZY_EXPORTS = {
     "VALID_CURRENCY_TOKENS": "commodutil.standards.currency",
     "fractional_to_major": "commodutil.standards.currency",
     "is_fractional_currency": "commodutil.standards.currency",
+    "normalize_currency_token": "commodutil.standards.currency",
     "split_currency_unit": "commodutil.standards.currency",
     # standards.units (stdlib-only -- cheap, no pint)
     "canonical_quantity_unit": "commodutil.standards.units",

{commodutil-4.3.0 → commodutil-4.3.2}/commodutil/standards/__init__.py

@@ -28,6 +28,7 @@ from commodutil.standards.currency import (
     VALID_CURRENCY_TOKENS,
     fractional_to_major,
     is_fractional_currency,
+    normalize_currency_token,
     required_fx_pair,
     split_currency_unit,
     to_symbol,
@@ -70,6 +71,7 @@ __all__ = [
     "VALID_CURRENCY_TOKENS",
     "fractional_to_major",
     "is_fractional_currency",
+    "normalize_currency_token",
     "required_fx_pair",
     "split_currency_unit",
     "to_symbol",

{commodutil-4.3.0 → commodutil-4.3.2}/commodutil/standards/currency.py

@@ -80,12 +80,56 @@ _VALID_CURRENCY_TOKENS = {
     "$",
 }
 
+_CURRENCY_TOKEN_LOOKUP = {token.upper(): token for token in _VALID_CURRENCY_TOKENS}
+_CURRENCY_TOKEN_ALIASES = {
+    "USC": "USc",
+    "US CENTS": "USc",
+    "U S CENTS": "USc",
+    "GBX": "GBp",
+    "GBPENCE": "GBp",
+    "GB PENCE": "GBp",
+    "PENCE": "GBp",
+    "RMB": "CNY",
+}
+
 # Public aliases — these are the import names downstream code should use.
 VALID_CURRENCY_TOKENS = _VALID_CURRENCY_TOKENS
 FRACTIONAL_TO_MAJOR = _FRACTIONAL_TO_MAJOR
 FRACTIONAL_CURRENCY_DIVISORS = _FRACTIONAL_CURRENCY_DIVISORS
 
 
+def _normalized_currency_lookup_key(token: str) -> str:
+    return " ".join(str(token).replace(".", " ").strip().upper().split())
+
+
+def normalize_currency_token(token: Optional[str]) -> Optional[str]:
+    """Return the canonical commodutil currency token for common aliases.
+
+    The canonical tokens remain ``VALID_CURRENCY_TOKENS``. This helper accepts
+    mixed case and legacy/fractional aliases used in vendor specs, such as
+    ``USC``/``US cents`` -> ``USc`` and ``GBX``/``pence`` -> ``GBp``. Unknown
+    values return ``None`` so callers can distinguish currency-like tokens
+    from physical units.
+    """
+    if token is None:
+        return None
+    cleaned = str(token).strip()
+    if not cleaned:
+        return None
+    if cleaned in _VALID_CURRENCY_TOKENS:
+        return cleaned
+
+    lower = cleaned.lower()
+    mapped = CURRENCY_MAP.get(lower)
+    if mapped:
+        return mapped
+
+    lookup_key = _normalized_currency_lookup_key(cleaned)
+    return _CURRENCY_TOKEN_LOOKUP.get(lookup_key) or _CURRENCY_TOKEN_ALIASES.get(
+        lookup_key
+    )
+
+
 def is_fractional_currency(token: str) -> bool:
     """Return True if `token` is a recognised fractional currency
     (e.g. 'GBp', 'USc'). Useful for detecting pure-scale conversions that
@@ -240,6 +284,7 @@ __all__ = [
     "FRACTIONAL_TO_MAJOR",
     "FRACTIONAL_CURRENCY_DIVISORS",
     "CURRENCY_MAP",
+    "normalize_currency_token",
     "is_fractional_currency",
     "fractional_to_major",
     "split_currency_unit",

{commodutil-4.3.0 → commodutil-4.3.2}/commodutil/standards/units.py

@@ -50,6 +50,10 @@ UNIT_MAP = {
     "mt": "mt",
     "tonne": "mt",
     "tonnes": "mt",
+    "pound": "lb",
+    "pounds": "lb",
+    "lb": "lb",
+    "lbs": "lb",
 }
 
 
@@ -129,6 +133,7 @@ def to_pint_token(unit: Optional[str]) -> Optional[str]:
       / ``CUBIC_METER`` / ``m3`` (case-insensitive exact match) -> ``m^3``.
     - Rate forms: ``m3/...`` / ``M3/...`` -> ``m^3/...``.
     - Energy casing: ``BTU`` -> ``Btu``; ``MMBTU`` -> ``MMBtu``.
+    - Pound casing/plurals: ``LBS`` / ``lbs`` -> ``lb``.
 
     Other tokens pass through unchanged. Aliases like ``barrel``, ``tonne``,
     ``gallon`` are not handled here -- they are registered as pint aliases
@@ -159,6 +164,8 @@ def to_pint_token(unit: Optional[str]) -> Optional[str]:
         u = "Btu"
     if u == "MMBTU":
         u = "MMBtu"
+    if u.upper() == "LBS":
+        u = "lb"
     return u
 
 

{commodutil-4.3.0 → commodutil-4.3.2}/commodutil.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commodutil
-Version: 4.3.0
+Version: 4.3.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-4.3.0 → commodutil-4.3.2}/tests/test_price_conv.py

@@ -206,6 +206,11 @@ def test_bug2_usc_to_usd_no_fx_required():
     assert out == pytest.approx(0.005, rel=1e-9)
 
 
+def test_usc_per_pound_to_usd_per_pound_no_fx_required():
+    out = convfactors.convert_price(71.26, "USc/LBS", "USD/lb")
+    assert out == pytest.approx(0.7126, rel=1e-9)
+
+
 def test_bug2_gbp_pence_to_gbp_no_fx_required():
     """Bug 2: GBp -> GBP is a pure /100 scale (no FX)."""
     out = convfactors.convert_price(50.0, "GBp/therm", "GBP/therm")

{commodutil-4.3.0 → commodutil-4.3.2}/tests/test_standards_currency.py

@@ -7,6 +7,7 @@ from commodutil.standards.currency import (
     VALID_CURRENCY_TOKENS,
     fractional_to_major,
     is_fractional_currency,
+    normalize_currency_token,
     required_fx_pair,
     split_currency_unit,
     to_symbol,
@@ -40,6 +41,21 @@ def test_fractional_to_major():
     assert fractional_to_major("") == ""
 
 
+def test_normalize_currency_token():
+    assert normalize_currency_token("USD") == "USD"
+    assert normalize_currency_token("usd") == "USD"
+    assert normalize_currency_token("$") == "$"
+    assert normalize_currency_token("USC") == "USc"
+    assert normalize_currency_token("U.S. cents") == "USc"
+    assert normalize_currency_token("GBX") == "GBp"
+    assert normalize_currency_token("pence") == "GBp"
+    assert normalize_currency_token("RMB") == "CNY"
+    assert normalize_currency_token("us dollars and cents") == "USD"
+    assert normalize_currency_token("bbl") is None
+    assert normalize_currency_token("") is None
+    assert normalize_currency_token(None) is None
+
+
 def test_fractional_currency_cac_auc_correctly_routed():
     # Regression guard for the pre-2026-05-14 bug where CAc/AUc were valid
     # currency tokens but had no fractional rule, so required_fx_pair
@@ -155,6 +171,7 @@ def test_legacy_convfactors_currency_shims_are_gone():
         "FRACTIONAL_TO_MAJOR",
         "fractional_to_major",
         "is_fractional_currency",
+        "normalize_currency_token",
         "split_currency_unit",
         "_split_currency_unit",
         "_FRACTIONAL_CURRENCY_DIVISORS",

{commodutil-4.3.0 → commodutil-4.3.2}/tests/test_standards_units.py

@@ -66,11 +66,20 @@ def test_unit_map_metric_ton_variants():
     assert UNIT_MAP["tonnes"] == "mt"
 
 
-def test_unit_map_canonical_set_only_three():
-    """UNIT_MAP normalises to exactly the canonical units bbl / gal / mt."""
+def test_unit_map_pound_variants():
     from commodutil.standards.units import UNIT_MAP
 
-    assert set(UNIT_MAP.values()) == {"bbl", "gal", "mt"}
+    assert UNIT_MAP["pound"] == "lb"
+    assert UNIT_MAP["pounds"] == "lb"
+    assert UNIT_MAP["lb"] == "lb"
+    assert UNIT_MAP["lbs"] == "lb"
+
+
+def test_unit_map_canonical_set():
+    """UNIT_MAP normalises to the canonical physical quote units."""
+    from commodutil.standards.units import UNIT_MAP
+
+    assert set(UNIT_MAP.values()) == {"bbl", "gal", "mt", "lb"}
 
 
 def test_canonical_quantity_unit_normalizes_common_labels():
@@ -120,6 +129,13 @@ def test_to_pint_token_energy_casing():
     assert to_pint_token("MMBTU") == "MMBtu"
 
 
+def test_to_pint_token_pound_casing():
+    from commodutil.standards.units import to_pint_token
+
+    assert to_pint_token("LBS") == "lb"
+    assert to_pint_token("lbs") == "lb"
+
+
 def test_to_pint_token_whitespace_stripped():
     from commodutil.standards.units import to_pint_token