edsl 0.1.37.dev4__py3-none-any.whl → 0.1.37.dev5__py3-none-any.whl

edsl/exceptions/agents.py

@@ -1,40 +1,38 @@
-class AgentErrors(Exception):
-    pass
-
-
-class AgentDynamicTraitsFunctionError(AgentErrors):
-    pass
-
-
-class AgentDirectAnswerFunctionError(AgentErrors):
-    pass
-
-
-class AgentAttributeLookupCallbackError(AgentErrors):
-    pass
-
-
-class AgentCombinationError(AgentErrors):
-    pass
-
-
-class AgentLacksLLMError(AgentErrors):
-    pass
-
-
-class AgentRespondedWithBadJSONError(AgentErrors):
-    pass
-
-
-class AgentNameError(AgentErrors):
-    pass
-
-
-class AgentTraitKeyError(AgentErrors):
-    pass
-
-
-class FailedTaskException(Exception):
-    def __init__(self, message, agent_response_dict):
-        super().__init__(message)
-        self.agent_response_dict = agent_response_dict
+from edsl.exceptions.BaseException import BaseException
+
+
+class AgentErrors(BaseException):
+    relevant_doc = "https://docs.expectedparrot.com/en/latest/agents.html"
+
+
+class AgentDynamicTraitsFunctionError(AgentErrors):
+    relevant_doc = (
+        "https://docs.expectedparrot.com/en/latest/agents.html#dynamic-traits-function"
+    )
+    relevant_notebook = "https://docs.expectedparrot.com/en/latest/notebooks/example_agent_dynamic_traits.html"
+
+
+class AgentDirectAnswerFunctionError(AgentErrors):
+    relevant_doc = "https://docs.expectedparrot.com/en/latest/agents.html#agent-direct-answering-methods"
+
+
+class AgentCombinationError(AgentErrors):
+    relevant_doc = (
+        "https://docs.expectedparrot.com/en/latest/agents.html#combining-agents"
+    )
+
+
+class AgentNameError(AgentErrors):
+    relevant_doc = "https://docs.expectedparrot.com/en/latest/agents.html#agent-names"
+
+
+class AgentTraitKeyError(AgentErrors):
+    relevant_doc = (
+        "https://docs.expectedparrot.com/en/latest/agents.html#constructing-an-agent"
+    )
+
+
+class FailedTaskException(Exception):
+    def __init__(self, message, agent_response_dict):
+        super().__init__(message)
+        self.agent_response_dict = agent_response_dict

edsl/exceptions/configuration.py

@@ -1,16 +1,16 @@
-class ConfigurationError(Exception):
-    """Base exception for errors."""
-
-    pass
-
-
-class InvalidEnvironmentVariableError(ConfigurationError):
-    """Raised when an environment variable is invalid."""
-
-    pass
-
-
-class MissingEnvironmentVariableError(ConfigurationError):
-    """Raised when an expected environment variable is missing."""
-
-    pass
+class ConfigurationError(Exception):
+    """Base exception for errors."""
+
+    pass
+
+
+class InvalidEnvironmentVariableError(ConfigurationError):
+    """Raised when an environment variable is invalid."""
+
+    pass
+
+
+class MissingEnvironmentVariableError(ConfigurationError):
+    """Raised when an expected environment variable is missing."""
+
+    pass

edsl/exceptions/coop.py

@@ -1,10 +1,10 @@
-class CoopErrors(Exception):
-    pass
-
-
-class CoopNoUUIDError(CoopErrors):
-    pass
-
-
-class CoopServerResponseError(CoopErrors):
-    pass
+class CoopErrors(Exception):
+    pass
+
+
+class CoopNoUUIDError(CoopErrors):
+    pass
+
+
+class CoopServerResponseError(CoopErrors):
+    pass

edsl/exceptions/data.py

@@ -1,14 +1,14 @@
-class DatabaseErrors(Exception):
-    pass
-
-
-class DatabaseConnectionError(DatabaseErrors):
-    pass
-
-
-class DatabaseCRUDError(DatabaseErrors):
-    pass
-
-
-class DatabaseIntegrityError(DatabaseErrors):
-    pass
+class DatabaseErrors(Exception):
+    pass
+
+
+class DatabaseConnectionError(DatabaseErrors):
+    pass
+
+
+class DatabaseCRUDError(DatabaseErrors):
+    pass
+
+
+class DatabaseIntegrityError(DatabaseErrors):
+    pass

