edsl 0.1.39.dev1__py3-none-any.whl → 0.1.39.dev2__py3-none-any.whl

edsl/questions/QuestionBase.py

@@ -3,30 +3,26 @@
 from __future__ import annotations
 from abc import ABC, abstractmethod
 from typing import Any, Type, Optional, List, Callable, Union, TypedDict
-import copy
 
-from edsl.exceptions import (
-    QuestionResponseValidationError,
-    QuestionAnswerValidationError,
+from edsl.exceptions.questions import (
     QuestionSerializationError,
 )
 from edsl.questions.descriptors import QuestionNameDescriptor, QuestionTextDescriptor
 
-
 from edsl.questions.AnswerValidatorMixin import AnswerValidatorMixin
 from edsl.questions.RegisterQuestionsMeta import RegisterQuestionsMeta
-from edsl.Base import PersistenceMixin, RichPrintingMixin
+from edsl.Base import PersistenceMixin, RepresentationMixin
 from edsl.BaseDiff import BaseDiff, BaseDiffCollection
 
 from edsl.questions.SimpleAskMixin import SimpleAskMixin
 from edsl.questions.QuestionBasePromptsMixin import QuestionBasePromptsMixin
 from edsl.questions.QuestionBaseGenMixin import QuestionBaseGenMixin
-from edsl.utilities.decorators import add_edsl_version, remove_edsl_version
+from edsl.utilities.remove_edsl_version import remove_edsl_version
 
 
 class QuestionBase(
     PersistenceMixin,
-    RichPrintingMixin,
+    RepresentationMixin,
     SimpleAskMixin,
     QuestionBasePromptsMixin,
     QuestionBaseGenMixin,
@@ -36,6 +32,14 @@ class QuestionBase(
 ):
     """ABC for the Question class. All questions inherit from this class.
     Some of the constraints on child questions are defined in the RegisterQuestionsMeta metaclass.
+
+
+    Every child class wiill have class attributes of question_type, _response_model and response_validator_class e.g.,
+
+        question_type = "free_text"
+        _response_model = FreeTextResponse
+        response_validator_class = FreeTextResponseValidator
+
     """
 
     question_name: str = QuestionNameDescriptor()
@@ -44,37 +48,13 @@ class QuestionBase(
     _answering_instructions = None
     _question_presentation = None
 
-    @property
-    def response_model(self) -> type["BaseModel"]:
-        if self._response_model is not None:
-            return self._response_model
-        else:
-            return self.create_response_model()
-
-    # region: Validation and simulation methods
     @property
     def response_validator(self) -> "ResponseValidatorBase":
         """Return the response validator."""
-        params = (
-            {
-                "response_model": self.response_model,
-            }
-            | {k: getattr(self, k) for k in self.validator_parameters}
-            | {"exception_to_throw": getattr(self, "exception_to_throw", None)}
-            | {"override_answer": getattr(self, "override_answer", None)}
-        )
-        return self.response_validator_class(**params)
-
-    @property
-    def validator_parameters(self) -> list[str]:
-        """Return the parameters required for the response validator.
+        from edsl.questions.ResponseValidatorFactory import ResponseValidatorFactory
 
-        >>> from edsl import QuestionMultipleChoice as Q
-        >>> Q.example().validator_parameters
-        ['question_options', 'use_code']
-
-        """
-        return self.response_validator_class.required_params
+        rvf = ResponseValidatorFactory(self)
+        return rvf.response_validator
 
     @property
     def fake_data_factory(self):
@@ -82,8 +62,7 @@ class QuestionBase(
         if not hasattr(self, "_fake_data_factory"):
             from polyfactory.factories.pydantic_factory import ModelFactory
 
-            class FakeData(ModelFactory[self.response_model]):
-                ...
+            class FakeData(ModelFactory[self.response_model]): ...
 
             self._fake_data_factory = FakeData
         return self._fake_data_factory
@@ -110,17 +89,14 @@ class QuestionBase(
         self, answer: dict, replacement_dict: dict = None
     ) -> ValidatedAnswer:
         """Validate the answer.
-        >>> from edsl.exceptions import QuestionAnswerValidationError
-        >>> from edsl import QuestionFreeText as Q
+        >>> from edsl.exceptions.questions import QuestionAnswerValidationError
+        >>> from edsl.questions import QuestionFreeText as Q
         >>> Q.example()._validate_answer({'answer': 'Hello', 'generated_tokens': 'Hello'})
         {'answer': 'Hello', 'generated_tokens': 'Hello'}
         """
 
         return self.response_validator.validate(answer, replacement_dict)
 
-    # endregion
-
-    # region: Serialization methods
     @property
     def name(self) -> str:
         "Helper function so questions and instructions can use the same access method"
@@ -141,7 +117,7 @@ class QuestionBase(
     def data(self) -> dict:
         """Return a dictionary of question attributes **except** for question_type.
 
-        >>> from edsl import QuestionFreeText as Q
+        >>> from edsl.questions import QuestionFreeText as Q
         >>> Q.example().data
         {'question_name': 'how_are_you', 'question_text': 'How are you?'}
         """
@@ -186,7 +162,7 @@ class QuestionBase(
     def to_dict(self, add_edsl_version=True):
         """Convert the question to a dictionary that includes the question type (used in deserialization).
 
-        >>> from edsl import QuestionFreeText as Q; Q.example().to_dict(add_edsl_version = False)
+        >>> from edsl.questions import QuestionFreeText as Q; Q.example().to_dict(add_edsl_version = False)
         {'question_name': 'how_are_you', 'question_text': 'How are you?', 'question_type': 'free_text'}
         """
         candidate_data = self.data.copy()
@@ -264,12 +240,10 @@ class QuestionBase(
         >>> m.execute_model_call("", "")
         {'message': [{'text': "Yo, what's up?"}], 'usage': {'prompt_tokens': 1, 'completion_tokens': 1}}
         >>> Q.run_example(show_answer = True, model = m, disable_remote_cache = True, disable_remote_inference = True)
-        answer.how_are_you
-        --------------------
-        Yo, what's up?
+        Dataset([{'answer.how_are_you': ["Yo, what's up?"]}])
         """
         if model is None:
-            from edsl import Model
+            from edsl.language_models.registry import Model
 
             model = Model()
         results = (
@@ -282,7 +256,7 @@ class QuestionBase(
             )
         )
         if show_answer:
-            return results.select("answer.*").print()
+            return results.select("answer.*")
         else:
             return results
 
@@ -293,6 +267,7 @@ class QuestionBase(
         agent=None,
         disable_remote_cache: bool = False,
         disable_remote_inference: bool = False,
+        verbose: bool = False,
         **kwargs,
     ):
         """Call the question.
@@ -311,6 +286,7 @@ class QuestionBase(
             agent=agent,
             **kwargs,
             cache=False,
+            verbose=verbose,
             disable_remote_cache=disable_remote_cache,
             disable_remote_inference=disable_remote_inference,
         )
@@ -337,7 +313,7 @@ class QuestionBase(
         """Call the question asynchronously.
 
         >>> import asyncio
-        >>> from edsl import QuestionFreeText as Q
+        >>> from edsl.questions import QuestionFreeText as Q
         >>> m = Q._get_test_model(canned_response = "Blue")
         >>> q = Q(question_name = "color", question_text = "What is your favorite color?")
         >>> async def test_run_async(): result = await q.run_async(model=m, disable_remote_inference = True); print(result)
@@ -356,27 +332,6 @@ class QuestionBase(
         else:
             return results
 
-    # endregion
-
-    # region: Magic methods
-    def _repr_html_(self):
-        # from edsl.utilities.utilities import data_to_html
-
-        data = self.to_dict(add_edsl_version=False)
-        # keys = list(data.keys())
-        # values = list(data.values())
-        from tabulate import tabulate
-
-        return tabulate(data.items(), headers=["keys", "values"], tablefmt="html")
-
-        # try:
-        #     _ = data.pop("edsl_version")
-        #     _ = data.pop("edsl_class_name")
-        # except KeyError:
-        #     print("Serialized question lacks edsl version, but is should have it.")
-
-        # return data_to_html(data)
-
     def __getitem__(self, key: str) -> Any:
         """Get an attribute of the question so it can be treated like a dictionary.
 
@@ -384,7 +339,10 @@ class QuestionBase(
         >>> Q.example()['question_text']
         'How are you?'
         """
-        return getattr(self, key)
+        try:
+            return getattr(self, key)
+        except TypeError:
+            raise KeyError(f"Question has no attribute {key} of type {type(key)}")
 
     def __repr__(self) -> str:
         """Return a string representation of the question. Should be able to be used to reconstruct the question.
@@ -414,9 +372,7 @@ class QuestionBase(
         False
 
         """
-        if not isinstance(other, QuestionBase):
-            return False
-        return self.to_dict() == other.to_dict()
+        return hash(self) == hash(other)
 
     def __sub__(self, other) -> BaseDiff:
         """Return the difference between two objects.
@@ -433,35 +389,18 @@ class QuestionBase(
     def __add__(self, other_question_or_diff):
         """
         Compose two questions into a single question.
-
-        TODO: Probably getting deprecated.
-
         """
         if isinstance(other_question_or_diff, BaseDiff) or isinstance(
             other_question_or_diff, BaseDiffCollection
         ):
             return other_question_or_diff.apply(self)
 
-        # from edsl.questions import compose_questions
-        # return compose_questions(self, other_question_or_diff)
-
-    # def _validate_response(self, response):
-    #     """Validate the response from the LLM. Behavior depends on the question type."""
-    #     if "answer" not in response:
-    #         raise QuestionResponseValidationError(
-    #             "Response from LLM does not have an answer"
-    #         )
-    #     return response
-
     def _translate_answer_code_to_answer(
         self, answer, scenario: Optional["Scenario"] = None
     ):
         """There is over-ridden by child classes that ask for codes."""
         return answer
 
-    # endregion
-
-    # region: Forward methods
     def add_question(self, other: QuestionBase) -> "Survey":
         """Add a question to this question by turning them into a survey with two questions.
 
@@ -471,10 +410,7 @@ class QuestionBase(
         >>> len(s.questions)
         2
         """
-        from edsl.surveys.Survey import Survey
-
-        s = Survey([self, other])
-        return s
+        return self.to_survey().add_question(other)
 
     def to_survey(self) -> "Survey":
         """Turn a single question into a survey.
@@ -494,15 +430,6 @@ class QuestionBase(
         s = Survey([self])
         return s.by(*args)
 
-    # endregion
-
-    # region: Display methods
-    def print(self):
-        from rich import print_json
-        import json
-
-        print_json(json.dumps(self.to_dict()))
-
     def human_readable(self) -> str:
         """Print the question in a human readable format.
 
@@ -529,97 +456,15 @@ class QuestionBase(
         width: Optional[int] = None,
         iframe=False,
     ):
-        """Return the question in HTML format."""
-        from jinja2 import Template
-
-        if scenario is None:
-            scenario = {}
-
-        prior_answers_dict = {}
-
-        if isinstance(answers, dict):
-            for key, value in answers.items():
-                if not key.endswith("_comment") and not key.endswith(
-                    "_generated_tokens"
-                ):
-                    prior_answers_dict[key] = {"answer": value}
-
-        # breakpoint()
-
-        base_template = """
-        <div id="{{ question_name }}" class="survey_question" data-type="{{ question_type }}">
-            {% if include_question_name %}
-            <p>question_name: {{ question_name }}</p>
-            {% endif %}
-            <p class="question_text">{{ question_text }}</p>
-            {{ question_content }}
-        </div>
-        """
-        if not hasattr(self, "question_type"):
-            self.question_type = "unknown"
-
-        if hasattr(self, "question_html_content"):
-            question_content = self.question_html_content
-        else:
-            question_content = Template("")
+        from edsl.questions.HTMLQuestion import HTMLQuestion
 
-        base_template = Template(base_template)
-
-        context = {
-            "scenario": scenario,
-            "agent": agent,
-        } | prior_answers_dict
-
-        # Render the question text
-        try:
-            question_text = Template(self.question_text).render(context)
-        except Exception as e:
-            print(
-                f"Error rendering question: question_text = {self.question_text}, error = {e}"
-            )
-            question_text = self.question_text
-
-        try:
-            question_content = Template(question_content).render(context)
-        except Exception as e:
-            print(
-                f"Error rendering question: question_content = {question_content}, error = {e}"
-            )
-            question_content = question_content
-
-        try:
-            params = {
-                "question_name": self.question_name,
-                "question_text": question_text,
-                "question_type": self.question_type,
-                "question_content": question_content,
-                "include_question_name": include_question_name,
-            }
-        except Exception as e:
-            raise ValueError(
-                f"Error rendering question: params = {params}, error = {e}"
-            )
-        rendered_html = base_template.render(**params)
-
-        if iframe:
-            import html
-            from IPython.display import display, HTML
-
-            height = height or 200
-            width = width or 600
-            escaped_output = html.escape(rendered_html)
-            # escaped_output = rendered_html
-            iframe = f""""
-            <iframe srcdoc="{ escaped_output }" style="width: {width}px; height: {height}px;"></iframe>
-            """
-            display(HTML(iframe))
-            return None
-
-        return rendered_html
+        return HTMLQuestion(self).html(
+            scenario, agent, answers, include_question_name, height, width, iframe
+        )
 
     @classmethod
     def example_model(cls):
-        from edsl import Model
+        from edsl.language_models.registry import Model
 
         q = cls.example()
         m = Model("test", canned_response=cls._simulate_answer(q)["answer"])

edsl/questions/QuestionBaseGenMixin.py

@@ -21,7 +21,7 @@ class QuestionBaseGenMixin:
     def option_permutations(self) -> list[QuestionBase]:
         """Return a list of questions with all possible permutations of the options.
 
-        >>> from edsl import QuestionMultipleChoice as Q
+        >>> from edsl.questions.QuestionMultipleChoice import QuestionMultipleChoice as Q
         >>> len(Q.example().option_permutations())
         24
         """
@@ -44,61 +44,65 @@ class QuestionBaseGenMixin:
 
         :param scenario_list: The list of scenarios to loop through.
 
-        >>> from edsl import QuestionFreeText
-        >>> from edsl import ScenarioList
+        >>> from edsl.questions.QuestionFreeText import QuestionFreeText
+        >>> from edsl.scenarios.ScenarioList import ScenarioList
         >>> q = QuestionFreeText(question_text = "What are your thoughts on: {{ subject}}?", question_name = "base_{{subject}}")
         >>> len(q.loop(ScenarioList.from_list("subject", ["Math", "Economics", "Chemistry"])))
         3
-
         """
-        from jinja2 import Environment
-        from edsl.questions.QuestionBase import QuestionBase
-
-        starting_name = self.question_name
-        questions = []
-        for index, scenario in enumerate(scenario_list):
-            env = Environment()
-            new_data = self.to_dict().copy()
-            for key, value in [(k, v) for k, v in new_data.items() if v is not None]:
-                if (
-                    isinstance(value, str) or isinstance(value, int)
-                ) and key != "question_options":
-                    new_data[key] = env.from_string(value).render(scenario)
-                elif isinstance(value, list):
-                    new_data[key] = [
-                        env.from_string(v).render(scenario) if isinstance(v, str) else v
-                        for v in value
-                    ]
-                elif isinstance(value, dict):
-                    new_data[key] = {
-                        (
-                            env.from_string(k).render(scenario)
-                            if isinstance(k, str)
-                            else k
-                        ): (
-                            env.from_string(v).render(scenario)
-                            if isinstance(v, str)
-                            else v
-                        )
-                        for k, v in value.items()
-                    }
-                elif key == "question_options" and isinstance(value, str):
-                    new_data[key] = value
-                else:
-                    raise ValueError(
-                        f"Unexpected value type: {type(value)} for key '{key}'"
-                    )
-
-            if new_data["question_name"] == starting_name:
-                new_data["question_name"] = new_data["question_name"] + f"_{index}"
-
-            questions.append(QuestionBase.from_dict(new_data))
-        return questions
+        from edsl.questions.LoopProcessor import LoopProcessor
+
+        lp = LoopProcessor(self)
+        return lp.process_templates(scenario_list)
+
+        # from jinja2 import Environment
+        # from edsl.questions.QuestionBase import QuestionBase
+
+        # starting_name = self.question_name
+        # questions = []
+        # for index, scenario in enumerate(scenario_list):
+        #     env = Environment()
+        #     new_data = self.to_dict().copy()
+        #     for key, value in [(k, v) for k, v in new_data.items() if v is not None]:
+        #         if (
+        #             isinstance(value, str) or isinstance(value, int)
+        #         ) and key != "question_options":
+        #             new_data[key] = env.from_string(value).render(scenario)
+        #         elif isinstance(value, list):
+        #             new_data[key] = [
+        #                 env.from_string(v).render(scenario) if isinstance(v, str) else v
+        #                 for v in value
+        #             ]
+        #         elif isinstance(value, dict):
+        #             new_data[key] = {
+        #                 (
+        #                     env.from_string(k).render(scenario)
+        #                     if isinstance(k, str)
+        #                     else k
+        #                 ): (
+        #                     env.from_string(v).render(scenario)
+        #                     if isinstance(v, str)
+        #                     else v
+        #                 )
+        #                 for k, v in value.items()
+        #             }
+        #         elif key == "question_options" and isinstance(value, str):
+        #             new_data[key] = value
+        #         else:
+        #             raise ValueError(
+        #                 f"Unexpected value type: {type(value)} for key '{key}'"
+        #             )
+
+        #     if new_data["question_name"] == starting_name:
+        #         new_data["question_name"] = new_data["question_name"] + f"_{index}"
+
+        #     questions.append(QuestionBase.from_dict(new_data))
+        # return questions
 
     def render(self, replacement_dict: dict) -> "QuestionBase":
         """Render the question components as jinja2 templates with the replacement dictionary."""
         from jinja2 import Environment
-        from edsl import Scenario
+        from edsl.scenarios.Scenario import Scenario
 
         strings_only_replacement_dict = {
             k: v for k, v in replacement_dict.items() if not isinstance(v, Scenario)

edsl/questions/QuestionBasePromptsMixin.py

@@ -1,8 +1,6 @@
 from importlib import resources
 from typing import Optional
-from edsl.prompts import Prompt
 from edsl.exceptions.questions import QuestionAnswerValidationError
-
 from functools import lru_cache
 
 
@@ -71,7 +69,7 @@ class QuestionBasePromptsMixin:
         >>> q.get_instructions(model = "gpt3")
         Prompt(text=\"""{{question_text}}. Answer in valid JSON like so {'answer': 'comment: <>}\""")
         """
-        from edsl import Model
+        from edsl.language_models.registry import Model
 
         if not hasattr(self, "_model_instructions"):
             self._model_instructions = {}
@@ -122,6 +120,8 @@ class QuestionBasePromptsMixin:
         template_text = template_manager.get_template(
             cls.question_type, "answering_instructions.jinja"
         )
+        from edsl.prompts import Prompt
+
         return Prompt(text=template_text)
 
     @classmethod
@@ -129,6 +129,8 @@ class QuestionBasePromptsMixin:
         template_text = template_manager.get_template(
             cls.question_type, "question_presentation.jinja"
         )
+        from edsl.prompts import Prompt
+
         return Prompt(text=template_text)
 
     @property
@@ -182,6 +184,8 @@ class QuestionBasePromptsMixin:
     @property
     def new_default_instructions(self) -> "Prompt":
         "This is set up as a property because there are mutable question values that determine how it is rendered."
+        from edsl.prompts import Prompt
+
         return Prompt(self.question_presentation) + Prompt(self.answering_instructions)
 
     @property

edsl/questions/QuestionCheckBox.py

@@ -16,7 +16,7 @@ from pydantic import field_validator
 from edsl.questions.ResponseValidatorABC import ResponseValidatorABC
 from edsl.questions.ResponseValidatorABC import BaseResponse
 
-from edsl.exceptions import QuestionAnswerValidationError
+from edsl.exceptions.questions import QuestionAnswerValidationError
 
 from pydantic import BaseModel, Field, conlist
 from typing import List, Literal, Optional, Annotated

edsl/questions/QuestionExtract.py

@@ -8,7 +8,7 @@ from edsl.questions.descriptors import AnswerTemplateDescriptor
 
 from edsl.questions.ResponseValidatorABC import ResponseValidatorABC
 from edsl.questions.ResponseValidatorABC import BaseResponse
-from edsl.exceptions import QuestionAnswerValidationError
+from edsl.exceptions.questions import QuestionAnswerValidationError
 from edsl.questions.decorators import inject_exception
 
 from typing import Dict, Any

edsl/questions/QuestionFreeText.py

@@ -7,13 +7,12 @@ from pydantic import field_validator
 from edsl.questions.QuestionBase import QuestionBase
 from edsl.questions.ResponseValidatorABC import ResponseValidatorABC
 
-from edsl.exceptions import QuestionAnswerValidationError
+from edsl.exceptions.questions import QuestionAnswerValidationError
 from edsl.questions.decorators import inject_exception
 
 from pydantic import BaseModel
 from typing import Optional, Any, List
 
-from edsl.exceptions import QuestionAnswerValidationError
 from edsl.prompts.Prompt import Prompt
 
 

edsl/questions/QuestionList.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
-import random
-import textwrap
+import json
+
 from typing import Any, Optional, Union
 from edsl.questions.QuestionBase import QuestionBase
 from edsl.questions.descriptors import IntegerOrNoneDescriptor
@@ -10,9 +10,7 @@ from pydantic import field_validator, Field
 from edsl.questions.ResponseValidatorABC import ResponseValidatorABC
 from edsl.questions.ResponseValidatorABC import BaseResponse
 
-from edsl.exceptions import QuestionAnswerValidationError
-import textwrap
-import json
+from edsl.exceptions.questions import QuestionAnswerValidationError
 
 from json_repair import repair_json