edsl 0.1.38.dev2__py3-none-any.whl → 0.1.38.dev3__py3-none-any.whl

edsl/questions/derived/QuestionLinearScale.py

@@ -1,87 +1,87 @@
-from __future__ import annotations
-from typing import Optional
-
-from edsl.questions.descriptors import QuestionOptionsDescriptor, OptionLabelDescriptor
-from edsl.questions.QuestionMultipleChoice import QuestionMultipleChoice
-
-from edsl.questions.decorators import inject_exception
-
-
-class QuestionLinearScale(QuestionMultipleChoice):
-    """This question prompts the agent to respond to a statement on a linear scale."""
-
-    question_type = "linear_scale"
-    option_labels: Optional[dict[int, str]] = OptionLabelDescriptor()
-    question_options = QuestionOptionsDescriptor(linear_scale=True)
-
-    def __init__(
-        self,
-        question_name: str,
-        question_text: str,
-        question_options: list[int],
-        option_labels: Optional[dict[int, str]] = None,
-        answering_instructions: Optional[str] = None,
-        question_presentation: Optional[str] = None,
-        include_comment: Optional[bool] = True,
-    ):
-        """Instantiate a new QuestionLinearScale.
-
-        :param question_name: The name of the question.
-        :param question_text: The text of the question.
-        :param question_options: The options the respondent should select from.
-        :param option_labels: Maps question_options to labels.
-        :param instructions: Instructions for the question. If not provided, the default instructions are used. To view them, run `QuestionLinearScale.default_instructions`.
-        """
-        super().__init__(
-            question_name=question_name,
-            question_text=question_text,
-            question_options=question_options,
-            use_code=False,  # question linear scale will have it's own code
-            include_comment=include_comment,
-        )
-        self.question_options = question_options
-        self.option_labels = (
-            {int(k): v for k, v in option_labels.items()} if option_labels else {}
-        )
-        self.answering_instructions = answering_instructions
-        self.question_presentation = question_presentation
-
-    ################
-    # Helpful
-    ################
-    @classmethod
-    @inject_exception
-    def example(cls, include_comment: bool = True) -> QuestionLinearScale:
-        """Return an example of a linear scale question."""
-        return cls(
-            question_text="How much do you like ice cream?",
-            question_options=[1, 2, 3, 4, 5],
-            question_name="ice_cream",
-            option_labels={1: "I hate it", 5: "I love it"},
-            include_comment=include_comment,
-        )
-
-
-def main():
-    """Create an example of a linear scale question and demonstrate its functionality."""
-    from edsl.questions.derived.QuestionLinearScale import QuestionLinearScale
-
-    q = QuestionLinearScale.example()
-    q.question_text
-    q.question_options
-    q.question_name
-    # validate an answer
-    q._validate_answer({"answer": 3, "comment": "I like custard"})
-    # translate answer code
-    q._translate_answer_code_to_answer(3, {})
-    # simulate answer
-    q._simulate_answer()
-    q._simulate_answer(human_readable=False)
-    q._validate_answer(q._simulate_answer(human_readable=False))
-    # serialization (inherits from Question)
-    q.to_dict()
-    assert q.from_dict(q.to_dict()) == q
-
-    import doctest
-
-    doctest.testmod(optionflags=doctest.ELLIPSIS)
+from __future__ import annotations
+from typing import Optional
+
+from edsl.questions.descriptors import QuestionOptionsDescriptor, OptionLabelDescriptor
+from edsl.questions.QuestionMultipleChoice import QuestionMultipleChoice
+
+from edsl.questions.decorators import inject_exception
+
+
+class QuestionLinearScale(QuestionMultipleChoice):
+    """This question prompts the agent to respond to a statement on a linear scale."""
+
+    question_type = "linear_scale"
+    option_labels: Optional[dict[int, str]] = OptionLabelDescriptor()
+    question_options = QuestionOptionsDescriptor(linear_scale=True)
+
+    def __init__(
+        self,
+        question_name: str,
+        question_text: str,
+        question_options: list[int],
+        option_labels: Optional[dict[int, str]] = None,
+        answering_instructions: Optional[str] = None,
+        question_presentation: Optional[str] = None,
+        include_comment: Optional[bool] = True,
+    ):
+        """Instantiate a new QuestionLinearScale.
+
+        :param question_name: The name of the question.
+        :param question_text: The text of the question.
+        :param question_options: The options the respondent should select from.
+        :param option_labels: Maps question_options to labels.
+        :param instructions: Instructions for the question. If not provided, the default instructions are used. To view them, run `QuestionLinearScale.default_instructions`.
+        """
+        super().__init__(
+            question_name=question_name,
+            question_text=question_text,
+            question_options=question_options,
+            use_code=False,  # question linear scale will have it's own code
+            include_comment=include_comment,
+        )
+        self.question_options = question_options
+        self.option_labels = (
+            {int(k): v for k, v in option_labels.items()} if option_labels else {}
+        )
+        self.answering_instructions = answering_instructions
+        self.question_presentation = question_presentation
+
+    ################
+    # Helpful
+    ################
+    @classmethod
+    @inject_exception
+    def example(cls, include_comment: bool = True) -> QuestionLinearScale:
+        """Return an example of a linear scale question."""
+        return cls(
+            question_text="How much do you like ice cream?",
+            question_options=[1, 2, 3, 4, 5],
+            question_name="ice_cream",
+            option_labels={1: "I hate it", 5: "I love it"},
+            include_comment=include_comment,
+        )
+
+
+def main():
+    """Create an example of a linear scale question and demonstrate its functionality."""
+    from edsl.questions.derived.QuestionLinearScale import QuestionLinearScale
+
+    q = QuestionLinearScale.example()
+    q.question_text
+    q.question_options
+    q.question_name
+    # validate an answer
+    q._validate_answer({"answer": 3, "comment": "I like custard"})
+    # translate answer code
+    q._translate_answer_code_to_answer(3, {})
+    # simulate answer
+    q._simulate_answer()
+    q._simulate_answer(human_readable=False)
+    q._validate_answer(q._simulate_answer(human_readable=False))
+    # serialization (inherits from Question)
+    q.to_dict()
+    assert q.from_dict(q.to_dict()) == q
+
+    import doctest
+
+    doctest.testmod(optionflags=doctest.ELLIPSIS)

