renames

Author: EgeKaraismailogluQC

diffly/comparison.py

@@ -25,7 +25,7 @@
     lazy_len,
     make_and_validate_mapping,
 )
-from .metrics import Metric, make_numeric_metric
+from .metrics import MetricFn, _make_numeric_metric
 
 if TYPE_CHECKING:  # pragma: no cover
     # NOTE: We cannot import at runtime as we're otherwise running into circular
@@ -920,7 +920,7 @@ def summary(
         right_name: str = Side.RIGHT,
         slim: bool = False,
         hidden_columns: list[str] | None = None,
-        metrics: Mapping[str, Metric] | None = None,
+        metrics: Mapping[str, MetricFn] | None = None,
     ) -> Summary:
         """Generate a summary of all aspects of the comparison.
 
@@ -955,7 +955,7 @@ def summary(
                 :class:`polars.Expr` referring to the left and right values of a single
                 numerical column across all joined rows, and must return a scalar
                 aggregation expression. See :doc:`/api/metrics` for the full list of
-                presets and the :data:`~diffly.metrics.Metric` type. When ``None``
+                presets and the :data:`~diffly.metrics.MetricFn` type. When ``None``
                 (default), no metrics are computed; presets are not applied
                 automatically. Metrics are only computed for numerical columns. Prefer
                 short labels — the summary has a fixed width and many or long labels
@@ -976,7 +976,7 @@ def summary(
         from .summary import Summary
 
         resolved_metrics = (
-            {label: make_numeric_metric(fn) for label, fn in metrics.items()}
+            {label: _make_numeric_metric(fn) for label, fn in metrics.items()}
             if metrics is not None
             else None
         )

diffly/metrics.py

@@ -11,27 +11,27 @@
 
 
 @dataclass(frozen=True)
-class _Metric:
-    """A metric paired with a column-applicability selector.
+class Metric:
+    """A metric function paired with a column-applicability selector.
 
     Internal only.
     """
 
-    fn: Metric
+    fn: MetricFn
     selector: cs.Selector
 
 
-Metric = Callable[[pl.Expr, pl.Expr], pl.Expr]
-"""A metric is a callable mapping ``(left_expr, right_expr)`` to a scalar aggregation
+MetricFn = Callable[[pl.Expr, pl.Expr], pl.Expr]
+"""A metric function maps ``(left_expr, right_expr)`` to a scalar aggregation
 expression.
 
 The expressions refer to the left-side and right-side values of a single column across
 all joined rows.
 """
 
 
-def _make_numeric_metric(metric: Metric) -> _Metric:
-    return _Metric(fn=metric, selector=cs.numeric())
+def _make_numeric_metric(fn: MetricFn) -> Metric:
+    return Metric(fn=fn, selector=cs.numeric())
 
 
 def mean(left: pl.Expr, right: pl.Expr) -> pl.Expr:
@@ -70,7 +70,7 @@ def mean_relative_deviation(left: pl.Expr, right: pl.Expr) -> pl.Expr:
     return ((right - left) / left).abs().mean()
 
 
-def quantile(q: float) -> Metric:
+def quantile(q: float) -> MetricFn:
     """Factory returning a metric that computes the ``q``-quantile of
     ``right - left``."""
     if not 0 <= q <= 1:
@@ -82,7 +82,7 @@ def _quantile(left: pl.Expr, right: pl.Expr) -> pl.Expr:
     return _quantile
 
 
-DEFAULT_METRICS: dict[str, Metric] = {
+DEFAULT_METRICS: dict[str, MetricFn] = {
     "Mean": mean,
     "Median": median,
     "Min": min,

diffly/summary.py

@@ -23,7 +23,7 @@
 from rich.text import Text
 
 from ._utils import Side, capitalize_first
-from .metrics import _Metric
+from .metrics import Metric
 
 if TYPE_CHECKING:  # pragma: no cover
     from .comparison import DataFrameComparison
@@ -61,7 +61,7 @@ def __init__(
         right_name: str,
         slim: bool,
         hidden_columns: list[str] | None,
-        metrics: Mapping[str, _Metric] | None,
+        metrics: Mapping[str, Metric] | None,
     ):
         self.slim = slim
         self._data = _compute_summary_data(
@@ -772,7 +772,7 @@ def _compute_summary_data(
     right_name: str,
     slim: bool,
     hidden_columns: list[str] | None,
-    metrics: Mapping[str, _Metric] | None,
+    metrics: Mapping[str, Metric] | None,
 ) -> SummaryData:
     from .comparison import DataFrameComparison
 
@@ -839,7 +839,7 @@ def _validate_primary_key_hidden_columns() -> None:
             _metric_labels=[],
         )
 
-    metrics_resolved: dict[str, _Metric] = dict(metrics or {})
+    metrics_resolved: dict[str, Metric] = dict(metrics or {})
     metrics_by_column = _compute_column_metrics(comp, metrics_resolved)
     metric_labels = list(metrics_resolved.keys())
 
@@ -935,7 +935,7 @@ def _compute_rows(comp: DataFrameComparison, slim: bool) -> SummaryDataRows | No
 
 def _compute_column_metrics(
     comp: DataFrameComparison,
-    metrics: Mapping[str, _Metric],
+    metrics: Mapping[str, Metric],
 ) -> dict[str, dict[str, Any]]:
     if comp.primary_key is None or comp.num_rows_joined() == 0:
         return {}

diffly/testing.py

@@ -19,7 +19,7 @@
 
 from ._compat import dy
 from .comparison import DataFrameComparison, compare_frames
-from .metrics import Metric
+from .metrics import MetricFn
 
 
 def assert_collection_equal(
@@ -40,7 +40,7 @@ def assert_collection_equal(
     right_name: str = Side.RIGHT,
     slim: bool = False,
     hidden_columns: list[str] | None = None,
-    metrics: Mapping[str, Metric] | None = None,
+    metrics: Mapping[str, MetricFn] | None = None,
 ) -> None:
     """Assert that two :mod:`dataframely` collections are equal.
 
