dsp-tools 9.1.0.post11__py3-none-any.whl → 18.3.0.post13__py3-none-any.whl

dsp_tools/xmllib/internal/serialise_values.py

@@ -0,0 +1,152 @@
+import os
+from collections import defaultdict
+from copy import deepcopy
+from typing import cast
+
+from dotenv import find_dotenv
+from dotenv import load_dotenv
+from lxml import etree
+
+from dsp_tools.error.xmllib_errors import XmllibInternalError
+from dsp_tools.xmllib.internal.circumvent_circular_imports import parse_richtext_as_xml
+from dsp_tools.xmllib.internal.constants import DASCH_SCHEMA
+from dsp_tools.xmllib.internal.constants import XML_NAMESPACE_MAP
+from dsp_tools.xmllib.models.internal.values import BooleanValue
+from dsp_tools.xmllib.models.internal.values import ColorValue
+from dsp_tools.xmllib.models.internal.values import DateValue
+from dsp_tools.xmllib.models.internal.values import DecimalValue
+from dsp_tools.xmllib.models.internal.values import GeonameValue
+from dsp_tools.xmllib.models.internal.values import IntValue
+from dsp_tools.xmllib.models.internal.values import LinkValue
+from dsp_tools.xmllib.models.internal.values import ListValue
+from dsp_tools.xmllib.models.internal.values import Richtext
+from dsp_tools.xmllib.models.internal.values import SimpleText
+from dsp_tools.xmllib.models.internal.values import TimeValue
+from dsp_tools.xmllib.models.internal.values import UriValue
+from dsp_tools.xmllib.models.internal.values import Value
+from dsp_tools.xmllib.models.permissions import Permissions
+
+load_dotenv(dotenv_path=find_dotenv(usecwd=True))
+
+PROP_TYPE_LOOKUP = {
+    BooleanValue: "boolean",
+    ColorValue: "color",
+    DateValue: "date",
+    DecimalValue: "decimal",
+    GeonameValue: "geoname",
+    IntValue: "integer",
+    LinkValue: "resptr",
+    ListValue: "list",
+    TimeValue: "time",
+    UriValue: "uri",
+    Richtext: "richtext",
+    SimpleText: "simpletext",
+}
+
+
+def serialise_values(all_values: list[Value]) -> list[etree._Element]:
+    """
+    Serialise a list of values for a resource.
+
+    Args:
+        all_values: List of Values
+
+    Returns:
+        list of serialised values
+    """
+    prop_tuples, type_lookup = _sort_and_group_values(all_values)
+    serialised = []
+    for prop_name, prop_values in prop_tuples:
+        prop_type = type_lookup[prop_name]
+        match prop_type:
+            case "list":
+                serialised.append(_serialise_complete_list_prop(cast(list[ListValue], prop_values), prop_name))
+            case "simpletext":
+                serialised.append(_serialise_complete_simple_text_prop(cast(list[SimpleText], prop_values), prop_name))
+            case "richtext":
+                serialised.append(_serialise_complete_richtext_prop(cast(list[Richtext], prop_values), prop_name))
+            case _:
+                serialised.append(_serialise_complete_generic_prop(prop_values, prop_name, prop_type))
+    return serialised
+
+
+def _sort_and_group_values(all_values: list[Value]) -> tuple[list[tuple[str, list[Value]]], dict[str, str]]:
+    prop_groups, type_lookup = _group_properties(all_values)
+    prop_tuples = [(prop_name, values) for prop_name, values in prop_groups.items()]
+    env_var = str(os.getenv("XMLLIB_SORT_PROPERTIES")).lower()
+    if env_var == "true":
+        prop_tuples = [
+            (prop_name, sorted(prop_values, key=lambda x: x.value)) for (prop_name, prop_values) in prop_tuples
+        ]
+        prop_tuples = sorted(prop_tuples, key=lambda x: x[0])
+    return prop_tuples, type_lookup
+
+
+def _group_properties(values: list[Value]) -> tuple[dict[str, list[Value]], dict[str, str]]:
+    grouped = defaultdict(list)
+    name_type_lookup = {}
+    for val in values:
+        grouped[val.prop_name].append(val)
+        name_type_lookup[val.prop_name] = PROP_TYPE_LOOKUP[type(val)]
+    return grouped, name_type_lookup
+
+
+def _serialise_complete_generic_prop(values: list[Value], prop_name: str, prop_type: str) -> etree._Element:
+    prop = _serialise_generic_prop(prop_name, prop_type)
+    for val in values:
+        val_ele = _serialise_generic_element(val, prop_type)
+        prop.append(val_ele)
+    return prop
+
+
+def _serialise_generic_prop(prop_name: str, prop_type: str) -> etree._Element:
+    return etree.Element(f"{DASCH_SCHEMA}{prop_type}-prop", name=prop_name, nsmap=XML_NAMESPACE_MAP)
+
+
+def _serialise_generic_element(value: Value, prop_type: str) -> etree._Element:
+    attribs = {}
+    if value.permissions != Permissions.PROJECT_SPECIFIC_PERMISSIONS:
+        attribs["permissions"] = value.permissions.value
+    if value.comment is not None:
+        attribs["comment"] = str(value.comment)
+    ele = etree.Element(f"{DASCH_SCHEMA}{prop_type}", attrib=attribs, nsmap=XML_NAMESPACE_MAP)
+    ele.text = str(value.value)
+    return ele
+
+
+def _serialise_complete_list_prop(values: list[ListValue], prop_name: str) -> etree._Element:
+    list_name = next(iter(values)).list_name
+    prop = etree.Element(f"{DASCH_SCHEMA}list-prop", name=prop_name, list=list_name, nsmap=XML_NAMESPACE_MAP)
+    for val in values:
+        prop.append(_serialise_generic_element(val, "list"))
+    return prop
+
+
+def _serialise_complete_simple_text_prop(values: list[SimpleText], prop_name: str) -> etree._Element:
+    prop = _serialise_generic_prop(prop_name, "text")
+    for val in values:
+        val_ele = _serialise_generic_element(val, "text")
+        val_ele.attrib["encoding"] = "utf8"
+        prop.append(val_ele)
+    return prop
+
+
+def _serialise_complete_richtext_prop(values: list[Richtext], prop_name: str) -> etree._Element:
+    prop = _serialise_generic_prop(prop_name, "text")
+    for val in values:
+        val_ele = _serialise_generic_element(val, "text")  # produces wrong text content
+        val_ele.attrib["encoding"] = "xml"
+        prop.append(_create_richtext_elements_from_string(val, val_ele))  # overwrite the wrong text content
+    return prop
+
+
+def _create_richtext_elements_from_string(value: Richtext, text_element: etree._Element) -> etree._Element:
+    new_element = deepcopy(text_element)
+    parsed_xml = parse_richtext_as_xml(value.value)
+    if not isinstance(parsed_xml, etree._Element):
+        raise XmllibInternalError(
+            "Richtexts should be validated for correct XML syntax when they are created. Apparently this didn't happen."
+        )
+    new_element.text = parsed_xml.text  # everything before the first child tag
+    new_element.extend(list(parsed_xml))  # all (nested) children of the pseudo-xml
+    return new_element

