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

edsl/scenarios/{ScenarioListPdfMixin.py → scenario_list_pdf_tools.py}

@@ -4,6 +4,9 @@ import copy
 import atexit
 import tempfile
 import subprocess
+import requests
+
+from .scenario import Scenario
 
 
 class GoogleDriveDownloader:
@@ -12,7 +15,6 @@ class GoogleDriveDownloader:
 
     @classmethod
     def fetch_from_drive(cls, url, filename=None):
-        import requests
 
         # Extract file ID from the URL
         file_id = cls._extract_file_id(url)
@@ -107,11 +109,13 @@ def fetch_and_save_pdf(url, filename):
     return temp_file_path
 
 
-class ScenarioListPdfMixin:
-    @classmethod
-    def from_pdf(cls, filename_or_url, collapse_pages=False):
+class PdfTools:
+    """Class for handling PDF-related operations for scenarios"""
+    
+    @staticmethod
+    def from_pdf(filename_or_url, collapse_pages=False):
         # Check if the input is a URL
-        if cls.is_url(filename_or_url):
+        if PdfTools.is_url(filename_or_url):
             # Check if it's a Google Drive URL
             if "drive.google.com" in filename_or_url:
                 temp_filename = GoogleDriveDownloader.fetch_from_drive(
@@ -121,17 +125,16 @@ class ScenarioListPdfMixin:
                 # For other URLs, use the previous fetch_and_save_pdf function
                 temp_filename = fetch_and_save_pdf(filename_or_url, "temp_pdf.pdf")
 
-            scenarios = list(cls.extract_text_from_pdf(temp_filename))
+            scenarios = list(PdfTools.extract_text_from_pdf(temp_filename))
         else:
             # If it's not a URL, assume it's a local file path
-            scenarios = list(cls.extract_text_from_pdf(filename_or_url))
+            scenarios = list(PdfTools.extract_text_from_pdf(filename_or_url))
         if not collapse_pages:
-            return cls(scenarios)
+            return scenarios
         else:
             txt = ""
             for scenario in scenarios:
                 txt += scenario["text"]
-            from edsl.scenarios import Scenario
 
             base_scenario = copy.copy(scenarios[0])
             base_scenario["text"] = txt
@@ -147,8 +150,8 @@ class ScenarioListPdfMixin:
         except ValueError:
             return False
 
-    @classmethod
-    def from_pdf_to_image(cls, pdf_path, image_format="jpeg"):
+    @staticmethod
+    def from_pdf_to_image(pdf_path, image_format="jpeg"):
         """
         Convert each page of a PDF into an image and create Scenario instances.
 
@@ -160,7 +163,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
@@ -173,7 +175,6 @@ class ScenarioListPdfMixin:
                 image_path = os.path.join(output_folder, f"page_{i+1}.{image_format}")
                 image.save(image_path, image_format.upper())
 
-                from edsl import FileStore
                 scenario = Scenario({
                     "filepath":image_path,
                     "page":i,
@@ -181,11 +182,10 @@ class ScenarioListPdfMixin:
                     })
                 scenarios.append(scenario)
 
-            return cls(scenarios)
+            return scenarios
 
     @staticmethod
     def extract_text_from_pdf(pdf_path):
-        from edsl.scenarios.Scenario import Scenario
         import fitz  # PyMuPDF
 
         # TODO: Add test case
@@ -208,6 +208,7 @@ class ScenarioListPdfMixin:
             page_info = {"filename": filename, "page": page_num + 1, "text": text}
             yield Scenario(page_info)
 
+    @staticmethod
     def create_hello_world_pdf(pdf_path):
         # LaTeX content
         latex_content = r"""

edsl/scenarios/scenario_selector.py

@@ -1,6 +1,10 @@
 from typing import TYPE_CHECKING
 
 
+if TYPE_CHECKING:
+    from .scenario_list import ScenarioList
+    from .scenario import Scenario
+
 class ScenarioSelector:
     """
     A class for performing advanced field selection on ScenarioList objects,
@@ -34,7 +38,7 @@ class ScenarioSelector:
             field: The field name to check
 
         Examples:
-            >>> from edsl.scenarios import ScenarioList, Scenario
+            >>> from edsl import ScenarioList, Scenario
             >>> selector = ScenarioSelector(ScenarioList([]))
             >>> selector._match_field_pattern('test*', 'test_field')
             True

edsl/study/ObjectEntry.py

@@ -1,8 +1,8 @@
 import time
 import webbrowser
 from typing import Any, Dict, Optional, Type
-from edsl.questions.QuestionBase import QuestionBase
-from edsl.Base import RegisterSubclassesMeta
+from edsl.questions import QuestionBase
+from edsl.base import RegisterSubclassesMeta
 
 
 class ObjectEntry:

edsl/study/SnapShot.py

@@ -26,13 +26,13 @@ class SnapShot:
         >>> sn.edsl_classes
         {}
 
-        >>> from edsl.data.Cache import Cache
+        >>> from edsl.caching import Cache
         >>> sn = SnapShot(namespace = globals())
         >>> sn.edsl_classes
-        {'Cache': <class 'edsl.data.Cache.Cache'>}
+        {'Cache': <class 'edsl.caching.cache.Cache'>}
         """
-        from edsl.Base import RegisterSubclassesMeta
-        from edsl.questions.QuestionBase import QuestionBase
+        from ..base import RegisterSubclassesMeta
+        from ..questions import QuestionBase
 
         all_edsl_objects = RegisterSubclassesMeta.get_registry()
 
@@ -54,7 +54,7 @@ class SnapShot:
         {}
 
         """
-        from edsl.Base import Base
+        from edsl.base import Base
         from edsl.study.Study import Study
 
         def is_edsl_object(obj):

edsl/study/Study.py

@@ -8,12 +8,12 @@ from datetime import datetime
 from typing import Dict, Optional, Union
 from uuid import UUID, uuid4
 
-from edsl.data.Cache import Cache
-from edsl import set_session_cache, unset_session_cache
-from edsl.utilities.utilities import dict_hash
-from edsl.study.ObjectEntry import ObjectEntry
-from edsl.study.ProofOfWork import ProofOfWork
-from edsl.study.SnapShot import SnapShot
+from ..caching import Cache
+#from edsl import set_session_cache, unset_session_cache
+from ..utilities.utilities import dict_hash
+from ..study.ObjectEntry import ObjectEntry
+from ..study.ProofOfWork import ProofOfWork
+from ..study.SnapShot import SnapShot
 
 
 class Study:
@@ -224,15 +224,13 @@ class Study:
 
     def __enter__(self):
         """
-        >>> s = Study(name = "temp", use_study_cache = True, verbose = False)
-        >>> _ = s.__enter__()
-        >>> from edsl.config import CONFIG
-        >>> hasattr(CONFIG, "EDSL_SESSION_CACHE")
-        True
-        >>> _ = s.__exit__(None, None, None)
-        >>> len(s.objects)
-        0
-        >>> os.remove("temp.json")
+        >>> #s = Study(name = "temp", use_study_cache = True, verbose = False)
+        >>> #_ = s.__enter__()
+        >>> #from edsl.config import CONFIG
+        >>> #hasattr(CONFIG, "EDSL_SESSION_CACHE")
+        >>> #_ = s.__exit__(None, None, None)
+        >>> #len(s.objects)
+        >>> #os.remove("temp.json")
 
         """
         if self.verbose:
@@ -242,7 +240,7 @@ class Study:
         if self.use_study_cache:
             if self.verbose:
                 print("Using study cache.")
-            set_session_cache(self.cache)
+            #set_session_cache(self.cache)
 
         if snapshot.edsl_objects:
             raise ValueError(
@@ -258,7 +256,7 @@ class Study:
 
     def study_diff(self):
         ## Need to also report missing.
-        from edsl.BaseDiff import BaseDiff
+        from ..base import BaseDiff
 
         raise NotImplementedError("Need to implement this.")
 
@@ -308,7 +306,8 @@ class Study:
         # print("Frame objects are:", snapshot.namespace.keys())
         # breakpoint()
         if self.use_study_cache:
-            unset_session_cache()
+            #unset_session_cache()
+            pass
 
         for variable_name, object in snapshot.edsl_objects.items():
             self._add_edsl_object(object=object, variable_name=variable_name)
@@ -407,7 +406,7 @@ class Study:
 
         study_file = tempfile.NamedTemporaryFile()
         with cls(filename=study_file.name, verbose=verbose) as study:
-            from edsl.questions.QuestionFreeText import QuestionFreeText
+            from ..questions import QuestionFreeText
 
             q = QuestionFreeText.example(randomize=randomize)
         return study

edsl/study/__init__.py

@@ -1,4 +1,6 @@
-from edsl.study.ObjectEntry import ObjectEntry
-from edsl.study.ProofOfWork import ProofOfWork
-from edsl.study.SnapShot import SnapShot
-from edsl.study.Study import Study
+from .ObjectEntry import ObjectEntry
+from .ProofOfWork import ProofOfWork
+from .SnapShot import SnapShot
+from .Study import Study
+
+__all__ = ["ObjectEntry", "ProofOfWork", "SnapShot", "Study"]

edsl/surveys/__init__.py

@@ -1,5 +1,8 @@
-from edsl.surveys.Survey import Survey
-from edsl.surveys.instructions.Instruction import Instruction
+from .survey import Survey
+from .survey_flow_visualization import SurveyFlowVisualization
 
-# from edsl.surveys.Rule import Rule
-# from edsl.surveys.RuleCollection import RuleCollection
+from .rules import Rule, RuleCollection
+from .base import EndOfSurvey, RulePriority
+
+__all__ = ["Survey"]
+## , "SurveyFlowVisualization", "Rule", "RuleCollection", "EndOfSurvey", "RulePriority"]

edsl/surveys/dag/__init__.py

@@ -0,0 +1,2 @@
+from .dag import DAG
+from .construct_dag import ConstructDAG

edsl/surveys/{ConstructDAG.py → dag/construct_dag.py}

@@ -1,6 +1,6 @@
-from edsl.surveys.base import EndOfSurvey
-from edsl.surveys.DAG import DAG
-from edsl.exceptions.surveys import SurveyError
+from ..base import EndOfSurvey
+from . import DAG
+from ..exceptions import SurveyError
 
 
 class ConstructDAG:

edsl/surveys/{DAG.py → dag/dag.py}

@@ -13,7 +13,7 @@ class DAG(UserDict):
         self.reverse_mapping = self._create_reverse_mapping()
         self.validate_no_cycles()
 
-    def _create_reverse_mapping(self):
+    def _create_reverse_mapping(self) -> dict:
         """
         Create a reverse mapping of the DAG, where the keys are the children and the values are the parents.
 
@@ -33,7 +33,7 @@ class DAG(UserDict):
                 rev_map.setdefault(value, set()).add(key)
         return rev_map
 
-    def get_all_children(self, key):
+    def get_all_children(self, key) -> set:
         """Get all children of a node in the DAG."""
         children = set()
 
@@ -46,7 +46,7 @@ class DAG(UserDict):
         dfs(key)
         return children
 
-    def topologically_sorted_nodes(self):
+    def topologically_sorted_nodes(self) -> list[str]:
         """
         Return a sequence of the DAG.
 
@@ -62,17 +62,20 @@ class DAG(UserDict):
         """
         return list(TopologicalSorter(self).static_order())
 
-    def __add__(self, other_dag):
-        """Combine two DAGs."""
+    def __add__(self, other_dag: 'DAG') -> 'DAG':
+        """Combine two DAGs.
+        
+        >>> from edsl.surveys.dag import DAG
+        >>> dag1 = DAG({'a': {'b'}, 'b': {'c'}})
+        >>> dag2 = DAG({'d': {'e'}, 'e': {'f'}})
+        >>> dag1 + dag2 ==  {'d': {'e'}, 'a': {'b'}, 'e': {'f'}, 'b': {'c'}}
+        True
+        """
         d = {}
         combined_keys = set(self.keys()).union(set(other_dag.keys()))
         for key in combined_keys:
-            d[key] = self.get(key, set({})).union(other_dag.get(key, set({})))
+            d[key] = set(self.get(key, set({}))).union(set(other_dag.get(key, set({}))))
         return DAG(d)
-        # if textify:
-        #     return DAG(self.textify(d))
-        # else:
-        #     return DAG(d)
 
     def remove_node(self, node: int) -> None:
         """Remove a node and all its connections from the DAG."""

edsl/surveys/descriptors.py

@@ -38,7 +38,7 @@ 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
+        from ..questions import QuestionBase
 
         if not isinstance(value, list):
             raise TypeError("Questions must be a list.")

edsl/surveys/{EditSurvey.py → edit_survey.py}

@@ -1,13 +1,14 @@
+import math
+
 from typing import Union, Optional, TYPE_CHECKING
-from edsl.exceptions.surveys import SurveyError
 
 if TYPE_CHECKING:
-    from edsl.questions.QuestionBase import QuestionBase
-
-from edsl.exceptions.surveys import SurveyError, SurveyCreationError
-from edsl.surveys.Rule import Rule
-from edsl.surveys.base import RulePriority, EndOfSurvey
+    from ..questions import QuestionBase
+    from .survey import Survey
 
+from .exceptions import SurveyError, SurveyCreationError
+from .rules.rule import Rule
+from .base import RulePriority, EndOfSurvey
 
 class EditSurvey:
     def __init__(self, survey):
@@ -147,7 +148,7 @@ class EditSurvey:
                 self.survey._pseudo_indices[question_name] = old_index - 1
 
         # Update rules
-        from .RuleCollection import RuleCollection
+        from .rules import RuleCollection
 
         new_rule_collection = RuleCollection()
         for rule in self.survey.rule_collection:
@@ -182,7 +183,7 @@ class EditSurvey:
         :param instruction: The instruction to add to the survey.
 
         >>> from edsl import Instruction
-        >>> from edsl.surveys.Survey import Survey
+        >>> from edsl.surveys import Survey
         >>> i = Instruction(text="Pay attention to the following questions.", name="intro")
         >>> s = Survey().add_instruction(i)
         >>> s._instruction_names_to_instructions
@@ -190,7 +191,6 @@ class EditSurvey:
         >>> s._pseudo_indices
         {'intro': -0.5}
         """
-        import math
 
         if instruction.name in self.survey._instruction_names_to_instructions:
             raise SurveyCreationError(

edsl/{exceptions/surveys.py → surveys/exceptions.py}

@@ -1,5 +1,4 @@
-from edsl.exceptions.BaseException import BaseException
-
+from ..base import BaseException
 
 class SurveyError(BaseException):
     relevant_doc = "https://docs.expectedparrot.com/en/latest/surveys.html"

edsl/surveys/memory/__init__.py

@@ -0,0 +1,3 @@
+from .memory_plan import MemoryPlan
+from .memory_management import MemoryManagement
+from .memory import Memory

edsl/surveys/{MemoryPlan.py → memory/memory_plan.py}

@@ -1,12 +1,13 @@
 """A survey has a memory plan that specifies what the agent should remember when answering a question."""
 
+from typing import TYPE_CHECKING
 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
-
+if TYPE_CHECKING:
+    from ...surveys import Survey
+    from ...prompts import Prompt
+    from ..dag import DAG
 
 class MemoryPlan(UserDict):
     """A survey has a memory plan that specifies what the agent should remember when answering a question.
@@ -61,7 +62,7 @@ class MemoryPlan(UserDict):
         :param answers: A dictionary of question names to answers.
 
         """
-        from edsl.prompts.Prompt import Prompt
+        from ...prompts import Prompt
 
         self._check_valid_question_name(focal_question)
 
@@ -123,7 +124,7 @@ 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
+        from .memory import Memory
 
         if focal_question not in self:
             memory = Memory()
@@ -163,7 +164,7 @@ class MemoryPlan(UserDict):
     @classmethod
     def from_dict(cls, data) -> "MemoryPlan":
         """Deserialize a memory plan from a dictionary."""
-        from edsl.surveys.Memory import Memory
+        from .memory import Memory
 
         newdata = {}
         for question_name, memory in data["data"].items():
@@ -194,7 +195,7 @@ class MemoryPlan(UserDict):
         >>> mp.dag
         {1: {0}}
         """
-        from edsl.surveys.DAG import DAG
+        from edsl.surveys.dag import DAG
 
         d = defaultdict(set)
         for focal_question, memory in self.items():
@@ -205,7 +206,7 @@ class MemoryPlan(UserDict):
     @classmethod
     def example(cls):
         """Return an example memory plan."""
-        from edsl import Survey
+        from edsl.surveys import Survey
 
         mp = cls(survey=Survey.example())
         mp.add_single_memory("q1", "q0")

edsl/surveys/rules/__init__.py

@@ -0,0 +1,3 @@
+from .rule import Rule
+from .rule_manager import RuleManager
+from .rule_collection import RuleCollection