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

edsl/questions/loop_processor.py

@@ -0,0 +1,149 @@
+from typing import List, Any, Dict, Union
+from jinja2 import Environment
+from edsl.questions.QuestionBase import QuestionBase
+from edsl import ScenarioList
+
+
+class LoopProcessor:
+    def __init__(self, question: QuestionBase):
+        self.question = question
+        self.env = Environment()
+
+    def process_templates(self, scenario_list: ScenarioList) -> List[QuestionBase]:
+        """Process templates for each scenario and return list of modified questions.
+
+        Args:
+            scenario_list: List of scenarios to process templates against
+
+        Returns:
+            List of QuestionBase objects with rendered templates
+        """
+        questions = []
+        starting_name = self.question.question_name
+
+        for index, scenario in enumerate(scenario_list):
+            question_data = self.question.to_dict().copy()
+            processed_data = self._process_data(question_data, scenario)
+
+            if processed_data["question_name"] == starting_name:
+                processed_data["question_name"] += f"_{index}"
+
+            questions.append(QuestionBase.from_dict(processed_data))
+
+        return questions
+
+    def _process_data(
+        self, data: Dict[str, Any], scenario: Dict[str, Any]
+    ) -> Dict[str, Any]:
+        """Process all data fields according to their type.
+
+        Args:
+            data: Dictionary of question data
+            scenario: Current scenario to render templates against
+
+        Returns:
+            Processed dictionary with rendered templates
+        """
+        processed = {}
+
+        for key, value in [(k, v) for k, v in data.items() if v is not None]:
+            processed[key] = self._process_value(key, value, scenario)
+
+        return processed
+
+    def _process_value(self, key: str, value: Any, scenario: Dict[str, Any]) -> Any:
+        """Process a single value according to its type.
+
+        Args:
+            key: Dictionary key
+            value: Value to process
+            scenario: Current scenario
+
+        Returns:
+            Processed value
+        """
+        if key == "question_options" and isinstance(value, str):
+            return value
+
+        if key == "option_labels":
+            import json
+
+            return (
+                eval(self._render_template(value, scenario))
+                if isinstance(value, str)
+                else value
+            )
+
+        if isinstance(value, str):
+            return self._render_template(value, scenario)
+
+        if isinstance(value, list):
+            return self._process_list(value, scenario)
+
+        if isinstance(value, dict):
+            return self._process_dict(value, scenario)
+
+        if isinstance(value, (int, float)):
+            return value
+
+        raise ValueError(f"Unexpected value type: {type(value)} for key '{key}'")
+
+    def _render_template(self, template: str, scenario: Dict[str, Any]) -> str:
+        """Render a single template string.
+
+        Args:
+            template: Template string to render
+            scenario: Current scenario
+
+        Returns:
+            Rendered template string
+        """
+        return self.env.from_string(template).render(scenario)
+
+    def _process_list(self, items: List[Any], scenario: Dict[str, Any]) -> List[Any]:
+        """Process all items in a list.
+
+        Args:
+            items: List of items to process
+            scenario: Current scenario
+
+        Returns:
+            List of processed items
+        """
+        return [
+            self._render_template(item, scenario) if isinstance(item, str) else item
+            for item in items
+        ]
+
+    def _process_dict(
+        self, data: Dict[str, Any], scenario: Dict[str, Any]
+    ) -> Dict[str, Any]:
+        """Process all keys and values in a dictionary.
+
+        Args:
+            data: Dictionary to process
+            scenario: Current scenario
+
+        Returns:
+            Dictionary with processed keys and values
+        """
+        return {
+            (self._render_template(k, scenario) if isinstance(k, str) else k): (
+                self._render_template(v, scenario) if isinstance(v, str) else v
+            )
+            for k, v in data.items()
+        }
+
+
+# Usage example:
+"""
+from edsl import QuestionFreeText, ScenarioList
+
+question = QuestionFreeText(
+    question_text="What are your thoughts on: {{subject}}?",
+    question_name="base_{{subject}}"
+)
+processor = TemplateProcessor(question)
+scenarios = ScenarioList.from_list("subject", ["Math", "Economics", "Chemistry"])
+processed_questions = processor.process_templates(scenarios)
+"""

