edsl 0.1.39.dev3__py3-none-any.whl → 0.1.39.dev4__py3-none-any.whl

edsl/results/{ResultsToolsMixin.py → results_tools_mixin.py}

@@ -1,98 +1,98 @@
-class ResultsToolsMixin:
-    def get_themes(
-        self,
-        field: str,
-        context: str,
-        max_values=100,
-        num_themes: int = 10,
-        seed=None,
-        progress_bar=False,
-        print_exceptions=False,
-    ) -> list:
-        values = [
-            str(txt)[:1000]
-            for txt in self.shuffle(seed=seed).select(field).to_list()[:max_values]
-        ]
-        from edsl import ScenarioList
-        from edsl.questions import QuestionList, QuestionCheckBox
-
-        q = QuestionList(
-            question_text=f"""
-        {context}
-        Here are some examples: { values }. 
-        What are some 5-8 word themes that would mostly capture these examples?
-        Please shoot for {num_themes} as target number of themes.
-        """,
-            question_name="themes",
-        )
-        results = q.run(print_exceptions=print_exceptions, progress_bar=progress_bar)
-        return results.select("themes").first()
-
-    def answers_to_themes(
-        self,
-        field,
-        context: str,
-        themes: list,
-        progress_bar=False,
-        print_exceptions=False,
-    ) -> dict:
-        from edsl import ScenarioList
-        from edsl import QuestionCheckBox
-
-        values = self.select(field).to_list()
-        scenarios = ScenarioList.from_list("field", values).add_value(
-            "context", context
-        )
-        q = QuestionCheckBox(
-            question_text="""
-            {{ context }}
-            Consider the following response: 
-
-            " {{ field }} "
-
-            Please check the themes that apply to these examples.
-            If blank, please check 'None'.
-            """,
-            question_options=themes + ["None", "Other"],
-            question_name="themes",
-        )
-        results = q.by(scenarios).run(
-            progress_bar=progress_bar, print_exceptions=print_exceptions
-        )
-        return {k: v for k, v in results.select("field", "themes").to_list()}
-
-    def apply_themes(self, field: str, new_field: str, answers_to_themes: dict):
-        def translate(x):
-            return answers_to_themes.get(x, "Other")
-
-        self.mutate(f"{new_field} = f({field})", functions_dict={"f": translate})
-        return self
-
-    def auto_theme(
-        self,
-        field: str,
-        context: str,
-        themes: list[str],
-        newfield: str = None,
-        progress_bar=False,
-        print_exceptions=False,
-    ) -> tuple:
-        """
-        :param field: The field to be themed.
-        :param context: The context of the field.
-        :param themes: The list of themes.
-        :param newfield: The new field name.
-
-        """
-
-        if not newfield:
-            newfield = f"{field}_themes"
-
-        answers_to_themes = self.answers_to_themes(
-            field=field,
-            context=context,
-            themes=themes,
-            progress_bar=progress_bar,
-            print_exceptions=print_exceptions,
-        )
-        return self.apply_themes(field, newfield, answers_to_themes), themes
+class ResultsToolsMixin:
+    def get_themes(
+        self,
+        field: str,
+        context: str,
+        max_values=100,
+        num_themes: int = 10,
+        seed=None,
+        progress_bar=False,
+        print_exceptions=False,
+    ) -> list:
+        values = [
+            str(txt)[:1000]
+            for txt in self.shuffle(seed=seed).select(field).to_list()[:max_values]
+        ]
+        from edsl import ScenarioList
+        from edsl.questions import QuestionList, QuestionCheckBox
+
+        q = QuestionList(
+            question_text=f"""
+        {context}
+        Here are some examples: { values }. 
+        What are some 5-8 word themes that would mostly capture these examples?
+        Please shoot for {num_themes} as target number of themes.
+        """,
+            question_name="themes",
+        )
+        results = q.run(print_exceptions=print_exceptions, progress_bar=progress_bar)
+        return results.select("themes").first()
+
+    def answers_to_themes(
+        self,
+        field,
+        context: str,
+        themes: list,
+        progress_bar=False,
+        print_exceptions=False,
+    ) -> dict:
+        from edsl import ScenarioList
+        from edsl import QuestionCheckBox
+
+        values = self.select(field).to_list()
+        scenarios = ScenarioList.from_list("field", values).add_value(
+            "context", context
+        )
+        q = QuestionCheckBox(
+            question_text="""
+            {{ context }}
+            Consider the following response: 
+
+            " {{ field }} "
+
+            Please check the themes that apply to these examples.
+            If blank, please check 'None'.
+            """,
+            question_options=themes + ["None", "Other"],
+            question_name="themes",
+        )
+        results = q.by(scenarios).run(
+            progress_bar=progress_bar, print_exceptions=print_exceptions
+        )
+        return {k: v for k, v in results.select("field", "themes").to_list()}
+
+    def apply_themes(self, field: str, new_field: str, answers_to_themes: dict):
+        def translate(x):
+            return answers_to_themes.get(x, "Other")
+
+        self.mutate(f"{new_field} = f({field})", functions_dict={"f": translate})
+        return self
+
+    def auto_theme(
+        self,
+        field: str,
+        context: str,
+        themes: list[str],
+        newfield: str = None,
+        progress_bar=False,
+        print_exceptions=False,
+    ) -> tuple:
+        """
+        :param field: The field to be themed.
+        :param context: The context of the field.
+        :param themes: The list of themes.
+        :param newfield: The new field name.
+
+        """
+
+        if not newfield:
+            newfield = f"{field}_themes"
+
+        answers_to_themes = self.answers_to_themes(
+            field=field,
+            context=context,
+            themes=themes,
+            progress_bar=progress_bar,
+            print_exceptions=print_exceptions,
+        )
+        return self.apply_themes(field, newfield, answers_to_themes), themes

