feat: add summary algs support for VariableDescription

ydataai · Dec 16, 2023 · c0d29b4 · c0d29b4
1 parent c8d253a
commit c0d29b4
Showing 1 changed file with 41 additions and 44 deletions.
diff --git a/src/ydata_profiling/model/summary_algorithms.py b/src/ydata_profiling/model/summary_algorithms.py
@@ -7,6 +7,7 @@
 from scipy.stats import chisquare
 
 from ydata_profiling.config import Settings
+from ydata_profiling.model.var_description.default import VarDescription
 
 T = TypeVar("T")
 
@@ -58,28 +59,38 @@ def chi_square(
 
 
 def series_hashable(
-    fn: Callable[[Settings, pd.Series, dict], Tuple[Settings, pd.Series, dict]]
-) -> Callable[[Settings, pd.Series, dict], Tuple[Settings, pd.Series, dict]]:
+    fn: Callable[
+        [Settings, pd.Series, VarDescription],
+        Tuple[Settings, pd.Series, VarDescription],
+    ]
+) -> Callable[
+    [Settings, pd.Series, VarDescription], Tuple[Settings, pd.Series, VarDescription]
+]:
     @functools.wraps(fn)
     def inner(
-        config: Settings, series: pd.Series, summary: dict
-    ) -> Tuple[Settings, pd.Series, dict]:
-        if not summary["hashable"]:
+        config: Settings, series: pd.Series, summary: VarDescription
+    ) -> Tuple[Settings, pd.Series, VarDescription]:
+        if not summary.hashable:
             return config, series, summary
         return fn(config, series, summary)
 
     return inner
 
 
 def series_handle_nulls(
-    fn: Callable[[Settings, pd.Series, dict], Tuple[Settings, pd.Series, dict]]
-) -> Callable[[Settings, pd.Series, dict], Tuple[Settings, pd.Series, dict]]:
+    fn: Callable[
+        [Settings, pd.Series, VarDescription],
+        Tuple[Settings, pd.Series, VarDescription],
+    ]
+) -> Callable[
+    [Settings, pd.Series, VarDescription], Tuple[Settings, pd.Series, VarDescription]
+]:
     """Decorator for nullable series"""
 
     @functools.wraps(fn)
     def inner(
-        config: Settings, series: pd.Series, summary: dict
-    ) -> Tuple[Settings, pd.Series, dict]:
+        config: Settings, series: pd.Series, summary: VarDescription
+    ) -> Tuple[Settings, pd.Series, VarDescription]:
         if series.hasnans:
             series = series.dropna()
 
@@ -99,92 +110,78 @@ def named_aggregate_summary(series: pd.Series, key: str) -> dict:
     return summary
 
 
-@multimethod
-def describe_counts(
-    config: Settings, series: Any, summary: dict
-) -> Tuple[Settings, Any, dict]:
-    raise NotImplementedError()
-
-
 @multimethod
 def describe_supported(
     config: Settings, series: Any, series_description: dict
-) -> Tuple[Settings, Any, dict]:
-    raise NotImplementedError()
-
-
-@multimethod
-def describe_generic(
-    config: Settings, series: Any, summary: dict
-) -> Tuple[Settings, Any, dict]:
+) -> Tuple[Settings, Any, VarDescription]:
     raise NotImplementedError()
 
 
 @multimethod
 def describe_numeric_1d(
-    config: Settings, series: Any, summary: dict
-) -> Tuple[Settings, Any, dict]:
+    config: Settings, series: Any, summary: VarDescription
+) -> Tuple[Settings, Any, VarDescription]:
     raise NotImplementedError()
 
 
 @multimethod
 def describe_text_1d(
-    config: Settings, series: Any, summary: dict
-) -> Tuple[Settings, Any, dict, Any]:
+    config: Settings, series: Any, summary: VarDescription
+) -> Tuple[Settings, Any, VarDescription]:
     raise NotImplementedError()
 
 
 @multimethod
 def describe_date_1d(
-    config: Settings, series: Any, summary: dict
-) -> Tuple[Settings, Any, dict]:
+    config: Settings, series: Any, summary: VarDescription
+) -> Tuple[Settings, Any, VarDescription]:
     raise NotImplementedError()
 
 
 @multimethod
 def describe_categorical_1d(
-    config: Settings, series: pd.Series, summary: dict
-) -> Tuple[Settings, pd.Series, dict]:
+    config: Settings, series: pd.Series, summary: VarDescription
+) -> Tuple[Settings, Any, VarDescription]:
     raise NotImplementedError()
 
 
 @multimethod
 def describe_url_1d(
-    config: Settings, series: Any, summary: dict
-) -> Tuple[Settings, Any, dict]:
+    config: Settings, series: Any, summary: VarDescription
+) -> Tuple[Settings, Any, VarDescription]:
     raise NotImplementedError()
 
 
 @multimethod
 def describe_file_1d(
-    config: Settings, series: Any, summary: dict
-) -> Tuple[Settings, Any, dict]:
+    config: Settings, series: Any, summary: VarDescription
+) -> Tuple[Settings, Any, VarDescription]:
     raise NotImplementedError()
 
 
 @multimethod
 def describe_path_1d(
-    config: Settings, series: Any, summary: dict
-) -> Tuple[Settings, Any, dict]:
+    config: Settings, series: Any, summary: VarDescription
+) -> Tuple[Settings, Any, VarDescription]:
     raise NotImplementedError()
 
 
 @multimethod
 def describe_image_1d(
-    config: Settings, series: Any, summary: dict
-) -> Tuple[Settings, Any, dict]:
+    config: Settings, series: Any, summary: VarDescription
+) -> Tuple[Settings, Any, VarDescription]:
     raise NotImplementedError()
 
 
 @multimethod
 def describe_boolean_1d(
-    config: Settings, series: Any, summary: dict
-) -> Tuple[Settings, Any, dict]:
+    config: Settings, series: Any, summary: VarDescription
+) -> Tuple[Settings, Any, VarDescription]:
     raise NotImplementedError()
 
 
 @multimethod
 def describe_timeseries_1d(
-    config: Settings, series: Any, summary: dict
-) -> Tuple[Settings, Any, dict]:
+    config: Settings, series: Any, summary: VarDescription
+) -> Tuple[Settings, Any, VarDescription]:
     raise NotImplementedError()