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

edsl/surveys/SurveyToApp.py

@@ -0,0 +1,141 @@
+from fastapi import FastAPI
+from pydantic import BaseModel, create_model
+from typing import Callable, Optional, Type, Dict, Any, List, Union
+
+
+class SurveyToApp:
+    def __init__(self, survey):
+        self.survey = survey
+        self.app = FastAPI()
+
+    def parameters(self):
+        return self.survey.parameters
+
+    def create_input(self) -> Type[BaseModel]:
+        """
+        Creates a Pydantic model based on the survey parameters.
+        Returns:
+            Type[BaseModel]: A dynamically created Pydantic model class
+        """
+        # Get parameters from survey - now calling the method
+        params = self.parameters()
+
+        # Create field definitions dictionary
+        fields: Dict[str, Any] = {}
+
+        # Since params is a set, we'll handle each parameter directly
+        # Assuming each parameter in the set has the necessary attributes
+        for param in params:
+            # You might need to adjust these based on the actual parameter object structure
+            param_name = getattr(param, "name", str(param))
+            param_type = getattr(param, "type", "string")
+            is_required = getattr(param, "required", True)
+
+            # Map survey parameter types to Python types
+            type_mapping = {
+                "string": str,
+                "integer": int,
+                "float": float,
+                "boolean": bool,
+                "array": List,
+                # Add more type mappings as needed
+            }
+
+            # Get the Python type from mapping
+            python_type = type_mapping.get(param_type, str)
+
+            if is_required:
+                fields[param_name] = (python_type, ...)
+            else:
+                fields[param_name] = (Optional[python_type], None)
+
+        # Add the template variable 'name' that's used in the question text
+        fields["name"] = (str, ...)
+
+        # Create and return the Pydantic model
+        model_name = f"{self.survey.__class__.__name__}Model"
+        return create_model(model_name, **fields)
+
+    def create_route(self) -> Callable:
+        """
+        Creates a FastAPI route handler for the survey.
+        Returns:
+            Callable: A route handler function
+        """
+        input_model = self.create_input()
+
+        async def route_handler(input_data: input_model):
+            """
+            Handles the API route by processing the input data through the survey.
+            Args:
+                input_data: The validated input data matching the created Pydantic model
+            Returns:
+                dict: The processed survey results
+            """
+            # Convert Pydantic model to dict
+            data = input_data.dict()
+            print(data)
+            from edsl.scenarios.Scenario import Scenario
+
+            # Process the data through the survey
+            try:
+                s = Scenario(data)
+                results = self.survey.by(s).run()
+                return {
+                    "status": "success",
+                    "data": results.select("answer.*").to_scenario_list().to_dict(),
+                }
+            except Exception as e:
+                return {"status": "error", "message": str(e)}
+
+        return route_handler
+
+    def add_to_app(
+        self, app: FastAPI, path: str = "/survey", methods: List[str] = ["POST", "GET"]
+    ):
+        """
+        Adds the survey route to a FastAPI application.
+        Args:
+            app (FastAPI): The FastAPI application instance
+            path (str): The API endpoint path
+            methods (List[str]): HTTP methods to support
+        """
+        route_handler = self.create_route()
+        input_model = self.create_input()
+
+        app.add_api_route(
+            path, route_handler, methods=methods, response_model=Dict[str, Any]
+        )
+
+    def create_app(self, path: str = "/survey", methods: List[str] = ["POST", "GET"]):
+        """
+        Creates a FastAPI application with the survey route.
+        Args:
+            path (str): The API endpoint path
+            methods (List[str]): HTTP methods to support
+        Returns:
+            FastAPI: The FastAPI application instance
+        """
+        app = FastAPI()
+        self.add_to_app(app, path=path, methods=methods)
+        return app
+
+
+from edsl import QuestionFreeText, QuestionList
+
+# q = QuestionFreeText(
+#     question_name="name_gender",
+#     question_text="Is this customarily a boy's name or a girl's name: {{ name}}",
+# )
+
+q = QuestionList(
+    question_name="examples",
+    question_text="Give me {{ num }} examples of {{ thing }}",
+)
+
+survey_app = SurveyToApp(q.to_survey())
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(survey_app.create_app(path="/examples"), host="127.0.0.1", port=8000)

edsl/surveys/__init__.py