edsl/questions/prompt_templates/question_budget.jinja

@@ -1,13 +1,13 @@
-You are being asked the following question: {{question_text}}
-The options are:
-{% for option in question_options %}
-    {{ loop.index0 }}: {{option}}
-{% endfor %}                       
-Return a valid JSON formatted as follows, with a dictionary for your "answer" 
-where the keys are the option numbers and the values are the amounts you want 
-to allocate to the options, and the sum of the values is {{budget_sum}}:
-
-{"answer": {<put dict of option numbers and allocation amounts here>}, "comment": "<put explanation here>"}
-Example response for a budget of 100 and 4 options: 
-{"answer": {"0": 25, "1": 25, "2": 25, "3": 25}, "comment": "I allocated 25 to each option."}
-There must be an allocation listed for each item (including 0).
+You are being asked the following question: {{question_text}}
+The options are:
+{% for option in question_options %}
+    {{ loop.index0 }}: {{option}}
+{% endfor %}                       
+Return a valid JSON formatted as follows, with a dictionary for your "answer" 
+where the keys are the option numbers and the values are the amounts you want 
+to allocate to the options, and the sum of the values is {{budget_sum}}:
+
+{"answer": {<put dict of option numbers and allocation amounts here>}, "comment": "<put explanation here>"}
+Example response for a budget of 100 and 4 options: 
+{"answer": {"0": 25, "1": 25, "2": 25, "3": 25}, "comment": "I allocated 25 to each option."}
+There must be an allocation listed for each item (including 0).

edsl/questions/prompt_templates/question_checkbox.jinja

