update series description. replace dict with class

Author: vorel99

src/ydata_profiling/model/alerts.py

@@ -1,13 +1,14 @@
 """Logic for alerting the user on possibly problematic patterns in the data (e.g. high number of zeros , constant
 values, high correlations)."""
 from enum import Enum, auto, unique
-from typing import Any, Dict, List, Optional, Set
+from typing import Dict, List, Optional, Set
 
 import numpy as np
 import pandas as pd
 
 from ydata_profiling.config import Settings
 from ydata_profiling.model.correlations import perform_check_correlation
+from ydata_profiling.model.var_description.default import VarDescription
 
 
 def fmt_percent(value: float, edge_cases: bool = True) -> str:
@@ -143,13 +144,13 @@ def __repr__(self):
 class ConstantLengthAlert(Alert):
     def __init__(
         self,
-        values: Optional[Dict] = None,
+        values: VarDescription,
         column_name: Optional[str] = None,
         is_empty: bool = False,
     ):
         super().__init__(
             alert_type=AlertType.CONSTANT_LENGTH,
-            values=values,
+            values=values.var_specific,
             column_name=column_name,
             fields={"composition_min_length", "composition_max_length"},
             is_empty=is_empty,
@@ -162,15 +163,14 @@ def _get_description(self) -> str:
 class ConstantAlert(Alert):
     def __init__(
         self,
-        values: Optional[Dict] = None,
+        values: VarDescription,
         column_name: Optional[str] = None,
         is_empty: bool = False,
     ):
         super().__init__(
             alert_type=AlertType.CONSTANT,
-            values=values,
+            values={"n_distinct": values.n_distinct},
             column_name=column_name,
-            fields={"n_distinct"},
             is_empty=is_empty,
         )
 
@@ -181,7 +181,7 @@ def _get_description(self) -> str:
 class DuplicatesAlert(Alert):
     def __init__(
         self,
-        values: Optional[Dict] = None,
+        values: dict,
         column_name: Optional[str] = None,
         is_empty: bool = False,
     ):
@@ -203,15 +203,14 @@ def _get_description(self) -> str:
 class EmptyAlert(Alert):
     def __init__(
         self,
-        values: Optional[Dict] = None,
+        values: VarDescription,
         column_name: Optional[str] = None,
         is_empty: bool = False,
     ):
         super().__init__(
             alert_type=AlertType.EMPTY,
-            values=values,
+            values={"n": values.n},
             column_name=column_name,
-            fields={"n"},
             is_empty=is_empty,
         )
 
@@ -222,15 +221,14 @@ def _get_description(self) -> str:
 class HighCardinalityAlert(Alert):
     def __init__(
         self,
-        values: Optional[Dict] = None,
+        values: VarDescription,
         column_name: Optional[str] = None,
         is_empty: bool = False,
     ):
         super().__init__(
             alert_type=AlertType.HIGH_CARDINALITY,
-            values=values,
+            values={"n_distinct": values.n_distinct},
             column_name=column_name,
-            fields={"n_distinct"},
             is_empty=is_empty,
         )
 
@@ -244,7 +242,7 @@ def _get_description(self) -> str:
 class HighCorrelationAlert(Alert):
     def __init__(
         self,
-        values: Optional[Dict] = None,
+        values: Dict,
         column_name: Optional[str] = None,
         is_empty: bool = False,
     ):
@@ -270,13 +268,13 @@ def _get_description(self) -> str:
 class ImbalanceAlert(Alert):
     def __init__(
         self,
-        values: Optional[Dict] = None,
+        values: VarDescription,
         column_name: Optional[str] = None,
         is_empty: bool = False,
     ):
         super().__init__(
             alert_type=AlertType.IMBALANCE,
-            values=values,
+            values=values.var_specific,
             column_name=column_name,
             fields={"imbalance"},
             is_empty=is_empty,
@@ -293,13 +291,13 @@ def _get_description(self) -> str:
 class InfiniteAlert(Alert):
     def __init__(
         self,
-        values: Optional[Dict] = None,
+        values: VarDescription,
         column_name: Optional[str] = None,
         is_empty: bool = False,
     ):
         super().__init__(
             alert_type=AlertType.INFINITE,
-            values=values,
+            values=values.var_specific,
             column_name=column_name,
             fields={"p_infinite", "n_infinite"},
             is_empty=is_empty,
@@ -315,15 +313,14 @@ def _get_description(self) -> str:
 class MissingAlert(Alert):
     def __init__(
         self,
-        values: Optional[Dict] = None,
+        values: VarDescription,
         column_name: Optional[str] = None,
         is_empty: bool = False,
     ):
         super().__init__(
             alert_type=AlertType.MISSING,
-            values=values,
+            values={"p_missing": values.p_missing, "n_missing": values.n_missing},
             column_name=column_name,
-            fields={"p_missing", "n_missing"},
             is_empty=is_empty,
         )
 
@@ -373,13 +370,13 @@ def _get_description(self) -> str:
 class SkewedAlert(Alert):
     def __init__(
         self,
-        values: Optional[Dict] = None,
+        values: VarDescription,
         column_name: Optional[str] = None,
         is_empty: bool = False,
     ):
         super().__init__(
             alert_type=AlertType.SKEWED,
-            values=values,
+            values=values.var_specific,
             column_name=column_name,
             fields={"skewness"},
             is_empty=is_empty,
@@ -432,15 +429,19 @@ def _get_description(self) -> str:
 class UniqueAlert(Alert):
     def __init__(
         self,
-        values: Optional[Dict] = None,
+        values: VarDescription,
         column_name: Optional[str] = None,
         is_empty: bool = False,
     ):
         super().__init__(
             alert_type=AlertType.UNIQUE,
-            values=values,
+            values={
+                "n_distinct": values.n_distinct,
+                "p_distinct": values.p_distinct,
+                "n_unique": values.n_unique,
+                "p_unique": values.p_unique,
+            },
             column_name=column_name,
-            fields={"n_distinct", "p_distinct", "n_unique", "p_unique"},
             is_empty=is_empty,
         )
 
@@ -469,13 +470,13 @@ def _get_description(self) -> str:
 class ZerosAlert(Alert):
     def __init__(
         self,
-        values: Optional[Dict] = None,
+        values: VarDescription,
         column_name: Optional[str] = None,
         is_empty: bool = False,
     ):
         super().__init__(
             alert_type=AlertType.ZEROS,
-            values=values,
+            values=values.var_specific,
             column_name=column_name,
             fields={"n_zeros", "p_zeros"},
             is_empty=is_empty,
@@ -531,7 +532,7 @@ def check_table_alerts(table: dict) -> List[Alert]:
     return alerts
 
 
-def numeric_alerts(config: Settings, summary: dict) -> List[Alert]:
+def numeric_alerts(config: Settings, summary: VarDescription) -> List[Alert]:
     alerts: List[Alert] = []
 
     # Skewness
@@ -555,7 +556,7 @@ def numeric_alerts(config: Settings, summary: dict) -> List[Alert]:
     return alerts
 
 
-def timeseries_alerts(config: Settings, summary: dict) -> List[Alert]:
+def timeseries_alerts(config: Settings, summary: VarDescription) -> List[Alert]:
     alerts: List[Alert] = numeric_alerts(config, summary)
 
     if not summary["stationary"]:
@@ -567,7 +568,7 @@ def timeseries_alerts(config: Settings, summary: dict) -> List[Alert]:
     return alerts
 
 
-def categorical_alerts(config: Settings, summary: dict) -> List[Alert]:
+def categorical_alerts(config: Settings, summary: VarDescription) -> List[Alert]:
     alerts: List[Alert] = []
 
     # High cardinality
@@ -585,7 +586,7 @@ def categorical_alerts(config: Settings, summary: dict) -> List[Alert]:
 
     # Constant length
     if "composition" in summary and summary["min_length"] == summary["max_length"]:
-        alerts.append(ConstantLengthAlert())
+        alerts.append(ConstantLengthAlert(summary))
 
     # Imbalance
     if (
@@ -596,46 +597,48 @@ def categorical_alerts(config: Settings, summary: dict) -> List[Alert]:
     return alerts
 
 
-def boolean_alerts(config: Settings, summary: dict) -> List[Alert]:
+def boolean_alerts(config: Settings, summary: VarDescription) -> List[Alert]:
     alerts: List[Alert] = []
 
     if (
         "imbalance" in summary
         and summary["imbalance"] > config.vars.bool.imbalance_threshold
     ):
-        alerts.append(ImbalanceAlert())
+        alerts.append(ImbalanceAlert(summary))
     return alerts
 
 
-def generic_alerts(summary: dict) -> List[Alert]:
+def generic_alerts(summary: VarDescription) -> List[Alert]:
     alerts: List[Alert] = []
 
     # Missing
-    if alert_value(summary["p_missing"]):
-        alerts.append(MissingAlert())
+    if alert_value(summary.p_missing):
+        alerts.append(MissingAlert(summary))
 
     return alerts
 
 
-def supported_alerts(summary: dict) -> List[Alert]:
+def supported_alerts(summary: VarDescription) -> List[Alert]:
     alerts: List[Alert] = []
 
-    if summary.get("n_distinct", np.nan) == summary["n"]:
-        alerts.append(UniqueAlert())
-    if summary.get("n_distinct", np.nan) == 1:
+    if summary.n_distinct == summary.n:
+        alerts.append(UniqueAlert(summary))
+    if summary.n_distinct == 1:
         alerts.append(ConstantAlert(summary))
     return alerts
 
 
-def unsupported_alerts(summary: Dict[str, Any]) -> List[Alert]:
+def unsupported_alerts(summary: VarDescription) -> List[Alert]:
     alerts: List[Alert] = [
         UnsupportedAlert(),
         RejectedAlert(),
     ]
     return alerts
 
 
-def check_variable_alerts(config: Settings, col: str, description: dict) -> List[Alert]:
+def check_variable_alerts(
+    config: Settings, col: str, description: VarDescription
+) -> List[Alert]:
     """Checks individual variables for alerts.
 
     Args:
@@ -665,7 +668,6 @@ def check_variable_alerts(config: Settings, col: str, description: dict) -> List
 
     for idx in range(len(alerts)):
         alerts[idx].column_name = col
-        alerts[idx].values = description
     return alerts
 
 
@@ -693,7 +695,10 @@ def check_correlation_alerts(config: Settings, correlations: dict) -> List[Alert
 
 
 def get_alerts(
-    config: Settings, table_stats: dict, series_description: dict, correlations: dict
+    config: Settings,
+    table_stats: dict,
+    series_description: dict[str, VarDescription],
+    correlations: dict,
 ) -> List[Alert]:
     alerts: List[Alert] = check_table_alerts(table_stats)
     for col, description in series_description.items():

src/ydata_profiling/model/describe.py

@@ -23,6 +23,7 @@
 from ydata_profiling.model.summary import get_series_descriptions
 from ydata_profiling.model.table import get_table_stats
 from ydata_profiling.model.timeseries_index import get_time_index_description
+from ydata_profiling.model.var_description.default import VarDescription
 from ydata_profiling.utils.progress_bar import progress
 from ydata_profiling.version import __version__
 
@@ -71,7 +72,7 @@ def describe(
 
         # Variable-specific
         pbar.total += len(df.columns)
-        series_description = get_series_descriptions(
+        series_description: dict[str, VarDescription] = get_series_descriptions(
             config, df, summarizer, typeset, pbar
         )
 

src/ydata_profiling/model/description.py

@@ -2,6 +2,8 @@
 from datetime import datetime, timedelta
 from typing import Any, Dict, List, Optional, Union
 
+from ydata_profiling.model.var_description.default import VarDescription
+
 
 @dataclass
 class BaseAnalysis:
@@ -96,7 +98,7 @@ class BaseDescription:
     analysis: BaseAnalysis
     time_index_analysis: Optional[TimeIndexAnalysis]
     table: Any
-    variables: Dict[str, Any]
+    variables: Dict[str, VarDescription]
     scatter: Any
     correlations: Dict[str, Any]
     missing: Dict[str, Any]