edsl/exceptions/general.py

@@ -1,34 +1,34 @@
-import re
-from textwrap import dedent
-
-
-class GeneralErrors(Exception):
-    def __init__(self, message):
-        super().__init__(message)
-        self.message = message
-
-    def __str__(self):
-        return self.make_urls_clickable(self.message)
-
-    @staticmethod
-    def make_urls_clickable(text):
-        url_pattern = r"https?://[^\s]+"
-        urls = re.findall(url_pattern, text)
-        for url in urls:
-            clickable_url = f"\033]8;;{url}\007{url}\033]8;;\007"
-            text = text.replace(url, clickable_url)
-        return text
-
-
-class MissingAPIKeyError(GeneralErrors):
-    def __init__(self, full_message=None, model_name=None, inference_service=None):
-        if model_name and inference_service:
-            full_message = dedent(
-                f"""
-            An API Key for model `{model_name}` is missing from the .env file.
-            This key is associated with the inference service `{inference_service}`.
-            Please see https://docs.expectedparrot.com/en/latest/api_keys.html for more information.
-            """
-            )
-
-        super().__init__(full_message)
+import re
+from textwrap import dedent
+
+
+class GeneralErrors(Exception):
+    def __init__(self, message):
+        super().__init__(message)
+        self.message = message
+
+    def __str__(self):
+        return self.make_urls_clickable(self.message)
+
+    @staticmethod
+    def make_urls_clickable(text):
+        url_pattern = r"https?://[^\s]+"
+        urls = re.findall(url_pattern, text)
+        for url in urls:
+            clickable_url = f"\033]8;;{url}\007{url}\033]8;;\007"
+            text = text.replace(url, clickable_url)
+        return text
+
+
+class MissingAPIKeyError(GeneralErrors):
+    def __init__(self, full_message=None, model_name=None, inference_service=None):
+        if model_name and inference_service:
+            full_message = dedent(
+                f"""
+            An API Key for model `{model_name}` is missing from the .env file.
+            This key is associated with the inference service `{inference_service}`.
+            Please see https://docs.expectedparrot.com/en/latest/api_keys.html for more information.
+            """
+            )
+
+        super().__init__(full_message)

edsl/exceptions/jobs.py

@@ -1,33 +1,33 @@
-from textwrap import dedent
-
-
-class JobsErrors(Exception):
-    pass
-
-
-class JobsRunError(JobsErrors):
-    pass
-
-
-class MissingRemoteInferenceError(JobsErrors):
-    def __init__(self):
-        message = dedent(
-            """\\
-                        You are trying to run the job remotely, but you have not set the EXPECTED_PARROT_INFERENCE_URL environment variable.
-                        This remote running service is not quite ready yet! 
-                        But please see https://docs.expectedparrot.com/en/latest/coop.html for what we are working on.
-                        """
-        )
-        super().__init__(message)
-
-
-class InterviewError(Exception):
-    pass
-
-
-class InterviewErrorPriorTaskCanceled(InterviewError):
-    pass
-
-
-class InterviewTimeoutError(InterviewError):
-    pass
+from textwrap import dedent
+
+
+class JobsErrors(Exception):
+    pass
+
+
+class JobsRunError(JobsErrors):
+    pass
+
+
+class MissingRemoteInferenceError(JobsErrors):
+    def __init__(self):
+        message = dedent(
+            """\\
+                        You are trying to run the job remotely, but you have not set the EXPECTED_PARROT_INFERENCE_URL environment variable.
+                        This remote running service is not quite ready yet! 
+                        But please see https://docs.expectedparrot.com/en/latest/coop.html for what we are working on.
+                        """
+        )
+        super().__init__(message)
+
+
+class InterviewError(Exception):
+    pass
+
+
+class InterviewErrorPriorTaskCanceled(InterviewError):
+    pass
+
+
+class InterviewTimeoutError(InterviewError):
+    pass

edsl/exceptions/language_models.py

