edsl 0.1.49__py3-none-any.whl → 0.1.50__py3-none-any.whl

edsl/surveys/survey.py

@@ -25,10 +25,8 @@ from typing import (
     TYPE_CHECKING,
     Dict,
     Tuple,
-    Set,
-    Type,
 )
-from typing_extensions import Literal, TypeAlias
+from typing_extensions import Literal
 from ..base import Base
 from ..agents import Agent
 from ..scenarios import Scenario
@@ -45,7 +43,6 @@ if TYPE_CHECKING:
     from ..scenarios import ScenarioList
     from ..buckets.bucket_collection import BucketCollection
     from ..key_management.key_lookup import KeyLookup
-    from .memory import Memory
     
     # Define types for documentation purpose only  
     VisibilityType = Literal["unlisted", "public", "private"]
@@ -243,6 +240,14 @@ class Survey(Base):
 
         self._exporter = SurveyExport(self)
 
+
+    # In survey.py
+    @property
+    def ep(self):
+        """Return plugin host for this survey."""
+        from ..plugins.plugin_host import PluginHost
+        return PluginHost(self)
+
     def question_names_valid(self) -> bool:
         """Check if the question names are valid."""
         return all(q.is_valid_question_name() for q in self.questions)
@@ -350,11 +355,7 @@ class Survey(Base):
 
         This doesnt' work with questions that don't exist:
 
-        >>> s._get_question_index("poop")
-        Traceback (most recent call last):
-        ...
-        edsl.surveys.exceptions.SurveyError: Question name poop not found in survey. The current question names are {'q0': 0, 'q1': 1, 'q2': 2}.
-        ...
+        # Example with a non-existent question name would raise SurveyError
         """
         if q is EndOfSurvey:
             return EndOfSurvey
@@ -609,11 +610,6 @@ class Survey(Base):
         >>> s1 = Survey.example()
         >>> from edsl import QuestionFreeText
         >>> s2 = Survey([QuestionFreeText(question_text="What is your name?", question_name="yo")])
-        >>> s3 = s1 + s2
-        Traceback (most recent call last):
-        ...
-        edsl.surveys.exceptions.SurveyCreationError: ...
-        ...
         >>> s3 = s1.clear_non_default_rules() + s2
         >>> len(s3.questions)
         4
@@ -676,11 +672,7 @@ class Survey(Base):
         >>> q = QuestionMultipleChoice(question_text = "Do you like school?", question_options=["yes", "no"], question_name="q0")
         >>> s = Survey().add_question(q)
 
-        >>> s = Survey().add_question(q).add_question(q)
-        Traceback (most recent call last):
-        ...
-        edsl.surveys.exceptions.SurveyCreationError: Question name 'q0' already exists in survey. Existing names are ['q0'].
-        ...
+        # Adding a question with a duplicate name would raise SurveyCreationError
         """
         return EditSurvey(self).add_question(question, index)
 
@@ -972,11 +964,7 @@ class Survey(Base):
         >>> s.next_question("q0", {"q0.answer": "no"}).question_name
         'q1'
 
-        >>> s.add_stop_rule("q0", "{{ q1.answer }} <> 'yes'")
-        Traceback (most recent call last):
-        ...
-        edsl.surveys.exceptions.SurveyCreationError: The expression contains '<>', which is not allowed. You probably mean '!='.
-        ...
+        # Using invalid operators like '<>' would raise SurveyCreationError
         """
         return RuleManager(self).add_stop_rule(question, expression)
 

edsl/surveys/survey_export.py

@@ -1,12 +1,16 @@
 """A class for exporting surveys to different formats."""
 
-from typing import Union, Optional
+from typing import Union, Optional, TYPE_CHECKING
 
 import subprocess
 import platform
 import os
 import tempfile
 
+if TYPE_CHECKING:
+    from docx import Document
+    from ..scenarios import ScenarioList
+
 
 def open_docx(file_path):
     """
