edsl 0.1.39__py3-none-any.whl → 0.1.39.dev1__py3-none-any.whl

edsl/surveys/SurveyCSS.py

@@ -1,5 +1,5 @@
 from typing import Optional
-from edsl.utilities.remove_edsl_version import remove_edsl_version
+from edsl.utilities.decorators import add_edsl_version, remove_edsl_version
 
 
 class CSSRuleMeta(type):
@@ -64,21 +64,14 @@ class CSSRule(metaclass=CSSRuleMeta):
     def __repr__(self) -> str:
         return f"CSSRule(select = {self.selector}, properties = {self.properties})"
 
-    def to_dict(self, add_esl_version: bool = True) -> dict:
+    @add_edsl_version
+    def to_dict(self) -> dict:
         """
         >>> rule = CSSRule("survey_container", {"width": "80%", "margin": "0 auto"})
         >>> rule.to_dict()
-        {'selector': 'survey_container', 'properties': {'width': '80%', 'margin': '0 auto'}, 'edsl_version': '...', 'edsl_class_name': '...'}
+        {'selector': 'survey_container', 'properties': {'width': '80%', 'margin': '0 auto'}, 'edsl_version': '...', 'edsl_class_name': 'CSSRule'}
         """
-        d = {"selector": self.selector, "properties": self.properties}
-
-        if add_esl_version:
-            from edsl import __version__
-
-            d["edsl_version"] = __version__
-            d["edsl_class_name"] = self.__class__.__name__
-
-        return d
+        return {"selector": self.selector, "properties": self.properties}
 
     @classmethod
     @remove_edsl_version
@@ -225,19 +218,14 @@ class SurveyCSS:
             css_lines.append(rule.generate_rule())
         return "\n".join(css_lines)
 
-    def to_dict(self, add_edsl_version: bool = True) -> dict:
+    @add_edsl_version
+    def to_dict(self) -> dict:
         """
         >>> css = SurveyCSS(rules = []).update_style("survey_container", "width", "100%")
         >>> css.to_dict()
         {'rules': [{'selector': 'survey_container', 'properties': {'width': '100%'}, 'edsl_version': '...', 'edsl_class_name': 'CSSRule'}], 'edsl_version': '...', 'edsl_class_name': 'SurveyCSS'}
         """
-        d = {"rules": [rule.to_dict() for rule in self.rules.values()]}
-        if add_edsl_version:
-            from edsl import __version__
-
-            d["edsl_version"] = __version__
-            d["edsl_class_name"] = self.__class__.__name__
-        return d
+        return {"rules": [rule.to_dict() for rule in self.rules.values()]}
 
     def __repr__(self) -> str:
         return f"SurveyCSS(rules = {[rule for rule in self.rules.values()]})"

edsl/surveys/{SurveyFlowVisualization.py → SurveyFlowVisualizationMixin.py}

@@ -1,16 +1,14 @@
 """A mixin for visualizing the flow of a survey with parameter nodes."""
 
-from typing import Optional, TYPE_CHECKING
+from typing import Optional
 from edsl.surveys.base import RulePriority, EndOfSurvey
 import tempfile
+import os
 
 
-class SurveyFlowVisualization:
+class SurveyFlowVisualizationMixin:
     """A mixin for visualizing the flow of a survey with parameter visualization."""
 
-    def __init__(self, survey: "Survey"):
-        self.survey = survey
-
     def show_flow(self, filename: Optional[str] = None):
         """Create an image showing the flow of users through the survey and question parameters."""
         # Create a graph object
@@ -24,7 +22,7 @@ class SurveyFlowVisualization:
         answer_refs = set()  # Track answer references between questions
 
         # First pass: collect parameters and their question associations