@@ -1,63 +1,63 @@
-from textwrap import dedent
-from typing import Optional
-
-
-class LanguageModelExceptions(Exception):
-    explanation = (
-        "This is the base class for all exceptions in the LanguageModel class."
-    )
-
-    def __init__(self, message):
-        super().__init__(message)
-        self.message = message
-
-
-class LanguageModelNoResponseError(LanguageModelExceptions):
-    explanation = (
-        """This happens when the LLM API cannot be reached and/or does not respond."""
-    )
-
-    def __init__(self, message):
-        super().__init__(message)
-
-
-class LanguageModelBadResponseError(LanguageModelExceptions):
-    explanation = """This happens when the LLM API can be reached and responds, does not return a usable answer."""
-
-    def __init__(self, message, response_json: Optional[dict] = None):
-        super().__init__(message)
-        self.response_json = response_json
-
-
-class LanguageModelNotFound(LanguageModelExceptions):
-    def __init__(self, model_name):
-        msg = dedent(
-            f"""\
-            Model {model_name} not found.
-            To create an instance, you can do: 
-            >>> m = Model('gpt-4-1106-preview', temperature=0.5, ...)
-            
-            To get the default model, you can leave out the model name. 
-            To see the available models, you can do:
-            >>> Model.available()
-
-            See https://docs.expectedparrot.com/en/latest/language_models.html#available-models for more details.
-            """
-        )
-        super().__init__(msg)
-
-
-class LanguageModelResponseNotJSONError(LanguageModelExceptions):
-    pass
-
-
-class LanguageModelMissingAttributeError(LanguageModelExceptions):
-    pass
-
-
-class LanguageModelAttributeTypeError(LanguageModelExceptions):
-    pass
-
-
-class LanguageModelDoNotAddError(LanguageModelExceptions):
-    pass
+from textwrap import dedent
+from typing import Optional
+
+
+class LanguageModelExceptions(Exception):
+    explanation = (
+        "This is the base class for all exceptions in the LanguageModel class."
+    )
+
+    def __init__(self, message):
+        super().__init__(message)
+        self.message = message
+
+
+class LanguageModelNoResponseError(LanguageModelExceptions):
+    explanation = (
+        """This happens when the LLM API cannot be reached and/or does not respond."""
+    )
+
+    def __init__(self, message):
+        super().__init__(message)
+
+
+class LanguageModelBadResponseError(LanguageModelExceptions):
+    explanation = """This happens when the LLM API can be reached and responds, does not return a usable answer."""
+
+    def __init__(self, message, response_json: Optional[dict] = None):
+        super().__init__(message)
+        self.response_json = response_json
+
+
+class LanguageModelNotFound(LanguageModelExceptions):
+    def __init__(self, model_name):
+        msg = dedent(
+            f"""\
+            Model {model_name} not found.
+            To create an instance, you can do: 
+            >>> m = Model('gpt-4-1106-preview', temperature=0.5, ...)
+            
+            To get the default model, you can leave out the model name. 
+            To see the available models, you can do:
+            >>> Model.available()
+
+            See https://docs.expectedparrot.com/en/latest/language_models.html#available-models for more details.
+            """
+        )
+        super().__init__(msg)
+
+
+class LanguageModelResponseNotJSONError(LanguageModelExceptions):
+    pass
+
+
+class LanguageModelMissingAttributeError(LanguageModelExceptions):
+    pass
+
+
+class LanguageModelAttributeTypeError(LanguageModelExceptions):
+    pass
+
+
+class LanguageModelDoNotAddError(LanguageModelExceptions):
+    pass

edsl/exceptions/prompts.py

@@ -1,15 +1,15 @@
-class PromptError(Exception):
-    pass
-
-
-class TemplateRenderError(PromptError):
-    "TODO: Move to exceptions file"
-    pass
-
-
-class PromptBadQuestionTypeError(PromptError):
-    pass
-
-
-class PromptBadLanguageModelTypeError(PromptError):
-    pass
+class PromptError(Exception):
+    pass
+
+
+class TemplateRenderError(PromptError):
+    "TODO: Move to exceptions file"
+    pass
+
+
+class PromptBadQuestionTypeError(PromptError):
+    pass
+
+
+class PromptBadLanguageModelTypeError(PromptError):
+    pass

edsl/exceptions/questions.py

