Skip to content

XMLRoot

Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/root.py 
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
@dataclass
class XMLRoot:
    shortcode: str
    default_ontology: str
    resources: list[AnyResource] = field(default_factory=list)

    @staticmethod
    def create_new(shortcode: str, default_ontology: str) -> XMLRoot:
        """
        Create a new XML root, for one file.

        Args:
            shortcode: project shortcode
            default_ontology: name of the default ontology

        Returns:
            Instance of `XMLRoot`
        """
        return XMLRoot(shortcode=shortcode, default_ontology=default_ontology)

    def add_resource(self, resource: AnyResource) -> XMLRoot:
        """
        Add one resource to the root.

        Args:
            resource: any one of:
                    `Resource`,
                    `AnnotationResource`,
                    `RegionResource`,
                    `LinkResource`,
                    `VideoSegmentResource`,
                    `AudioSegmentResource`

        Returns:
            The original XMLRoot, with the added resource
        """
        self.resources.append(resource)
        return self

    def add_resource_multiple(self, resources: Collection[AnyResource]) -> XMLRoot:
        """
        Add a list of resources to the root.

        Args:
            resources: a list of:
                    `Resource`,
                    `AnnotationResource`,
                    `RegionResource`,
                    `LinkResource`,
                    `VideoSegmentResource`,
                    `AudioSegmentResource`
                    The types of the resources may be mixed.

        Returns:
            The original XMLRoot, with the added resource
        """
        self.resources.extend(resources)
        return self

    def add_resource_optional(self, resource: AnyResource | None) -> XMLRoot:
        """
        If the resource is not None, add it to the XMLRoot, otherwise return the XMLRoot unchanged.

        Args:
            resource: any one of:
                    `Resource`,
                    `AnnotationResource`,
                    `RegionResource`,
                    `LinkResource`,
                    `VideoSegmentResource`,
                    `AudioSegmentResource`

        Returns:
            The original XMLRoot, with the added value if it was not empty. Else the unchanged original XMLRoot.
        """
        if resource:
            self.resources.append(resource)
        return self

    def write_file(self, filepath: str | Path) -> None:
        """
        Write the finished XML to a file.

        Args:
            filepath: where to save the file

        Warning:
            if the XML is not valid according to the schema
        """
        root = self._serialise()
        etree.indent(root, space="    ")
        xml_string = etree.tostring(
            root,
            encoding="unicode",
            pretty_print=True,
            doctype='<?xml version="1.0" encoding="UTF-8"?>',
        )
        xml_string = xml_string.replace(r"\'", "'")
        with open(filepath, "w", encoding="utf-8") as f:
            f.write(xml_string)
        try:
            validate_xml_file(input_file=filepath)
            print(f"The XML file was successfully saved to {filepath}")
        except BaseError as err:
            msg = (
                f"The XML file was successfully saved to {filepath}, "
                f"but the following Schema validation error(s) occurred: {err.message}"
            )
            warnings.warn(DspToolsUserWarning(msg))

    def _make_root(self) -> etree._Element:
        schema_url = (
            "https://raw.githubusercontent.com/dasch-swiss/dsp-tools/main/src/dsp_tools/resources/schema/data.xsd"
        )
        schema_location_key = str(etree.QName("http://www.w3.org/2001/XMLSchema-instance", "schemaLocation"))
        schema_location_value = f"https://dasch.swiss/schema {schema_url}"
        return etree.Element(
            f"{DASCH_SCHEMA}knora",
            attrib={
                schema_location_key: schema_location_value,
                "shortcode": self.shortcode,
                "default-ontology": self.default_ontology,
            },
            nsmap=XML_NAMESPACE_MAP,
        )

    def _serialise(self) -> etree._Element:
        root = self._make_root()
        permissions = XMLPermissions().serialise()
        root.extend(permissions)
        serialised_resources = [x.serialise() for x in self.resources]
        root.extend(serialised_resources)
        return root

create_new

Create a new XML root, for one file.

Parameters:

Name Type Description Default
shortcode str

project shortcode

 required
default_ontology str

name of the default ontology

 required

Returns:

Type Description
XMLRoot

