xsdata.formats.converter module

class xsdata.formats.converter.Converter

Bases: object

Abstract converter class.

abstract deserialize(value, **kwargs)

Convert any type to the converter dedicated type.

Raises

ConverterError – if converter fails with and expected ValueError

Parameters

• value (Any) –

• kwargs (Any) –

Return type

Any

abstract serialize(value, **kwargs)

Convert to string.

Parameters

• value (Any) –

• kwargs (Any) –

Return type

str

class xsdata.formats.converter.ConverterAdapter(registry=<factory>)

Bases: object

Parameters

registry (Dict[Type, Converter]) – Converters registry

registry: Dict[Type, xsdata.formats.converter.Converter]

deserialize(value, types, **kwargs)

Attempt to convert a any value to one of the given types.

If all attempts fail return the value input value and issue a warning.

Return type

Any

Returns

The first successful converted value.

Parameters

• value (Any) –

• types (List[Type]) –

• kwargs (Any) –

serialize(value, **kwargs)

Convert the given value to string, ignore None values.

If the value is a list assume the value is a list of tokens.

Parameters

• value (Any) –

• kwargs (Any) –

Return type

Any

register_converter(data_type, func)

Register a callable or converter for the given data type.

Callables will be wrapped in a xsdata.formats.converter.ProxyConverter

Parameters

• data_type (Type) –

• func (Union[Callable, Converter]) –

unregister_converter(data_type)

Unregister the converter for the given data type.

Raises

KeyError – if the data type is not registered.

Parameters

data_type (Type) –

type_converter(data_type)

Get a suitable converter for given data type.

Try the parent type if the original doesn’t exist, fall back to str and issue a warning if no converter matches.

Parameters

data_type (Type) –

Return type

Converter

value_converter(value)

Get a suitable converter for the given value.

Parameters

value (Any) –

Return type

Converter

classmethod sort_types(types)

Sort a list of types by giving priority to strict types first.

Parameters

types (List[Type]) –

Return type

List[Type]

class xsdata.formats.converter.BoolConverter

Bases: xsdata.formats.converter.Converter

deserialize(value, **kwargs)

Convert any type to the converter dedicated type.

Raises

ConverterError – if converter fails with and expected ValueError

Parameters

• value (Any) –

• kwargs (Any) –

Return type

bool

serialize(value, **kwargs)

Convert to string.

Parameters

• value (bool) –

• kwargs (Any) –

Return type

str

class xsdata.formats.converter.IntConverter

Bases: xsdata.formats.converter.Converter

deserialize(value, **kwargs)

Convert any type to the converter dedicated type.

Raises

ConverterError – if converter fails with and expected ValueError

Parameters

• value (Any) –

• kwargs (Any) –

Return type

int

serialize(value, **kwargs)

Convert to string.

Parameters

• value (int) –

• kwargs (Any) –

Return type

str

class xsdata.formats.converter.StrConverter

Bases: xsdata.formats.converter.Converter

deserialize(value, **kwargs)

Convert any type to the converter dedicated type.

Raises

ConverterError – if converter fails with and expected ValueError

Parameters

• value (Any) –

• kwargs (Any) –

Return type

str

serialize(value, **kwargs)

Convert to string.

Parameters

• value (str) –

• kwargs (Any) –

Return type

str

class xsdata.formats.converter.FloatConverter

Bases: xsdata.formats.converter.Converter

deserialize(value, **kwargs)

Convert any type to the converter dedicated type.

Raises

ConverterError – if converter fails with and expected ValueError

Parameters

• value (Any) –

• kwargs (Any) –

Return type

float

serialize(value, **kwargs)

Convert to string.

Parameters

• value (float) –

• kwargs (Any) –

Return type

str

class xsdata.formats.converter.DecimalConverter

Bases: xsdata.formats.converter.Converter

deserialize(value, **kwargs)

Convert any type to the converter dedicated type.

Raises

ConverterError – if converter fails with and expected ValueError

Parameters

• value (Any) –

• kwargs (Any) –

Return type

Decimal

serialize(value, **kwargs)

Convert to string.

Parameters

• value (Decimal) –

• kwargs (Any) –

Return type

str

class xsdata.formats.converter.QNameConverter

Bases: xsdata.formats.converter.Converter

deserialize(value, ns_map=None, **kwargs)

Convert namespace prefixed strings, or fully qualified strings to QNames.

examples:

• xs:string -> QName(“http://www.w3.org/2001/XMLSchema”, “string”)

• {foo}bar -> QName(“foo”, “bar”

Parameters

• value (str) –

• ns_map (Optional[Dict]) –

• kwargs (Any) –

Return type

QName

serialize(value, ns_map=None, **kwargs)

Convert a QName instance to string either with a namespace prefix if a prefix-URI namespaces mapping is provided or to a fully qualified name with the namespace.

examples:

• QName(“http://www.w3.org/2001/XMLSchema”, “int”) & ns_map -> xs:int

• QName(“foo, “bar”) -> {foo}bar

Parameters

• value (QName) –

• ns_map (Optional[Dict]) –

• kwargs (Any) –

Return type

str

static resolve(value, ns_map)

Parameters

• value (str) –

• ns_map (Optional[Dict]) –

Return type

Tuple

class xsdata.formats.converter.LxmlQNameConverter

Bases: xsdata.formats.converter.Converter

deserialize(value, ns_map=None, **kwargs)

Convert namespace prefixed strings, or fully qualified strings to QNames.

examples:

• xs:string -> QName(“http://www.w3.org/2001/XMLSchema”, “string”)

• {foo}bar -> QName(“foo”, “bar”

Parameters

• value (str) –

• ns_map (Optional[Dict]) –

• kwargs (Any) –

Return type

QName

serialize(value, ns_map=None, **kwargs)

Convert a QName instance to string either with a namespace prefix if a prefix-URI namespaces mapping is provided or to a fully qualified name with the namespace.

examples:

• QName(“http://www.w3.org/2001/XMLSchema”, “int”) & ns_map -> xs:int

• QName(“foo, “bar”) -> {foo}bar

Parameters

• value (QName) –

• ns_map (Optional[Dict]) –

• kwargs (Any) –

Return type

str

class xsdata.formats.converter.EnumConverter

Bases: xsdata.formats.converter.Converter

deserialize(value, data_type=None, **kwargs)

Convert any type to the converter dedicated type.

Raises

ConverterError – if converter fails with and expected ValueError

Parameters

• value (Any) –

• data_type (Optional[Type[Enum]]) –

• kwargs (Any) –

Return type

Enum

serialize(value, **kwargs)

Convert to string.

Parameters

• value (Enum) –

• kwargs (Any) –

Return type

str

class xsdata.formats.converter.ProxyConverter(func)

Bases: xsdata.formats.converter.Converter

Parameters

func (Callable) – the callable to convert from string

func: Callable

deserialize(value, **kwargs)

Convert any type to the converter dedicated type.

Raises

ConverterError – if converter fails with and expected ValueError

Parameters

• value (Any) –

• kwargs (Any) –

Return type

Any

serialize(value, **kwargs)

Convert to string.

Parameters

• value (Any) –

• kwargs (Any) –

Return type

str