feat: refactor code to render HTML and widget flavours (#1740)

* feat: refactor code to render HTML and widget flavours

* fix: code linter issues

* fix: issues related with the banner link

* fix: linter errors with imports from flavour_widget

* fix: remove unused import

* fix: typing fixes

* fix: linting types

* fix: rm circular import

* fix: linting

* fix: linter and typing errors

* feat: update report rendering to show overview

* fix: remove unused import

* fix(linting): code formatting

---------

Co-authored-by: Azory YData Bot <[email protected]>

Author: fabclmnt

src/ydata_profiling/report/presentation/core/__init__.py

@@ -12,6 +12,7 @@
 from ydata_profiling.report.presentation.core.image import Image
 from ydata_profiling.report.presentation.core.root import Root
 from ydata_profiling.report.presentation.core.sample import Sample
+from ydata_profiling.report.presentation.core.scores import Scores
 from ydata_profiling.report.presentation.core.table import Table
 from ydata_profiling.report.presentation.core.toggle_button import ToggleButton
 from ydata_profiling.report.presentation.core.variable import Variable
@@ -34,4 +35,5 @@
     "VariableInfo",
     "Alerts",
     "CorrelationTable",
+    "Scores",
 ]

src/ydata_profiling/report/presentation/core/container.py

@@ -12,11 +12,16 @@ def __init__(
         name: Optional[str] = None,
         anchor_id: Optional[str] = None,
         classes: Optional[str] = None,
+        oss: Optional[bool] = None,
         **kwargs,
     ):
         args = {"items": items, "nested": nested}
         args.update(**kwargs)
         super().__init__(args, name, anchor_id, classes)
+
+        if oss is not None:
+            self.oss = oss
+
         self.sequence_type = sequence_type
 
     def __str__(self) -> str:

src/ydata_profiling/report/presentation/core/renderable.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import Any, Callable, Dict, Optional
+from typing import Any, Dict, Optional
 
 
 class Renderable(ABC):
@@ -38,5 +38,5 @@ def __str__(self):
         return self.__class__.__name__
 
     @classmethod
-    def convert_to_class(cls, obj: "Renderable", flv: Callable) -> None:
+    def convert_to_class(cls, obj: "Renderable", flavour_func) -> None:  # noqa: ANN001
         obj.__class__ = cls

src/ydata_profiling/report/presentation/core/scores.py

@@ -0,0 +1,31 @@
+"""
+    Scores ItemRendered class
+"""
+from typing import Any, Dict, List, Optional
+
+from ydata_profiling.report.presentation.core.item_renderer import ItemRenderer
+
+
+class Scores(ItemRenderer):
+    def __init__(
+        self,
+        items: List[Dict],
+        overall_score: float,
+        name: Optional[str],
+        caption: Optional[str],
+        **kwargs
+    ):
+        content = {
+            "items": items,
+            "overall_score": overall_score,
+            "name": name,
+            "caption": caption,
+        }
+
+        super().__init__("scores", content=content, **kwargs)
+
+    def __repr__(self) -> str:
+        return "Scores"
+
+    def render(self) -> Any:
+        raise NotImplementedError("Handled by flavour-specific class")

src/ydata_profiling/report/presentation/flavours/flavour_html.py

@@ -0,0 +1,64 @@
+"""
+    HTML flavour mapping
+"""
+from ydata_profiling.report.presentation.core import (
+    HTML,
+    Alerts,
+    Collapse,
+    Container,
+    CorrelationTable,
+    Dropdown,
+    Duplicate,
+    FrequencyTable,
+    FrequencyTableSmall,
+    Image,
+    Root,
+    Sample,
+    Scores,
+    Table,
+    ToggleButton,
+    Variable,
+    VariableInfo,
+)
+from ydata_profiling.report.presentation.flavours.flavours import register_flavour
+from ydata_profiling.report.presentation.flavours.html import (
+    HTMLHTML,
+    HTMLAlerts,
+    HTMLCollapse,
+    HTMLContainer,
+    HTMLCorrelationTable,
+    HTMLDropdown,
+    HTMLDuplicate,
+    HTMLFrequencyTable,
+    HTMLFrequencyTableSmall,
+    HTMLImage,
+    HTMLRoot,
+    HTMLSample,
+    HTMLScores,
+    HTMLTable,
+    HTMLToggleButton,
+    HTMLVariable,
+    HTMLVariableInfo,
+)
+
+html_mapping = {
+    Container: HTMLContainer,
+    Variable: HTMLVariable,
+    VariableInfo: HTMLVariableInfo,
+    Table: HTMLTable,
+    HTML: HTMLHTML,
+    Root: HTMLRoot,
+    Image: HTMLImage,
+    FrequencyTable: HTMLFrequencyTable,
+    FrequencyTableSmall: HTMLFrequencyTableSmall,
+    Alerts: HTMLAlerts,
+    Duplicate: HTMLDuplicate,
+    Dropdown: HTMLDropdown,
+    Sample: HTMLSample,
+    ToggleButton: HTMLToggleButton,
+    Collapse: HTMLCollapse,
+    CorrelationTable: HTMLCorrelationTable,
+    Scores: HTMLScores,
+}
+
+register_flavour("html", html_mapping)

