edsl 0.1.29__py3-none-any.whl → 0.1.29.dev2__py3-none-any.whl

edsl/scenarios/ScenarioList.py

@@ -5,22 +5,25 @@ import csv
 import random
 from collections import UserList, Counter
 from collections.abc import Iterable
+
 from typing import Any, Optional, Union, List
 
+from rich.table import Table
 from simpleeval import EvalWithCompoundTypes
 
+from edsl.scenarios.Scenario import Scenario
 from edsl.Base import Base
 from edsl.utilities.decorators import add_edsl_version, remove_edsl_version
-from edsl.scenarios.Scenario import Scenario
 from edsl.scenarios.ScenarioListPdfMixin import ScenarioListPdfMixin
-from edsl.scenarios.ScenarioListExportMixin import ScenarioListExportMixin
 
+from edsl.utilities.interface import print_scenario_list
 
-class ScenarioListMixin(ScenarioListPdfMixin, ScenarioListExportMixin):
-    pass
+from edsl.utilities import is_valid_variable_name
 
+from edsl.results.ResultsExportMixin import ResultsExportMixin
 
-class ScenarioList(Base, UserList, ScenarioListMixin):
+
+class ScenarioList(Base, UserList, ScenarioListPdfMixin, ResultsExportMixin):
     """Class for creating a list of scenarios to be used in a survey."""
 
     def __init__(self, data: Optional[list] = None):
@@ -116,7 +119,7 @@ class ScenarioList(Base, UserList, ScenarioListMixin):
 
         return ScenarioList(random.sample(self.data, n))
 
-    def expand(self, expand_field: str, number_field=False) -> ScenarioList:
+    def expand(self, expand_field: str, number_field = False) -> ScenarioList:
         """Expand the ScenarioList by a field.
 
         Example:
@@ -134,7 +137,7 @@ class ScenarioList(Base, UserList, ScenarioListMixin):
                 new_scenario = scenario.copy()
                 new_scenario[expand_field] = value
                 if number_field:
-                    new_scenario[expand_field + "_number"] = index + 1
+                    new_scenario[expand_field + '_number'] = index + 1
                 new_scenarios.append(new_scenario)
         return ScenarioList(new_scenarios)
 
@@ -154,8 +157,6 @@ class ScenarioList(Base, UserList, ScenarioListMixin):
             )
         raw_var_name, expression = new_var_string.split("=", 1)
         var_name = raw_var_name.strip()
-        from edsl.utilities.utilities import is_valid_variable_name
-
         if not is_valid_variable_name(var_name):
             raise Exception(f"{var_name} is not a valid variable name.")
 
@@ -191,7 +192,7 @@ class ScenarioList(Base, UserList, ScenarioListMixin):
 
         def get_sort_key(scenario: Any) -> tuple:
             return tuple(scenario[field] for field in fields)
-
+        
         return ScenarioList(sorted(self, key=get_sort_key, reverse=reverse))
 
     def filter(self, expression: str) -> ScenarioList:
@@ -342,20 +343,6 @@ class ScenarioList(Base, UserList, ScenarioListMixin):
         """
         return cls([Scenario(row) for row in df.to_dict(orient="records")])
 
-    def to_key_value(self, field, value=None) -> Union[dict, set]:
-        """Return the set of values in the field.
-
-        Example:
-
-        >>> s = ScenarioList([Scenario({'name': 'Alice'}), Scenario({'name': 'Bob'})])
-        >>> s.to_key_value('name') == {'Alice', 'Bob'}
-        True
-        """
-        if value is None:
-            return {scenario[field] for scenario in self}
-        else:
-            return {scenario[field]: scenario[value] for scenario in self}
-
     @classmethod
     def from_csv(cls, filename: str) -> ScenarioList:
         """Create a ScenarioList from a CSV file.
@@ -375,8 +362,6 @@ class ScenarioList(Base, UserList, ScenarioListMixin):
         >>> scenario_list[1]['age']
         '25'
         """