Instance of XMLRoot
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/root.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
@staticmethod
def create_new(shortcode: str, default_ontology: str) -> XMLRoot:
    """
    Create a new XML root, for one file.

    Args:
        shortcode: project shortcode
        default_ontology: name of the default ontology

    Returns:
        Instance of `XMLRoot`
    """
    return XMLRoot(shortcode=shortcode, default_ontology=default_ontology)

add_resource

Add one resource to the root.

Parameters:

Name Type Description Default
resource AnyResource

any one of: Resource, AnnotationResource, RegionResource, LinkResource, VideoSegmentResource, AudioSegmentResource

 required

Returns:

Type Description
XMLRoot

The original XMLRoot, with the added resource
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/root.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
def add_resource(self, resource: AnyResource) -> XMLRoot:
    """
    Add one resource to the root.

    Args:
        resource: any one of:
                `Resource`,
                `AnnotationResource`,
                `RegionResource`,
                `LinkResource`,
                `VideoSegmentResource`,
                `AudioSegmentResource`

    Returns:
        The original XMLRoot, with the added resource
    """
    self.resources.append(resource)
    return self

add_resource_multiple

Add a list of resources to the root.

Parameters:

Name Type Description Default
resources Collection[AnyResource]

a list of: Resource, AnnotationResource, RegionResource, LinkResource, VideoSegmentResource, AudioSegmentResource The types of the resources may be mixed.

 required

Returns:

Type Description
XMLRoot

The original XMLRoot, with the added resource
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/root.py 
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
def add_resource_multiple(self, resources: Collection[AnyResource]) -> XMLRoot:
    """
    Add a list of resources to the root.

    Args:
        resources: a list of:
                `Resource`,
                `AnnotationResource`,
                `RegionResource`,
                `LinkResource`,
                `VideoSegmentResource`,
                `AudioSegmentResource`
                The types of the resources may be mixed.

    Returns:
        The original XMLRoot, with the added resource
    """
    self.resources.extend(resources)
    return self

add_resource_optional

If the resource is not None, add it to the XMLRoot, otherwise return the XMLRoot unchanged.

Parameters:

Name Type Description Default
resource AnyResource | None

any one of: Resource, AnnotationResource, RegionResource, LinkResource, VideoSegmentResource, AudioSegmentResource

 required

Returns:

Type Description
XMLRoot

The original XMLRoot, with the added value if it was not empty. Else the unchanged original XMLRoot.
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/root.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
def add_resource_optional(self, resource: AnyResource | None) -> XMLRoot:
    """
    If the resource is not None, add it to the XMLRoot, otherwise return the XMLRoot unchanged.

    Args:
        resource: any one of:
                `Resource`,
                `AnnotationResource`,
                `RegionResource`,
                `LinkResource`,
                `VideoSegmentResource`,
                `AudioSegmentResource`

    Returns:
        The original XMLRoot, with the added value if it was not empty. Else the unchanged original XMLRoot.
    """
    if resource:
        self.resources.append(resource)
    return self

write_file

Write the finished XML to a file.

Parameters:

Name Type Description Default
filepath str | Path

where to save the file

 required
Warning

if the XML is not valid according to the schema

Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/root.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
def write_file(self, filepath: str | Path) -> None:
    """
    Write the finished XML to a file.

    Args:
        filepath: where to save the file

    Warning:
        if the XML is not valid according to the schema
    """
    root = self._serialise()
    etree.indent(root, space="    ")
    xml_string = etree.tostring(
        root,
        encoding="unicode",
        pretty_print=True,
        doctype='<?xml version="1.0" encoding="UTF-8"?>',
    )
    xml_string = xml_string.replace(r"\'", "'")
    with open(filepath, "w", encoding="utf-8") as f:
        f.write(xml_string)
    try:
        validate_xml_file(input_file=filepath)
        print(f"The XML file was successfully saved to {filepath}")
    except BaseError as err:
        msg = (
            f"The XML file was successfully saved to {filepath}, "
            f"but the following Schema validation error(s) occurred: {err.message}"
        )
        warnings.warn(DspToolsUserWarning(msg))