Initial implementation of pydantic driven QTI XML generation.

Author: rtibbles

contentcuration/contentcuration/tests/utils/qti/test_assessment_items.py

@@ -257,7 +257,7 @@ def test_long_text_question(self):
 <p>Sam</p>
 </blockquote>
 </div>
-<qti-extended-text-interaction response-identifier="RESPONSE">
+<qti-extended-text-interaction response-identifier="RESPONSE" min-strings="0" format="plain">
 <qti-prompt>Write Sam a postcard. Answer the questions. Write 23–30 words</qti-prompt>
 </qti-extended-text-interaction>
 </qti-item-body>

contentcuration/contentcuration/tests/utils/qti/test_html.py

@@ -140,10 +140,12 @@ def test_embed_elements(self):
         )
 
     def test_flow_elements(self):
-        blockquote_element = Blockquote(children=["Test Blockquote"], cite="test.com")
+        blockquote_element = Blockquote(
+            children=["Test Blockquote"], cite="http://test.com"
+        )
         self.assertEqual(
             blockquote_element.to_xml_string(),
-            '<blockquote cite="test.com">Test Blockquote</blockquote>',
+            '<blockquote cite="http://test.com/">Test Blockquote</blockquote>',
         )
 
         div_element = Div(children=["Test Div"])

contentcuration/contentcuration/tests/utils/qti/test_imsmanifest.py

@@ -2,16 +2,16 @@
 
 from contentcuration.utils.assessment.qti.imsmanifest import Dependency
 from contentcuration.utils.assessment.qti.imsmanifest import File
-from contentcuration.utils.assessment.qti.imsmanifest import IMSManifest
 from contentcuration.utils.assessment.qti.imsmanifest import Item
+from contentcuration.utils.assessment.qti.imsmanifest import Manifest
 from contentcuration.utils.assessment.qti.imsmanifest import Metadata
 from contentcuration.utils.assessment.qti.imsmanifest import Organization
 from contentcuration.utils.assessment.qti.imsmanifest import Organizations
 from contentcuration.utils.assessment.qti.imsmanifest import Resource
 from contentcuration.utils.assessment.qti.imsmanifest import Resources
 
 
-class TestIMSManifestXMLOutput(unittest.TestCase):
+class TestManifestXMLOutput(unittest.TestCase):
     def test_metadata_to_xml_string(self):
         metadata = Metadata(schema="test_schema", schemaversion="1.0")
         expected_xml = "<metadata><schema>test_schema</schema><schemaversion>1.0</schemaversion></metadata>"
@@ -93,7 +93,7 @@ def test_imsmanifest_to_xml_string(self):
         resources = Resources(
             resources=[Resource(identifier="res1", type_="webcontent")]
         )