-        from edsl.scenarios.Scenario import Scenario
-
         observations = []
         with open(filename, "r") as f:
             reader = csv.reader(f)
@@ -414,16 +399,12 @@ class ScenarioList(Base, UserList, ScenarioListMixin):
         ScenarioList([Scenario({'name': 'Alice'}), Scenario({'name': 'Bob'})])
 
         """
-        from edsl.scenarios.Scenario import Scenario
-
         return cls([Scenario(s) for s in scenario_dicts_list])
 
     @classmethod
     @remove_edsl_version
     def from_dict(cls, data) -> ScenarioList:
         """Create a `ScenarioList` from a dictionary."""
-        from edsl.scenarios.Scenario import Scenario
-
         return cls([Scenario.from_dict(s) for s in data["scenarios"]])
 
     def code(self) -> str:
@@ -448,8 +429,6 @@ class ScenarioList(Base, UserList, ScenarioListMixin):
 
     def rich_print(self) -> None:
         """Display an object as a table."""
-        from rich.table import Table
-
         table = Table(title="ScenarioList")
         table.add_column("Index", style="bold")
         table.add_column("Scenario")
@@ -464,8 +443,6 @@ class ScenarioList(Base, UserList, ScenarioListMixin):
         pretty_labels: Optional[dict] = None,
         filename: str = None,
     ):
-        from edsl.utilities.interface import print_scenario_list
-
         print_scenario_list(self[:max_rows])
 
     def __getitem__(self, key: Union[int, slice]) -> Any:

edsl/scenarios/ScenarioListPdfMixin.py

@@ -2,7 +2,7 @@ import fitz  # PyMuPDF
 import os
 import subprocess
 
-# from edsl import Scenario
+from edsl import Scenario
 
 
 class ScenarioListPdfMixin:
@@ -22,7 +22,6 @@ class ScenarioListPdfMixin:
         """
         import tempfile
         from pdf2image import convert_from_path
-        from edsl.scenarios import Scenario
 
         with tempfile.TemporaryDirectory() as output_folder:
             # Convert PDF to images

edsl/scenarios/__init__.py

@@ -1,2 +1 @@
 from edsl.scenarios.Scenario import Scenario
-from edsl.scenarios.ScenarioList import ScenarioList

edsl/study/Study.py

@@ -472,12 +472,18 @@ class Study:
         coop.create(self, description=self.description)
 
     @classmethod
-    def pull(cls, uuid: Optional[Union[str, UUID]] = None, url: Optional[str] = None):
+    def pull(cls, id_or_url: Union[str, UUID], exec_profile=None):
         """Pull the object from coop."""
         from edsl.coop import Coop
 
-        coop = Coop()
-        return coop.get(uuid, url, "study")
+        if id_or_url.startswith("http"):
+            uuid_value = id_or_url.split("/")[-1]
+        else:
+            uuid_value = id_or_url
+
+        c = Coop()
+
+        return c._get_base(cls, uuid_value, exec_profile=exec_profile)
 
     def __repr__(self):
         return f"""Study(name = "{self.name}", description = "{self.description}", objects = {self.objects}, cache = {self.cache}, filename = "{self.filename}", coop = {self.coop}, use_study_cache = {self.use_study_cache}, overwrite_on_change = {self.overwrite_on_change})"""

edsl/surveys/MemoryPlan.py

@@ -3,9 +3,9 @@
 from collections import UserDict, defaultdict
 from typing import Optional
 
-# from edsl.surveys.Memory import Memory
-# from edsl.prompts.Prompt import Prompt
-# from edsl.surveys.DAG import DAG
+from edsl.surveys.Memory import Memory
+from edsl.prompts.Prompt import Prompt
+from edsl.surveys.DAG import DAG
 
 
 class MemoryPlan(UserDict):