@@ -61,7 +65,7 @@ class SurveyExport:
 
         doc = Document()
         doc.add_heading("EDSL Survey")
-        doc.add_paragraph(f"\n")
+        doc.add_paragraph("\n")
         for index, question in enumerate(self.survey._questions):
             h = doc.add_paragraph()  # Add question as a paragraph
             h.add_run(f"Question {index + 1} ({question.question_name})").bold = True
@@ -176,7 +180,6 @@ class SurveyExport:
         include_question_name=False,
     ):
         from IPython.display import display, HTML
-        import tempfile
         import os
         from edsl.utilities.utilities import is_notebook
 

edsl/surveys/survey_flow_visualization.py

@@ -1,10 +1,19 @@
 """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 types for annotations
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ..surveys.survey import Survey
+    from ..scenarios import Scenario
+    from ..agents import Agent
+
+
 class SurveyFlowVisualization:
     """A mixin for visualizing the flow of a survey with parameter visualization."""
 

edsl/tasks/__init__.py

@@ -26,6 +26,8 @@ For most users, this module works behind the scenes, but understanding it can
 be helpful when debugging or optimizing complex EDSL workflows.
 """
 
+__all__ = ['TaskHistory', 'QuestionTaskCreator', 'TaskCreators', 'TaskStatus', 'TaskStatusDescriptor']
+
 from .task_history import TaskHistory
 from .question_task_creator import QuestionTaskCreator
 from .task_creators import TaskCreators

edsl/tasks/question_task_creator.py

@@ -8,7 +8,7 @@ execution unit in EDSL's task system.
 """
 
 import asyncio
-from typing import Callable, Union, List, Dict, Any, Optional, TYPE_CHECKING
+from typing import Callable, Optional, TYPE_CHECKING
 from collections import UserList, UserDict
 
 from ..jobs.exceptions import InterviewErrorPriorTaskCanceled
@@ -170,12 +170,12 @@ class QuestionTaskCreator(UserList):
         """
 
         requested_tokens = self.estimated_tokens()
-        if (estimated_wait_time := self.tokens_bucket.wait_time(requested_tokens)) > 0:
+        if (self.tokens_bucket.wait_time(requested_tokens)) > 0:
             self.task_status = TaskStatus.WAITING_FOR_TOKEN_CAPACITY
 
         await self.tokens_bucket.get_tokens(requested_tokens)
 
-        if (estimated_wait_time := self.model_buckets.requests_bucket.wait_time(1)) > 0:
+        if self.model_buckets.requests_bucket.wait_time(1) > 0:
             self.waiting = True  #  do we need this?
             self.task_status = TaskStatus.WAITING_FOR_REQUEST_CAPACITY
 

edsl/tasks/task_creators.py

@@ -6,15 +6,13 @@ for executing a single question within an interview. It aggregates status and to
 information across all tasks, providing a complete view of interview execution.
 """
 
-from typing import Callable, Union, List, Dict, TYPE_CHECKING
+from typing import List, TYPE_CHECKING
 from collections import UserDict
 
 if TYPE_CHECKING:
-    from ..tokens import TokenUsage
     from ..tokens import InterviewTokenUsage
     from ..interviews import InterviewStatusDictionary
     from .task_status_log import TaskStatusLog
-    from .question_task_creator import QuestionTaskCreator
 
 class TaskCreators(UserDict):
     """

edsl/tasks/task_history.py