@@ -1,3 +1,5 @@
-from edsl.surveys.Survey import Survey
-from edsl.surveys.Rule import Rule
-from edsl.surveys.RuleCollection import RuleCollection
+from edsl.surveys.Survey import Survey
+from edsl.surveys.instructions.Instruction import Instruction
+
+# from edsl.surveys.Rule import Rule
+# from edsl.surveys.RuleCollection import RuleCollection

edsl/surveys/base.py

@@ -1,53 +1,53 @@
-"""Base classes and enumerations for the surveyor package."""
-
-from enum import Enum
-
-
-class RulePriority(Enum):
-    """Enumeration of the priority of a rule."""
-
-    DEFAULT = -1
-
-
-class EndOfSurveyParent:
-    """A named object that represents the end of the survey."""
-
-    pass
-
-    def __repr__(self):
-        """Return a string representation of the object."""
-        return "EndOfSurvey"
-
-    def __str__(self):
-        """Return a string representation of the object."""
-        return "EndOfSurvey"
-
-    def __bool__(self):
-        """Return False."""
-        return False
-
-    def __add__(self, other):
-        """Add the object to another object.
-
-        Example:
-        >>> e = EndOfSurveyParent()
-        >>> e + 1
-        EndOfSurvey
-        """
-        return self
-
-    def __deepcopy__(self, memo):
-        # Return the same instance when deepcopy is called
-        return self
-
-    def __radd__(self, other):
-        """Add the object to another object.
-
-        Example:
-        >>> 1 + EndOfSurveyParent()
-        EndOfSurvey
-        """
-        return self
-
-
-EndOfSurvey = EndOfSurveyParent()
+"""Base classes and enumerations for the surveyor package."""
+
+from enum import Enum
+
+
+class RulePriority(Enum):
+    """Enumeration of the priority of a rule."""
+
+    DEFAULT = -1
+
+
+class EndOfSurveyParent:
+    """A named object that represents the end of the survey."""
+
+    pass
+
+    def __repr__(self):
+        """Return a string representation of the object."""
+        return "EndOfSurvey"
+
+    def __str__(self):
+        """Return a string representation of the object."""
+        return "EndOfSurvey"
+
+    def __bool__(self):
+        """Return False."""
+        return False
+
+    def __add__(self, other):
+        """Add the object to another object.
+
+        Example:
+        >>> e = EndOfSurveyParent()
+        >>> e + 1
+        EndOfSurvey
+        """
+        return self
+
+    def __deepcopy__(self, memo):
+        # Return the same instance when deepcopy is called
+        return self
+
+    def __radd__(self, other):
+        """Add the object to another object.
+
+        Example:
+        >>> 1 + EndOfSurveyParent()
+        EndOfSurvey
+        """
+        return self
+
+
+EndOfSurvey = EndOfSurveyParent()

edsl/surveys/descriptors.py