@@ -61,8 +61,6 @@ class MemoryPlan(UserDict):
         :param answers: A dictionary of question names to answers.
 
         """
-        from edsl.prompts.Prompt import Prompt
-
         self._check_valid_question_name(focal_question)
 
         if focal_question not in self:
@@ -123,7 +121,6 @@ class MemoryPlan(UserDict):
         self._check_valid_question_name(focal_question)
         self._check_valid_question_name(prior_question)
         self._check_order(focal_question, prior_question)
-        from edsl.surveys.Memory import Memory
 
         if focal_question not in self:
             memory = Memory()
@@ -163,8 +160,6 @@ class MemoryPlan(UserDict):
     @classmethod
     def from_dict(cls, data) -> "MemoryPlan":
         """Deserialize a memory plan from a dictionary."""
-        from edsl.surveys.Memory import Memory
-
         newdata = {}
         for question_name, memory in data["data"].items():
             newdata[question_name] = Memory.from_dict(memory)
@@ -187,15 +182,13 @@ class MemoryPlan(UserDict):
         return new_d
 
     @property
-    def dag(self) -> "DAG":
+    def dag(self) -> DAG:
         """Return a directed acyclic graph of the memory plan.
 
         >>> mp = MemoryPlan.example()
         >>> mp.dag
         {1: {0}}
         """
-        from edsl.surveys.DAG import DAG
-
         d = defaultdict(set)
         for focal_question, memory in self.items():
             for prior_question in memory:

edsl/surveys/Survey.py

@@ -5,6 +5,9 @@ import re
 
 from typing import Any, Generator, Optional, Union, List, Literal, Callable
 
+from rich import print
+from rich.table import Table
+
 from edsl.exceptions import SurveyCreationError, SurveyHasNoRulesError
 from edsl.questions.QuestionBase import QuestionBase
 from edsl.surveys.base import RulePriority, EndOfSurvey
@@ -15,8 +18,8 @@ from edsl.Base import Base
 from edsl.surveys.SurveyExportMixin import SurveyExportMixin
 from edsl.surveys.descriptors import QuestionsDescriptor
 from edsl.surveys.MemoryPlan import MemoryPlan
-
 from edsl.surveys.DAG import DAG
+from edsl.utilities import is_notebook
 from edsl.utilities.decorators import add_edsl_version, remove_edsl_version
 from edsl.surveys.SurveyFlowVisualizationMixin import SurveyFlowVisualizationMixin
 
@@ -93,10 +96,6 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
         index = self.question_name_to_index[question_name]
         return self._questions[index]
 
-    def question_names_to_questions(self) -> dict:
-        """Return a dictionary mapping question names to question attributes."""
-        return {q.question_name: q for q in self.questions}
-
     def get_question(self, question_name: str) -> QuestionBase:
         """Return the question object given the question name."""
         # import warnings
@@ -113,10 +112,6 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
     def parameters(self):
         return set.union(*[q.parameters for q in self.questions])
 
-    @property
-    def parameters_by_question(self):
-        return {q.question_name: q.parameters for q in self.questions}
-
     @property
     def question_names(self) -> list[str]:
         """Return a list of question names in the survey.
@@ -560,12 +555,6 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
         job = Jobs(survey=self)
         return job.by(*args)
 
-    def to_jobs(self):
-        """Convert the survey to a Jobs object."""
-        from edsl.jobs.Jobs import Jobs
-
-        return Jobs(survey=self)
-
     def run(self, *args, **kwargs) -> "Results":
         """Turn the survey into a Job and runs it.
 
@@ -743,22 +732,6 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
         except IndexError:
             raise
 
-    @property
-    def piping_dag(self) -> DAG:
-        d = {}
-        for question_name, depenencies in self.parameters_by_question.items():
-            if depenencies:
-                question_index = self.question_name_to_index[question_name]
-                for dependency in depenencies:
-                    if dependency not in self.question_name_to_index:
-                        pass
-                    else:
-                        dependency_index = self.question_name_to_index[dependency]
-                        if question_index not in d:
-                            d[question_index] = set()
-                        d[question_index].add(dependency_index)
-        return d
-
     def dag(self, textify: bool = False) -> DAG:
         """Return the DAG of the survey, which reflects both skip-logic and memory.
 
