Skip to content

xml

django_spire.contrib.sync.file.writer.xml

XmlWriter

Bases: Writer

Source code in django_spire/contrib/sync/file/writer/xml.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
def __init__(
    self,
    root_tag: str,
    record_tag: str,
    fields: list[XmlField | XmlListField],
    encoding: str = 'utf-8',
) -> None:
    if not root_tag:
        message = 'root_tag must not be empty'
        raise FileSyncParameterError(message)

    if not record_tag:
        message = 'record_tag must not be empty'
        raise FileSyncParameterError(message)

    if not fields:
        message = 'fields must not be empty'
        raise FileSyncParameterError(message)

    self._root_tag = root_tag
    self._record_tag = record_tag
    self._encoding = encoding
    self._fields: list[XmlField] = []
    self._list_fields: list[XmlListField] = []

    for f in fields:
        if isinstance(f, XmlListField):
            self._list_fields.append(f)
        else:
            self._fields.append(f)

write

Source code in django_spire/contrib/sync/file/writer/xml.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
def write(self, file_path: str | Path, records: list[dict[str, Any]]) -> None:
    file_path = Path(file_path)
    root = Element(self._root_tag)

    for record in records:
        element = SubElement(root, self._record_tag)

        for field in self._fields:
            value = record.get(field.key, field.default)
            self._set_field(element, field.path, value)

        for field in self._list_fields:
            values = record.get(field.key, [])
            self._set_list_field(element, field.path, values)

    tree = ElementTree(root)
    indent(tree, space='  ')
    tree.write(str(file_path), encoding=self._encoding, xml_declaration=True)