syntaxmatrix 1.4.6__py3-none-any.whl → 2.5.5.4__py3-none-any.whl

syntaxmatrix/display.py

@@ -1,132 +1,106 @@
-# syntaxmatrix/display.py
-# import pandas as pd
-# from IPython.display import HTML, display  
-# from syntaxmatrix.plottings import datatable_box          
-
-# def show(obj, *, name=None):
-#     """
-#     Smart display for the SyntaxMatrix auto-code kernel.
-#     * Scalars / simple tuples → pretty print
-#     * pandas Series / DataFrame → display()
-#     * matplotlib / seaborn figs → already auto-render
-#     * dicts → key-value table
-#     * sklearn estimators with .score_ / feature_importances_ → summary
-#     """
-#     try:
-#         import matplotlib.pyplot as plt
-#     except Exception:
-#         plt = None
-
-#     if isinstance(obj, (float, int)) and (0 <= obj <= 1):
-#         print(f"accuracy = {obj:.3f}")
-#         return
-
-     # 1️⃣ pandas objects
-    #  if isinstance(obj, (pd.Series, pd.DataFrame)):
-
-    #     html = obj.to_html(classes="smx-table", border=0)
-    #     wrapped_html = (
-    #         "<style>"
-    #         ".smx-table{border-collapse:collapse;font-size:0.9em;white-space:nowrap;}"
-    #         ".smx-table th{background:#f0f2f5;text-align:left;padding:6px 8px;border:1px solid gray;}"
-    #         ".smx-table td{border:1px solid #ddd;padding:6px 8px;}"
-    #         ".smx-table tbody tr:nth-child(even){background-color:#f9f9f9;}"
-    #         "</style>"
-    #         "<div style='overflow-x:auto; max-width:100%; margin-bottom:1rem;'>"
-    #         + html +
-    #         "</div>"
-    #     )
-    #     display(HTML(wrapped_html))
-    #     return
-
-#     # matplotlib figs (let Jupyter handle them)
-#     if plt and isinstance(obj, plt.Figure):
-#         return
-
-#     # tuples of stats results (length 2 or 4 are common)
-#     if isinstance(obj, tuple):
-#         if len(obj) == 2 and all(isinstance(v, (int, float)) for v in obj):
-#             mse, r2 = obj
-#             if len(obj) == 2: 
-#                 stat, p = obj
-#                 print(f"statistic = {stat:.4g}   p-value = {p:.4g}")
-#                 print("Result: " + ("significant ✅" if p < 0.05 else "not significant ❌"))
-#                 return
-#             if len(obj) == 4:         # e.g. χ²
-#                 chi2, p, dof, _ = obj
-#                 print(f"chi² = {chi2:.3g}   dof = {dof}   p-value = {p:.4g}")
-#                 print("Result: " + ("significant ✅" if p < 0.05 else "not significant ❌"))
-#                 return
-#         # Treat as regression metrics if r2 is ≤ 1 and mse ≥ 0
-#         if 0 <= r2 <= 1 and mse >= 0:
-#             df_ = pd.DataFrame(
-#                 {"metric": ["Mean-squared error", "R²"],
-#                 "value":  [mse, r2]}
-#             )
-#             display(HTML(datatable_box(df_)))
-#             return
-
-#     # dict → nice key:value printout
-#     if isinstance(obj, dict):
-#         for k, v in obj.items():
-#             print(f"{k:<25} {v}")
-#         return
-
-#     # fallback
-#     print(obj)
-
-  
-# -----------------------------------------------------------------
-#  Paste *inside* syntaxmatrix/display.py – only the show() body
-# -----------------------------------------------------------------
-def show(obj):
+"""
+syntaxmatrix.display
+--------------------
+Single responsibility: render arbitrary Python objects in the SMX UI.
+
+- Matplotlib figures: displayed directly.
+- Pandas Styler (with .set_caption): rendered to HTML so captions always show.
+- Pandas DataFrame/Series: rendered to HTML (no caption path).
+- Dict of scalars: rendered as a small table.
+- Tuple of two numbers (e.g., mse, r2): rendered as a labelled 2-row table.
+- Everything else: shown as <pre> for safe inspection.
+"""
+
+from typing import Any
+import numbers
+
+import pandas as pd
+import matplotlib.figure as mpfig
+from IPython.display import display, HTML
+
+try:
+    # Optional: if pandas Styler exists, we can keep captions reliably
+    from pandas.io.formats.style import Styler as _Styler  # type: ignore
+except Exception:  # pragma: no cover
+    _Styler = None  # type: ignore
+
+
+__all__ = ["show"]
+
+
+# ---- internal helpers -------------------------------------------------------
+
+
+def _wrap_html_table(html: str) -> str:
+    """Apply consistent UI styling and horizontal scrolling."""
+    return (
+        "<style>"
+        "caption{caption-side: top; font-weight:600; margin:0 0 6px 0;}"
+        "table{border-collapse:collapse;font-size:0.9em;white-space:nowrap;}"
+        "th{background:#f0f2f5;text-align:left;padding:6px 8px;border:1px solid gray;}"
+        "td{border:1px solid #ddd;padding:6px 8px;}"
+        "tbody tr:nth-child(even){background-color:#f9f9f9;}"
+        "</style>"
+        "<div style='overflow-x:auto;max-width:100%;margin-bottom:1rem;'>"
+        + html +
+        "</div>"
+    )
+
+
+# ---- public API -------------------------------------------------------------
+
+
+def show(obj: Any) -> None:
     """
     Render common objects so the Dashboard (or chat) always shows output.
-    """
-    import io, base64, numbers
-    from IPython.display import display, HTML
-    import pandas as pd
-    import matplotlib.figure as mpfig
 