@@ -772,12 +745,10 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
         """
         memory_dag = self.memory_plan.dag
         rule_dag = self.rule_collection.dag
-        piping_dag = self.piping_dag
         if textify:
             memory_dag = DAG(self.textify(memory_dag))
             rule_dag = DAG(self.textify(rule_dag))
-            piping_dag = DAG(self.textify(piping_dag))
-        return memory_dag + rule_dag + piping_dag
+        return memory_dag + rule_dag
 
     ###################
     # DUNDER METHODS
@@ -960,8 +931,6 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
         │ └───────────────┴─────────────────┴───────────────┴──────────────────────────────────────────────┘ │
         └────────────────────────────────────────────────────────────────────────────────────────────────────┘
         """
-        from rich.table import Table
-
         table = Table(show_header=True, header_style="bold magenta")
         table.add_column("Questions", style="dim")
 
@@ -1025,7 +994,7 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
         return res
 
     @classmethod
-    def example(cls, params=False) -> Survey:
+    def example(cls) -> Survey:
         """Return an example survey.
 
         >>> s = Survey.example()
@@ -1049,20 +1018,12 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
             question_options=["**lack*** of killer bees in cafeteria", "other"],
             question_name="q2",
         )
-        if params:
-            q3 = QuestionMultipleChoice(
-                question_text="To the question '{{ q0.question_text}}', you said '{{ q0.answer }}'. Do you still feel this way?",
-                question_options=["yes", "no"],
-                question_name="q3",
-            )
-            s = cls(questions=[q0, q1, q2, q3])
-            return s
         s = cls(questions=[q0, q1, q2])
         s = s.add_rule(q0, "q0 == 'yes'", q2)
         return s
 
     def get_job(self, model=None, agent=None, **kwargs):
-        if model is None:
+        if not model:
             from edsl import Model
 
             model = Model()

edsl/surveys/SurveyExportMixin.py

@@ -1,6 +1,8 @@
 """A mixin class for exporting surveys to different formats."""
 
+from docx import Document
 from typing import Union, Optional
+import black
 
 
 class SurveyExportMixin:
@@ -27,8 +29,6 @@ class SurveyExportMixin:
 
     def docx(self, filename=None) -> Union["Document", None]:
         """Generate a docx document for the survey."""
-        from docx import Document
-
         doc = Document()
         doc.add_heading("EDSL Survey")
         doc.add_paragraph(f"\n")
@@ -83,8 +83,6 @@ class SurveyExportMixin:
         survey = Survey(questions=[q0, q1, q2])
         ...
         """
-        import black
-
         header_lines = ["from edsl.surveys.Survey import Survey"]
         header_lines.append("from edsl import Question")
         lines = ["\n".join(header_lines)]

edsl/surveys/SurveyFlowVisualizationMixin.py

@@ -1,7 +1,10 @@
 """A mixin for visualizing the flow of a survey."""
 
-from edsl.surveys.base import RulePriority, EndOfSurvey
+import pydot
 import tempfile
+from IPython.display import Image
+from edsl.utilities import is_notebook
+from edsl.surveys.base import RulePriority, EndOfSurvey
 
 
 class SurveyFlowVisualizationMixin:
@@ -10,8 +13,6 @@ class SurveyFlowVisualizationMixin:
     def show_flow(self, filename: str = None):
         """Create an image showing the flow of users through the survey."""
         # Create a graph object
-        import pydot
-
         graph = pydot.Dot(graph_type="digraph")
 
         # Add nodes for each question
@@ -100,11 +101,8 @@ class SurveyFlowVisualizationMixin:
                         on Ubuntu.
                     """
                 )
-            from edsl.utilities.utilities import is_notebook
 
             if is_notebook():
-                from IPython.display import Image
-
                 display(Image(tmp_file.name))
             else:
                 import os

edsl/tools/plotting.py

@@ -93,10 +93,8 @@ def theme_plot(results, field, context, themes=None, progress_bar=False):
           SELECT json_each.value AS theme 
           FROM self, 
           json_each({ field }_themes)
-          ) 
-    GROUP BY theme
-    HAVING theme <> 'Other'
-    ORDER BY mentions DESC
+          ) GROUP BY theme
+          ORDER BY mentions DESC
              """
     themes = results.sql(themes_query, to_list=True)
 