src/ydata_profiling/report/presentation/flavours/flavour_widget.py

@@ -0,0 +1,61 @@
+"""
+    Flavour widget
+"""
+from ydata_profiling.report.presentation.core import (
+    HTML,
+    Alerts,
+    Collapse,
+    Container,
+    CorrelationTable,
+    Dropdown,
+    Duplicate,
+    FrequencyTable,
+    FrequencyTableSmall,
+    Image,
+    Root,
+    Sample,
+    Table,
+    ToggleButton,
+    Variable,
+    VariableInfo,
+)
+from ydata_profiling.report.presentation.flavours.flavours import register_flavour
+from ydata_profiling.report.presentation.flavours.widget import (
+    WidgetAlerts,
+    WidgetCollapse,
+    WidgetContainer,
+    WidgetCorrelationTable,
+    WidgetDropdown,
+    WidgetDuplicate,
+    WidgetFrequencyTable,
+    WidgetFrequencyTableSmall,
+    WidgetHTML,
+    WidgetImage,
+    WidgetRoot,
+    WidgetSample,
+    WidgetTable,
+    WidgetToggleButton,
+    WidgetVariable,
+    WidgetVariableInfo,
+)
+
+widget_mapping = {
+    Container: WidgetContainer,
+    Variable: WidgetVariable,
+    VariableInfo: WidgetVariableInfo,
+    Table: WidgetTable,
+    HTML: WidgetHTML,
+    Root: WidgetRoot,
+    Image: WidgetImage,
+    FrequencyTable: WidgetFrequencyTable,
+    FrequencyTableSmall: WidgetFrequencyTableSmall,
+    Alerts: WidgetAlerts,
+    Duplicate: WidgetDuplicate,
+    Dropdown: WidgetDropdown,
+    Sample: WidgetSample,
+    ToggleButton: WidgetToggleButton,
+    Collapse: WidgetCollapse,
+    CorrelationTable: WidgetCorrelationTable,
+}
+
+register_flavour("widget", widget_mapping)

src/ydata_profiling/report/presentation/flavours/flavours.py

@@ -1,153 +1,43 @@
-from typing import Callable, Dict, Type
-
+"""
+    Flavours registry information
+"""
 from ydata_profiling.report.presentation.core import Root
 from ydata_profiling.report.presentation.core.renderable import Renderable
 
+_FLAVOUR_REGISTRY: dict = {}
 
-def apply_renderable_mapping(
-    mapping: Dict[Type[Renderable], Type[Renderable]],
-    structure: Renderable,
-    flavour: Callable,
-) -> None:
-    mapping[type(structure)].convert_to_class(structure, flavour)
 
+def register_flavour(name: str, mapping: dict) -> None:
+    _FLAVOUR_REGISTRY[name] = mapping
 