@@ -7,7 +7,10 @@ visualization and reporting to help users understand task execution patterns and
 issues.
 """
 
-from typing import List, Optional, Dict, Any, Union
+from typing import List, Optional, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ..interviews import Interview
 from io import BytesIO
 import base64
 import os
@@ -89,12 +92,10 @@ class TaskHistory(RepresentationMixin):
     @classmethod
     def example(cls):
         """ """
-        from ..interviews import Interview
         from ..jobs import Jobs
 
         j = Jobs.example(throw_exception_probability=1, test_model=True)
 
-        from edsl.config import CONFIG
 
         results = j.run(
             print_exceptions=False,
@@ -404,7 +405,7 @@ class TaskHistory(RepresentationMixin):
 
         models_used = set([i.model.model for index, i in self._interviews.items()])
 
-        from jinja2 import Environment, FileSystemLoader
+        from jinja2 import Environment
         from edsl.utilities import TemplateLoader
 
         env = Environment(loader=TemplateLoader("edsl", "templates/error_reporting"))
@@ -463,7 +464,6 @@ class TaskHistory(RepresentationMixin):
             - Exception details, status transitions, and timing are all included
         """
         from IPython.display import display, HTML
-        import tempfile
         import os
         from edsl.utilities.utilities import is_notebook
 
@@ -509,8 +509,6 @@ class TaskHistory(RepresentationMixin):
         """Create a notebook with the HTML content embedded in the first cell, then delete the cell content while keeping the output."""
         from nbformat import v4 as nbf
         from nbconvert.preprocessors import ExecutePreprocessor
-        import nbformat
-        import os
 
         # Use the existing html method to generate the HTML content
         output_html = self.generate_html_report(css=None)

edsl/tasks/task_status_log.py

@@ -7,9 +7,8 @@ execution, including timing, state transitions, and status at any point in time.
 """
 
 from collections import UserList
-from typing import List, Optional, Union
 
-from .task_status_enum import TaskStatus, TaskStatusLogEntry
+from .task_status_enum import TaskStatus
 
 
 class TaskStatusLog(UserList):

edsl/tokens/__init__.py

@@ -1,2 +1,4 @@
 from .token_usage import TokenUsage
-from .interview_token_usage import InterviewTokenUsage
+from .interview_token_usage import InterviewTokenUsage
+
+__all__ = ["TokenUsage", "InterviewTokenUsage"]

edsl/tokens/token_usage.py

@@ -17,7 +17,7 @@ class TokenUsage:
         if not isinstance(other, TokenUsage):
             raise ValueError(f"Can't add {type(other)} to InterviewTokenUsage")
         if self.from_cache != other.from_cache:
-            raise ValueError(f"Can't add token usages from different sources")
+            raise ValueError("Can't add token usages from different sources")
         return TokenUsage(
             from_cache=self.from_cache,
             prompt_tokens=self.prompt_tokens + other.prompt_tokens,

edsl/utilities/__init__.py

@@ -26,5 +26,25 @@ from .is_valid_variable_name import is_valid_variable_name
 from .naming_utilities import sanitize_string
 
 # Interface module - note: print_results_long is imported directly in results.py
-from .interface import print_results_long
+
+__all__ = [
+    "TemplateLoader",
+    "PrettyList",
+    "create_restricted_function",
+    "remove_edsl_version",
+    "extract_variable_names",
+    "clean_json",
+    "dict_hash",
+    "hash_value",
+    "repair_json",
+    "create_valid_var_name",
+    "random_string",
+    "shorten_string", 
+    "is_gzipped",
+    "sync_wrapper",
+    "jupyter_nb_handler",
+    "is_notebook",
+    "is_valid_variable_name",
+    "sanitize_string"
+]
 

edsl/utilities/decorators.py

@@ -1,11 +1,10 @@
 import functools
 import asyncio
 import nest_asyncio
+from edsl import __version__ as edsl_version
 
 nest_asyncio.apply()
 
-from edsl import __version__ as edsl_version
-
 
 def add_edsl_version(func):
     """

edsl/utilities/markdown_to_docx.py

@@ -69,7 +69,7 @@ class MarkdownToDocx:
 
         try:
             # Run pandoc command