@@ -1,56 +1,60 @@
-"""This module contains the descriptors for the classes in the edsl package."""
-
-from abc import ABC, abstractmethod
-from typing import Any
-from edsl.questions.QuestionBase import QuestionBase
-
-
-class BaseDescriptor(ABC):
-    """ABC for something."""
-
-    @abstractmethod
-    def validate(self, value: Any) -> None:
-        """Validate the value. If it is invalid, raise an exception. If it is valid, do nothing."""
-        pass
-
-    def __get__(self, instance, owner):
-        """Get the value of the attribute."""
-        return instance.__dict__[self.name]
-
-    def __set__(self, instance, value: Any) -> None:
-        """Set the value of the attribute."""
-        self.validate(value, instance)
-        instance.__dict__[self.name] = value
-
-    def __set_name__(self, owner, name: str) -> None:
-        """Set the name of the attribute."""
-        self.name = "_" + name
-
-
-class QuestionsDescriptor(BaseDescriptor):
-    """Descriptor for questions."""
-
-    def __get__(self, instance, owner):
-        """Get the value of the attribute."""
-        return instance.__dict__[self.name]
-
-    def validate(self, value: Any, instance) -> None:
-        """Validate the value. If it is invalid, raise an exception. If it is valid, do nothing."""
-        if not isinstance(value, list):
-            raise TypeError("Questions must be a list.")
-        if not all(isinstance(question, QuestionBase) for question in value):
-            raise TypeError("Questions must be a list of Question objects.")
-        question_names = [question.question_name for question in value]
-        if len(question_names) != len(set(question_names)):
-            raise ValueError("Question names must be unique.")
-
-    def __set__(self, instance, value: Any) -> None:
-        """Set the value of the attribute."""
-        self.validate(value, instance)
-        instance.__dict__[self.name] = []
-        for question in value:
-            instance.add_question(question)
-
-    def __set_name__(self, owner, name: str) -> None:
-        """Set the name of the attribute."""
-        self.name = "_" + name
+"""This module contains the descriptors for the classes in the edsl package."""
+
+from abc import ABC, abstractmethod
+from typing import Any, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from edsl.questions.QuestionBase import QuestionBase
+
+
+class BaseDescriptor(ABC):
+    """ABC for something."""
+
+    @abstractmethod
+    def validate(self, value: Any) -> None:
+        """Validate the value. If it is invalid, raise an exception. If it is valid, do nothing."""
+        pass
+
+    def __get__(self, instance, owner):
+        """Get the value of the attribute."""
+        return instance.__dict__[self.name]
+
+    def __set__(self, instance, value: Any) -> None:
+        """Set the value of the attribute."""
+        self.validate(value, instance)
+        instance.__dict__[self.name] = value
+
+    def __set_name__(self, owner, name: str) -> None:
+        """Set the name of the attribute."""
+        self.name = "_" + name
+
+
+class QuestionsDescriptor(BaseDescriptor):
+    """Descriptor for questions."""
+
+    def __get__(self, instance, owner):
+        """Get the value of the attribute."""
+        return instance.__dict__[self.name]
+
+    def validate(self, value: Any, instance) -> None:
+        """Validate the value. If it is invalid, raise an exception. If it is valid, do nothing."""
+        from edsl.questions.QuestionBase import QuestionBase
+
+        if not isinstance(value, list):
+            raise TypeError("Questions must be a list.")
+        if not all(isinstance(question, QuestionBase) for question in value):
+            raise TypeError("Questions must be a list of Question objects.")
+        question_names = [question.question_name for question in value]
+        if len(question_names) != len(set(question_names)):
+            raise ValueError("Question names must be unique.")
+
+    def __set__(self, instance, value: Any) -> None:
+        """Set the value of the attribute."""
+        self.validate(value, instance)
+        instance.__dict__[self.name] = []
+        for question in value:
+            instance.add_question(question)
+
+    def __set_name__(self, owner, name: str) -> None:
+        """Set the name of the attribute."""
+        self.name = "_" + name

edsl/surveys/instructions/ChangeInstruction.py

@@ -1,49 +1,48 @@
-from typing import List, Optional
-
-from edsl.utilities.decorators import add_edsl_version, remove_edsl_version
-
-
-class ChangeInstruction:
-    def __init__(
-        self,
-        keep: Optional[List[str]] = None,
-        drop: Optional[List[str]] = None,
-    ):
-        if keep is None and drop is None:
-            raise ValueError("Keep and drop cannot both be None")
-
-        self.keep = keep or []
-        self.drop = drop or []
-
-    def include_instruction(self, instruction_name) -> bool:
-        return (instruction_name in self.keep) or (not instruction_name in self.drop)
-
-    def add_name(self, index) -> None:
-        self.name = "change_instruction_{}".format(index)
-
-    def __str__(self):
-        return self.text
-
-    def to_dict(self, add_edsl_version=True):
-        d = {
-            "keep": self.keep,
-            "drop": self.drop,
-        }
-        if add_edsl_version:
-            from edsl import __version__
-
-            d["edsl_version"] = __version__
-            d["edsl_class_name"] = "ChangeInstruction"
-
-        return d
-
-    def __hash__(self) -> int:
-        """Return a hash of the question."""
-        from edsl.utilities.utilities import dict_hash
-
-        return dict_hash(self.to_dict(add_edsl_version=False))
-
-    @classmethod
-    @remove_edsl_version
-    def from_dict(cls, data):
-        return cls(data["keep"], data["drop"])
+from typing import List, Optional
+from edsl.utilities.remove_edsl_version import remove_edsl_version
+
+
+class ChangeInstruction:
+    def __init__(
+        self,
+        keep: Optional[List[str]] = None,
+        drop: Optional[List[str]] = None,
+    ):
+        if keep is None and drop is None:
+            raise ValueError("Keep and drop cannot both be None")
+
+        self.keep = keep or []
+        self.drop = drop or []
+
+    def include_instruction(self, instruction_name) -> bool:
+        return (instruction_name in self.keep) or (not instruction_name in self.drop)
+
+    def add_name(self, index) -> None:
+        self.name = "change_instruction_{}".format(index)
+
+    def __str__(self):
+        return self.text
+
+    def to_dict(self, add_edsl_version=True):
+        d = {
+            "keep": self.keep,
+            "drop": self.drop,
+        }
+        if add_edsl_version:
+            from edsl import __version__
+
+            d["edsl_version"] = __version__
+            d["edsl_class_name"] = "ChangeInstruction"
+
+        return d
+
+    def __hash__(self) -> int:
+        """Return a hash of the question."""
+        from edsl.utilities.utilities import dict_hash
+
+        return dict_hash(self.to_dict(add_edsl_version=False))
+
+    @classmethod
+    @remove_edsl_version
+    def from_dict(cls, data):
+        return cls(data["keep"], data["drop"])

