dict

xsdata.formats.dataclass.serializers.dict

DictFactory

Dictionary factory types.

Source code in xsdata/formats/dataclass/serializers/dict.py

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	SerializerConfig()
context	XmlContext	The models context instance	XmlContext()
dict_factory	Callable	Dictionary factory	dict

Source code in xsdata/formats/dataclass/serializers/dict.py

@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: XmlVar | None = None,
        wrapped: bool = False,
    ) -> Any:
        """Convert a value to a dictionary object.

        Args:
            value: The input value
            var: The xml var instance
            wrapped: Whether this is a wrapped value

        Returns:
            The converted json serializable value.
        """
        if value is None:
            return None

        if var is None:
            if collections.is_array(value):
                return list(map(self.encode, value))

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

        if var and var.wrapper and not wrapped:
            return self.dict_factory(((var.local_name, self.encode(value, var, True)),))

        if self.context.class_type.is_model(value):
            return self.dict_factory(self.next_value(value))

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

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

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

        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)
            ):
                if var.wrapper:
                    yield var.wrapper, self.encode(value, var)
                else:
                    yield var.local_name, self.encode(value, var)

encode(value, var=None, wrapped=False)

Convert a value to a dictionary object.

Parameters:

Name	Type	Description	Default
value	Any	The input value	required
var	XmlVar | None	The xml var instance	None
wrapped	bool	Whether this is a wrapped value	False

Returns:

Type	Description
Any	The converted json serializable value.

Source code in xsdata/formats/dataclass/serializers/dict.py

def encode(
    self,
    value: Any,
    var: XmlVar | None = None,
    wrapped: bool = False,
) -> Any:
    """Convert a value to a dictionary object.

    Args:
        value: The input value
        var: The xml var instance
        wrapped: Whether this is a wrapped value

    Returns:
        The converted json serializable value.
    """
    if value is None:
        return None

    if var is None:
        if collections.is_array(value):
            return list(map(self.encode, value))

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

    if var and var.wrapper and not wrapped:
        return self.dict_factory(((var.local_name, self.encode(value, var, True)),))

    if self.context.class_type.is_model(value):
        return self.dict_factory(self.next_value(value))

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

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

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

    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
tuple[str, Any]	An iterator of field name and value tuples.

Source code in xsdata/formats/dataclass/serializers/dict.py

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)
        ):
            if var.wrapper:
                yield var.wrapper, self.encode(value, var)
            else:
                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

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}