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

edsl/BaseDiff.py

@@ -1,260 +0,0 @@
-import difflib
-import json
-from typing import Any, Dict, Tuple
-from collections import UserList
-import inspect
-
-
-class BaseDiffCollection(UserList):
-    def __init__(self, diffs=None):
-        if diffs is None:
-            diffs = []
-        super().__init__(diffs)
-
-    def apply(self, obj: Any):
-        for diff in self:
-            obj = diff.apply(obj)
-        return obj
-
-    def add_diff(self, diff) -> "BaseDiffCollection":
-        self.append(diff)
-        return self
-
-
-class DummyObject:
-    def __init__(self, object_dict):
-        self.object_dict = object_dict
-
-    def to_dict(self):
-        return self.object_dict
-
-
-class BaseDiff:
-    def __init__(
-        self, obj1: Any, obj2: Any, added=None, removed=None, modified=None, level=0
-    ):
-        self.level = level
-
-        self.obj1 = obj1
-        self.obj2 = obj2
-
-        if "sort" in inspect.signature(obj1.to_dict).parameters:
-            self._dict1 = obj1.to_dict(sort=True)
-            self._dict2 = obj2.to_dict(sort=True)
-        else:
-            self._dict1 = obj1.to_dict()
-            self._dict2 = obj2.to_dict()
-        self._obj_class = type(obj1)
-
-        self.added = added
-        self.removed = removed
-        self.modified = modified
-
-    def __bool__(self):
-        return bool(self.added or self.removed or self.modified)
-
-    @property
-    def added(self):
-        if self._added is None:
-            self._added = self._find_added()
-        return self._added
-
-    def __add__(self, other):
-        return self.apply(other)
-
-    @added.setter
-    def added(self, value):
-        self._added = value if value is not None else self._find_added()
-
-    @property
-    def removed(self):
-        if self._removed is None:
-            self._removed = self._find_removed()
-        return self._removed
-
-    @removed.setter
-    def removed(self, value):
-        self._removed = value if value is not None else self._find_removed()
-
-    @property
-    def modified(self):
-        if self._modified is None:
-            self._modified = self._find_modified()
-        return self._modified
-
-    @modified.setter
-    def modified(self, value):
-        self._modified = value if value is not None else self._find_modified()
-
-    def _find_added(self) -> Dict[Any, Any]:
-        return {k: self._dict2[k] for k in self._dict2 if k not in self._dict1}
-
-    def _find_removed(self) -> Dict[Any, Any]:
-        return {k: self._dict1[k] for k in self._dict1 if k not in self._dict2}
-
-    def _find_modified(self) -> Dict[Any, Tuple[Any, Any, str]]:
-        modified = {}
-        for k in self._dict1:
-            if k in self._dict2 and self._dict1[k] != self._dict2[k]:
-                if isinstance(self._dict1[k], str) and isinstance(self._dict2[k], str):
-                    diff = self._diff_strings(self._dict1[k], self._dict2[k])
-                    modified[k] = (self._dict1[k], self._dict2[k], diff)
-                elif isinstance(self._dict1[k], dict) and isinstance(
-                    self._dict2[k], dict
-                ):
-                    diff = self._diff_dicts(self._dict1[k], self._dict2[k])
-                    modified[k] = (self._dict1[k], self._dict2[k], diff)
-                elif isinstance(self._dict1[k], list) and isinstance(
-                    self._dict2[k], list
-                ):
-                    d1 = dict(zip(range(len(self._dict1[k])), self._dict1[k]))
-                    d2 = dict(zip(range(len(self._dict2[k])), self._dict2[k]))
-                    diff = BaseDiff(
-                        DummyObject(d1), DummyObject(d2), level=self.level + 1
-                    )
-                    modified[k] = (self._dict1[k], self._dict2[k], diff)
-                else:
-                    modified[k] = (self._dict1[k], self._dict2[k], "")
-        return modified
-
-    @staticmethod
-    def is_json(string_that_could_be_json: str) -> bool:
-        try:
-            json.loads(string_that_could_be_json)
-            return True
-        except json.JSONDecodeError:
-            return False
-
-    def _diff_dicts(self, dict1: Dict[str, Any], dict2: Dict[str, Any]) -> str:
-        diff = BaseDiff(DummyObject(dict1), DummyObject(dict2), level=self.level + 1)
-        return diff
-
-    def _diff_strings(self, str1: str, str2: str) -> str:
-        if self.is_json(str1) and self.is_json(str2):
-            diff = self._diff_dicts(json.loads(str1), json.loads(str2))
-            return diff
-        diff = difflib.ndiff(str1.splitlines(), str2.splitlines())
-        return diff
-
-    def apply(self, obj: Any):
-        """Apply the diff to the object."""
-
-        new_obj_dict = obj.to_dict()
-        for k, v in self.added.items():
-            new_obj_dict[k] = v
-        for k in self.removed.keys():
-            del new_obj_dict[k]
-        for k, (v1, v2, diff) in self.modified.items():
-            new_obj_dict[k] = v2
-
-        return obj.from_dict(new_obj_dict)
-
-    def to_dict(self) -> Dict[str, Any]:
-        return {
-            "added": self.added,
-            "removed": self.removed,
-            "modified": self.modified,
-            "obj1": self._dict1,
-            "obj2": self._dict2,
-            "obj_class": self._obj_class.__name__,
-            "level": self.level,
-        }
-
-    @classmethod
-    def from_dict(cls, diff_dict: Dict[str, Any], obj1: Any, obj2: Any):
-        return cls(
-            obj1=obj1,
-            obj2=obj2,
-            added=diff_dict["added"],
-            removed=diff_dict["removed"],
-            modified=diff_dict["modified"],
-            level=diff_dict["level"],
-        )
-
-    class Results(UserList):
-        def __init__(self, prepend=" ", level=0):
-            super().__init__()
-            self.prepend = prepend
-            self.level = level
-
-        def append(self, item):
-            super().append(self.prepend * self.level + item)
-
-    def __str__(self):
-        prepend = " "
-        result = self.Results(level=self.level, prepend="\t")
-        if self.added:
-            result.append("Added keys and values:")
-            for k, v in self.added.items():
-                result.append(prepend + f"  {k}: {v}")
-        if self.removed:
-            result.append("Removed keys and values:")
-            for k, v in self.removed.items():
-                result.append(f"  {k}: {v}")
-        if self.modified:
-            result.append("Modified keys and values:")
-            for k, (v1, v2, diff) in self.modified.items():
-                result.append(f"Key: {k}:")
-                result.append(f"    Old value: {v1}")
-                result.append(f"    New value: {v2}")
-                if diff:
-                    result.append(f"    Diff:")
-                    try:
-                        for line in diff:
-                            result.append(f"      {line}")
-                    except:
-                        result.append(f"      {diff}")
-        return "\n".join(result)
-
-    def __repr__(self):
-        return (
-            f"BaseDiff(obj1={self.obj1!r}, obj2={self.obj2!r}, added={self.added!r}, "
-            f"removed={self.removed!r}, modified={self.modified!r})"
-        )
-
-    def add_diff(self, diff) -> "BaseDiffCollection":
-        return BaseDiffCollection([self, diff])
-
-
-if __name__ == "__main__":
-    from edsl import Question
-
-    q_ft = Question.example("free_text")
-    q_mc = Question.example("multiple_choice")
-
-    diff1 = q_ft - q_mc
-    assert q_ft == q_mc + diff1
-    assert q_ft == diff1.apply(q_mc)
-    # new_q_mc = diff1.apply(q_ft)
-    # assert new_q_mc == q_mc
-
-    # new_q_mc = q_ft + diff1
-    # assert new_q_mc == q_mc
-
-    # new_q_mc = diff1 + q_ft
-    # assert new_q_mc == q_mc
-
-    # ## Test chain of diffs
-    q0 = Question.example("free_text")
-    q1 = q0.copy()
-    q1.question_text = "Why is Buzzard's Bay so named?"
-    diff1 = q1 - q0
-    q2 = q1.copy()
-    q2.question_name = "buzzard_bay"
-    diff2 = q2 - q1
-
-    diff_chain = diff1.add_diff(diff2)
-
-    new_q2 = diff_chain.apply(q0)
-    assert new_q2 == q2
-
-    new_q2 = diff_chain + q0
-    assert new_q2 == q2
-
-    # new_diffs = diff1.add_diff(diff1).add_diff(diff1)
-    # assert len(new_diffs) == 3
-
-    # q0 = Question.example("free_text")
-    # q1 = Question.example("free_text")
-    # q1.question_text = "Why is Buzzard's Bay so named?"
-    # q2 = q1.copy()