edsl/results/smart_objects.py

@@ -0,0 +1,96 @@
+from typing import Optional
+
+
+class SmartInt(int):
+    pass
+
+
+class SmartFloat(float):
+    pass
+
+
+class SmartStr(str):
+    def clipboard(self) -> None:
+        try:
+            import pyperclip
+        except ImportError:
+            print(
+                "pyperclip is not installed. Run `pip install pyperclip` to install it."
+            )
+            return None
+
+        pyperclip.copy(self)
+        print("Text copied to clipboard.")
+
+    def write(self, filename: str):
+        with open(filename, "w") as f:
+            f.write(str(self))
+        return None
+
+    def _repr_html_(self):
+        pass
+
+    def markdown(self):
+        return SmartMarkdown(self)
+
+    def pdf(self, filename: Optional[str] = None):  # Markdown will have this as well
+        # renders the markdown as a pdf that can be downloaded
+        from edsl.results.MarkdownToPDF import MarkdownToPDF
+
+        return MarkdownToPDF(self, filename).preview()
+
+    def docx(self, filename: Optional[str] = None):
+        # renders the markdown as a docx that can be downloaded
+        from edsl.results.MarkdownToDocx import MarkdownToDocx
+
+        return MarkdownToDocx(self, filename).preview()
+
+    def edit(self):
+        from edsl.results.TextEditor import TextEditor
+
+        editor = TextEditor(self)
+        self = self.__class__(editor.edit_gui())
+        # print(f"Updated text: {self}")
+
+
+class SmartMarkdown(SmartStr):
+    def _repr_markdown_(self):
+        return self
+
+    def _repr_html_(self):
+        from IPython.display import Markdown, display
+
+        display(Markdown(self))
+
+
+class SmartLaTeX(SmartStr):
+    def _repr_html_(self):
+        print(self)
+
+    def pdf(self, filename: Optional[str] = None):
+        from edsl.results.LaTeXToPDF import LaTeXToPDF
+
+        return LaTeXToPDF(self, filename).preview()
+
+    def docx(self, filename: Optional[str] = None):
+        from edsl.results.LaTeXToDocx import LaTeXToDocx
+
+        return LaTeXToDocx(self, filename).preview()
+
+    def edit(self):
+        from edsl.results.TextEditor import TextEditor
+
+        editor = TextEditor(self)
+        self = self.__class__(editor.edit_gui())
+        # print(f"Updated LaTeX: {self}")
+
+
+class FirstObject:
+    def __new__(self, value):
+        if isinstance(value, int):
+            return SmartInt(value)
+        if isinstance(value, float):
+            return SmartFloat(value)
+        if isinstance(value, str):
+            return SmartStr(value)
+        return value

edsl/results/table_data_class.py

@@ -0,0 +1,12 @@
+from dataclasses import dataclass
+from typing import Any, List
+
+
+@dataclass
+class TableData:
+    """Simple data class to hold table information"""
+
+    headers: List[str]
+    data: List[List[Any]]
+    parameters: dict = None
+    raw_data_set: Any = None