-def get_html_renderable_mapping() -> Dict[Type[Renderable], Type[Renderable]]:
-    """Workaround variable type annotations not being supported in Python 3.5
 
-    Returns:
-        type annotated mapping dict
-    """
-    from ydata_profiling.report.presentation.core import (
-        HTML,
-        Alerts,
-        Collapse,
-        Container,
-        CorrelationTable,
-        Dropdown,
-        Duplicate,
-        FrequencyTable,
-        FrequencyTableSmall,
-        Image,
-        Root,
-        Sample,
-        Table,
-        ToggleButton,
-        Variable,
-        VariableInfo,
-    )
-    from ydata_profiling.report.presentation.flavours.html import (
-        HTMLHTML,
-        HTMLAlerts,
-        HTMLCollapse,
-        HTMLContainer,
-        HTMLCorrelationTable,
-        HTMLDropdown,
-        HTMLDuplicate,
-        HTMLFrequencyTable,
-        HTMLFrequencyTableSmall,
-        HTMLImage,
-        HTMLRoot,
-        HTMLSample,
-        HTMLTable,
-        HTMLToggleButton,
-        HTMLVariable,
-        HTMLVariableInfo,
-    )
-
-    return {
-        Container: HTMLContainer,
-        Variable: HTMLVariable,
-        VariableInfo: HTMLVariableInfo,
-        Table: HTMLTable,
-        HTML: HTMLHTML,
-        Root: HTMLRoot,
-        Image: HTMLImage,
-        FrequencyTable: HTMLFrequencyTable,
-        FrequencyTableSmall: HTMLFrequencyTableSmall,
-        Alerts: HTMLAlerts,
-        Duplicate: HTMLDuplicate,
-        Dropdown: HTMLDropdown,
-        Sample: HTMLSample,
-        ToggleButton: HTMLToggleButton,
-        Collapse: HTMLCollapse,
-        CorrelationTable: HTMLCorrelationTable,
-    }
+def get_flavour_mapping(name: str) -> dict:
+    if name not in _FLAVOUR_REGISTRY:
+        raise ValueError(f"Flavour '{name}' is not registered.")
+    return _FLAVOUR_REGISTRY[name]
 
 
-def HTMLReport(structure: Root) -> Root:
-    """Adds HTML flavour to Renderable
+def apply_renderable_mapping(
+    mapping: dict,
+    structure: Renderable,
+    flavour_func,  # noqa: ANN001
+) -> None:
+    mapping[type(structure)].convert_to_class(structure, flavour_func)
 
-    Args:
-        structure:
 
-    Returns:
+def HTMLReport(structure: Root) -> Root:
+    from ydata_profiling.report.presentation.flavours import flavour_html  # noqa: F401
 
-    """
-    mapping = get_html_renderable_mapping()
-    apply_renderable_mapping(mapping, structure, flavour=HTMLReport)
+    mapping = get_flavour_mapping("html")
+    apply_renderable_mapping(mapping, structure, flavour_func=HTMLReport)
     return structure
 
 
-def get_widget_renderable_mapping() -> Dict[Type[Renderable], Type[Renderable]]:
-    from ydata_profiling.report.presentation.core import (
-        HTML,
-        Alerts,
-        Collapse,
-        Container,
-        CorrelationTable,
-        Dropdown,
-        Duplicate,
-        FrequencyTable,
-        FrequencyTableSmall,
-        Image,
-        Root,
-        Sample,
-        Table,
-        ToggleButton,
-        Variable,
-        VariableInfo,
-    )
-    from ydata_profiling.report.presentation.flavours.widget import (
-        WidgetAlerts,
-        WidgetCollapse,
-        WidgetContainer,
-        WidgetCorrelationTable,
-        WidgetDropdown,
-        WidgetDuplicate,
-        WidgetFrequencyTable,
-        WidgetFrequencyTableSmall,
-        WidgetHTML,
-        WidgetImage,
-        WidgetRoot,
-        WidgetSample,
-        WidgetTable,
-        WidgetToggleButton,
-        WidgetVariable,
-        WidgetVariableInfo,
+def WidgetReport(structure: Root) -> Root:
+    from ydata_profiling.report.presentation.flavours import (  # noqa: F401
+        flavour_widget,
     )
 
-    return {
-        Container: WidgetContainer,
-        Variable: WidgetVariable,
-        VariableInfo: WidgetVariableInfo,
-        Table: WidgetTable,
-        HTML: WidgetHTML,
-        Root: WidgetRoot,
-        Image: WidgetImage,
-        FrequencyTable: WidgetFrequencyTable,
-        FrequencyTableSmall: WidgetFrequencyTableSmall,
-        Alerts: WidgetAlerts,
-        Duplicate: WidgetDuplicate,
-        Dropdown: WidgetDropdown,
-        Sample: WidgetSample,
-        ToggleButton: WidgetToggleButton,
-        Collapse: WidgetCollapse,
-        CorrelationTable: WidgetCorrelationTable,
-    }
-
-
-def WidgetReport(structure: Root) -> Root:
-    mapping = get_widget_renderable_mapping()
-    apply_renderable_mapping(mapping, structure, flavour=WidgetReport)
+    mapping = get_flavour_mapping("widget")
+    apply_renderable_mapping(mapping, structure, flavour_func=WidgetReport)
     return structure

src/ydata_profiling/report/presentation/flavours/html/__init__.py

@@ -16,6 +16,7 @@
 from ydata_profiling.report.presentation.flavours.html.image import HTMLImage
 from ydata_profiling.report.presentation.flavours.html.root import HTMLRoot
 from ydata_profiling.report.presentation.flavours.html.sample import HTMLSample
+from ydata_profiling.report.presentation.flavours.html.scores import HTMLScores
 from ydata_profiling.report.presentation.flavours.html.table import HTMLTable
 from ydata_profiling.report.presentation.flavours.html.toggle_button import (
     HTMLToggleButton,
@@ -42,4 +43,5 @@
     "HTMLVariableInfo",
     "HTMLAlerts",
     "HTMLCorrelationTable",
+    "HTMLScores",
 ]