xsdata.formats.dataclass.models.elements module

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

Bases: object

Parameters

• name (str) –

• qname (QName) –

• init (bool) –

• nillable (bool) –

• dataclass (bool) –

• sequential (bool) –

• default (Optional[Any]) –

• types (List[Type]) –

• namespaces (List[str]) –

name: str = None

qname: QName = None

init: bool = True

nillable: bool = False

dataclass: bool = False

sequential: bool = False

default: Any = None

types: List[Type] = None

namespaces: List[str] = None

property clazz

Return type

Optional[Type]

property is_any_type

Return type

bool

property is_attribute

Return type

bool

property is_attributes

Return type

bool

property is_element

Return type

bool

property is_list

Return type

bool

property is_text

Return type

bool

property is_tokens

Return type

bool

property is_wildcard

Return type

bool

matches(qname)

Parameters

qname (QName) –

Return type

bool

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

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

Parameters

• name (str) –

• qname (QName) –

• init (bool) –

• nillable (bool) –

• dataclass (bool) –

• sequential (bool) –

• default (Optional[Any]) –

• types (List[Type]) –

• namespaces (List[str]) –

property is_element

Return type

bool

property is_any_type

xs:element with type anyType.

Return type

bool

name = None

namespaces = None

qname = None

types = None

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

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

Parameters

• name (str) –

• qname (QName) –

• init (bool) –

• nillable (bool) –

• dataclass (bool) –

• sequential (bool) –

• default (Optional[Any]) –

• types (List[Type]) –

• namespaces (List[str]) –

property is_wildcard

Return type

bool

property is_any_type

Return type

bool

matches(qname)

Parameters

qname (QName) –

Return type

bool

name = None

namespaces = None

qname = None

types = None

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

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

Parameters

• name (str) –

• qname (QName) –

• init (bool) –

• nillable (bool) –

• dataclass (bool) –

• sequential (bool) –

• default (Optional[Any]) –

• types (List[Type]) –

• namespaces (List[str]) –

property is_attribute

Return type

bool

name = None

namespaces = None

qname = None

types = None

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

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

Parameters

• name (str) –

• qname (QName) –

• init (bool) –

• nillable (bool) –

• dataclass (bool) –

• sequential (bool) –

• default (Optional[Any]) –

• types (List[Type]) –

• namespaces (List[str]) –

property is_attributes

Return type

bool

name = None

namespaces = None

qname = None

types = None

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

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

Parameters

• name (str) –

• qname (QName) –

• init (bool) –

• nillable (bool) –

• dataclass (bool) –

• sequential (bool) –

• default (Optional[Any]) –

• types (List[Type]) –

• namespaces (List[str]) –

property is_tokens

Return type

bool

property is_text

Return type

bool

name = None

namespaces = None

qname = None

types = None

class xsdata.formats.dataclass.models.elements.FindMode

Bases: enum.IntEnum

An enumeration.

ALL = 1

ATTRIBUTE = 2

ATTRIBUTES = 3

ELEMENT = 4

TEXT = 5

WILDCARD = 6

NOT_WILDCARD = 7

LIST = 8

NOT_LIST = 9

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

Bases: object

Parameters

• name (str) –

• clazz (Type) –

• qname (QName) –

• source_qname (QName) –

• nillable (bool) –

• vars (List[XmlVar]) –

• cache (Dict) –

name: str = None

clazz: Type = None

qname: QName = None

source_qname: QName = None

nillable: bool = None

vars: List[XmlVar] = None

cache: Dict = None

property element_form

Return type

FormType

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

Parameters

• qname (QName) –

• mode (FindMode) –

Return type

Optional[XmlVar]