edsl/utilities/__init__.py

@@ -1,22 +1,22 @@
-# from edsl.utilities.interface import (
-#     print_dict_as_html_table,
-#     print_dict_with_rich,
-#     print_list_of_dicts_as_html_table,
-#     print_table_with_rich,
-#     print_public_methods_with_doc,
-#     print_list_of_dicts_as_markdown_table,
-# )
+from edsl.utilities.interface import (
+    print_dict_as_html_table,
+    print_dict_with_rich,
+    print_list_of_dicts_as_html_table,
+    print_table_with_rich,
+    print_public_methods_with_doc,
+    print_list_of_dicts_as_markdown_table,
+)
 
-# from edsl.utilities.utilities import (
-#     create_valid_var_name,
-#     dict_to_html,
-#     hash_value,
-#     HTMLSnippet,
-#     is_notebook,
-#     is_gzipped,
-#     is_valid_variable_name,
-#     random_string,
-#     repair_json,
-#     shorten_string,
-#     time_all_functions,
-# )
+from edsl.utilities.utilities import (
+    create_valid_var_name,
+    dict_to_html,
+    hash_value,
+    HTMLSnippet,
+    is_notebook,
+    is_gzipped,
+    is_valid_variable_name,
+    random_string,
+    repair_json,
+    shorten_string,
+    time_all_functions,
+)

edsl/utilities/interface.py

@@ -1,45 +1,12 @@
 """A module for displaying data in various formats."""
 
 from html import escape
+from IPython.display import HTML
+from IPython.display import display as ipython_diplay
 
-
-def create_image(console, image_filename):
-    """Create an image from the console output."""
-    font_size = 15
-    from PIL import Image, ImageDraw, ImageFont
-
-    text = console.export_text()  # Get the console output as text.
-
-    # Create an image from the text
-    font_size = 15
-    font = ImageFont.load_default()  # Use the default font to avoid file path issues.
-    # text_width, text_height = ImageDraw.Draw(
-    #    Image.new("RGB", (100, 100))
-    # ).multiline_textsize(text, font=font)
-    text_width, text_height = get_multiline_textsize(text, font)
-    image = Image.new(
-        "RGB", (text_width + 20, text_height + 20), color=(255, 255, 255)
-    )  # Add some padding
-    d = ImageDraw.Draw(image)
-
-    # Draw text to image
-    d.multiline_text((10, 10), text, font=font, fill=(0, 0, 0))
-    # Save the image
-    image.save(image_filename)
-
-
-def display_table(console, table, filename):
-    # from rich.console import Console
-    # from rich.table import Table
-    """Display the table using the rich library and save it to a file if a filename is provided."""
-    if filename is not None:
-        with open(filename, "w") as f:
-            with console.capture() as capture:
-                console.print(table)
-            f.write(capture.get())
-        create_image(console, filename + ".png")
-    else:
-        console.print(table)
+# from PIL import Image, ImageDraw, ImageFont
+from rich.console import Console
+from rich.table import Table
 
 
 def gen_html_sandwich(html_inner, interactive=False):
@@ -166,10 +133,43 @@ def get_multiline_textsize(text, font):
     return max_width, total_height
 
 
-def print_results_long(results, max_rows=None):
-    from rich.console import Console
-    from rich.table import Table
+# def create_image(console, image_filename):
+#     """Create an image from the console output."""
+#     font_size = 15
+
+#     text = console.export_text()  # Get the console output as text.
+
+#     # Create an image from the text
+#     font_size = 15
+#     font = ImageFont.load_default()  # Use the default font to avoid file path issues.
+#     # text_width, text_height = ImageDraw.Draw(
+#     #    Image.new("RGB", (100, 100))
+#     # ).multiline_textsize(text, font=font)
+#     text_width, text_height = get_multiline_textsize(text, font)
+#     image = Image.new(
+#         "RGB", (text_width + 20, text_height + 20), color=(255, 255, 255)
+#     )  # Add some padding
+#     d = ImageDraw.Draw(image)
+
+#     # Draw text to image
+#     d.multiline_text((10, 10), text, font=font, fill=(0, 0, 0))
+#     # Save the image
+#     image.save(image_filename)
+
 
