xsdata.formats.dataclass.models.elements module

class xsdata.formats.dataclass.models.elements.XmlVar(name, qname, init=True, mixed=False, nillable=False, dataclass=False, sequential=False, default=None, types=<factory>, namespaces=<factory>)

Bases: object

Dataclass field bind metadata.

Parameters

• name (str) – field name,

• qname (QName) – qualified local name,

• init (bool) – field is present in the constructor arguments.

• mixed (bool) – field supports mixed content.

• nillable (bool) – allow to render empty nillable elements,

• dataclass (bool) – field type is a dataclass or a primitive type.

• sequential (bool) – switch to sequential rendering with other sequential siblings,

• default (Optional[Any]) – default value or factory

• types (List[Type]) – field bind or cast types.

• namespaces (List[str]) – a list of the all the possible namespaces.

name: str

qname: QName

init: bool = True

mixed: bool = False

nillable: bool = False

dataclass: bool = False

sequential: bool = False

default: Any = None

types: List[Type]

namespaces: List[str]

property clazz

Return the first type if field is bound to a dataclass.

Return type

Optional[Type]

property is_any_type

Return whether the field type is xs:anyType.

Return type

bool

property is_attribute

Return whether the field is derived from xs:attribute.

Return type

bool

property is_attributes

Return whether the field is derived from xs:anyAttributes.

Return type

bool

property is_element

Return whether the field is derived from xs:element.

Return type

bool

property is_list

Return whether the field is a list of elements.

Return type

bool

property is_mixed_content

Return whether the field is a mixed content list of of elements.

Return type

bool

property is_clazz_union

Return type

bool

property is_text

Return whether the field is a text element.

Return type

bool

property is_tokens

Return whether the field is a list of tokens.

Return type

bool

property is_wildcard

Return whether the field is a text element.

Return type

bool

matches(qname)

Match the field qualified local name to the given qname.

Return True automatically if the local name is a wildcard.

Parameters

qname (QName) –

Return type

bool

class xsdata.formats.dataclass.models.elements.XmlElement(name, qname, init=True, mixed=False, nillable=False, dataclass=False, sequential=False, default=None, types=<factory>, namespaces=<factory>)

Bases: xsdata.formats.dataclass.models.elements.XmlVar

Dataclass field bind metadata for xml elements.

Parameters

• name (str) –

• qname (QName) –

• init (bool) –

• mixed (bool) –

• nillable (bool) –

• dataclass (bool) –

• sequential (bool) –

• default (Optional[Any]) –

• types (List[Type]) –

• namespaces (List[str]) –

property is_element

Return whether the field is derived from xs:element.

Return type

bool

property is_any_type

Return whether the field type is xs:anyType.

Return type

bool

name

qname

types

namespaces

class xsdata.formats.dataclass.models.elements.XmlWildcard(name, qname, init=True, mixed=False, nillable=False, dataclass=False, sequential=False, default=None, types=<factory>, namespaces=<factory>)

Bases: xsdata.formats.dataclass.models.elements.XmlVar

Dataclass field bind metadata for xml wildcard elements.

Parameters

• name (str) –

• qname (QName) –

• init (bool) –

• mixed (bool) –

• nillable (bool) –

• dataclass (bool) –

• sequential (bool) –

• default (Optional[Any]) –

• types (List[Type]) –

• namespaces (List[str]) –

property is_mixed_content

Return whether the field is a mixed content list of of elements.

Return type

bool

property is_wildcard

Return whether the field is a text element.

Return type

bool

property is_any_type

Return whether the field type is xs:anyType.

Return type

bool

matches(qname)

Match the given qname to the wildcard allowed namespaces.

Parameters

qname (QName) –

Return type

bool

name

qname

types

namespaces

class xsdata.formats.dataclass.models.elements.XmlAttribute(name, qname, init=True, mixed=False, nillable=False, dataclass=False, sequential=False, default=None, types=<factory>, namespaces=<factory>)

Bases: xsdata.formats.dataclass.models.elements.XmlVar

Dataclass field bind metadata for xml attributes.

Parameters

• name (str) –

• qname (QName) –

• init (bool) –

• mixed (bool) –

• nillable (bool) –

• dataclass (bool) –

• sequential (bool) –

• default (Optional[Any]) –

• types (List[Type]) –

• namespaces (List[str]) –

property is_attribute

Return whether the field is derived from xs:attribute.

Return type

bool

property is_tokens

Return whether the field is a list of tokens.

Return type

bool

name

qname

types

namespaces

class xsdata.formats.dataclass.models.elements.XmlAttributes(name, qname, init=True, mixed=False, nillable=False, dataclass=False, sequential=False, default=None, types=<factory>, namespaces=<factory>)

Bases: xsdata.formats.dataclass.models.elements.XmlVar

Dataclass field bind metadata for xml wildcard attributes.

Parameters

• name (str) –

• qname (QName) –

• init (bool) –

• mixed (bool) –

• nillable (bool) –

• dataclass (bool) –

• sequential (bool) –

• default (Optional[Any]) –

• types (List[Type]) –

• namespaces (List[str]) –

property is_attributes

Return whether the field is derived from xs:anyAttributes.

Return type

bool

name

qname

types

namespaces

class xsdata.formats.dataclass.models.elements.XmlText(name, qname, init=True, mixed=False, nillable=False, dataclass=False, sequential=False, default=None, types=<factory>, namespaces=<factory>)

Bases: xsdata.formats.dataclass.models.elements.XmlVar

Dataclass field bind metadata for xml text content.

Parameters

• name (str) –

• qname (QName) –

• init (bool) –

• mixed (bool) –

• nillable (bool) –

• dataclass (bool) –

• sequential (bool) –

• default (Optional[Any]) –

• types (List[Type]) –

• namespaces (List[str]) –

property is_tokens

Return whether the field is a list of tokens.

Return type

bool

property is_text

Return whether the field is a text element.

Return type

bool

name

qname

types

namespaces

class xsdata.formats.dataclass.models.elements.FindMode(value)

Bases: enum.IntEnum

Find switches to be used to find a specific var.

ALL = 1

ATTRIBUTE = 2

ATTRIBUTES = 3

ELEMENT = 4

TEXT = 5

WILDCARD = 6

MIXED_CONTENT = 0

NOT_WILDCARD = 7

LIST = 8

NOT_LIST = 9

class xsdata.formats.dataclass.models.elements.XmlMeta(name, clazz, qname, source_qname, nillable, vars=<factory>)

Bases: object

Dataclass model bind metadata.

Parameters

• name (str) – The local name

• clazz (Type) – The dataclass type

• qname (QName) – The namespace qualified name.

• source_qname (QName) – The source namespace qualified name.

• nillable (bool) – Specifies whether an explicit empty value can be assigned.

• vars (List[XmlVar]) – The list of field metadata

name: str

clazz: Type

qname: QName

source_qname: QName

nillable: bool

vars: List[XmlVar]

cache: Dict

property element_form

Return element form: qualified/unqualified.

Return type

FormType

find_var(qname=<lxml.etree.QName object>, mode=<FindMode.ALL: 1>)

Find a field by it’s qualified name and the specified type.

The lookup process is cached.

Parameters

• qname (QName) –

• mode (FindMode) –

Return type

Optional[XmlVar]