@@ -1,91 +1,91 @@
-from typing import Any, SupportsIndex
-from jinja2 import Template
-import json
-
-
-class QuestionErrors(Exception):
-    """
-    Base exception class for question-related errors.
-    """
-
-    def __init__(self, message="An error occurred with the question"):
-        self.message = message
-        super().__init__(self.message)
-
-
-class QuestionAnswerValidationError(QuestionErrors):
-    documentation = "https://docs.expectedparrot.com/en/latest/exceptions.html"
-
-    explanation = """This when the answer coming from the Language Model does not conform to the expectation for that question type.
-    For example, if the question is a multiple choice question, the answer should be drawn from the list of options provided.
-    """
-
-    def __init__(self, message="Invalid answer.", data=None, model=None):
-        self.message = message
-        self.data = data
-        self.model = model
-        super().__init__(self.message)
-
-    def __str__(self):
-        return f"""{repr(self)} 
-        Data being validated: {self.data} 
-        Pydnantic Model: {self.model}.
-        Reported error: {self.message}."""
-
-    def to_html_dict(self):
-        return {
-            "error_type": ("Name of the exception", "p", "/p", self.__class__.__name__),
-            "explaination": ("Explanation", "p", "/p", self.explanation),
-            "edsl answer": (
-                "What model returned",
-                "pre",
-                "/pre",
-                json.dumps(self.data, indent=2),
-            ),
-            "validating_model": (
-                "Pydantic model for answers",
-                "pre",
-                "/pre",
-                json.dumps(self.model.model_json_schema(), indent=2),
-            ),
-            "error_message": (
-                "Error message Pydantic returned",
-                "p",
-                "/p",
-                self.message,
-            ),
-            "documentation_url": (
-                "URL to EDSL docs",
-                f"a href='{self.documentation}'",
-                "/a",
-                self.documentation,
-            ),
-        }
-
-
-class QuestionCreationValidationError(QuestionErrors):
-    pass
-
-
-class QuestionResponseValidationError(QuestionErrors):
-    pass
-
-
-class QuestionAttributeMissing(QuestionErrors):
-    pass
-
-
-class QuestionSerializationError(QuestionErrors):
-    pass
-
-
-class QuestionScenarioRenderError(QuestionErrors):
-    pass
-
-
-class QuestionMissingTypeError(QuestionErrors):
-    pass
-
-
-class QuestionBadTypeError(QuestionErrors):
-    pass
+from typing import Any, SupportsIndex
+from jinja2 import Template
+import json
+
+
+class QuestionErrors(Exception):
+    """
+    Base exception class for question-related errors.
+    """
+
+    def __init__(self, message="An error occurred with the question"):
+        self.message = message
+        super().__init__(self.message)
+
+
+class QuestionAnswerValidationError(QuestionErrors):
+    documentation = "https://docs.expectedparrot.com/en/latest/exceptions.html"
+
+    explanation = """This when the answer coming from the Language Model does not conform to the expectation for that question type.
+    For example, if the question is a multiple choice question, the answer should be drawn from the list of options provided.
+    """
+
+    def __init__(self, message="Invalid answer.", data=None, model=None):
+        self.message = message
+        self.data = data
+        self.model = model
+        super().__init__(self.message)
+
+    def __str__(self):
+        return f"""{repr(self)} 
+        Data being validated: {self.data} 
+        Pydnantic Model: {self.model}.
+        Reported error: {self.message}."""
+
+    def to_html_dict(self):
+        return {
+            "error_type": ("Name of the exception", "p", "/p", self.__class__.__name__),
+            "explaination": ("Explanation", "p", "/p", self.explanation),
+            "edsl answer": (
+                "What model returned",
+                "pre",
+                "/pre",
+                json.dumps(self.data, indent=2),
+            ),
+            "validating_model": (
+                "Pydantic model for answers",
+                "pre",
+                "/pre",
+                json.dumps(self.model.model_json_schema(), indent=2),
+            ),
+            "error_message": (
+                "Error message Pydantic returned",
+                "p",
+                "/p",
+                self.message,
+            ),
+            "documentation_url": (
+                "URL to EDSL docs",
+                f"a href='{self.documentation}'",
+                "/a",
+                self.documentation,
+            ),
+        }
+
+
+class QuestionCreationValidationError(QuestionErrors):
+    pass
+
+
+class QuestionResponseValidationError(QuestionErrors):
+    pass
+
+
+class QuestionAttributeMissing(QuestionErrors):
+    pass
+
+
+class QuestionSerializationError(QuestionErrors):
+    pass
+
+
+class QuestionScenarioRenderError(QuestionErrors):
+    pass
+
+
+class QuestionMissingTypeError(QuestionErrors):
+    pass
+
+
+class QuestionBadTypeError(QuestionErrors):
+    pass