Skip to content

mixins

xsdata.formats.dataclass.serializers.tree.mixins

TreeSerializer dataclass

Bases: EventGenerator

Source code in xsdata/formats/dataclass/serializers/tree/mixins.py
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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
@dataclass
class TreeSerializer(EventGenerator):
    @abc.abstractmethod
    def render(self, obj: T) -> Any:
        """Serialize the input model instance to element tree.

        Args:
            obj: The input model instance to serialize

        Returns:
            The generated element tree instance.
        """

    def build(self, obj: T, builder: TreeBuilder):
        """Feed the builder with events from input model instance.

        Args:
            obj: The input model instance to serialize
            builder: The tree builder instance
        """
        pending_tag = None
        pending_attrs: Dict[str, Any] = {}
        flush_events = (XmlWriterEvent.START, XmlWriterEvent.END, XmlWriterEvent.DATA)
        for event, *element in self.generate(obj):
            if pending_tag is not None and event in flush_events:
                builder.start(pending_tag, pending_attrs)
                pending_tag = None
                pending_attrs = {}

            if event == XmlWriterEvent.START:
                pending_tag = element[0]
                pending_attrs = {}
            elif event == XmlWriterEvent.ATTR:
                key, value = element
                pending_attrs[key] = self.encode_data(value)
            elif event == XmlWriterEvent.END:
                builder.end(*element)
            elif event == XmlWriterEvent.DATA:
                data = self.encode_data(element[0])
                builder.data(data)
            else:
                raise XmlHandlerError(f"Unhandled event: `{event}`.")

    @classmethod
    def encode_data(cls, data: Any) -> str:
        """Encode data for xml rendering.

        Args:
            data: The content to encode/serialize

        Returns:
            The xml encoded data
        """
        if data is None or isinstance(data, list) and not data:
            return ""

        if isinstance(data, str):
            return data

        return converter.serialize(data)

render(obj) abstractmethod

Serialize the input model instance to element tree.

Parameters:

Name Type Description Default
obj T

The input model instance to serialize

required

Returns:

Type Description
Any

The generated element tree instance.

Source code in xsdata/formats/dataclass/serializers/tree/mixins.py
21
22
23
24
25
26
27
28
29
30
@abc.abstractmethod
def render(self, obj: T) -> Any:
    """Serialize the input model instance to element tree.

    Args:
        obj: The input model instance to serialize

    Returns:
        The generated element tree instance.
    """

build(obj, builder)

Feed the builder with events from input model instance.

Parameters:

Name Type Description Default
obj T

The input model instance to serialize

required
builder TreeBuilder

The tree builder instance

required
Source code in xsdata/formats/dataclass/serializers/tree/mixins.py
32
33
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
def build(self, obj: T, builder: TreeBuilder):
    """Feed the builder with events from input model instance.

    Args:
        obj: The input model instance to serialize
        builder: The tree builder instance
    """
    pending_tag = None
    pending_attrs: Dict[str, Any] = {}
    flush_events = (XmlWriterEvent.START, XmlWriterEvent.END, XmlWriterEvent.DATA)
    for event, *element in self.generate(obj):
        if pending_tag is not None and event in flush_events:
            builder.start(pending_tag, pending_attrs)
            pending_tag = None
            pending_attrs = {}

        if event == XmlWriterEvent.START:
            pending_tag = element[0]
            pending_attrs = {}
        elif event == XmlWriterEvent.ATTR:
            key, value = element
            pending_attrs[key] = self.encode_data(value)
        elif event == XmlWriterEvent.END:
            builder.end(*element)
        elif event == XmlWriterEvent.DATA:
            data = self.encode_data(element[0])
            builder.data(data)
        else:
            raise XmlHandlerError(f"Unhandled event: `{event}`.")

encode_data(data) classmethod

Encode data for xml rendering.

Parameters:

Name Type Description Default
data Any

The content to encode/serialize

required

Returns:

Type Description
str

The xml encoded data

Source code in xsdata/formats/dataclass/serializers/tree/mixins.py
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
@classmethod
def encode_data(cls, data: Any) -> str:
    """Encode data for xml rendering.

    Args:
        data: The content to encode/serialize

    Returns:
        The xml encoded data
    """
    if data is None or isinstance(data, list) and not data:
        return ""

    if isinstance(data, str):
        return data

    return converter.serialize(data)