add additionalNotesObj

Author: Remi-Gau

reproschema/models/base.py

@@ -1,6 +1,7 @@
 import json
 import os
 from pathlib import Path
+from typing import Any
 from typing import Dict
 from typing import List
 from typing import Optional
@@ -43,6 +44,32 @@ def COMMON_SCHEMA_ORDER() -> list:
     ]
 
 
+@define(kw_only=True)
+class AdditionalNoteObj(SchemaUtils):
+    column: Optional[str] = field(
+        factory=(str),
+        converter=default_if_none(default=""),  # type: ignore
+        validator=optional(instance_of(str)),
+    )
+    source: Optional[str] = field(
+        factory=(str),
+        converter=default_if_none(default=""),  # type: ignore
+        validator=optional(instance_of(str)),
+    )
+    value: Any = field(default=None)
+
+    def __attrs_post_init__(self) -> None:
+
+        if self.schema_order in [None, []]:
+            self.schema_order = [
+                "column",
+                "source",
+                "value",
+            ]
+
+        self.update().sort_schema()
+
+
 @define(kw_only=True)
 class Message(SchemaUtils):
 
@@ -216,6 +243,11 @@ def _default_context(self) -> str:
         converter=default_if_none(default={}),  # type: ignore
         validator=optional(instance_of(dict)),
     )
+    additionalNotesObj: Optional[list] = field(
+        factory=(list),
+        converter=default_if_none(default=[]),  # type: ignore
+        validator=optional(instance_of(list)),
+    )
 
     """
     UI related
@@ -318,6 +350,7 @@ def update(self) -> None:
             "compute",
             "question",
             "messages",
+            "additionalNotesObj",
         ]
         for key in keys_to_update:
             self.schema[key] = self.__getattribute__(key)

reproschema/models/item.py

@@ -1,5 +1,7 @@
 from pathlib import Path
+from typing import Any
 from typing import Dict
+from typing import List
 from typing import Optional
 from typing import Union
 
@@ -27,6 +29,7 @@ def __init__(
         audio: Optional[Union[str, Dict[str, str]]] = None,
         video: Optional[Union[str, Dict[str, str]]] = None,
         preamble: Optional[str] = None,
+        additionalNotesObj: List[Dict[str, Any]] = None,
         visible: Optional[bool] = True,
         required: Optional[bool] = False,
         skippable: Optional[bool] = True,
@@ -43,6 +46,7 @@ def __init__(
         schema_order = COMMON_SCHEMA_ORDER() + [
             "question",
             "responseOptions",
+            "additionalNotesObj",
         ]
 
         super().__init__(
@@ -57,6 +61,7 @@ def __init__(
             image=image,
             audio=audio,
             video=video,
+            additionalNotesObj=additionalNotesObj,
             schema_order=schema_order,
             visible=visible,
             required=required,

reproschema/models/tests/test_item.py

@@ -1,5 +1,4 @@
 import os
-from asyncio import QueueEmpty
 from pathlib import Path
 
 import pytest
@@ -8,6 +7,7 @@
 from utils import output_dir
 from utils import read_json
 
+from reproschema.models.base import AdditionalNoteObj
 from reproschema.models.item import Item
 from reproschema.models.item import ResponseOption
 
@@ -166,6 +166,20 @@ def test_slider():
 
 def test_item1():
 
+    additionalNotes = [
+        AdditionalNoteObj(
+            column="notes", source="redcap", value="some extra note"
+        ).schema
+    ]
+    print(additionalNotes)
+    additionalNotes.append(
+        AdditionalNoteObj(
+            column="notes",
+            source="redcap",
+            value={"@id": "http://example.com/iri-example"},
+        ).schema
+    )
+
     item = Item(
         name="item1",
         input_type="radio",
@@ -179,6 +193,7 @@ def test_item1():
             "@type": "AudioObject",
             "contentUrl": "http://media.freesound.org/sample-file.mp4",
         },
+        additionalNotesObj=additionalNotes,
         read_only=None,
         output_dir=item_dir,
     )