edsl/questions/derived/QuestionTopK.py

@@ -1,93 +1,93 @@
-from __future__ import annotations
-from typing import Optional
-
-from edsl.exceptions import QuestionCreationValidationError
-from edsl.questions.QuestionCheckBox import QuestionCheckBox
-from edsl.questions.decorators import inject_exception
-
-
-class QuestionTopK(QuestionCheckBox):
-    """This question prompts the agent to select exactly K options from a list."""
-
-    question_type = "top_k"
-
-    def __init__(
-        self,
-        question_name: str,
-        question_text: str,
-        question_options: list[str],
-        min_selections: int,
-        max_selections: int,
-        question_presentation: Optional[str] = None,
-        answering_instructions: Optional[str] = None,
-        include_comment: Optional[bool] = True,
-        use_code: Optional[bool] = True,
-    ):
-        """Initialize the question.
-
-        :param question_name: The name of the question.
-        :param question_text: The text of the question.
-        :param question_options: The options the respondent should select from.
-        :param instructions: Instructions for the question. If not provided, the default instructions are used. To view them, run `QuestionTopK.default_instructions`.
-        :param num_selections: The number of options that must be selected.
-        """
-        super().__init__(
-            question_name=question_name,
-            question_text=question_text,
-            question_options=question_options,
-            min_selections=min_selections,
-            max_selections=max_selections,
-            question_presentation=question_presentation,
-            answering_instructions=answering_instructions,
-            include_comment=include_comment,
-            use_code=use_code,
-        )
-        if min_selections != max_selections:
-            raise QuestionCreationValidationError(
-                "TopK questions must have min_selections == max_selections"
-            )
-        if min_selections < 1:
-            raise QuestionCreationValidationError(
-                "TopK questions must have min_selections > 0"
-            )
-
-    ################
-    # Helpful
-    ################
-    @classmethod
-    @inject_exception
-    def example(cls, include_comment: bool = True) -> QuestionTopK:
-        """Return an example question."""
-        return cls(
-            question_name="two_fruits",
-            question_text="Which of the following fruits do you prefer?",
-            question_options=["apple", "banana", "carrot", "durian"],
-            min_selections=2,
-            max_selections=2,
-            include_comment=include_comment,
-        )
-
-
-def main():
-    """Test QuestionTopK."""
-    from edsl.questions.derived.QuestionTopK import QuestionTopK
-
-    q = QuestionTopK.example()
-    q.question_text
-    q.question_options
-    q.question_name
-    # validate an answer
-    q._validate_answer({"answer": [0, 3], "comment": "I like custard"})
-    # translate answer code
-    q._translate_answer_code_to_answer([0, 3], {})
-    # simulate answer
-    q._simulate_answer()
-    q._simulate_answer(human_readable=False)
-    q._validate_answer(q._simulate_answer(human_readable=False))
-    # serialization (inherits from Question)
-    q.to_dict()
-    assert q.from_dict(q.to_dict()) == q
-
-    import doctest
-
-    doctest.testmod(optionflags=doctest.ELLIPSIS)
+from __future__ import annotations
+from typing import Optional
+
+from edsl.exceptions import QuestionCreationValidationError
+from edsl.questions.QuestionCheckBox import QuestionCheckBox
+from edsl.questions.decorators import inject_exception
+
+
+class QuestionTopK(QuestionCheckBox):
+    """This question prompts the agent to select exactly K options from a list."""
+
+    question_type = "top_k"
+
+    def __init__(
+        self,
+        question_name: str,
+        question_text: str,
+        question_options: list[str],
+        min_selections: int,
+        max_selections: int,
+        question_presentation: Optional[str] = None,
+        answering_instructions: Optional[str] = None,
+        include_comment: Optional[bool] = True,
+        use_code: Optional[bool] = True,
+    ):
+        """Initialize the question.
+
+        :param question_name: The name of the question.
+        :param question_text: The text of the question.
+        :param question_options: The options the respondent should select from.
+        :param instructions: Instructions for the question. If not provided, the default instructions are used. To view them, run `QuestionTopK.default_instructions`.
+        :param num_selections: The number of options that must be selected.
+        """
+        super().__init__(
+            question_name=question_name,
+            question_text=question_text,
+            question_options=question_options,
+            min_selections=min_selections,
+            max_selections=max_selections,
+            question_presentation=question_presentation,
+            answering_instructions=answering_instructions,
+            include_comment=include_comment,
+            use_code=use_code,
+        )
+        if min_selections != max_selections:
+            raise QuestionCreationValidationError(
+                "TopK questions must have min_selections == max_selections"
+            )
+        if min_selections < 1:
+            raise QuestionCreationValidationError(
+                "TopK questions must have min_selections > 0"
+            )
+
+    ################
+    # Helpful
+    ################
+    @classmethod
+    @inject_exception
+    def example(cls, include_comment: bool = True) -> QuestionTopK:
+        """Return an example question."""
+        return cls(
+            question_name="two_fruits",
+            question_text="Which of the following fruits do you prefer?",
+            question_options=["apple", "banana", "carrot", "durian"],
+            min_selections=2,
+            max_selections=2,
+            include_comment=include_comment,
+        )
+
+
+def main():
+    """Test QuestionTopK."""
+    from edsl.questions.derived.QuestionTopK import QuestionTopK
+
+    q = QuestionTopK.example()
+    q.question_text
+    q.question_options
+    q.question_name
+    # validate an answer
+    q._validate_answer({"answer": [0, 3], "comment": "I like custard"})
+    # translate answer code
+    q._translate_answer_code_to_answer([0, 3], {})
+    # simulate answer
+    q._simulate_answer()
+    q._simulate_answer(human_readable=False)
+    q._validate_answer(q._simulate_answer(human_readable=False))
+    # serialization (inherits from Question)
+    q.to_dict()
+    assert q.from_dict(q.to_dict()) == q
+
+    import doctest
+
+    doctest.testmod(optionflags=doctest.ELLIPSIS)