@@ -174,7 +174,7 @@ def assert_frame_equal(
     right_name: str = Side.RIGHT,
     slim: bool = False,
     hidden_columns: list[str] | None = None,
-    metrics: Mapping[str, Metric] | None = None,
+    metrics: Mapping[str, MetricFn] | None = None,
 ) -> None:
     """Assert that two :mod:`polars` data frames are equal.
 

docs/api/index.rst

@@ -27,7 +27,7 @@ API Reference
       :link: metrics
       :link-type: doc
 
-      Built-in metric presets and the ``Metric`` callable for ``summary(metrics=...)``.
+      Built-in metric presets and the ``MetricFn`` callable for ``summary(metrics=...)``.
 
    .. grid-item-card:: Testing
       :link: testing

docs/api/metrics.rst

@@ -6,11 +6,11 @@ Metrics
 
 Metrics are scalar aggregations computed per numerical column when generating a
 :meth:`~diffly.comparison.DataFrameComparison.summary`. Pass them via the
-``metrics`` argument as a mapping from display label to a :data:`Metric`
+``metrics`` argument as a mapping from display label to a :data:`MetricFn`
 callable. :mod:`diffly.metrics` ships a set of presets; you can also supply
 your own callable ``(left_expr, right_expr) -> pl.Expr``.
 
-.. autodata:: Metric
+.. autodata:: MetricFn
    :no-value:
 
 Presets

tests/test_metrics.py

@@ -7,7 +7,7 @@
 import pytest
 
 from diffly import metrics
-from diffly.metrics import Metric
+from diffly.metrics import MetricFn
 
 
 @pytest.fixture
@@ -16,7 +16,7 @@ def frame() -> pl.DataFrame:
     return pl.DataFrame({"l": [1, 2, 3, None], "r": [1, 2, 5, 4]})
 
 
-def _apply(metric: Metric, frame: pl.DataFrame) -> float:
+def _apply(metric: MetricFn, frame: pl.DataFrame) -> float:
     return frame.select(metric(pl.col("l"), pl.col("r"))).item()