edsl/surveys/instructions/Instruction.py

@@ -1,65 +1,56 @@
-from typing import Union, Optional, List, Generator, Dict
-from edsl.questions import QuestionBase
-
-from edsl.utilities.decorators import add_edsl_version, remove_edsl_version
-
-
-class Instruction:
-    def __init__(
-        self, name, text, preamble="You were given the following instructions:"
-    ):
-        self.name = name
-        self.text = text
-        self.preamble = preamble
-
-    def __str__(self):
-        return self.text
-
-    def __repr__(self):
-        return """Instruction(name="{}", text="{}")""".format(self.name, self.text)
-
-    def _repr_html_(self):
-        d = self.to_dict(add_edsl_version=False)
-        data = [[k, v] for k, v in d.items()]
-        from tabulate import tabulate
-
-        table = str(tabulate(data, headers=["keys", "values"], tablefmt="html"))
-        return f"<pre>{table}</pre>"
-
-    @classmethod
-    def example(cls) -> "Instruction":
-        return cls(name="example", text="This is an example instruction.")
-
-    def to_dict(self, add_edsl_version=True):
-        d = {
-            "name": self.name,
-            "text": self.text,
-            "edsl_class_name": "Instruction",
-            "preamble": self.preamble,
-        }
-        if add_edsl_version:
-            from edsl import __version__
-
-            d["edsl_version"] = __version__
-            d["edsl_class_name"] = "Instruction"
-        return d
-
-    def add_question(self, question) -> "Survey":
-        from edsl import Survey
-
-        return Survey([self, question])
-
-    def __hash__(self) -> int:
-        """Return a hash of the question."""
-        from edsl.utilities.utilities import dict_hash
-
-        return dict_hash(self.to_dict(add_edsl_version=False))
-
-    @classmethod
-    @remove_edsl_version
-    def from_dict(cls, data):
-        return cls(
-            data["name"],
-            data["text"],
-            data.get("preamble", "You were given the following instructions:"),
-        )
+from typing import Union, Optional, List, Generator, Dict
+from edsl.utilities.remove_edsl_version import remove_edsl_version
+from edsl.Base import RepresentationMixin
+
+
+class Instruction(RepresentationMixin):
+    def __init__(
+        self, name, text, preamble="You were given the following instructions:"
+    ):
+        self.name = name
+        self.text = text
+        self.preamble = preamble
+
+    def __str__(self):
+        return self.text
+
+    def __repr__(self):
+        return """Instruction(name="{}", text="{}")""".format(self.name, self.text)
+
+    @classmethod
+    def example(cls) -> "Instruction":
+        return cls(name="example", text="This is an example instruction.")
+
+    def to_dict(self, add_edsl_version=True):
+        d = {
+            "name": self.name,
+            "text": self.text,
+            "edsl_class_name": "Instruction",
+            "preamble": self.preamble,
+        }
+        if add_edsl_version:
+            from edsl import __version__
+
+            d["edsl_version"] = __version__
+            d["edsl_class_name"] = "Instruction"
+        return d
+
+    def add_question(self, question) -> "Survey":
+        from edsl.surveys.Survey import Survey
+
+        return Survey([self, question])
+
+    def __hash__(self) -> int:
+        """Return a hash of the question."""
+        from edsl.utilities.utilities import dict_hash
+
+        return dict_hash(self.to_dict(add_edsl_version=False))
+
+    @classmethod
+    @remove_edsl_version
+    def from_dict(cls, data):
+        return cls(
+            data["name"],
+            data["text"],
+            data.get("preamble", "You were given the following instructions:"),
+        )