-        manifest = IMSManifest(
+        manifest = Manifest(
             identifier="manifest1",
             version="1.0",
             metadata=metadata,
@@ -112,16 +112,17 @@ def test_imsmanifest_to_xml_string(self):
         )
         self.assertEqual(manifest.to_xml_string(), expected_xml)
 
-        manifest = IMSManifest()
+        manifest = Manifest(identifier="democracy_manifest")
         expected_xml = (
             '<manifest xmlns="http://www.imsglobal.org/xsd/qti/qtiv3p0/imscp_v1p2" '
             'xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" '
-            'xsi:schemaLocation="http://www.imsglobal.org/xsd/qti/qtiv3p0/imscp_v1p2 https://purl.imsglobal.org/spec/qti/v3p0/schema/xsd/imsqtiv3p0_imscpv1p2_v1p0.xsd" />'  # noqa: E501
+            'xsi:schemaLocation="http://www.imsglobal.org/xsd/qti/qtiv3p0/imscp_v1p2 https://purl.imsglobal.org/spec/qti/v3p0/schema/xsd/imsqtiv3p0_imscpv1p2_v1p0.xsd" '  # noqa: E501
+            'identifier="democracy_manifest" />'
         )
         self.assertEqual(manifest.to_xml_string(), expected_xml)
 
     def test_imsmanifest_full_integration(self):
-        manifest = IMSManifest(
+        manifest = Manifest(
             identifier="level1-T1-test-entry",
             version="1.0",
             metadata=Metadata(schema="QTI Package", schemaversion="3.0.0"),

contentcuration/contentcuration/tests/utils/qti/test_qti.py

@@ -125,10 +125,8 @@ def test_text_entry_interaction_element(self):
     def test_extended_text_interaction_element(self):
         extended_text_interaction = ExtendedTextInteraction(
             response_identifier="extendedText1",
-            rows=5,
-            cols=30,
             placeholder_text="Enter your essay here.",
             prompt=Prompt(children=["What is truth?"]),
         )
-        expected_xml = '<qti-extended-text-interaction response-identifier="extendedText1" rows="5" cols="30" placeholder-text="Enter your essay here."><qti-prompt>What is truth?</qti-prompt></qti-extended-text-interaction>'  # noqa: E501
+        expected_xml = '<qti-extended-text-interaction response-identifier="extendedText1" placeholder-text="Enter your essay here." min-strings="0" format="plain"><qti-prompt>What is truth?</qti-prompt></qti-extended-text-interaction>'  # noqa: E501
         self.assertEqual(extended_text_interaction.to_xml_string(), expected_xml)

contentcuration/contentcuration/utils/assessment/qti/assessment_item.py

@@ -4,6 +4,7 @@
 
 from pydantic import AnyUrl
 from pydantic import Field
+from pydantic import PositiveInt
 
 from contentcuration.utils.assessment.qti.base import BaseSequence
 from contentcuration.utils.assessment.qti.base import QTIBase
@@ -14,7 +15,6 @@
 from contentcuration.utils.assessment.qti.constants import View
 from contentcuration.utils.assessment.qti.fields import BCP47Language
 from contentcuration.utils.assessment.qti.fields import LocalHrefPath
-from contentcuration.utils.assessment.qti.fields import PositiveInt
 from contentcuration.utils.assessment.qti.html import BlockContentElement
 from contentcuration.utils.assessment.qti.interaction_types.base import BlockInteraction
 

contentcuration/contentcuration/utils/assessment/qti/base.py

@@ -99,10 +99,9 @@ def to_element(self) -> ET.Element:  # noqa: C901
                                 element.text = (element.text or "") + item.text
 
                     continue
-                else:
-                    raise ValueError(
-                        "List types should only contain XMLElement or TextNodes"
-                    )
+                raise ValueError(
+                    "List types should only contain XMLElement or TextNodes"
+                )
 
             elif isinstance(value, bool):
                 value = str(value).lower()

contentcuration/contentcuration/utils/assessment/qti/constants.py

@@ -30,7 +30,7 @@ class View(Enum):
     CANDIDATE = "candidate"
     PROCTOR = "proctor"
     SCORER = "scorer"
-    TEST_CONDUCTOR = "testConstructor"
+    TEST_CONSTRUCTOR = "testConstructor"
     TUTOR = "tutor"
 
 

contentcuration/contentcuration/utils/assessment/qti/fields.py

@@ -7,9 +7,6 @@
 from pydantic import Field
 
 
-PositiveInt = Annotated[int, Field(gt=0)]
-
-
 def validate_bcp47_language(value: str) -> str:
     """Validate and normalize BCP47 language tag."""
     if not isinstance(value, str):
@@ -22,7 +19,7 @@ def validate_bcp47_language(value: str) -> str:
         # Validate and normalize using langcodes
         return LangCodesLanguage.get(value).to_tag()
     except ValueError as e:
-        raise ValueError(f"Invalid BCP47 language tag: {e}")
+        raise ValueError("Invalid BCP47 language tag") from e
 
 
 BCP47Language = Annotated[str, BeforeValidator(validate_bcp47_language)]
@@ -106,3 +103,16 @@ def validate_local_srcset(value: str) -> str:
 LocalHrefPath = Annotated[str, BeforeValidator(validate_local_href_path)]
 LocalSrcPath = Annotated[str, BeforeValidator(validate_local_src_path)]
 LocalSrcSet = Annotated[str, BeforeValidator(validate_local_srcset)]
+
+
+QTIIdentifier = Annotated[
+    str,
+    Field(
+        pattern=r"^[a-zA-Z_][a-zA-Z0-9_\-.]{0,31}$",
+        min_length=1,
+        max_length=32,
+        description="QTI XML identifier: must start with letter or underscore, "
+        "contain only letters, digits, underscores, hyphens, and periods, "
+        "no colons, max 32 characters",
+    ),
+]

contentcuration/contentcuration/utils/assessment/qti/html/base.py

@@ -5,6 +5,8 @@
 from typing import Type
 from typing import Union
 
+from pydantic import model_validator
+
 from contentcuration.utils.assessment.qti.base import BaseSequence
 from contentcuration.utils.assessment.qti.base import TextNode
 from contentcuration.utils.assessment.qti.fields import LocalSrcPath
@@ -142,6 +144,9 @@ class Source(HTMLElement):
     height: Optional[int] = None
     width: Optional[int] = None
 
-    @classmethod
-    def element_name(cls):
-        return "source"
+    @model_validator(mode="after")
+    def _check_src_and_srcset(self):
+        # both None or both set
+        if (self.src is None) == (self.srcset is None):
+            raise ValueError("Exactly one of 'src' or 'srcset' must be specified")
+        return self

contentcuration/contentcuration/utils/assessment/qti/html/flow.py

@@ -1,6 +1,7 @@
 from typing import Optional
 
 from pydantic import Field
+from pydantic import HttpUrl
 
 from contentcuration.utils.assessment.qti.html.base import BlockContentElement
 from contentcuration.utils.assessment.qti.html.content_types import FlowContentList
@@ -17,7 +18,7 @@ class HTMLFlowContainer(BlockContentElement):
 
 
 class Blockquote(HTMLFlowContainer):
-    cite: Optional[str] = None
+    cite: Optional[HttpUrl] = None
 
 
 class Div(HTMLFlowContainer):