@@ -1,32 +1,32 @@
-{# Question Presention #}
-{{question_text}}
-{% if use_code %}
-    {% for option in question_options %}
-        {{ loop.index0 }}: {{option}}
-    {% endfor %}
-{% else %}
-    {% for option in question_options %}
-        {{ option }}
-    {% endfor %}    
-{% endif %}
-
-{# Restrictions #}
-{% if min_selections != None and max_selections != None and min_selections == max_selections %}
-    You must select exactly {{min_selections}} options.
-{% elif min_selections != None and max_selections != None %}
-    Minimum number of options that must be selected: {{min_selections}}.
-    Maximum number of options that must be selected: {{max_selections}}.
-{% elif min_selections != None %}
-    Minimum number of options that must be selected: {{min_selections}}.
-{% elif max_selections != None %}
-    Maximum number of options that must be selected: {{max_selections}}.
-{% endif %}
-
-{# Answering Instructions #}
-Please respond with valid JSON, formatted like so:
-{% if include_comment %}
-    {"answer": [<put comma-separated list here>], "comment": "<put explanation here>"}
-{% else %}
-    {"answer": [<put comma-separated list here>]}
-{% endif %}
-
+{# Question Presention #}
+{{question_text}}
+{% if use_code %}
+    {% for option in question_options %}
+        {{ loop.index0 }}: {{option}}
+    {% endfor %}
+{% else %}
+    {% for option in question_options %}
+        {{ option }}
+    {% endfor %}    
+{% endif %}
+
+{# Restrictions #}
+{% if min_selections != None and max_selections != None and min_selections == max_selections %}
+    You must select exactly {{min_selections}} options.
+{% elif min_selections != None and max_selections != None %}
+    Minimum number of options that must be selected: {{min_selections}}.
+    Maximum number of options that must be selected: {{max_selections}}.
+{% elif min_selections != None %}
+    Minimum number of options that must be selected: {{min_selections}}.
+{% elif max_selections != None %}
+    Maximum number of options that must be selected: {{max_selections}}.
+{% endif %}
+
+{# Answering Instructions #}
+Please respond with valid JSON, formatted like so:
+{% if include_comment %}
+    {"answer": [<put comma-separated list here>], "comment": "<put explanation here>"}
+{% else %}
+    {"answer": [<put comma-separated list here>]}
+{% endif %}
+

edsl/questions/prompt_templates/question_extract.jinja

@@ -1,11 +1,11 @@
-{{question_text}}
-
-Create an ANSWER should be formatted like this: 
-{{ answer_template }}
-
-It should have the same keys but values extracted from the input.
-If the value of a key is not present in the input, fill with "null".
-
-Return a valid JSON formatted like this:
-{"answer": <put your ANSWER here>}
-ONLY RETURN THE JSON, AND NOTHING ELSE.
+{{question_text}}
+
+Create an ANSWER should be formatted like this: 
+{{ answer_template }}
+
+It should have the same keys but values extracted from the input.
+If the value of a key is not present in the input, fill with "null".
+
+Return a valid JSON formatted like this:
+{"answer": <put your ANSWER here>}
+ONLY RETURN THE JSON, AND NOTHING ELSE.

edsl/questions/prompt_templates/question_free_text.jinja

@@ -1,3 +1,3 @@
-{{question_text}}
-Return a valid JSON formatted like this: 
-{"answer": "<put free text answer here>"}
+{{question_text}}
+Return a valid JSON formatted like this: 
+{"answer": "<put free text answer here>"}

edsl/questions/prompt_templates/question_linear_scale.jinja

@@ -1,11 +1,11 @@
-    {{question_text}}
-        {% for option in question_options %}
-            {{option}} : {{ option_labels.get(option, "") }}
-        {% endfor %}
-    Return a valid JSON formatted like this, selecting only the code of the option (codes start at 0):
-    {% if include_comment %}  
-        {"answer": <put answer code here>, "comment": <comment>} 
-    {% else %} 
-        {"answer": <put answer here>} 
-    {% endif %}
-    Only 1 option may be selected.
+    {{question_text}}
+        {% for option in question_options %}
+            {{option}} : {{ option_labels.get(option, "") }}
+        {% endfor %}
+    Return a valid JSON formatted like this, selecting only the code of the option (codes start at 0):
+    {% if include_comment %}  
+        {"answer": <put answer code here>, "comment": <comment>} 
+    {% else %} 
+        {"answer": <put answer here>} 
+    {% endif %}
+    Only 1 option may be selected.

edsl/questions/prompt_templates/question_list.jinja

@@ -1,17 +1,17 @@
-{{question_text}}
-
-Your response should be only a valid JSON in the following format:
-{% if include_comment %}
-    {
-    "answer": [<comma-separated list of responsive words or phrases as independent strings>],
-    "comment": "<put comment here>"
-    }
-{% else %}
-    {
-    "answer": [<comma-separated list of responsive words or phrases as independent strings>],
-    }
-{% endif %}
-
-{% if max_list_items is not none %}
-The list must not contain more than {{ max_list_items }} items.
-{% endif %}
+{{question_text}}
+
+Your response should be only a valid JSON in the following format:
+{% if include_comment %}
+    {
+    "answer": [<comma-separated list of responsive words or phrases as independent strings>],
+    "comment": "<put comment here>"
+    }
+{% else %}
+    {
+    "answer": [<comma-separated list of responsive words or phrases as independent strings>],
+    }
+{% endif %}
+
+{% if max_list_items is not none %}
+The list must not contain more than {{ max_list_items }} items.
+{% endif %}

edsl/questions/prompt_templates/question_multiple_choice.jinja

@@ -1,33 +1,33 @@
-{# Question Presention #}
-{{question_text}}
-
-{% if use_code %}
-    {% for option in question_options %}
-        {{ loop.index0 }}: {{option}}
-    {% endfor %}
-{% else %}
-    {% for option in question_options %}
-        {{option}}
-    {% endfor %}
-{% endif %}
-
-Only 1 option may be selected.
-
-{# Answering Instructions #}
-Return a valid JSON formatted like this:
-
-{% if use_code %}
-    {% if include_comment %}
-        {"answer": <put answer code here>, "comment": "<put explanation here>"}
-    {% else %}
-        {"answer": <put answer code here>}
-    {% endif %}
-{% else %}
-
-    {% if include_comment %}
-        {"answer": <text of option>, "comment": "<put explanation here>"}
-    {% else %}
-        {"answer": <put option here>}
-    {% endif %}
-
-{% endif %}
+{# Question Presention #}
+{{question_text}}
+
+{% if use_code %}
+    {% for option in question_options %}
+        {{ loop.index0 }}: {{option}}
+    {% endfor %}
+{% else %}
+    {% for option in question_options %}
+        {{option}}
+    {% endfor %}
+{% endif %}
+
+Only 1 option may be selected.
+
+{# Answering Instructions #}
+Return a valid JSON formatted like this:
+
+{% if use_code %}
+    {% if include_comment %}
+        {"answer": <put answer code here>, "comment": "<put explanation here>"}
+    {% else %}
+        {"answer": <put answer code here>}
+    {% endif %}
+{% else %}
+
+    {% if include_comment %}
+        {"answer": <text of option>, "comment": "<put explanation here>"}
+    {% else %}
+        {"answer": <put option here>}
+    {% endif %}
+
+{% endif %}

edsl/questions/prompt_templates/question_numerical.jinja

@@ -1,37 +1,37 @@
-You are being asked a question that requires a numerical response 
-in the form of an integer or decimal (e.g., -12, 0, 1, 2, 3.45, ...).
-        
-Your response must be in the following format:
-
-{% if include_comment %}
-    {"answer": "<your numerical answer here>", "comment": "<your explanation here>"}
-{% else %}
-    {"answer": "<your numerical answer here>"}
-{% endif %}
-
-You must only include an integer or decimal in the quoted "answer" part of your response.
-        
-Here is an example of a valid response:
-{% if include_comment %}
-    {"answer": "100", "comment": "This is my explanation..."}
-{% else %}
-    {"answer": "100"}
-{% endif %}
-        
-Here is an example of a response that is invalid because the "answer" includes words:
-{"answer": "I don't know.", ...}
-
-If your response is equivalent to zero, your formatted response should look like this:
-{% if include_comment %}
-    {"answer": "0", "comment": "This is my explanation..."}
-{% else %}
-    {"answer": "0"}
-{% endif %}
-
-You are being asked the following question: {{question_text}}
-{% if min_value is not none %}
-    Minimum answer value: {{min_value}}
-{% endif %}
-{% if max_value is not none %}
-    Maximum answer value: {{max_value}}
+You are being asked a question that requires a numerical response 
+in the form of an integer or decimal (e.g., -12, 0, 1, 2, 3.45, ...).
+        
+Your response must be in the following format:
+
+{% if include_comment %}
+    {"answer": "<your numerical answer here>", "comment": "<your explanation here>"}
+{% else %}
+    {"answer": "<your numerical answer here>"}
+{% endif %}
+
+You must only include an integer or decimal in the quoted "answer" part of your response.
+        
+Here is an example of a valid response:
+{% if include_comment %}
+    {"answer": "100", "comment": "This is my explanation..."}
+{% else %}
+    {"answer": "100"}
+{% endif %}
+        
+Here is an example of a response that is invalid because the "answer" includes words:
+{"answer": "I don't know.", ...}
+
+If your response is equivalent to zero, your formatted response should look like this:
+{% if include_comment %}
+    {"answer": "0", "comment": "This is my explanation..."}
+{% else %}
+    {"answer": "0"}
+{% endif %}
+
+You are being asked the following question: {{question_text}}
+{% if min_value is not none %}
+    Minimum answer value: {{min_value}}
+{% endif %}
+{% if max_value is not none %}
+    Maximum answer value: {{max_value}}
 {% endif %}