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

edsl/instructions/change_instruction.py

@@ -1,5 +1,5 @@
 from typing import List, Optional
-from edsl.utilities.remove_edsl_version import remove_edsl_version
+from ..utilities.remove_edsl_version import remove_edsl_version
 
 
 class ChangeInstruction:
@@ -9,11 +9,12 @@ class ChangeInstruction:
         drop: Optional[List[str]] = None,
     ):
         if keep is None and drop is None:
-            from edsl.instructions.exceptions import InstructionValueError
+            from .exceptions import InstructionValueError
             raise InstructionValueError("Keep and drop cannot both be None")
 
         self.keep = keep or []
         self.drop = drop or []
+        self.pseudo_index = 0.0
 
     def include_instruction(self, instruction_name) -> bool:
         return (instruction_name in self.keep) or (instruction_name not in self.drop)
@@ -30,7 +31,7 @@ class ChangeInstruction:
             "drop": self.drop,
         }
         if add_edsl_version:
-            from edsl import __version__
+            from .. import __version__
 
             d["edsl_version"] = __version__
             d["edsl_class_name"] = "ChangeInstruction"
@@ -39,7 +40,7 @@ class ChangeInstruction:
 
     def __hash__(self) -> int:
         """Return a hash of the question."""
-        from edsl.utilities.utilities import dict_hash
+        from ..utilities.utilities import dict_hash
 
         return dict_hash(self.to_dict(add_edsl_version=False))
 

edsl/instructions/instruction.py

@@ -14,6 +14,7 @@ class Instruction(RepresentationMixin):
         self.name = name
         self.text = text
         self.preamble = preamble
+        self.pseudo_index = 0.0
 
     def __str__(self):
         return self.text

edsl/instructions/instruction_collection.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING, Dict, List, Generator, Union
+from typing import TYPE_CHECKING, Dict, List, Generator, Union, Tuple
 from collections import UserDict
 
 from .instruction import Instruction
@@ -40,13 +40,14 @@ class InstructionCollection(UserDict):
 
     def _entries_before(
         self, question_name
-    ) -> tuple[List[Instruction], List[ChangeInstruction]]:
+    ) -> Tuple[List[Instruction], List[ChangeInstruction]]:
         if question_name not in self.question_names:
-            from edsl.instructions.exceptions import InstructionCollectionError
+            from .exceptions import InstructionCollectionError
             raise InstructionCollectionError(
                 f"Question name not found in the list of questions: got '{question_name}'; list is {self.question_names}"
             )
-        instructions, changes = [], []
+        instructions: List[Instruction] = []
+        changes: List[ChangeInstruction] = []
 
         index = self.question_index(question_name)
         for instruction in self.instruction_names_to_instruction.values():

edsl/instructions/instruction_handler.py

@@ -1,11 +1,13 @@
 from dataclasses import dataclass
 
 
+from typing import Dict, List, Any
+
 @dataclass
 class SeparatedComponents:
-    true_questions: list
-    instruction_names_to_instructions: dict
-    pseudo_indices: dict
+    true_questions: List[Any]
+    instruction_names_to_instructions: Dict[str, Any]
+    pseudo_indices: Dict[str, float]
 
 
 class InstructionHandler:
@@ -13,7 +15,7 @@ class InstructionHandler:
         self.survey = survey
 
     @staticmethod
-    def separate_questions_and_instructions(questions_and_instructions: list) -> tuple:
+    def separate_questions_and_instructions(questions_and_instructions: list) -> SeparatedComponents:
         """
         The 'pseudo_indices' attribute is a dictionary that maps question names to pseudo-indices
         that are used to order questions and instructions in the survey.
@@ -48,9 +50,9 @@ class InstructionHandler:
         """
         from .instruction import Instruction
         from .change_instruction import ChangeInstruction
-        from edsl.questions import QuestionBase
+        from ..questions import QuestionBase
 