-    # ── matplotlib Figure ─────────────────────────────────────────
+    Notes
+    -----
+    * Do not print here. All rendering goes through IPython's display layer.
+    * Captions are supplied upstream by the SMX PREFACE via DataFrame.style.set_caption(...).
+    """
+    # 1) Matplotlib figures
     if isinstance(obj, mpfig.Figure):
-        display(obj)                  
-        return obj
-    
-    if isinstance(obj, (pd.Series, pd.DataFrame)):
+        display(obj)
+        return None
+
+    # 2) Pandas Styler (keeps caption)
+    if _Styler is not None and isinstance(obj, _Styler):  # type: ignore
+        try:
+            html = obj.to_html()
+            display(HTML(_wrap_html_table(html)))
+        except Exception:
+            # Fallback: if Styler HTML fails for any reason, display raw Styler
+            display(obj)
+        return None
 
+    # 3) Series / DataFrame (no caption path)
+    if isinstance(obj, (pd.Series, pd.DataFrame)):
         html = obj.to_html(classes="smx-table", border=0)
-        wrapped_html = (
-            "<style>"
-            ".smx-table{border-collapse:collapse;font-size:0.9em;white-space:nowrap;}"
-            ".smx-table th{background:#f0f2f5;text-align:left;padding:6px 8px;border:1px solid gray;}"
-            ".smx-table td{border:1px solid #ddd;padding:6px 8px;}"
-            ".smx-table tbody tr:nth-child(even){background-color:#f9f9f9;}"
-            "</style>"
-            "<div style='overflow-x:auto; max-width:100%; margin-bottom:1rem;'>"
-            + html +
-            "</div>"
-        )
-        display(HTML(wrapped_html))
-        return HTML(wrapped_html)
+        display(HTML(_wrap_html_table(html)))
+        return None
 
-    # ── dict of scalars → pretty 2-col table ─────────────────────
+    # 4) Dict of scalar numbers → pretty 2-col table
     if isinstance(obj, dict) and all(isinstance(v, numbers.Number) for v in obj.values()):
-        df_ = pd.DataFrame({"metric": list(obj.keys()),
-                            "value":  list(obj.values())})
-        display(df_)
-        return df_
-
-    # ── 2-tuple of numbers (mse, r²) ─────────────────────────────
-    if (isinstance(obj, tuple) and len(obj) == 2 and
-            all(isinstance(v, numbers.Number) for v in obj)):
+        df_ = pd.DataFrame({"metric": list(obj.keys()), "value": list(obj.values())})
+        html = df_.to_html(classes="smx-table", border=0, index=False)
+        display(HTML(_wrap_html_table(html)))
+        return None
+
+    # 5) Two-number tuple → labelled metric table (e.g., (mse, r2))
+    if (
+        isinstance(obj, tuple)
+        and len(obj) == 2
+        and all(isinstance(v, numbers.Number) for v in obj)
+    ):
         mse, r2 = obj
-        df_ = pd.DataFrame({"metric": ["Mean-squared error", "R²"],
-                            "value":  [mse, r2]})
-        display(df_)
-        return df_
+        df_ = pd.DataFrame(
+            {"metric": ["Mean-squared error", "R²"], "value": [mse, r2]}
+        )
+        html = df_.to_html(classes="smx-table", border=0, index=False)
+        display(HTML(_wrap_html_table(html)))
+        return None
 
-    # ── fallback ─────────────────────────────────────────────────
+    # 6) Fallback: show as preformatted text (safe and predictable)
     display(HTML(f"<pre>{obj}</pre>"))
-
-    return obj
+    return None