-        for index, question in enumerate(self.survey.questions):
+        for index, question in enumerate(self.questions):
             # Add the main question node
             question_node = pydot.Node(
                 f"Q{index}", label=f"{question.question_name}", shape="ellipse"
@@ -71,7 +69,7 @@ class SurveyFlowVisualization:
             # Find the source question index by name
             source_q_index = next(
                 i
-                for i, q in enumerate(self.survey.questions)
+                for i, q in enumerate(self.questions)
                 if q.question_name == source_q_name
             )
             ref_edge = pydot.Edge(
@@ -89,7 +87,7 @@ class SurveyFlowVisualization:
         )
 
         # Add edges for normal flow through the survey
-        num_questions = len(self.survey.questions)
+        num_questions = len(self.questions)
         for index in range(num_questions - 1):
             graph.add_edge(pydot.Edge(f"Q{index}", f"Q{index+1}"))
 
@@ -97,7 +95,7 @@ class SurveyFlowVisualization:
 
         relevant_rules = [
             rule
-            for rule in self.survey.rule_collection
+            for rule in self.rule_collection
             if rule.priority > RulePriority.DEFAULT.value
         ]
 
@@ -161,10 +159,10 @@ class SurveyFlowVisualization:
                         on Ubuntu.
                     """
                 )
-            from edsl.utilities.is_notebook import is_notebook
+            from edsl.utilities.utilities import is_notebook
 
             if is_notebook():
-                from IPython.display import Image, display
+                from IPython.display import Image
 
                 display(Image(tmp_file.name))
             else:

edsl/surveys/__init__.py

@@ -1,5 +1,3 @@
 from edsl.surveys.Survey import Survey
-from edsl.surveys.instructions.Instruction import Instruction
-
-# from edsl.surveys.Rule import Rule
-# from edsl.surveys.RuleCollection import RuleCollection
+from edsl.surveys.Rule import Rule
+from edsl.surveys.RuleCollection import RuleCollection

edsl/surveys/descriptors.py

@@ -1,10 +1,8 @@
 """This module contains the descriptors for the classes in the edsl package."""
 
 from abc import ABC, abstractmethod
-from typing import Any, TYPE_CHECKING
-
-if TYPE_CHECKING:
-    from edsl.questions.QuestionBase import QuestionBase
+from typing import Any
+from edsl.questions.QuestionBase import QuestionBase
 
 
 class BaseDescriptor(ABC):
@@ -38,8 +36,6 @@ class QuestionsDescriptor(BaseDescriptor):
 
     def validate(self, value: Any, instance) -> None:
         """Validate the value. If it is invalid, raise an exception. If it is valid, do nothing."""
-        from edsl.questions.QuestionBase import QuestionBase
-
         if not isinstance(value, list):
             raise TypeError("Questions must be a list.")
         if not all(isinstance(question, QuestionBase) for question in value):

edsl/surveys/instructions/ChangeInstruction.py

@@ -1,5 +1,6 @@
 from typing import List, Optional
-from edsl.utilities.remove_edsl_version import remove_edsl_version
+
+from edsl.utilities.decorators import add_edsl_version, remove_edsl_version
 
 
 class ChangeInstruction:

edsl/surveys/instructions/Instruction.py

@@ -1,9 +1,10 @@
 from typing import Union, Optional, List, Generator, Dict
-from edsl.utilities.remove_edsl_version import remove_edsl_version
-from edsl.Base import RepresentationMixin
+from edsl.questions import QuestionBase
 
+from edsl.utilities.decorators import add_edsl_version, remove_edsl_version
 
-class Instruction(RepresentationMixin):
+
+class Instruction:
     def __init__(
         self, name, text, preamble="You were given the following instructions:"
     ):
@@ -17,6 +18,14 @@ class Instruction(RepresentationMixin):
     def __repr__(self):
         return """Instruction(name="{}", text="{}")""".format(self.name, self.text)
 
+    def _repr_html_(self):
+        d = self.to_dict(add_edsl_version=False)
+        data = [[k, v] for k, v in d.items()]
+        from tabulate import tabulate
+
+        table = str(tabulate(data, headers=["keys", "values"], tablefmt="html"))
+        return f"<pre>{table}</pre>"
+
     @classmethod
     def example(cls) -> "Instruction":
         return cls(name="example", text="This is an example instruction.")
@@ -36,7 +45,7 @@ class Instruction(RepresentationMixin):
         return d
 
     def add_question(self, question) -> "Survey":
-        from edsl.surveys.Survey import Survey
+        from edsl import Survey
 
         return Survey([self, question])
 

edsl/surveys/instructions/InstructionCollection.py

@@ -1,18 +1,17 @@
-from typing import TYPE_CHECKING, Dict, List, Generator, Union
-from collections import UserDict
-
 from edsl.surveys.instructions.Instruction import Instruction
 from edsl.surveys.instructions.ChangeInstruction import ChangeInstruction
+from edsl.questions import QuestionBase
+from typing import Union, Optional, List, Generator, Dict
+
 
-if TYPE_CHECKING:
-    from edsl.questions.QuestionBase import QuestionBase
+from collections import UserDict
 
 
 class InstructionCollection(UserDict):
     def __init__(
         self,
         instruction_names_to_instruction: Dict[str, Instruction],
-        questions: List["QuestionBase"],
+        questions: List[QuestionBase],
     ):
         self.instruction_names_to_instruction = instruction_names_to_instruction
         self.questions = questions
@@ -25,8 +24,6 @@ class InstructionCollection(UserDict):
 
     def __getitem__(self, key):
         # in case the person uses question instead of the name
-        from edsl.questions.QuestionBase import QuestionBase
-
         if isinstance(key, QuestionBase):
             key = key.name
         return self.data[key]
@@ -57,11 +54,9 @@ class InstructionCollection(UserDict):
         return instructions, changes
 
     def relevant_instructions(
-        self, question: Union[str, "QuestionBase"]
+        self, question: Union[str, QuestionBase]
     ) -> Generator[Instruction, None, None]:
         ## Find all the questions that are after a given instruction
-        from edsl.questions.QuestionBase import QuestionBase
-
         if isinstance(question, str):
             question_name = question
         elif isinstance(question, QuestionBase):

edsl/templates/error_reporting/interview_details.html

@@ -31,7 +31,7 @@
  
             <tr>
                 <td>Human-readable question</td>
-                <td>{{ interview.survey._get_question_by_name(question).html(
+                <td>{{ interview.survey.get_question(question).html(
                     scenario = interview.scenario, 
                     agent = interview.agent,
                     answers = exception_message.answers) 

edsl/templates/error_reporting/report.html

@@ -82,7 +82,7 @@
 
                     <h2>Question</h2>
                     <div class="question-detail"> 
-                            {{ interview.survey._get_question_by_name(question).html() }}
+                            {{ interview.survey.get_question(question).html() }}
                     </div>        
 
                     <h2>Scenario</h2>                            

edsl/tools/plotting.py

@@ -11,7 +11,7 @@ def count_query(field):
 
 
 def get_options(results, field):
-    question_type = results.survey._get_question_by_name(field).question_type
+    question_type = results.survey.get_question(field).question_type
     if question_type in ["multiple_choice", "checkbox"]:
         return results.select(f"{field}_question_options").first()
     else:

edsl/utilities/utilities.py

@@ -121,27 +121,27 @@ def clean_json(bad_json_str):
     return s
 
 
-# def data_to_html(data, replace_new_lines=False):
-#     if "edsl_version" in data:
-#         _ = data.pop("edsl_version")
-#     if "edsl_class_name" in data:
-#         _ = data.pop("edsl_class_name")
-
-#     from pygments import highlight
-#     from pygments.lexers import JsonLexer
-#     from pygments.formatters import HtmlFormatter
-#     from IPython.display import HTML
-
-#     json_str = json.dumps(data, indent=4, cls=CustomEncoder)
-#     formatted_json = highlight(
-#         json_str,
-#         JsonLexer(),
-#         HtmlFormatter(style="default", full=False, noclasses=False),
-#     )
-#     if replace_new_lines:
-#         formatted_json = formatted_json.replace("\\n", "<br>")
+def data_to_html(data, replace_new_lines=False):
+    if "edsl_version" in data:
+        _ = data.pop("edsl_version")
+    if "edsl_class_name" in data:
+        _ = data.pop("edsl_class_name")
+
+    from pygments import highlight
+    from pygments.lexers import JsonLexer
+    from pygments.formatters import HtmlFormatter
+    from IPython.display import HTML
+
+    json_str = json.dumps(data, indent=4, cls=CustomEncoder)
+    formatted_json = highlight(
+        json_str,
+        JsonLexer(),
+        HtmlFormatter(style="default", full=False, noclasses=False),
+    )
+    if replace_new_lines:
+        formatted_json = formatted_json.replace("\\n", "<br>")
 
-#     return HTML(formatted_json).data
+    return HTML(formatted_json).data
 
 
 def is_gzipped(file_path):
@@ -194,21 +194,15 @@ def dict_to_html(d):
 
 
 def is_notebook() -> bool:
-    """Check if the code is running in a Jupyter notebook or Google Colab."""
+    """Check if the code is running in a Jupyter notebook."""
     try:
         shell = get_ipython().__class__.__name__
         if shell == "ZMQInteractiveShell":
             return True  # Jupyter notebook or qtconsole
-        elif shell == "Shell":  # Google Colab's shell class
-            import sys
-
-            if "google.colab" in sys.modules:
-                return True  # Running in Google Colab
-            return False
         elif shell == "TerminalInteractiveShell":
             return False  # Terminal running IPython
         else:
-            return False  # Other type
+            return False  # Other type (e.g., IDLE, PyCharm, etc.)
     except NameError:
         return False  # Probably standard Python interpreter
 
@@ -412,13 +406,11 @@ def shorten_string(s, max_length, placeholder="..."):
     return s[:start_remove] + placeholder + s[end_remove:]
 
 
-def write_api_key_to_env(api_key: str) -> str:
+def write_api_key_to_env(api_key: str) -> None:
     """
     Write the user's Expected Parrot key to their .env file.
 
     If a .env file doesn't exist in the current directory, one will be created.
-
-    Returns a string representing the absolute path to the .env file.
     """
     from pathlib import Path
     from dotenv import set_key
@@ -430,7 +422,3 @@ def write_api_key_to_env(api_key: str) -> str:
 
     # Write API key to file
     set_key(env_path, "EXPECTED_PARROT_API_KEY", str(api_key))
-
-    absolute_path_to_env = env_file.absolute().as_posix()
-
-    return absolute_path_to_env

{edsl-0.1.39.dist-info → edsl-0.1.39.dev1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edsl
-Version: 0.1.39
+Version: 0.1.39.dev1
 Summary: Create and analyze LLM-based surveys
 Home-page: https://www.expectedparrot.com/
 License: MIT
@@ -34,15 +34,12 @@ Requires-Dist: numpy (>=1.22,<2.0)
 Requires-Dist: openai (>=1.4.0,<2.0.0)
 Requires-Dist: openpyxl (>=3.1.5,<4.0.0)
 Requires-Dist: pandas (>=2.1.4,<3.0.0)
-Requires-Dist: platformdirs (>=4.3.6,<5.0.0)
 Requires-Dist: pydot (>=2.0.0,<3.0.0)
 Requires-Dist: pygments (>=2.17.2,<3.0.0)
 Requires-Dist: pymupdf (>=1.24.4,<2.0.0)
-Requires-Dist: pypdf2 (>=3.0.1,<4.0.0)
 Requires-Dist: pyreadstat (>=1.2.7,<2.0.0)
 Requires-Dist: python-docx (>=1.1.0,<2.0.0)
 Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
-Requires-Dist: python-pptx (>=1.0.2,<2.0.0)
 Requires-Dist: restrictedpython (>=7.1,<8.0)
 Requires-Dist: rich (>=13.7.0,<14.0.0)
 Requires-Dist: setuptools (<72.0)
@@ -87,23 +84,24 @@ q = QuestionMultipleChoice(
 # Run it with the default language model
 results = q.run()
 
-# Inspect the results 
-results.select("example_question")
+# Inspect the results in a dataset
+results.select("example_question").print()
 ```
 
 Output:
 ```python
-┏━━━━━━━━━━━━━━━━━━━━━━━━━┓
-┃ answer.example_question ┃
-┡━━━━━━━━━━━━━━━━━━━━━━━━━┩
-│ Good                    │
-└─────────────────────────┘
+┏━━━━━━━━━━━━━━━━━━━┓
+┃ answer            ┃
+┃ .example_question ┃
+┡━━━━━━━━━━━━━━━━━━━┩
+│ Good              │
+└───────────────────┘
 ```
 
 ## 💻 Requirements
 * EDSL is compatible with Python 3.9 - 3.12.
 * API keys for large language models that you want to use, stored in a `.env` file.
-See instructions on [storing API keys](https://docs.expectedparrot.com/en/latest/api_keys.html) and [activating remote inference](https://docs.expectedparrot.com/en/latest/remote_inference.html).
+See instructions on [storing API keys](https://docs.expectedparrot.com/en/latest/api_keys.html).
 
 ## 💡 Contributions, feature requests & bugs
 Interested in contributing? Want us to add a new feature? Found a bug for us to squash?