-        true_questions = []
+        true_questions: List[QuestionBase] = []
         instruction_names_to_instructions = {}
 
         num_change_instructions = 0
@@ -63,7 +65,7 @@ class InstructionHandler:
                     num_change_instructions += 1
                     for prior_instruction in entry.keep + entry.drop:
                         if prior_instruction not in instruction_names_to_instructions:
-                            from edsl.instructions.exceptions import InstructionValueError
+                            from .exceptions import InstructionValueError
                             raise InstructionValueError(
                                 f"ChangeInstruction {entry.name} references instruction {prior_instruction} which does not exist."
                             )
@@ -77,7 +79,7 @@ class InstructionHandler:
                 instructions_run_length = 0
                 true_questions.append(entry)
             else:
-                from edsl.instructions.exceptions import InstructionValueError
+                from .exceptions import InstructionValueError
                 raise InstructionValueError(
                     f"Entry {repr(entry)} is not a QuestionBase or an Instruction."
                 )

edsl/interviews/exception_tracking.py

@@ -92,7 +92,7 @@ class InterviewExceptionEntry:
     def code(self, run=True):
         """Return the code to reproduce the exception."""
         lines = []
-        lines.append("from edsl import Question, Model, Scenario, Agent")
+        lines.append("from .. import Question, Model, Scenario, Agent")
 
         lines.append(f"q = {repr(self.invigilator.question)}")
         lines.append(f"scenario = {repr(self.invigilator.scenario)}")

edsl/interviews/interview.py

@@ -365,7 +365,7 @@ class Interview:
             bool: True if the interviews are equivalent, False otherwise
             
         Examples:
-            >>> from edsl.interviews import Interview
+            >>> from . import Interview
             >>> i = Interview.example()
             >>> d = i.to_dict()
             >>> i2 = Interview.from_dict(d)

edsl/interviews/interview_status_dictionary.py

@@ -27,7 +27,7 @@ class InterviewStatusDictionary(UserDict):
     ) -> "InterviewStatusDictionary":
         """Adds two InterviewStatusDictionaries together."""
         if not isinstance(other, InterviewStatusDictionary):
-            from edsl.interviews.exceptions import InterviewStatusError
+            from .exceptions import InterviewStatusError
             raise InterviewStatusError(f"Can't add {type(other)} to InterviewStatusDictionary")
         new_dict = {}
         for key in self.keys():

edsl/interviews/interview_task_manager.py

@@ -29,7 +29,7 @@ class InterviewTaskManager:
         self, answer_func, token_estimator, model_buckets
     ) -> list[asyncio.Task]:
         """Create tasks for all questions with proper dependencies."""
-        tasks = []
+        tasks: list[asyncio.Task] = []
         for question in self.survey.questions:
             dependencies = self._get_task_dependencies(tasks, question)
             task = self._create_single_task(
@@ -40,7 +40,7 @@ class InterviewTaskManager:
                 model_buckets=model_buckets,
             )
             tasks.append(task)
-        return tuple(tasks)
+        return tasks
 
     def _get_task_dependencies(
         self, existing_tasks: list[asyncio.Task], question: "QuestionBase"

edsl/interviews/request_token_estimator.py

@@ -26,9 +26,10 @@ class RequestTokenEstimator:
                     if isinstance(file, FileStore):
                         file_tokens += file.size * 0.25
             else:
-                from edsl.interviews.exceptions import InterviewTokenError
+                from .exceptions import InterviewTokenError
                 raise InterviewTokenError(f"Prompt is of type {type(prompt)}")
-        return len(combined_text) / 4.0 + file_tokens
+        result: float = len(combined_text) / 4.0 + file_tokens
+        return result
 
 
 

edsl/interviews/statistics.py

@@ -1,5 +1,5 @@
 from collections import UserDict
-from typing import DefaultDict
+from typing import DefaultDict, Union, Optional
 
 from ..tokens import InterviewTokenUsage
 
@@ -43,7 +43,7 @@ class InterviewStatistic(UserDict):
         value: float,
         digits: int = 0,
         units: str = "",
-        pretty_name: str = None,
+        pretty_name: Optional[str] = None,
     ):
         """Create a new InterviewStatistic object."""
         self.name = name

