Add HTML representation methods for Jupyter notebook display in LabeledEnum and DataSet

Author: PierreRaybaut

doc/release_notes/release_3.14.md

@@ -4,6 +4,12 @@
 
 ✨ New features:
 
+* **Jupyter notebook HTML representation**: Added rich HTML display support for DataSet and LabeledEnum objects
+  * New `_repr_html_()` method on `DataSet` class for styled HTML table rendering in Jupyter notebooks
+  * New `_repr_html_()` method on `LabeledEnum` class for formatted display of enum values with labels
+  * CSS styling with `.guidata-dataset-table` class for consistent visual appearance
+  * Automatically called by Jupyter when displaying objects as cell output
+
 * **Secure build utility**: Added `--prebuild` option to run commands before package build
   * New `--prebuild` command-line argument for `guidata.utils.securebuild`
   * Executes custom commands in the temporary build directory before `python -m build`

guidata/dataset/dataitems.py

@@ -178,6 +178,27 @@ def __hash__(self) -> int:
         return hash(self._value_)
 
 
+# Add _repr_html_ after class definition to avoid Enum member name restrictions
+def _labeled_enum_repr_html(self) -> str:
+    """Return HTML representation for Jupyter notebook display.
+
+    This method is automatically called by Jupyter when displaying the object
+    as a cell output, providing a styled representation of the enum value.
+
+    Returns:
+        HTML representation of the enum value with styling.
+    """
+    enum_class = self.__class__.__name__
+    return (
+        f'<span style="color: #5294e2; font-family: monospace;">'
+        f"{enum_class}.<b>{self.name}</b></span> "
+        f'(<code>{self._value_!r}</code>: "{self.label}")'
+    )
+
+
+LabeledEnum._repr_html_ = _labeled_enum_repr_html
+
+
 class NumericTypeItem(DataItem):
     """Numeric data item
 

guidata/dataset/datatypes.py

@@ -82,6 +82,29 @@
 
 DEBUG_DESERIALIZE = False
 
+# CSS styling for HTML tables in Jupyter notebooks
+DATASET_TABLE_CSS = """
+<style>
+    .guidata-dataset-table {
+        border-collapse: collapse;
+        font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto,
+                     'Helvetica Neue', Arial, sans-serif;
+        font-size: 13px;
+        margin: 10px 0;
+    }
+    .guidata-dataset-table td {
+        border: 1px solid #dee2e6;
+        padding: 8px 12px;
+    }
+    .guidata-dataset-table tr:nth-child(even) {
+        background-color: #f8f9fa;
+    }
+    .guidata-dataset-table tr:hover {
+        background-color: #e9ecef;
+    }
+</style>
+"""
+
 if TYPE_CHECKING:
     from qtpy.QtCore import QSize
     from qtpy.QtWidgets import QDialog, QWidget
@@ -1846,6 +1869,17 @@ def to_html(self) -> str:
         html += "</table>"
         return html
 
+    def _repr_html_(self) -> str:
+        """Return HTML representation for Jupyter notebook display.
+
+        This method is automatically called by Jupyter when displaying the object
+        as a cell output, providing a rich HTML rendering of the dataset.
+
+        Returns:
+            HTML representation of the dataset with styling.
+        """
+        return DATASET_TABLE_CSS + self.to_html()
+
     def serialize(self, writer: HDF5Writer | JSONWriter | INIWriter) -> None:
         """Serialize the dataset