feat: initial release

Author: Pkcha

src/ydata_profiling/model/handler.py

@@ -1,63 +1,60 @@
-"""
-    Auxiliary handler methods for data summary extraction
-"""
-from typing import Any, Callable, Dict, List, Sequence
-
-import networkx as nx
-from visions import VisionsTypeset
-
-
-def compose(functions: Sequence[Callable]) -> Callable:
-    """
-    Compose a sequence of functions.
-
-    :param functions: sequence of functions
-    :return: combined function applying all functions in order.
-    """
-
-    def composed_function(*args) -> List[Any]:
-        result = args  # Start with the input arguments
-        for func in functions:
-            result = func(*result) if isinstance(result, tuple) else func(result)
-        return result  # type: ignore
-
-    return composed_function  # type: ignore
-
-
-class Handler:
-    """A generic handler
-
-    Allows any custom mapping between data types and functions
-    """
-
-    def __init__(
-        self,
-        mapping: Dict[str, List[Callable]],
-        typeset: VisionsTypeset,
-        *args,
-        **kwargs
-    ):
-        self.mapping = mapping
-        self.typeset = typeset
-        self._complete_dag()
-
-    def _complete_dag(self) -> None:
-        for from_type, to_type in nx.topological_sort(
-            nx.line_graph(self.typeset.base_graph)
-        ):
-            self.mapping[str(to_type)] = (
-                self.mapping[str(from_type)] + self.mapping[str(to_type)]
-            )
-
-    def handle(self, dtype: str, *args, **kwargs) -> dict:
-        """
-        Returns:
-            object: a tuple containing the config, the dataset series and the summary extracted
-        """
-        funcs = self.mapping.get(dtype, [])
-        op = compose(funcs)
-        summary = op(*args)[-1]
-        return summary
-
-
-
+"""
+    Auxiliary handler methods for data summary extraction
+"""
+from typing import Any, Callable, Dict, List, Sequence
+
+import networkx as nx
+from visions import VisionsTypeset
+
+
+def compose(functions: Sequence[Callable]) -> Callable:
+    """
+    Compose a sequence of functions.
+
+    :param functions: sequence of functions
+    :return: combined function applying all functions in order.
+    """
+
+    def composed_function(*args) -> List[Any]:
+        result = args  # Start with the input arguments
+        for func in functions:
+            result = func(*result) if isinstance(result, tuple) else func(result)
+        return result  # type: ignore
+
+    return composed_function  # type: ignore
+
+
+class Handler:
+    """A generic handler
+
+    Allows any custom mapping between data types and functions
+    """
+
+    def __init__(
+        self,
+        mapping: Dict[str, List[Callable]],
+        typeset: VisionsTypeset,
+        *args,
+        **kwargs
+    ):
+        self.mapping = mapping
+        self.typeset = typeset
+        self._complete_dag()
+
+    def _complete_dag(self) -> None:
+        for from_type, to_type in nx.topological_sort(
+            nx.line_graph(self.typeset.base_graph)
+        ):
+            self.mapping[str(to_type)] = (
+                self.mapping[str(from_type)] + self.mapping[str(to_type)]
+            )
+
+    def handle(self, dtype: str, *args, **kwargs) -> dict:
+        """
+        Returns:
+            object: a tuple containing the config, the dataset series and the summary extracted
+        """
+        funcs = self.mapping.get(dtype, [])
+        op = compose(funcs)
+        summary = op(*args)[-1]
+        return summary

src/ydata_profiling/report/structure/__init__.py

@@ -3,6 +3,14 @@
 
 
 def get_render_map() -> Dict[str, Callable]:
+    """Get the mapping of variable types to their render functions.
+
+    This function was moved from model.handler to report.structure to eliminate
+    the reverse dependency from model layer to report layer.
+
+    Returns:
+        Dictionary mapping type names to render functions.
+    """
     import ydata_profiling.report.structure.variables as render_algorithms
 
     render_map = {

src/ydata_profiling/utils/backend.py

@@ -1,5 +1,5 @@
 """
-    File with a function to check the backend being used
+Backend detection utilities for pandas and spark.
 """
 import importlib