-            result = subprocess.run(
+            subprocess.run(
                 cmd,
                 input=self.markdown_content,
                 text=True,
@@ -115,7 +115,7 @@ class MarkdownToDocx:
             cmd = ["pandoc", "--print-default-data-file", "reference.docx"]
 
             with open(output_path, "wb") as f:
-                result = subprocess.run(cmd, stdout=f, check=True)
+                subprocess.run(cmd, stdout=f, check=True)
             return True
         except subprocess.CalledProcessError as e:
             print(f"Error creating template: {e.stderr}")

edsl/utilities/markdown_to_pdf.py

@@ -86,7 +86,7 @@ class MarkdownToPDF:
 
         try:
             # Run pandoc command
-            result = subprocess.run(
+            subprocess.run(
                 cmd,
                 input=self.markdown_content,
                 text=True,

edsl/utilities/repair_functions.py

@@ -1,5 +1,4 @@
 import json
-from .utilities import valid_json
 
 
 def extract_json_from_string(s):

edsl/utilities/restricted_python.py

@@ -1,7 +1,6 @@
 from RestrictedPython import compile_restricted, safe_globals
 from RestrictedPython.Guards import (
     safe_builtins,
-    full_write_guard,
     guarded_iter_unpack_sequence,
 )
 

edsl/utilities/template_loader.py

@@ -1,6 +1,5 @@
 from importlib import resources
 from jinja2 import BaseLoader, TemplateNotFound
-import os
 
 
 class TemplateLoader(BaseLoader):
@@ -10,8 +9,8 @@ class TemplateLoader(BaseLoader):
 
     def get_source(self, environment, template):
         try:
-            parts = [self.templates_dir] + template.split("/")
-            template_path = os.path.join(*parts)
+            # Split template path into components
+            # (template_path from os.path.join is no longer needed with importlib.resources)
 
             # Use resources.files() to get a Traversable object
             templates = resources.files(self.package_name).joinpath(self.templates_dir)

edsl/utilities/utilities.py

@@ -14,7 +14,6 @@ import string
 import tempfile
 import gzip
 import webbrowser
-import json
 
 from html import escape
 from typing import Callable, Union
@@ -90,9 +89,9 @@ def fix_partial_correct_response(text: str) -> dict:
     start_pos = text.find(json_object)
     stop_pos = start_pos + len(json_object)
 
-    # Parse the JSON object to validate it
+    # Validate the JSON
     try:
-        parsed_json = json.loads(json_object)
+        json.loads(json_object)  # Just validate, don't need to keep the parsed result
     except json.JSONDecodeError:
         return {"error": "Failed to parse JSON object"}
 
@@ -215,17 +214,8 @@ def is_notebook() -> bool:
 
 def file_notice(file_name):
     """Print a notice about the file being created."""
-    if is_notebook():
-        from IPython.display import HTML, display
-
-        link_text = "Download file"
-        display(
-            HTML(
-                f'<p>File created: {file_name}</p>.<a href="{file_name}" download>{link_text}</a>'
-            )
-        )
-    else:
-        print(f"File created: {file_name}")
+    from ..display import file_notice as display_file_notice
+    display_file_notice(file_name, link_text="Download file")
 
 
 class HTMLSnippet(str):
@@ -316,20 +306,7 @@ def merge_dicts(dict_list):
         result[key] = [d.get(key, None) for d in dict_list]
     return result
 
-
-def extract_json_from_string(s):
-    """Extract a JSON string from a string."""
-    # Find the first occurrence of '{'
-    start_idx = s.find("{")
-    # Find the last occurrence of '}'
-    end_idx = s.rfind("}")
-    # If both '{' and '}' are found in the string
-    if start_idx != -1 and end_idx != -1 and start_idx < end_idx:
-        # Extract the substring from start_idx to end_idx (inclusive)
-        json_str = s[start_idx : end_idx + 1]
-        return json_str
-    else:
-        raise ValueError("No JSON object found in string")
+# Note: extract_json_from_string is already defined above (line 58)
 
 
 def valid_json(json_string):
@@ -354,7 +331,9 @@ def is_valid_variable_name(name, allow_name=True):
 def create_valid_var_name(s, transform_func: Callable = lambda x: x.lower()) -> str:
     """Create a valid variable name from a string."""
     if transform_func is None:
-        transform_func = lambda x: x
+        def identity(x):
+            return x
+        transform_func = identity
 
     # Ensure the string is not empty
     if not s:

{edsl-0.1.49.dist-info → edsl-0.1.50.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edsl
-Version: 0.1.49
+Version: 0.1.50
 Summary: Create and analyze LLM-based surveys
 Home-page: https://www.expectedparrot.com/
 License: MIT
@@ -36,6 +36,7 @@ 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: pluggy (>=1.3.0,<2.0.0)
 Requires-Dist: pydot (>=2.0.0,<3.0.0)
 Requires-Dist: pygments (>=2.17.2,<3.0.0)
 Requires-Dist: pypdf2 (>=3.0.1,<4.0.0)
@@ -50,6 +51,7 @@ Requires-Dist: simpleeval (>=0.9.13,<0.10.0)
 Requires-Dist: sqlalchemy (>=2.0.23,<3.0.0)
 Requires-Dist: tabulate (>=0.9.0,<0.10.0)
 Requires-Dist: tenacity (>=8.2.3,<9.0.0)
+Requires-Dist: typer[all] (>=0.9.0,<0.10.0)
 Requires-Dist: urllib3 (>=1.25.4,<1.27)
 Project-URL: Documentation, https://docs.expectedparrot.com
 Description-Content-Type: text/markdown
@@ -198,6 +200,27 @@ results.select("color", "flower")
 **Caching**: 
 API calls to LLMs are cached automatically, allowing you to retrieve responses to questions that have already been run and reproduce experiments at no cost. Learn more about how the <a href="https://docs.expectedparrot.com/en/latest/remote_caching.html" target="_blank" rel="noopener noreferrer">universal remote cache</a> works.
 
+**Logging**:
+EDSL includes a comprehensive logging system to help with debugging and monitoring. Control log levels and see important information about operations:
+
+```python
+from edsl import logger
+import logging
+
+# Set the logging level
+logger.set_level(logging.DEBUG)  # Show all log messages
+
+# Get a module-specific logger
+my_logger = logger.get_logger(__name__)
+my_logger.info("This is a module-specific log message")
+
+# Log messages at different levels
+logger.debug("Detailed debugging information")
+logger.info("General information about operation")
+logger.warning("Something unexpected but not critical")
+logger.error("Something went wrong")
+```
+
 **Flexibility**: 
 Choose whether to run surveys on your own computer or at the Expected Parrot server.
 
@@ -231,6 +254,13 @@ Analyze results as specified datasets from your account or workspace. Easily imp
 - API keys for language models. You can use your own keys or an Expected Parrot key that provides access to all available models.
 See instructions on <a href="https://docs.expectedparrot.com/en/latest/api_keys.html" target="_blank" rel="noopener noreferrer">managing keys</a> and <a href="https://www.expectedparrot.com/getting-started/coop-pricing" target="_blank" rel="noopener noreferrer">model pricing and performance</a> information.
 
+## Developer Notes
+
+### Running Tests
+- Unit tests: `python -m pytest tests/`  
+- Integration tests: `python -m pytest integration/`
+- Doctests: `python run_doctests.py` (use `-v` flag for verbose output)
+
 ## Coop
 An integrated platform for running experiments, sharing workflows and launching hybrid human/AI surveys.
 - <a href="https://www.expectedparrot.com/login" target="_blank" rel="noopener noreferrer">Login / Signup</a>
@@ -243,5 +273,5 @@ An integrated platform for running experiments, sharing workflows and launching
 - <a href="https://blog.expectedparrot.com" target="_blank" rel="noopener noreferrer">Blog</a>.
 
 ## Contact
-- <a href="mailto:info@expectedparrot.com" target="_blank" rel="noopener noreferrer">Email</a>
+- <a href="mailto:info@expectedparrot.com" target="_blank" rel="noopener noreferrer">Email</a>.