Merge pull request #778 from lindsay-stevens/pyxform-775

775: Support Entities from repeats

Author: lognaturel

pyxform/aliases.py

@@ -123,7 +123,6 @@
     "audio": survey_header["audio"],
     "video": survey_header["video"],
 }
-# Note that most of the type aliasing happens in all.xls
 _type_alias_map = {
     "imei": "deviceid",
     "image": "photo",

pyxform/constants.py

@@ -86,6 +86,7 @@
 OSM_TYPE = "binary"
 
 NAMESPACES = "namespaces"
+META = "meta"
 
 # The following are the possible sheet names:
 SUPPORTED_SHEET_NAMES = {
@@ -113,10 +114,15 @@
 # The ODK XForms version that generated forms comply to
 CURRENT_XFORMS_VERSION = "1.0.0"
 
+
 # The ODK entities spec version that generated forms comply to
-ENTITIES_OFFLINE_VERSION = "2024.1.0"
+class EntityVersion(StrEnum):
+    v2024_1_0 = "2024.1.0"
+    v2025_1_0 = "2025.1.0"
+
+
 ENTITY = "entity"
-ENTITY_FEATURES = "entity_features"
+ENTITY_VERSION = "entity_version"
 ENTITIES_RESERVED_PREFIX = "__"
 
 
@@ -125,6 +131,7 @@ class EntityColumns(StrEnum):
     ENTITY_ID = "entity_id"
     CREATE_IF = "create_if"
     UPDATE_IF = "update_if"
+    REPEAT = "repeat"
     LABEL = "label"
 
 
@@ -169,3 +176,4 @@ class EntityColumns(StrEnum):
 }
 SUPPORTED_MEDIA_TYPES = {"image", "big-image", "audio", "video"}
 OR_OTHER_CHOICE = {NAME: "other", LABEL: "Other"}
+RESERVED_NAMES_SURVEY_SHEET = {META}

pyxform/elements/__init__.py

@@ -0,0 +1,158 @@
+from enum import Enum
+
+from pyxform.elements.element import Element
+from pyxform.util.enum import StrEnum
+from pyxform.utils import node
+
+
+class Event(StrEnum):
+    """
+    Supported W3C XForms 1.1 Events and ODK extensions.
+    """
+
+    # For actions in model under /html/head/model
+    ODK_INSTANCE_FIRST_LOAD = "odk-instance-first-load"
+    ODK_INSTANCE_LOAD = "odk-instance-load"
+    # For actions in repeat control under /html/body
+    ODK_NEW_REPEAT = "odk-new-repeat"
+    # For actions in question control under /html/body
+    XFORMS_VALUE_CHANGED = "xforms-value-changed"
+
+
+class Action(Element):
+    """
+    Base class for supported Action elements.
+
+    https://getodk.github.io/xforms-spec/#actions
+    """
+
+    __slots__ = ("event", "kwargs", "ref", "value")
+
+    def __init__(
+        self,
+        ref: str,
+        event: Event,
+        value: str | None = None,
+        **kwargs,
+    ):
+        super().__init__()
+        self.ref: str = ref
+        self.event: Event = event
+        self.value: str | None = value
+
+    def node(self):
+        return node(self.name, ref=self.ref, event=self.event.value)
+
+
+class Setvalue(Action):
+    """
+    Explicitly sets the value of the specified instance data node.
+
+    https://getodk.github.io/xforms-spec/#action:setvalue
+    """
+
+    name = "setvalue"
+
+    def __init__(self, ref: str, event: Event, value: str | None = None, **kwargs):
+        super().__init__(ref=ref, event=event, value=value, **kwargs)
+
+    def node(self):
+        result = super().node()
+        if self.value:
+            result.setAttribute("value", self.value)
+        return result
+
+
+class ODKSetGeopoint(Action):
+    """
+    Sets the current location's geopoint value in the instance data node specified in the
+    ref attribute.
+
+    https://getodk.github.io/xforms-spec/#action:setgeopoint
+    """
+
+    name = "odk:setgeopoint"
+
+    def __init__(
+        self,
+        ref: str,
+        event: Event,
+        value: str | None = None,
+        **kwargs,
+    ):
+        super().__init__(ref=ref, event=event, value=value, **kwargs)
+
+
+class ODKRecordAudio(Action):
+    """
+    Records audio starting at the triggering event, saves the audio to a file, and writes
+    the filename to the node specified in the ref attribute.
+
+    https://getodk.github.io/xforms-spec/#action:recordaudio
+    """
+
+    __slots__ = ("quality",)
+    name = "odk:recordaudio"
+
+    def __init__(
+        self,
+        ref: str,
+        event: Event,
+        value: str | None = None,
+        **kwargs,
+    ):
+        super().__init__(ref=ref, event=event, value=value, **kwargs)
+        self.quality: str | None = kwargs.get("odk:quality")
+
+    def node(self):
+        result = super().node()
+        if self.quality:
+            result.setAttribute("odk:quality", self.quality)
+        return result
+
+
+ACTION_CLASSES = {
+    "setvalue": Setvalue,
+    "odk:setgeopoint": ODKSetGeopoint,
+    "odk:recordaudio": ODKRecordAudio,
+}
+
+
+class LibraryMember:
+    def __init__(self, name: str, event: str):
+        self.name: str = name
+        self.event: str = event
+
+    def to_dict(self):
+        return {"name": self.name, "event": self.event}
+
+
+class ActionLibrary(Enum):
+    """
+    A collection of action/event configs used by pyxform.
+    """
+
+    setvalue_first_load = LibraryMember(
+        name=Setvalue.name,
+        event=Event.ODK_INSTANCE_FIRST_LOAD.value,
+    )
+    setvalue_new_repeat = LibraryMember(
+        name=Setvalue.name,
+        event=Event.ODK_NEW_REPEAT.value,
+    )
+    setvalue_value_changed = LibraryMember(
+        name=Setvalue.name,
+        event=Event.XFORMS_VALUE_CHANGED.value,
+    )
+    odk_setgeopoint_first_load = LibraryMember(
+        name=ODKSetGeopoint.name,
+        event=Event.ODK_INSTANCE_FIRST_LOAD.value,
+    )
+    odk_setgeopoint_value_changed = LibraryMember(
+        name=ODKSetGeopoint.name,
+        event=Event.XFORMS_VALUE_CHANGED.value,
+    )
+    odk_recordaudio_instance_load = LibraryMember(
+        name=ODKRecordAudio.name,
+        event=Event.ODK_INSTANCE_LOAD.value,
+    )

pyxform/elements/action.py

@@ -0,0 +1,21 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from pyxform.utils import DetachableElement
+
+
+class Element:
+    """
+    Base class for Element interface and default behaviour.
+
+    Unlike SurveyElement which may emit multiple elements for a particular survey
+    component, this class is for defining individual elements for output.
+    """
+
+    name: str
+
+    def node(self) -> "DetachableElement":
+        """
+        Create the element.
+        """
+        raise NotImplementedError()