Drop .util.series_of_pint_quantity()

The warning handled no longer appears with pint 0.24.4 and pandas 2.2.3.

Author: khaeru

doc/api/util.rst

@@ -54,7 +54,6 @@ Commonly used:
    private_data_path
    same_node
    same_time
-   series_of_pint_quantity
    show_versions
 
 .. automodule:: message_ix_models.util

message_ix_models/model/transport/ikarus.py

@@ -19,7 +19,6 @@
     package_data_path,
     same_node,
     same_time,
-    series_of_pint_quantity,
 )
 
 from .key import bcast_tcl, bcast_y
@@ -190,7 +189,7 @@ def read_ikarus_data(occupancy, k_output, k_inv_cost):
         output = registry.Quantity(
             occupancy[tec], "passenger / vehicle"
         ) * k_output.get(tec, 1.0)
-        df["output"] = series_of_pint_quantity([output] * len(df.index), index=df.index)
+        df["output"] = pd.Series([output] * len(df.index), index=df.index)
 
         df["inv_cost"] *= k_inv_cost.get(tec, 1.0)
 

message_ix_models/tests/test_util.py

@@ -37,7 +37,6 @@
     replace_par_data,
     same_node,
     same_time,
-    series_of_pint_quantity,
     strip_par_data,
 )
 
@@ -148,11 +147,11 @@ def test_check_support(test_context):
 
 
 def test_convert_units(recwarn):
-    """:func:`.convert_units` and :func:`.series_of_pint_quantity` work."""
+    """:func:`.convert_units` works."""
     # Common arguments
     args = [pd.Series([1.1, 10.2, 100.3], name="bar"), dict(bar=(10.0, "lb", "kg"))]
 
-    exp = series_of_pint_quantity(
+    exp = pd.Series(
         [registry("4.9895 kg"), registry("46.2664 kg"), registry("454.9531 kg")],
     )
 
@@ -168,12 +167,14 @@ def test_convert_units(recwarn):
     exp = pd.Series([q.magnitude for q in exp.values], name="bar")
     assert_series_equal(exp, convert_units(*args, store="magnitude"), check_dtype=False)
 
+    N = len(recwarn)
+
     # Other values for store= are errors
     with pytest.raises(ValueError, match="store = 'foo'"):
         convert_units(*args, store="foo")
 
     # series_of_pint_quantity() successfully caught warnings
-    assert 0 == len(recwarn)
+    assert N == len(recwarn)
 
 
 def test_copy_column():

message_ix_models/util/__init__.py

@@ -20,7 +20,7 @@
 import pint
 from platformdirs import user_cache_path
 
-from ._convert_units import convert_units, series_of_pint_quantity
+from ._convert_units import convert_units
 from ._logging import mark_time, preserve_log_level, silence_log
 from .cache import cached
 from .common import (
@@ -82,7 +82,6 @@
     "replace_par_data",
     "same_node",
     "same_time",
-    "series_of_pint_quantity",
     "show_versions",
     "silence_log",
     "strip_par_data",

message_ix_models/util/_convert_units.py

@@ -2,7 +2,6 @@
 from collections.abc import Mapping
 from functools import singledispatch
 from typing import TYPE_CHECKING, Any, Optional
-from warnings import catch_warnings, filterwarnings
 
 import pandas as pd
 from iam_units import registry
@@ -13,24 +12,6 @@
 log = logging.getLogger(__name__)
 
 
-def series_of_pint_quantity(*args, **kwargs) -> pd.Series:
-    """Suppress a spurious warning.
-
-    Creating a :class:`pandas.Series` with a list of :class:`pint.Quantity` triggers a
-    warning “The unit of the quantity is stripped when downcasting to ndarray,” even
-    though the entire object is being stored and the unit is **not** stripped. This
-    function suppresses this warning.
-    """
-    with catch_warnings():
-        filterwarnings(
-            "ignore",
-            message="The unit of the quantity is stripped when downcasting to ndarray",
-            module="pandas.core.dtypes.cast",
-        )
-
-        return pd.Series(*args, **kwargs)
-
-
 @singledispatch
 def convert_units(data: Any, **kwargs):
     """Convert units of `data`.
@@ -85,7 +66,7 @@ def _(
     # - Reassemble into a series with index matching `s`
     result = registry.Quantity(factor * data.values, unit_in).to(unit_out)
 
-    return series_of_pint_quantity(
+    return pd.Series(
         result.magnitude if store == "magnitude" else result.tolist(),
         index=data.index,
         dtype=(float if store == "magnitude" else object),