edsl/agents/InvigilatorBase.py

@@ -1,260 +0,0 @@
-from abc import ABC, abstractmethod
-import asyncio
-from typing import Coroutine, Dict, Any, Optional, TYPE_CHECKING
-
-from edsl.utilities.decorators import jupyter_nb_handler
-from edsl.data_transfer_models import AgentResponseDict
-
-if TYPE_CHECKING:
-    from edsl.prompts.Prompt import Prompt
-    from edsl.data.Cache import Cache
-    from edsl.questions.QuestionBase import QuestionBase
-    from edsl.scenarios.Scenario import Scenario
-    from edsl.surveys.MemoryPlan import MemoryPlan
-    from edsl.language_models.LanguageModel import LanguageModel
-    from edsl.surveys.Survey import Survey
-    from edsl.agents.Agent import Agent
-    from edsl.language_models.key_management.KeyLookup import KeyLookup
-
-from edsl.data_transfer_models import EDSLResultObjectInput
-from edsl.agents.PromptConstructor import PromptConstructor
-from edsl.agents.prompt_helpers import PromptPlan
-
-
-class InvigilatorBase(ABC):
-    """An invigiator (someone who administers an exam) is a class that is responsible for administering a question to an agent.
-
-    >>> InvigilatorBase.example().answer_question()
-    {'message': [{'text': 'SPAM!'}], 'usage': {'prompt_tokens': 1, 'completion_tokens': 1}}
-
-    >>> InvigilatorBase.example().get_failed_task_result(failure_reason="Failed to get response").comment
-    'Failed to get response'
-
-    This returns an empty prompt because there is no memory the agent needs to have at q0.
-    """
-
-    def __init__(
-        self,
-        agent: "Agent",
-        question: "QuestionBase",
-        scenario: "Scenario",
-        model: "LanguageModel",
-        memory_plan: "MemoryPlan",
-        current_answers: dict,
-        survey: Optional["Survey"],
-        cache: Optional["Cache"] = None,
-        iteration: Optional[int] = 1,
-        additional_prompt_data: Optional[dict] = None,
-        raise_validation_errors: Optional[bool] = True,
-        prompt_plan: Optional["PromptPlan"] = None,
-        key_lookup: Optional["KeyLookup"] = None,
-    ):
-        """Initialize a new Invigilator."""
-        self.agent = agent
-        self.question = question
-        self.scenario = scenario
-        self.model = model
-        self.memory_plan = memory_plan
-        self.current_answers = current_answers or {}
-        self.iteration = iteration
-        self.additional_prompt_data = additional_prompt_data
-        self.cache = cache
-        self.survey = survey
-        self.raise_validation_errors = raise_validation_errors
-        self.key_lookup = key_lookup
-
-        if prompt_plan is None:
-            self.prompt_plan = PromptPlan()
-        else:
-            self.prompt_plan = prompt_plan
-
-        # placeholder to store the raw model response
-        self.raw_model_response = None
-
-    @property
-    def prompt_constructor(self) -> PromptConstructor:
-        """Return the prompt constructor."""
-        return PromptConstructor.from_invigilator(self, prompt_plan=self.prompt_plan)
-
-    def to_dict(self, include_cache=False) -> Dict[str, Any]:
-        attributes = [
-            "agent",
-            "question",
-            "scenario",
-            "model",
-            "memory_plan",
-            "current_answers",
-            "iteration",
-            "additional_prompt_data",
-            "survey",
-            "raw_model_response",
-        ]
-        if include_cache:
-            attributes.append("cache")
-
-        def serialize_attribute(attr):
-            value = getattr(self, attr)
-            if value is None:
-                return None
-            if hasattr(value, "to_dict"):
-                return value.to_dict()
-            if isinstance(value, (int, float, str, bool, dict, list)):
-                return value
-            return str(value)
-
-        return {attr: serialize_attribute(attr) for attr in attributes}
-
-    @classmethod
-    def from_dict(cls, data) -> "InvigilatorBase":
-        from edsl.agents.Agent import Agent
-        from edsl.questions import QuestionBase
-        from edsl.scenarios.Scenario import Scenario
-        from edsl.surveys.MemoryPlan import MemoryPlan
-        from edsl.language_models.LanguageModel import LanguageModel
-        from edsl.surveys.Survey import Survey
-        from edsl.data.Cache import Cache
-
-        attributes_to_classes = {
-            "agent": Agent,
-            "question": QuestionBase,
-            "scenario": Scenario,
-            "model": LanguageModel,
-            "memory_plan": MemoryPlan,
-            "survey": Survey,
-            "cache": Cache,
-        }
-        d = {}
-        for attr, cls_ in attributes_to_classes.items():
-            if attr in data and data[attr] is not None:
-                if attr not in data:
-                    d[attr] = {}
-                else:
-                    d[attr] = cls_.from_dict(data[attr])
-
-        d["current_answers"] = data["current_answers"]
-        d["iteration"] = data["iteration"]
-        d["additional_prompt_data"] = data["additional_prompt_data"]
-
-        d = cls(**d)
-        d.raw_model_response = data.get("raw_model_response")
-        return d
-
-    def __repr__(self) -> str:
-        """Return a string representation of the Invigilator.
-
-        >>> InvigilatorBase.example().__repr__()
-        'InvigilatorExample(...)'
-
-        """
-        return f"{self.__class__.__name__}(agent={repr(self.agent)}, question={repr(self.question)}, scenario={repr(self.scenario)}, model={repr(self.model)}, memory_plan={repr(self.memory_plan)}, current_answers={repr(self.current_answers)}, iteration={repr(self.iteration)}, additional_prompt_data={repr(self.additional_prompt_data)}, cache={repr(self.cache)})"
-
-    def get_failed_task_result(self, failure_reason: str) -> EDSLResultObjectInput:
-        """Return an AgentResponseDict used in case the question-asking fails.
-
-        Possible reasons include:
-        - Legimately skipped because of skip logic
-        - Failed to get response from the model
-
-        """
-        data = {
-            "answer": None,
-            "generated_tokens": None,
-            "comment": failure_reason,
-            "question_name": self.question.question_name,
-            "prompts": self.get_prompts(),
-            "cached_response": None,
-            "raw_model_response": None,
-            "cache_used": None,
-            "cache_key": None,
-        }
-        return EDSLResultObjectInput(**data)
-
-    def get_prompts(self) -> Dict[str, "Prompt"]:
-        """Return the prompt used."""
-        from edsl.prompts.Prompt import Prompt
-
-        return {
-            "user_prompt": Prompt("NA"),
-            "system_prompt": Prompt("NA"),
-        }
-
-    @abstractmethod
-    async def async_answer_question(self):
-        """Asnwer a question."""
-        pass
-
-    @jupyter_nb_handler
-    def answer_question(self) -> Coroutine:
-        """Return a function that gets the answers to the question."""
-
-        async def main():
-            """Return the answer to the question."""
-            results = await asyncio.gather(self.async_answer_question())
-            return results[0]  # Since there's only one task, return its result
-
-        return main()
-
-    @classmethod
-    def example(
-        cls, throw_an_exception=False, question=None, scenario=None, survey=None
-    ) -> "InvigilatorBase":
-        """Return an example invigilator.
-
-        >>> InvigilatorBase.example()
-        InvigilatorExample(...)
-
-        >>> InvigilatorBase.example().answer_question()
-        {'message': [{'text': 'SPAM!'}], 'usage': {'prompt_tokens': 1, 'completion_tokens': 1}}
-
-        >>> InvigilatorBase.example(throw_an_exception=True).answer_question()
-        Traceback (most recent call last):
-        ...
-        Exception: This is a test error
-        """
-        from edsl.agents.Agent import Agent
-        from edsl.scenarios.Scenario import Scenario
-        from edsl.surveys.MemoryPlan import MemoryPlan
-        from edsl.language_models.model import Model
-        from edsl.surveys.Survey import Survey
-
-        model = Model("test", canned_response="SPAM!")
-
-        if throw_an_exception:
-            model.throw_exception = True
-        agent = Agent.example()
-
-        if not survey:
-            survey = Survey.example()
-
-        if question not in survey.questions and question is not None:
-            survey.add_question(question)
-
-        question = question or survey.questions[0]
-        scenario = scenario or Scenario.example()
-        memory_plan = MemoryPlan(survey=survey)
-        current_answers = None
-
-        class InvigilatorExample(cls):
-            """An example invigilator."""
-
-            async def async_answer_question(self):
-                """Answer a question."""
-                return await self.model.async_execute_model_call(
-                    user_prompt="Hello", system_prompt="Hi"
-                )
-
-        return InvigilatorExample(
-            agent=agent,
-            question=question,
-            scenario=scenario,
-            survey=survey,
-            model=model,
-            memory_plan=memory_plan,
-            current_answers=current_answers,
-        )
-
-
-if __name__ == "__main__":
-    import doctest
-
-    doctest.testmod(optionflags=doctest.ELLIPSIS)