dsp_tools/xmllib/internal/type_aliases.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from typing import Union
+
+from dsp_tools.xmllib.models.dsp_base_resources import AudioSegmentResource
+from dsp_tools.xmllib.models.dsp_base_resources import LinkResource
+from dsp_tools.xmllib.models.dsp_base_resources import RegionResource
+from dsp_tools.xmllib.models.dsp_base_resources import VideoSegmentResource
+from dsp_tools.xmllib.models.res import Resource
+
+type AnyResource = Union[Resource, RegionResource, LinkResource, VideoSegmentResource, AudioSegmentResource]

dsp_tools/xmllib/models/config_options.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+from enum import Enum
+from enum import auto
+
+
+class NewlineReplacement(Enum):
+    """
+    Options how to deal with `\\n` inside rich text values.
+
+    - `NONE`: don't modify the rich text (`\\n` will be lost, because it is meaningless in an XML file)
+    - `PARAGRAPH`: replace `Start\\nEnd` with `<p>Start</p><p>End</p>`
+    - `LINEBREAK`: replace `Start\\nEnd` with `Start<br/>End`
+
+    Examples:
+        ```python
+        # setting the replacement options for newlines
+        resource = resource.add_richtext(
+            prop_name=":propName",
+            value="Start\\n\\nEnd",
+            newline_replacement=xmllib.NewlineReplacement.PARAGRAPH
+        )
+        ```
+    """
+
+    NONE = auto()
+    PARAGRAPH = auto()
+    LINEBREAK = auto()

dsp_tools/xmllib/models/date_formats.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+from enum import Enum
+from enum import auto
+
+
+class DateFormat(Enum):
+    """
+    Date format options for the [`reformat_date`](https://docs.dasch.swiss/latest/DSP-TOOLS/xmllib-docs/general-functions/#xmllib.general_functions.reformat_date) function.
+
+    - `YYYY_MM_DD`
+    - `DD_MM_YYYY`
+    - `MM_DD_YYYY`
+    """  # noqa: E501
+
+    YYYY_MM_DD = auto()
+    DD_MM_YYYY = auto()
+    MM_DD_YYYY = auto()
+
+
+class Calendar(Enum):
+    """
+    Calendar options for the [`reformat_date`](https://docs.dasch.swiss/latest/DSP-TOOLS/xmllib-docs/general-functions/#xmllib.general_functions.reformat_date) function.
+
+    - `GREGORIAN`
+    - `JULIAN`
+    - `ISLAMIC`
+    """  # noqa: E501
+
+    GREGORIAN = "GREGORIAN"
+    JULIAN = "JULIAN"
+    ISLAMIC = "ISLAMIC"
+
+
+class Era(Enum):
+    """
+    Era options for the [`reformat_date`](https://docs.dasch.swiss/latest/DSP-TOOLS/xmllib-docs/general-functions/#xmllib.general_functions.reformat_date) function.
+
+    - `CE`
+    - `BCE`
+    - `AD`
+    - `BC`
+    """  # noqa: E501
+
+    CE = "CE"
+    BCE = "BCE"
+    AD = "AD"
+    BC = "BC"