edsl 0.1.39.dev3__py3-none-any.whl → 0.1.39.dev4__py3-none-any.whl

edsl/questions/question_registry.py

@@ -1,177 +1,177 @@
-"""This module provides a factory class for creating question objects."""
-
-import textwrap
-from uuid import UUID
-from typing import Any, Optional, Union
-
-
-from edsl.questions.QuestionBase import RegisterQuestionsMeta
-
-
-class Meta(type):
-    """Metaclass for QuestionBase that provides a __repr__ method that lists all available questions."""
-
-    def __repr__(cls):
-        """Return a string that lists all available questions."""
-
-        s = textwrap.dedent(
-            """
-        You can use the Question class to create objects by name. 
-        For example, to create a multiple choice question, you can do:
-
-        >>> from edsl import Question
-        >>> q = Question('multiple_choice', question_text='What is your favorite color?', question_name='color')
-        
-        Question Types:\n"""
-        )
-        for question_type, question_class in cls.available(
-            show_class_names=True
-        ).items():
-            line_info = (
-                f"{question_type} ({question_class.__name__}): {question_class.__doc__}"
-            )
-            s += line_info + "\n"
-        return s
-
-
-class Question(metaclass=Meta):
-    """Factory class for creating question objects."""
-
-    def __new__(cls, question_type, *args, **kwargs):
-        """Create a new question object."""
-        get_question_classes = RegisterQuestionsMeta.question_types_to_classes()
-
-        subclass = get_question_classes.get(question_type, None)
-        if subclass is None:
-            raise ValueError(
-                f"No question registered with question_type {question_type}"
-            )
-
-        # Create an instance of the selected subclass
-        instance = object.__new__(subclass)
-        instance.__init__(*args, **kwargs)
-        return instance
-
-    @classmethod
-    def example(cls, question_type: str):
-        """Return an example question of the given type."""
-        get_question_classes = RegisterQuestionsMeta.question_types_to_classes()
-        q = get_question_classes.get(question_type, None)
-        return q.example()
-
-    @classmethod
-    def pull(cls, uuid: Optional[Union[str, UUID]] = None, url: Optional[str] = None):
-        """Pull the object from coop."""
-        from edsl.coop import Coop
-
-        coop = Coop()
-        return coop.get(uuid, url, "question")
-
-    @classmethod
-    def delete(cls, uuid: Optional[Union[str, UUID]] = None, url: Optional[str] = None):
-        """Delete the object from coop."""
-        from edsl.coop import Coop
-
-        coop = Coop()
-        return coop.delete(uuid, url)
-
-    @classmethod
-    def patch(
-        cls,
-        uuid: Optional[Union[str, UUID]] = None,
-        url: Optional[str] = None,
-        description: Optional[str] = None,
-        value: Optional[Any] = None,
-        visibility: Optional[str] = None,
-    ):
-        """Patch the object on coop."""
-        from edsl.coop import Coop
-
-        coop = Coop()
-        return coop.patch(uuid, url, description, value, visibility)
-
-    @classmethod
-    def list_question_types(cls):
-        """Return a list of available question types.
-
-        >>> from edsl import Question
-        >>> Question.list_question_types()
-        ['checkbox', 'extract', 'free_text', 'functional', 'likert_five', 'linear_scale', 'list', 'multiple_choice', 'numerical', 'rank', 'top_k', 'yes_no']
-        """
-        return [
-            q
-            for q in sorted(
-                list(RegisterQuestionsMeta.question_types_to_classes().keys())
-            )
-            if q not in ["budget"]
-        ]
-
-    @classmethod
-    def available(cls, show_class_names: bool = False) -> Union[list, dict]:
-        """Return a list of available question types.
-
-        :param show_class_names: If True, return a dictionary of question types to class names. If False, return a set of question types.
-
-        Example usage:
-
-        """
-        from edsl.results.Dataset import Dataset
-
-        exclude = ["budget"]
-        if show_class_names:
-            return RegisterQuestionsMeta.question_types_to_classes()
-        else:
-            question_list = [
-                q
-                for q in sorted(
-                    set(RegisterQuestionsMeta.question_types_to_classes().keys())
-                )
-                if q not in exclude
-            ]
-            d = RegisterQuestionsMeta.question_types_to_classes()
-            question_classes = [d[q] for q in question_list]
-            example_questions = [repr(q.example()) for q in question_classes]
-
-            return Dataset(
-                [
-                    {"question_type": [q for q in question_list]},
-                    {"question_class": [q.__name__ for q in question_classes]},
-                    {"example_question": example_questions},
-                ],
-                print_parameters={"containerHeight": "auto"},
-            )
-
-
-def get_question_class(question_type):
-    """Return the class for the given question type."""
-    q2c = RegisterQuestionsMeta.question_types_to_classes()
-    if question_type not in q2c:
-        raise ValueError(
-            f"The question type, {question_type}, is not recognized. Recognied types are: {q2c.keys()}"
-        )
-    return q2c.get(question_type)
-
-
-question_purpose = {
-    "multiple_choice": "When options are known and limited",
-    "free_text": "When options are unknown or unlimited",
-    "checkbox": "When multiple options can be selected",
-    "numerical": "When the answer is a single numerical value e.g., a float",
-    "linear_scale": "When options are text, but can be ordered, e.g., daily, weekly, monthly, etc.",
-    "yes_no": "When the question can be fully answered with either a yes or a no",
-    "list": "When the answer should be a list of items",
-    "rank": "When the answer should be a ranked list of items",
-    "budget": "When the answer should be an amount allocated among a set of options",
-    "top_k": "When the answer should be a list of the top k items",
-    "likert_five": "When the answer should be a value on the Likert scale from 1 to 5",
-    "extract": "When the answer should be information extracted or extrapolated from a text in a given format",
-}
-
-
-if __name__ == "__main__":
-    print(Question.available())
-
-    # q = Question("free_text", question_text="How are you doing?", question_name="test")
-    # results = q.run()
-
-    q = Question.pull(id=76)
+"""This module provides a factory class for creating question objects."""
+
+import textwrap
+from uuid import UUID
+from typing import Any, Optional, Union
+
+
+from edsl.questions.QuestionBase import RegisterQuestionsMeta
+
+
+class Meta(type):
+    """Metaclass for QuestionBase that provides a __repr__ method that lists all available questions."""
+
+    def __repr__(cls):
+        """Return a string that lists all available questions."""
+
+        s = textwrap.dedent(
+            """
+        You can use the Question class to create objects by name. 
+        For example, to create a multiple choice question, you can do:
+
+        >>> from edsl import Question
+        >>> q = Question('multiple_choice', question_text='What is your favorite color?', question_name='color')
+        
+        Question Types:\n"""
+        )
+        for question_type, question_class in cls.available(
+            show_class_names=True
+        ).items():
+            line_info = (
+                f"{question_type} ({question_class.__name__}): {question_class.__doc__}"
+            )
+            s += line_info + "\n"
+        return s
+
+
+class Question(metaclass=Meta):
+    """Factory class for creating question objects."""
+
+    def __new__(cls, question_type, *args, **kwargs):
+        """Create a new question object."""
+        get_question_classes = RegisterQuestionsMeta.question_types_to_classes()
+
+        subclass = get_question_classes.get(question_type, None)
+        if subclass is None:
+            raise ValueError(
+                f"No question registered with question_type {question_type}"
+            )
+
+        # Create an instance of the selected subclass
+        instance = object.__new__(subclass)
+        instance.__init__(*args, **kwargs)
+        return instance
+
+    @classmethod
+    def example(cls, question_type: str):
+        """Return an example question of the given type."""
+        get_question_classes = RegisterQuestionsMeta.question_types_to_classes()
+        q = get_question_classes.get(question_type, None)
+        return q.example()
+
+    @classmethod
+    def pull(cls, uuid: Optional[Union[str, UUID]] = None, url: Optional[str] = None):
+        """Pull the object from coop."""
+        from edsl.coop import Coop
+
+        coop = Coop()
+        return coop.get(uuid, url, "question")
+
+    @classmethod
+    def delete(cls, uuid: Optional[Union[str, UUID]] = None, url: Optional[str] = None):
+        """Delete the object from coop."""
+        from edsl.coop import Coop
+
+        coop = Coop()
+        return coop.delete(uuid, url)
+
+    @classmethod
+    def patch(
+        cls,
+        uuid: Optional[Union[str, UUID]] = None,
+        url: Optional[str] = None,
+        description: Optional[str] = None,
+        value: Optional[Any] = None,
+        visibility: Optional[str] = None,
+    ):
+        """Patch the object on coop."""
+        from edsl.coop import Coop
+
+        coop = Coop()
+        return coop.patch(uuid, url, description, value, visibility)
+
+    @classmethod
+    def list_question_types(cls):
+        """Return a list of available question types.
+
+        >>> from edsl import Question
+        >>> Question.list_question_types()
+        ['checkbox', 'extract', 'free_text', 'functional', 'likert_five', 'linear_scale', 'list', 'matrix', 'multiple_choice', 'numerical', 'rank', 'top_k', 'yes_no']
+        """
+        return [
+            q
+            for q in sorted(
+                list(RegisterQuestionsMeta.question_types_to_classes().keys())
+            )
+            if q not in ["budget"]
+        ]
+
+    @classmethod
+    def available(cls, show_class_names: bool = False) -> Union[list, dict]:
+        """Return a list of available question types.
+
+        :param show_class_names: If True, return a dictionary of question types to class names. If False, return a set of question types.
+
+        Example usage:
+
+        """
+        from edsl.results.Dataset import Dataset
+
+        exclude = ["budget"]
+        if show_class_names:
+            return RegisterQuestionsMeta.question_types_to_classes()
+        else:
+            question_list = [
+                q
+                for q in sorted(
+                    set(RegisterQuestionsMeta.question_types_to_classes().keys())
+                )
+                if q not in exclude
+            ]
+            d = RegisterQuestionsMeta.question_types_to_classes()
+            question_classes = [d[q] for q in question_list]
+            example_questions = [repr(q.example()) for q in question_classes]
+
+            return Dataset(
+                [
+                    {"question_type": [q for q in question_list]},
+                    {"question_class": [q.__name__ for q in question_classes]},
+                    {"example_question": example_questions},
+                ],
+                print_parameters={"containerHeight": "auto"},
+            )
+
+
+def get_question_class(question_type):
+    """Return the class for the given question type."""
+    q2c = RegisterQuestionsMeta.question_types_to_classes()
+    if question_type not in q2c:
+        raise ValueError(
+            f"The question type, {question_type}, is not recognized. Recognied types are: {q2c.keys()}"
+        )
+    return q2c.get(question_type)
+
+
+question_purpose = {
+    "multiple_choice": "When options are known and limited",
+    "free_text": "When options are unknown or unlimited",
+    "checkbox": "When multiple options can be selected",
+    "numerical": "When the answer is a single numerical value e.g., a float",
+    "linear_scale": "When options are text, but can be ordered, e.g., daily, weekly, monthly, etc.",
+    "yes_no": "When the question can be fully answered with either a yes or a no",
+    "list": "When the answer should be a list of items",
+    "rank": "When the answer should be a ranked list of items",
+    "budget": "When the answer should be an amount allocated among a set of options",
+    "top_k": "When the answer should be a list of the top k items",
+    "likert_five": "When the answer should be a value on the Likert scale from 1 to 5",
+    "extract": "When the answer should be information extracted or extrapolated from a text in a given format",
+}
+
+
+if __name__ == "__main__":
+    print(Question.available())
+
+    # q = Question("free_text", question_text="How are you doing?", question_name="test")
+    # results = q.run()
+
+    q = Question.pull(id=76)

