Skip to content

dict

xsdata.formats.dataclass.serializers.dict

DictFactory

Dictionary factory types.

Source code in xsdata/formats/dataclass/serializers/dict.py 
24
25
26
27
class DictFactory:
    """Dictionary factory types."""

    FILTER_NONE = filter_none

DictEncoder dataclass

Json serializer for data classes.

Parameters:

Name Type Description Default
config SerializerConfig

The serializer config instance

 field(default_factory=SerializerConfig)
context XmlContext

The models context instance

 field(default_factory=XmlContext)
dict_factory Callable

Dictionary factory

 field(default=dict)
Source code in xsdata/formats/dataclass/serializers/dict.py 
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
79
80
81
82
83
84
85
86
87
88
89
90
@dataclass
class DictEncoder:
    """Json serializer for data classes.

    Args:
        config: The serializer config instance
        context: The models context instance
        dict_factory: Dictionary factory
    """

    config: SerializerConfig = field(default_factory=SerializerConfig)
    context: XmlContext = field(default_factory=XmlContext)
    dict_factory: Callable = field(default=dict)

    def encode(self, value: Any, var: Optional[XmlVar] = None) -> Any:
        """Convert a value to a dictionary object.

        Args:
            value: The input value
            var: The xml var instance

        Returns:
            The converted json serializable value.
        """
        if var is None or self.context.class_type.is_model(value):
            if collections.is_array(value):
                return list(map(self.encode, value))

            return self.dict_factory(self.next_value(value))

        if collections.is_array(value):
            return type(value)(self.encode(val, var) for val in value)

        if isinstance(value, (dict, int, float, str, bool)):
            return value

        if isinstance(value, Enum):
            return self.encode(value.value, var)

        return converter.serialize(value, format=var.format)

    def next_value(self, obj: Any) -> Iterator[Tuple[str, Any]]:
        """Fetch the next value of a model instance to convert.

        Args:
            obj: The input model instance

        Yields:
            An iterator of field name and value tuples.
        """
        ignore_optionals = self.config.ignore_default_attributes
        meta = self.context.build(obj.__class__, globalns=self.config.globalns)

        for var in meta.get_all_vars():
            value = getattr(obj, var.name)
            if (
                not var.is_attribute
                or not ignore_optionals
                or not var.is_optional(value)
            ):
                yield var.local_name, self.encode(value, var)

encode(value, var=None)

Convert a value to a dictionary object.

Parameters:

Name Type Description Default
value Any

The input value

 required
var Optional[XmlVar]

The xml var instance

 None

Returns:

Type Description
Any

The converted json serializable value.
Source code in xsdata/formats/dataclass/serializers/dict.py 
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
def encode(self, value: Any, var: Optional[XmlVar] = None) -> Any:
    """Convert a value to a dictionary object.

    Args:
        value: The input value
        var: The xml var instance

    Returns:
        The converted json serializable value.
    """
    if var is None or self.context.class_type.is_model(value):
        if collections.is_array(value):
            return list(map(self.encode, value))

        return self.dict_factory(self.next_value(value))

    if collections.is_array(value):
        return type(value)(self.encode(val, var) for val in value)

    if isinstance(value, (dict, int, float, str, bool)):
        return value

    if isinstance(value, Enum):
        return self.encode(value.value, var)

    return converter.serialize(value, format=var.format)

next_value(obj)

Fetch the next value of a model instance to convert.

Parameters:

Name Type Description Default
obj Any

The input model instance

 required

Yields:

Type Description
str

An iterator of field name and value tuples.
Source code in xsdata/formats/dataclass/serializers/dict.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def next_value(self, obj: Any) -> Iterator[Tuple[str, Any]]:
    """Fetch the next value of a model instance to convert.

    Args:
        obj: The input model instance

    Yields:
        An iterator of field name and value tuples.
    """
    ignore_optionals = self.config.ignore_default_attributes
    meta = self.context.build(obj.__class__, globalns=self.config.globalns)

    for var in meta.get_all_vars():
        value = getattr(obj, var.name)
        if (
            not var.is_attribute
            or not ignore_optionals
            or not var.is_optional(value)
        ):
            yield var.local_name, self.encode(value, var)

filter_none(x)

Convert a key-value pairs to dict, ignoring None values.

Parameters:

Name Type Description Default
x Tuple

Key-value pairs

 required

Returns:

Type Description
Dict

The filtered dictionary.
Source code in xsdata/formats/dataclass/serializers/dict.py 
12
13
14
15
16
17
18
19
20
21
def filter_none(x: Tuple) -> Dict:
    """Convert a key-value pairs to dict, ignoring None values.

    Args:
        x: Key-value pairs

    Returns:
        The filtered dictionary.
    """
    return {k: v for k, v in x if v is not None}