rename from_yaml and remove expected_completion_time

canvas_sdk/questionnaires/__init__.py

@@ -1,3 +1,3 @@
-from .utils import from_yaml
+from .utils import from_yaml as questionnaire_from_yaml
 
-__all__ = ("from_yaml",)
+__all__ = ("questionnaire_from_yaml",)

canvas_sdk/questionnaires/tests/test_utils.py

@@ -6,7 +6,7 @@
 
 from canvas_sdk.effects import Effect
 from canvas_sdk.events import Event, EventRequest, EventType
-from canvas_sdk.questionnaires import from_yaml
+from canvas_sdk.questionnaires import questionnaire_from_yaml
 from plugin_runner.plugin_runner import LOADED_PLUGINS
 from settings import PLUGIN_DIRECTORY
 
@@ -56,4 +56,4 @@ def test_from_yaml_forbidden_questionnaire(
 
 def test_from_yaml_non_plugin_caller() -> None:
     """Test that the from_yaml function returns None when called outside a plugin."""
-    assert from_yaml("questionnaires/example_questionnaire.yml") is None
+    assert questionnaire_from_yaml("questionnaires/example_questionnaire.yml") is None

canvas_sdk/questionnaires/utils.py

@@ -1,7 +1,10 @@
+import functools
+import json
 from pathlib import Path
 from typing import Any, TypedDict
 
 import yaml
+from jsonschema import validate
 
 from canvas_sdk.utils.plugins import plugin_only
 
@@ -43,7 +46,6 @@ class QuestionnaireConfig(TypedDict):
     content: str
     prologue: str
     use_in_shx: bool
-    expected_completion_time: float
     questions: list[Question]
 
 
@@ -63,6 +65,7 @@ def from_yaml(questionnaire_name: str, **kwargs: Any) -> QuestionnaireConfig | N
         FileNotFoundError: If the questionnaire file does not exist within the plugin's directory
             or if the resolved path is invalid.
         PermissionError: If the resolved path is outside the plugin's directory.
+        ValidationError: If the questionnaire file does not conform to the JSON schema.
     """
     plugin_dir = kwargs["plugin_dir"]
     questionnaire_config_path = Path(plugin_dir / questionnaire_name.lstrip("/")).resolve()
@@ -73,5 +76,16 @@ def from_yaml(questionnaire_name: str, **kwargs: Any) -> QuestionnaireConfig | N
         raise FileNotFoundError(f"Questionnaire {questionnaire_name} not found.")
 
     questionnaire_config = yaml.load(questionnaire_config_path.read_text(), Loader=yaml.SafeLoader)
+    validate(questionnaire_config, json_schema())
 
     return questionnaire_config
+
+
+@functools.cache
+def json_schema() -> dict[str, Any]:
+    """Reads the JSON schema for a Questionnaire Config."""
+    schema = json.loads(
+        (Path(__file__).resolve().parent.parent.parent / "schemas/questionnaire.json").read_text()
+    )
+
+    return schema

schemas/questionnaire.json

@@ -23,7 +23,6 @@
         "content": { "type": "string" },
         "prologue": { "type": "string" },
         "use_in_shx": { "type": "boolean" },
-        "expected_completion_time": { "type": "number" },
         "questions": {
             "type": "array",
             "minItems": 1,
@@ -68,5 +67,5 @@
             }
         }
     },
-    "required": ["name", "use_case_in_charting", "code_system", "code", "questions", "expected_completion_time"]
+    "required": ["name", "use_case_in_charting", "code_system", "code", "questions"]
 }