edsl/questions/{RegisterQuestionsMeta.py → register_questions_meta.py}

@@ -1,71 +1,71 @@
-from __future__ import annotations
-from abc import ABCMeta
-
-from edsl.enums import QuestionType
-from edsl.exceptions.questions import QuestionMissingTypeError, QuestionBadTypeError
-
-import inspect
-
-
-class RegisterQuestionsMeta(ABCMeta):
-    """Metaclass to register output elements in a registry i.e., those that have a parent."""
-
-    _registry = {}  # Initialize the registry as a dictionary
-
-    def __init__(cls, name, bases, dct):
-        """Initialize the class and adds it to the registry if it's not the base class."""
-        super(RegisterQuestionsMeta, cls).__init__(name, bases, dct)
-        if (
-            name != "QuestionBase"
-            and name != "QuestionFunctional"
-            and name != "QuestionAddTwoNumbers"
-        ):
-            ## Enforce that all questions have a question_type class attribute
-            ## and it comes from our enum of valid question types.
-            required_attributes = [
-                "question_type",
-                "_response_model",
-                "response_validator_class",
-            ]
-            for attr in required_attributes:
-                if not hasattr(cls, attr):
-                    raise QuestionMissingTypeError(
-                        f"Question must have a {attr} class attribute"
-                    )
-
-            init_signature = inspect.signature(cls.__init__)
-            init_params = [p for p in init_signature.parameters if p != "self"]
-            required_params = [
-                "question_presentation",
-                "answering_instructions",
-                "question_name",
-                "question_text",
-            ]
-            for param in required_params:
-                if param not in init_params:
-                    raise QuestionBadTypeError(
-                        f"Question type {name} must have a question_presentation parameter in its __init__ method"
-                    )
-
-        if name != "QuestionBase":
-            RegisterQuestionsMeta._registry[name] = cls
-
-    @classmethod
-    def get_registered_classes(cls):
-        """Return the registry of registered classes."""
-        return cls._registry
-
-    @classmethod
-    def question_types_to_classes(
-        cls,
-    ):
-        """Return a dictionary of question types to classes."""
-        d = {}
-        for classname, cls in cls._registry.items():
-            if hasattr(cls, "question_type"):
-                d[cls.question_type] = cls
-            else:
-                raise Exception(
-                    f"Class {classname} does not have a question_type class attribute"
-                )
-        return d
+from __future__ import annotations
+from abc import ABCMeta
+
+from edsl.enums import QuestionType
+from edsl.exceptions.questions import QuestionMissingTypeError, QuestionBadTypeError
+
+import inspect
+
+
+class RegisterQuestionsMeta(ABCMeta):
+    """Metaclass to register output elements in a registry i.e., those that have a parent."""
+
+    _registry = {}  # Initialize the registry as a dictionary
+
+    def __init__(cls, name, bases, dct):
+        """Initialize the class and adds it to the registry if it's not the base class."""
+        super(RegisterQuestionsMeta, cls).__init__(name, bases, dct)
+        if (
+            name != "QuestionBase"
+            and name != "QuestionFunctional"
+            and name != "QuestionAddTwoNumbers"
+        ):
+            ## Enforce that all questions have a question_type class attribute
+            ## and it comes from our enum of valid question types.
+            required_attributes = [
+                "question_type",
+                "_response_model",
+                "response_validator_class",
+            ]
+            for attr in required_attributes:
+                if not hasattr(cls, attr):
+                    raise QuestionMissingTypeError(
+                        f"Question must have a {attr} class attribute"
+                    )
+
+            init_signature = inspect.signature(cls.__init__)
+            init_params = [p for p in init_signature.parameters if p != "self"]
+            required_params = [
+                "question_presentation",
+                "answering_instructions",
+                "question_name",
+                "question_text",
+            ]
+            for param in required_params:
+                if param not in init_params:
+                    raise QuestionBadTypeError(
+                        f"Question type {name} must have a question_presentation parameter in its __init__ method"
+                    )
+
+        if name != "QuestionBase":
+            RegisterQuestionsMeta._registry[name] = cls
+
+    @classmethod
+    def get_registered_classes(cls):
+        """Return the registry of registered classes."""
+        return cls._registry
+
+    @classmethod
+    def question_types_to_classes(
+        cls,
+    ):
+        """Return a dictionary of question types to classes."""
+        d = {}
+        for classname, cls in cls._registry.items():
+            if hasattr(cls, "question_type"):
+                d[cls.question_type] = cls
+            else:
+                raise Exception(
+                    f"Class {classname} does not have a question_type class attribute"
+                )
+        return d