edsl/invigilators/invigilators.py

@@ -6,7 +6,7 @@ from typing import Literal
 
 from ..utilities.decorators import sync_wrapper
 from ..questions.exceptions import QuestionAnswerValidationError
-from ..data_transfer_models import AgentResponseDict, EDSLResultObjectInput
+from ..base.data_transfer_models import AgentResponseDict, EDSLResultObjectInput
 from ..utilities.decorators import jupyter_nb_handler
 
 from .prompt_constructor import PromptConstructor
@@ -280,7 +280,7 @@ class InvigilatorAI(InvigilatorBase):
         }
         if "encoded_image" in prompts:
             params["encoded_image"] = prompts["encoded_image"]
-            from edsl.invigilators.exceptions import InvigilatorNotImplementedError
+            from .exceptions import InvigilatorNotImplementedError
             raise InvigilatorNotImplementedError("encoded_image not implemented")
 
         if "files_list" in prompts:

edsl/jobs/__init__.py

@@ -1,7 +1,44 @@
+"""
+The jobs module provides tools for running and managing EDSL jobs.
+
+It includes classes for job configuration, execution, pricing estimation,
+and management of concurrent language model API calls.
+"""
+
 from .jobs import Jobs
 from .jobs import RunConfig, RunParameters, RunEnvironment  # noqa: F401
 from .remote_inference import JobsRemoteInferenceHandler  # noqa: F401
 from .jobs_runner_status import JobsRunnerStatusBase  # noqa: F401
+from .exceptions import (
+    JobsErrors,
+    JobsRunError,
+    MissingRemoteInferenceError,
+    InterviewError,
+    InterviewErrorPriorTaskCanceled,
+    InterviewTimeoutError,
+    JobsValueError,
+    JobsCompatibilityError,
+    JobsImplementationError,
+    RemoteInferenceError,
+    JobsTypeError
+)
 
-
-__all__ = ["Jobs"]
+__all__ = [
+    "Jobs",
+    "JobsErrors",
+    "JobsRunError",
+    "MissingRemoteInferenceError",
+    "InterviewError",
+    "InterviewErrorPriorTaskCanceled",
+    "InterviewTimeoutError",
+    "JobsValueError",
+    "JobsCompatibilityError",
+    "JobsImplementationError",
+    "RemoteInferenceError",
+    "JobsTypeError",
+    "JobsRemoteInferenceHandler",
+    "JobsRunnerStatusBase",
+    "RunConfig",
+    "RunParameters",
+    "RunEnvironment"
+]

edsl/jobs/async_interview_runner.py

@@ -9,7 +9,7 @@ from collections.abc import AsyncGenerator
 from typing import List, Generator, Tuple, TYPE_CHECKING
 from dataclasses import dataclass
 import asyncio
-from edsl.data_transfer_models import EDSLResultObjectInput
+from ..data_transfer_models import EDSLResultObjectInput
 
 from ..results import Result
 from ..interviews import Interview

edsl/jobs/check_survey_scenario_compatibility.py

@@ -1,12 +1,12 @@
 import warnings
 from typing import TYPE_CHECKING
-from edsl.scenarios import ScenarioList
-from edsl.surveys import Survey
-from edsl.jobs.exceptions import JobsCompatibilityError
+from ..scenarios import ScenarioList
+from ..surveys import Survey
+from .exceptions import JobsCompatibilityError
 
 if TYPE_CHECKING:
-    from edsl.surveys.Survey import Survey
-    from edsl.scenarios.ScenarioList import ScenarioList
+    from ..surveys.survey import Survey
+    from ..scenarios.scenario_list import ScenarioList
 
 
 class CheckSurveyScenarioCompatibility:

edsl/jobs/data_structures.py

@@ -1,7 +1,7 @@
 from typing import Optional, Literal, TYPE_CHECKING
 from dataclasses import dataclass, asdict
 from collections import UserDict
-from edsl.data_transfer_models import EDSLResultObjectInput
+from ..data_transfer_models import EDSLResultObjectInput
 
 # from edsl.data_transfer_models import VisibilityType
 from ..caching import Cache
@@ -86,7 +86,7 @@ class RunParameters(Base):
     def to_dict(self, add_edsl_version=False) -> dict:
         d = asdict(self)
         if add_edsl_version:
-            from edsl import __version__
+            from .. import __version__
 
             d["edsl_version"] = __version__
             d["edsl_class_name"] = "RunConfig"

edsl/jobs/jobs.py

@@ -620,7 +620,7 @@ class Jobs(Base):
         if jh.use_remote_inference(self.run_config.parameters.disable_remote_inference):
             job_info: RemoteJobInfo = self._start_remote_inference_job(jh)
             if background:
-                from edsl.results import Results
+                from ..results import Results
 
                 results = Results.from_job_info(job_info)
                 return results, None
@@ -881,7 +881,7 @@ class Jobs(Base):
             ],
         }
         if add_edsl_version:
-            from edsl import __version__
+            from .. import __version__
 
             d["edsl_version"] = __version__
             d["edsl_class_name"] = "Jobs"

edsl/jobs/jobs_checks.py

@@ -3,7 +3,7 @@ Checks a Jobs object for missing API keys and other requirements.
 """
 
 import os
-from edsl.key_management.key_lookup_builder import MissingAPIKeyError
+from ..key_management.key_lookup_builder import MissingAPIKeyError
 
 
 class JobsChecks:
@@ -16,7 +16,7 @@ class JobsChecks:
         self.jobs = jobs
 
     def check_api_keys(self) -> None:
-        from edsl.language_models.model import Model
+        from ..language_models.model import Model
 
         if len(self.jobs.models) == 0:
             models = [Model()]
@@ -37,7 +37,7 @@ class JobsChecks:
         """
         missing_api_keys = set()
 
-        from edsl.enums import service_to_api_keyname
+        from ..enums import service_to_api_keyname
 
         for model in self.jobs.models: # + [Model()]:
             if not model.has_valid_api_key():
@@ -134,8 +134,8 @@ class JobsChecks:
     def key_process(self):
         import secrets
         from dotenv import load_dotenv
-        from edsl.coop.coop import Coop
-        from edsl.utilities.utilities import write_api_key_to_env
+        from ..coop.coop import Coop
+        from ..utilities.utilities import write_api_key_to_env
 
         missing_api_keys = self.get_missing_api_keys()
 

edsl/jobs/jobs_component_constructor.py

@@ -140,8 +140,8 @@ class JobsComponentConstructor:
 
     @staticmethod
     def _get_empty_container_object(object):