+def display(console, table, filename):
+    """Display the table using the rich library and save it to a file if a filename is provided."""
+    if filename is not None:
+        with open(filename, "w") as f:
+            with console.capture() as capture:
+                console.print(table)
+            f.write(capture.get())
+        create_image(console, filename + ".png")
+    else:
+        console.print(table)
+
+
+def print_results_long(results, max_rows=None):
     console = Console(record=True)
     table = Table(show_header=True, header_style="bold magenta")
     table.add_column("Result index", style="dim")
@@ -199,9 +199,6 @@ def print_dict_with_rich(d, key_name="Key", value_name="Value", filename=None):
     │ c   │ 3     │
     └─────┴───────┘
     """
-    from rich.console import Console
-    from rich.table import Table
-
     console = Console(record=True)
     table = Table(show_header=True, header_style="bold magenta")
     table.add_column(key_name, style="dim")
@@ -209,7 +206,7 @@ def print_dict_with_rich(d, key_name="Key", value_name="Value", filename=None):
     for key, value in d.items():
         table.add_row(key, str(value))
     console.print(table)
-    # display_table(console, table, filename)
+    # display(console, table, filename)
 
 
 def print_dict_as_html_table(
@@ -254,9 +251,6 @@ def print_dict_as_html_table(
 
 
 def print_scenario_list(data):
-    from rich.console import Console
-    from rich.table import Table
-
     new_data = []
     for obs in data:
         try:
@@ -306,9 +300,6 @@ def print_dataset_with_rich(data, filename=None, split_at_dot=True):
     │ 3 │ 6 │
     └───┴───┘
     """
-    from rich.console import Console
-    from rich.table import Table
-
     console = Console(record=True)
 
     # Create a table object
@@ -330,7 +321,7 @@ def print_dataset_with_rich(data, filename=None, split_at_dot=True):
         table.add_row(*row)
 
     console.print(table)
-    # display_table(console, table, filename)
+    # display(console, table, filename)
 
 
 def create_latex_table_from_data(data, filename=None, split_at_dot=True):
@@ -504,9 +495,6 @@ def print_list_of_dicts_as_markdown_table(data, filename=None):
 
 def print_public_methods_with_doc(obj):
     """Print the public methods of an object along with their docstrings."""
-    from rich.console import Console
-    from rich.table import Table
-
     console = Console()
     public_methods_with_docstrings = [
         (method, getattr(obj, method).__doc__)
@@ -537,10 +525,6 @@ def print_tally_with_rich(data, filename=None):
     └───────┴───────┘
     """
     # Initialize a console object
-    from rich.console import Console
-    from rich.table import Table
-    from IPython.display import display
-
     console = Console(record=True)
 
     # Create a new table
@@ -554,9 +538,7 @@ def print_tally_with_rich(data, filename=None):
     for key, value in data.items():
         table.add_row(key, str(value))
 
-    from IPython.display import display
-
-    display_table(console, table, filename)
+    display(console, table, filename)
 
 
 def print_table_with_rich(data, filename=None):
@@ -579,9 +561,6 @@ def print_table_with_rich(data, filename=None):
     │ 2 │ 9 │ 8 │
     └───┴───┴───┘
     """
-    from rich.console import Console
-    from rich.table import Table
-
     # Initialize a console object - expects a list of dictionaries
     console = Console(record=True)
 
@@ -601,7 +580,7 @@ def print_table_with_rich(data, filename=None):
     for row in data:
         table.add_row(*[str(value) for value in row.values()])
 
-    display_table(console, table, filename)
+    display(console, table, filename)
 
 
 if __name__ == "__main__":