edsl/results/table_display.css

@@ -1,78 +1,78 @@
-.table-container {
-    height: var(--containerHeight) !important;
-    width: 100%;
-    overflow: auto;  /* This enables both horizontal and vertical scrolling */
-    border: 1px solid #d4d4d4;
-    background: transparent;
-    position: relative;  /* Create stacking context for sticky header */
-}
-
-.scroll-table {
-    /* Remove width: 100% to prevent table from being constrained */
-    /* min-width: 100% ensures table takes at least full container width */
-    min-width: 100%;
-    border-collapse: separate;
-    border-spacing: 4px;
-    background: transparent;
-    table-layout: auto;  /* Allow table to size based on content */
-}
-
-.scroll-table th {
-    background: transparent;  /* Semi-transparent background to ensure text readability */
-    position: sticky;
-    top: 0;
-    z-index: 1;
-    text-align: left !important;
-    padding: 8px;
-    font-weight: bold;
-    white-space: nowrap;  /* Prevent header text from wrapping */
-    min-width: 100px;    /* Ensure minimum column width */
-    backdrop-filter: blur(8px);  /* Optional: adds extra clarity */
-    color: var(--headerColor);
-}
-
-.scroll-table td {
-    padding: 8px;
-    text-align: left !important;
-    white-space: pre-wrap;
-    word-wrap: break-word;
-    vertical-align: top;
-    color: inherit;
-    border-bottom: none;
-    background: transparent;
-    min-width: 100px;    /* Match header minimum width */
-}
-
-.scroll-table tbody tr:hover {
-    background: transparent;
-}
-
-/* Additional rule to ensure header background is truly transparent */
-.scroll-table thead tr {
-    background: transparent !important;
-}
-
-/* Add shadow to indicate scrollable content */
-.table-container::after {
-    content: '';
-    position: absolute;
-    top: 0;
-    right: 0;
-    bottom: 0;
-    width: 5px;
-    background: linear-gradient(to right, transparent, rgba(242, 6, 6, 0.1));
-    pointer-events: none;
-    opacity: 0;
-    transition: opacity 0.3s;
-}
-
-.table-container:hover::after {
-    opacity: 1;
-}
-
-/* Handle Jupyter notebook specific styling */
-.jp-OutputArea-output .table-container {
-    max-width: 100%;
-    margin: 0;
-    overflow-x: auto;
+.table-container {
+    height: var(--containerHeight) !important;
+    width: 100%;
+    overflow: auto;  /* This enables both horizontal and vertical scrolling */
+    border: 1px solid #d4d4d4;
+    background: transparent;
+    position: relative;  /* Create stacking context for sticky header */
+}
+
+.scroll-table {
+    /* Remove width: 100% to prevent table from being constrained */
+    /* min-width: 100% ensures table takes at least full container width */
+    min-width: 100%;
+    border-collapse: separate;
+    border-spacing: 4px;
+    background: transparent;
+    table-layout: auto;  /* Allow table to size based on content */
+}
+
+.scroll-table th {
+    background: transparent;  /* Semi-transparent background to ensure text readability */
+    position: sticky;
+    top: 0;
+    z-index: 1;
+    text-align: left !important;
+    padding: 8px;
+    font-weight: bold;
+    white-space: nowrap;  /* Prevent header text from wrapping */
+    min-width: 100px;    /* Ensure minimum column width */
+    backdrop-filter: blur(8px);  /* Optional: adds extra clarity */
+    color: var(--headerColor);
+}
+
+.scroll-table td {
+    padding: 8px;
+    text-align: left !important;
+    white-space: pre-wrap;
+    word-wrap: break-word;
+    vertical-align: top;
+    color: inherit;
+    border-bottom: none;
+    background: transparent;
+    min-width: 100px;    /* Match header minimum width */
+}
+
+.scroll-table tbody tr:hover {
+    background: transparent;
+}
+
+/* Additional rule to ensure header background is truly transparent */
+.scroll-table thead tr {
+    background: transparent !important;
+}
+
+/* Add shadow to indicate scrollable content */
+.table-container::after {
+    content: '';
+    position: absolute;
+    top: 0;
+    right: 0;
+    bottom: 0;
+    width: 5px;
+    background: linear-gradient(to right, transparent, rgba(242, 6, 6, 0.1));
+    pointer-events: none;
+    opacity: 0;
+    transition: opacity 0.3s;
+}
+
+.table-container:hover::after {
+    opacity: 1;
+}
+
+/* Handle Jupyter notebook specific styling */
+.jp-OutputArea-output .table-container {
+    max-width: 100%;
+    margin: 0;
+    overflow-x: auto;
 }

edsl/results/table_renderers.py

@@ -0,0 +1,118 @@
+from abc import ABC, abstractmethod
+from edsl.results.table_data_class import TableData
+
+
+class DataTablesRendererABC(ABC):
+    def __init__(self, table_data: TableData):
+        self.table_data = table_data
+
+    @abstractmethod
+    def render_html(self) -> str:
+        pass
+
+
+class DataTablesRenderer(DataTablesRendererABC):
+    """Interactive DataTables renderer implementation"""
+
+    def render_html(self) -> str:
+        html_template = """
+        <!DOCTYPE html>
+        <html>
+        <head>
+            <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet">
+            <link href="https://cdnjs.cloudflare.com/ajax/libs/datatables.net-bs5/1.13.6/dataTables.bootstrap5.min.css" rel="stylesheet">
+            <link href="https://cdnjs.cloudflare.com/ajax/libs/datatables.net-buttons-bs5/2.4.1/buttons.bootstrap5.min.css" rel="stylesheet">
+            <link href="https://cdnjs.cloudflare.com/ajax/libs/datatables.net-responsive-bs5/2.4.1/responsive.bootstrap5.min.css" rel="stylesheet">
+            <style>
+                {css}
+            </style>
+        </head>
+        <body>
+            <div class="container">
+                <table id="interactive-table" class="table table-striped" style="width:100%">
+                    <thead>
+                        <tr>{header_cells}</tr>
+                    </thead>
+                    <tbody>{body_rows}</tbody>
+                </table>
+            </div>
+            <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.0/jquery.min.js"></script>
+            <script src="https://cdnjs.cloudflare.com/ajax/libs/datatables.net/1.13.6/jquery.dataTables.min.js"></script>
+            <script src="https://cdnjs.cloudflare.com/ajax/libs/datatables.net-bs5/1.13.6/dataTables.bootstrap5.min.js"></script>
+            <script>
+                $(document).ready(function() {{
+                    $('#interactive-table').DataTable({{
+                        pageLength: 10,
+                        lengthMenu: [[5, 10, 25, -1], [5, 10, 25, "All"]],
+                        scrollX: true,
+                        responsive: true,
+                        dom: 'Bfrtip',
+                        buttons: [
+                            {{
+                                extend: 'colvis',
+                                text: 'Show/Hide Columns'
+                            }}
+                        ]
+                    }});
+                }});
+            </script>
+        </body>
+        </html>
+        """
+
+        header_cells = "".join(
+            f"<th>{header}</th>" for header in self.table_data.headers
+        )
+        body_rows = ""
+        for row in self.table_data.data:
+            body_rows += "<tr>"
+            body_rows += "".join(f"<td>{cell}</td>" for cell in row)
+            body_rows += "</tr>"
+
+        parameters = self.table_data.parameters or {}
+        css = self.get_css()
+        if hasattr(self, "css_parameterizer"):
+            css = self.css_parameterizer(css).apply_parameters(parameters)
+
+        return html_template.format(
+            css=css, header_cells=header_cells, body_rows=body_rows
+        )
+
+    @classmethod
+    def get_css(cls) -> str:
+        """Load CSS content from the file next to this module"""
+        css_path = Path(__file__).parent / "table_display.css"
+        return css_path.read_text()
+
+
+class PandasStyleRenderer(DataTablesRendererABC):
+    """Pandas-based styled renderer implementation"""
+
+    def render_html(self) -> str:
+        import pandas as pd
+
+        from contextlib import redirect_stderr
+        import io
+
+        stderr = io.StringIO()
+        with redirect_stderr(stderr):
+            if self.table_data.raw_data_set is not None and hasattr(
+                self.table_data.raw_data_set, "to_pandas"
+            ):
+                df = self.table_data.raw_data_set.to_pandas()
+            else:
+                df = pd.DataFrame(self.table_data.data, columns=self.table_data.headers)
+
+            styled_df = df.style.set_properties(
+                **{"text-align": "left"}
+            ).background_gradient()
+
+            return f"""
+            <div style="max-height: 500px; overflow-y: auto;">
+                {styled_df.to_html()}
+            </div>
+            """
+
+    @classmethod
+    def get_css(cls) -> str:
+        return ""  # Pandas styling handles its own CSS