-        from edsl.agents import AgentList
-        from edsl.scenarios import ScenarioList
+        from ..agents import AgentList
+        from ..scenarios import ScenarioList
 
         return {"Agent": AgentList([]), "Scenario": ScenarioList([])}.get(
             object.__class__.__name__, []

edsl/jobs/jobs_pricing_estimation.py

@@ -137,7 +137,7 @@ class JobsPrompts:
     def price_lookup(self) -> dict:
         """Fetches the price lookup from Coop if it is not already cached."""
         if self._price_lookup is None:
-            from edsl.coop.coop import Coop
+            from ..coop.coop import Coop
 
             c = Coop()
             self._price_lookup = c.fetch_prices()

edsl/jobs/jobs_runner_asyncio.py

@@ -186,7 +186,7 @@ class JobsRunnerAsyncio:
         self.start_time = time.monotonic()
         self.completed = False
 
-        from edsl.coop import Coop
+        from ..coop import Coop
 
         coop = Coop()
         endpoint_url = coop.get_progress_bar_url()
@@ -273,7 +273,7 @@ class JobsRunnerAsyncio:
             # breakpoint()
             results.bucket_collection = self.environment.bucket_collection
 
-            from edsl.jobs.results_exceptions_handler import ResultsExceptionsHandler
+            from .results_exceptions_handler import ResultsExceptionsHandler
 
             results_exceptions_handler = ResultsExceptionsHandler(results, parameters)
 

edsl/jobs/remote_inference.py

@@ -43,7 +43,7 @@ class JobsRemoteInferenceHandler:
         self.verbose = verbose
         self.poll_interval = poll_interval
 
-        from edsl.config import CONFIG
+        from ..config import CONFIG
 
         self.expected_parrot_url = CONFIG.get("EXPECTED_PARROT_URL")
         self.remote_inference_url = f"{self.expected_parrot_url}/home/remote-inference"

edsl/jobs/results_exceptions_handler.py

@@ -1,8 +1,8 @@
 from typing import Protocol
 import sys
 #from edsl.scenarios.FileStore import HTMLFileStore
-from edsl.config import CONFIG
-from edsl.coop.coop import Coop
+from ..config import CONFIG
+from ..coop.coop import Coop
 from ..scenarios import FileStore
 from .exceptions import JobsErrors
 

edsl/language_models/language_model.py

@@ -231,12 +231,16 @@ class LanguageModel(
         for key, value in kwargs.items():
             if key not in parameters:
                 setattr(self, key, value)
-
+            
         # Handle API key check skip for testing
         if kwargs.get("skip_api_key_check", False):
             # Skip the API key check. Sometimes this is useful for testing.
             self._api_token = None
 
+        # Add canned response to parameters
+        if "canned_response" in kwargs:
+            self.parameters["canned_response"] = kwargs["canned_response"]
+
     def _set_key_lookup(self, key_lookup: "KeyLookup") -> "KeyLookup":
         """Set up the API key lookup mechanism.
         

edsl/notebooks/__init__.py

@@ -1,3 +1,26 @@
+"""
+The notebooks module provides tools for working with Jupyter notebooks.
+
+It includes classes for notebook creation, manipulation, and conversion
+to other formats such as LaTeX.
+"""
+
 from .notebook import Notebook
+from .notebook_to_latex import NotebookToLaTeX
+from .exceptions import (
+    NotebookError,
+    NotebookValueError,
+    NotebookFormatError,
+    NotebookConversionError,
+    NotebookEnvironmentError,
+)
 
-__all__ = ["Notebook"]
+__all__ = [
+    "Notebook", 
+    "NotebookToLaTeX",
+    "NotebookError",
+    "NotebookValueError",
+    "NotebookFormatError", 
+    "NotebookConversionError",
+    "NotebookEnvironmentError",
+]

edsl/notebooks/exceptions.py

@@ -0,0 +1,82 @@
+"""
+Custom exceptions for the notebooks module.
+"""
+
+from ..base import BaseException
+
+
+class NotebookError(BaseException):
+    """
+    Base exception class for all notebook-related errors.
+    
+    This is the parent class for all exceptions related to notebook
+    operations, including creation, validation, and conversion.
+    """
+    relevant_doc = "https://docs.expectedparrot.com/"
+
+
+class NotebookValueError(NotebookError):
+    """
+    Exception raised when an invalid value is provided to a notebook method.
+    
+    This exception occurs when attempting to create or modify a notebook
+    with invalid values, such as:
+    - Invalid data format
+    - Incompatible notebook contents
+    
+    Examples:
+        ```python
+        # Attempting to create a notebook with invalid data
+        notebook = Notebook(data=invalid_data)  # Raises NotebookValueError
+        ```
+    """
+    relevant_doc = "https://docs.expectedparrot.com/"
+    
+
+class NotebookFormatError(NotebookError):
+    """
+    Exception raised when a notebook's format is invalid.
+    
+    This exception occurs when the notebook structure does not conform
+    to the expected Jupyter Notebook format.
+    
+    Examples:
+        ```python
+        # Attempting to load a notebook with invalid format
+        notebook = Notebook.from_dict(invalid_dict)  # Raises NotebookFormatError
+        ```
+    """
+    relevant_doc = "https://docs.expectedparrot.com/"
+
+
+class NotebookConversionError(NotebookError):
+    """
+    Exception raised when a notebook conversion fails.
+    
+    This exception occurs when attempting to convert a notebook to another
+    format (like LaTeX) and the conversion process fails.
+    
+    Examples:
+        ```python
+        # Attempting to convert a notebook to LaTeX with invalid options
+        notebook.to_latex(invalid_options)  # Raises NotebookConversionError
+        ```
+    """
+    relevant_doc = "https://docs.expectedparrot.com/"
+
+
+class NotebookEnvironmentError(NotebookError):
+    """
+    Exception raised when the notebook environment is not supportable.
+    
+    This exception occurs when attempting to create a notebook in an 
+    environment that doesn't provide required context, such as when
+    trying to create a notebook from within itself outside of VS Code.
+    
+    Examples:
+        ```python
+        # Attempting to create a notebook from within itself in an unsupported IDE
+        notebook = Notebook()  # Raises NotebookEnvironmentError
+        ```
+    """
+    relevant_doc = "https://docs.expectedparrot.com/"

edsl/notebooks/notebook.py

@@ -2,7 +2,10 @@
 
 from __future__ import annotations
 import json
-from typing import Dict, List, Optional
+from typing import Dict, List, Optional, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from rich.table import Table
 from uuid import uuid4
 
 from ..base import Base
@@ -47,7 +50,8 @@ class Notebook(Base):
             self.data = json.loads(json.dumps(data))
         else:
             # TODO: Support for IDEs other than VSCode
-            raise NotImplementedError(
+            from .exceptions import NotebookEnvironmentError
+            raise NotebookEnvironmentError(
                 "Cannot create a notebook from within itself in this development environment"
             )
 
@@ -251,7 +255,7 @@ class Notebook(Base):
 
         :param filename: Name of the output folder and main tex file (without extension)
         """
-        from .NotebookToLaTeX import NotebookToLaTeX
+        from .notebook_to_latex import NotebookToLaTeX
 
         NotebookToLaTeX(self).convert(filename)
 

edsl/notebooks/notebook_to_latex.py

@@ -122,7 +122,7 @@ To clean up build files:
 
 # Example usage:
 if __name__ == "__main__":
-    from edsl import Notebook
+    from .. import Notebook
 
     # Create or load a notebook
     notebook = Notebook.example()

edsl/prompts/__init__.py

@@ -1,4 +1,25 @@
-# from edsl.prompts.registry import get_classes
+"""
+The prompts module provides tools for creating and managing prompts.
+
+It includes classes for template-based prompts with variable substitution,
+prompt rendering, and component management for language model interactions.
+"""
 from .prompt import Prompt
+from .exceptions import (
+    PromptError,
+    TemplateRenderError,
+    PromptBadQuestionTypeError,
+    PromptBadLanguageModelTypeError,
+    PromptValueError,
+    PromptImplementationError
+)
 
-__all__ = ["Prompt"]
+__all__ = [
+    "Prompt",
+    "PromptError", 
+    "TemplateRenderError",
+    "PromptBadQuestionTypeError", 
+    "PromptBadLanguageModelTypeError",
+    "PromptValueError",
+    "PromptImplementationError"
+]

edsl/prompts/prompt.py

@@ -145,7 +145,7 @@ class Prompt(PersistenceMixin, RepresentationMixin):
         if path_to_folder is None:
             from importlib import resources
 
-            path_to_folder = resources.path("edsl.questions", "prompt_templates")
+            path_to_folder = resources.path("..questions", "prompt_templates")
 
         try:
             folder_path = Path(path_to_folder)