edsl/questions/derived/QuestionYesNo.py

@@ -1,82 +1,82 @@
-from __future__ import annotations
-from typing import Optional
-from edsl.questions.descriptors import QuestionOptionsDescriptor
-from edsl.questions.QuestionMultipleChoice import QuestionMultipleChoice
-
-from edsl.questions.decorators import inject_exception
-
-
-class QuestionYesNo(QuestionMultipleChoice):
-    """This question prompts the agent to respond with 'Yes' or 'No'."""
-
-    question_type = "yes_no"
-    question_options = QuestionOptionsDescriptor(num_choices=2)
-
-    def __init__(
-        self,
-        question_name: str,
-        question_text: str,
-        question_options: list[str] = ["No", "Yes"],
-        answering_instructions: Optional[str] = None,
-        question_presentation: Optional[str] = None,
-        include_comment: Optional[bool] = True,
-    ):
-        """Instantiate a new QuestionYesNo.
-
-        :param question_name: The name of the question.
-        :param question_text: The text of the question.
-        :param instructions: Instructions for the question. If not provided, the default instructions are used. To view them, run `QuestionYesNo.default_instructions`.
-        """
-        super().__init__(
-            question_name=question_name,
-            question_text=question_text,
-            question_options=question_options,
-            use_code=False,
-            answering_instructions=answering_instructions,
-            question_presentation=question_presentation,
-            include_comment=include_comment,
-        )
-        self.question_options = question_options
-
-    ################
-    # Helpful
-    ################
-    @classmethod
-    @inject_exception
-    def example(cls, include_comment: bool = True) -> QuestionYesNo:
-        """Return an example of a yes/no question."""
-        return cls(
-            question_name="is_it_equal",
-            question_text="Is 5 + 5 equal to 11?",
-            include_comment=include_comment,
-        )
-
-
-def main():
-    """Create an example of a yes/no question and demonstrate its functionality."""
-    from edsl.questions.derived.QuestionYesNo import QuestionYesNo
-
-    q = QuestionYesNo.example()
-    q.question_text
-    q.question_options
-    q.question_name
-    # validate an answer
-    q._validate_answer({"answer": 0, "comment": "I like custard"})
-    # translate answer code
-    q._translate_answer_code_to_answer(0, {})
-    q._simulate_answer()
-    q._simulate_answer(human_readable=False)
-    q._validate_answer(q._simulate_answer(human_readable=False))
-    # serialization (inherits from Question)
-    q.to_dict()
-    assert q.from_dict(q.to_dict()) == q
-
-    import doctest
-
-    doctest.testmod(optionflags=doctest.ELLIPSIS)
-
-
-if __name__ == "__main__":
-    import doctest
-
-    doctest.testmod(optionflags=doctest.ELLIPSIS)
+from __future__ import annotations
+from typing import Optional
+from edsl.questions.descriptors import QuestionOptionsDescriptor
+from edsl.questions.QuestionMultipleChoice import QuestionMultipleChoice
+
+from edsl.questions.decorators import inject_exception
+
+
+class QuestionYesNo(QuestionMultipleChoice):
+    """This question prompts the agent to respond with 'Yes' or 'No'."""
+
+    question_type = "yes_no"
+    question_options = QuestionOptionsDescriptor(num_choices=2)
+
+    def __init__(
+        self,
+        question_name: str,
+        question_text: str,
+        question_options: list[str] = ["No", "Yes"],
+        answering_instructions: Optional[str] = None,
+        question_presentation: Optional[str] = None,
+        include_comment: Optional[bool] = True,
+    ):
+        """Instantiate a new QuestionYesNo.
+
+        :param question_name: The name of the question.
+        :param question_text: The text of the question.
+        :param instructions: Instructions for the question. If not provided, the default instructions are used. To view them, run `QuestionYesNo.default_instructions`.
+        """
+        super().__init__(
+            question_name=question_name,
+            question_text=question_text,
+            question_options=question_options,
+            use_code=False,
+            answering_instructions=answering_instructions,
+            question_presentation=question_presentation,
+            include_comment=include_comment,
+        )
+        self.question_options = question_options
+
+    ################
+    # Helpful
+    ################
+    @classmethod
+    @inject_exception
+    def example(cls, include_comment: bool = True) -> QuestionYesNo:
+        """Return an example of a yes/no question."""
+        return cls(
+            question_name="is_it_equal",
+            question_text="Is 5 + 5 equal to 11?",
+            include_comment=include_comment,
+        )
+
+
+def main():
+    """Create an example of a yes/no question and demonstrate its functionality."""
+    from edsl.questions.derived.QuestionYesNo import QuestionYesNo
+
+    q = QuestionYesNo.example()
+    q.question_text
+    q.question_options
+    q.question_name
+    # validate an answer
+    q._validate_answer({"answer": 0, "comment": "I like custard"})
+    # translate answer code
+    q._translate_answer_code_to_answer(0, {})
+    q._simulate_answer()
+    q._simulate_answer(human_readable=False)
+    q._validate_answer(q._simulate_answer(human_readable=False))
+    # serialization (inherits from Question)
+    q.to_dict()
+    assert q.from_dict(q.to_dict()) == q
+
+    import doctest
+
+    doctest.testmod(optionflags=doctest.ELLIPSIS)
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod(optionflags=doctest.ELLIPSIS)