xsdata.formats.dataclass.models.elements module¶
-
class
xsdata.formats.dataclass.models.elements.
XmlVar
(name, qname, init=True, mixed=False, tokens=False, derived=False, nillable=False, dataclass=False, sequential=False, list_element=False, default=None, choices=<factory>, types=<factory>, namespaces=<factory>)[source]¶ Bases:
object
Dataclass field bind metadata.
- Parameters
name (
str
) – Field name.qname (
str
) – The namespace qualified local name.init (
bool
) – Field is present in the constructor parameters.mixed (
bool
) – Field supports mixed content.tokens (
bool
) – Use a list to map simple values.derived (
bool
) – Use derived elements to bind data.nillable (
bool
) – Allow empty content elements rendering.dataclass (
bool
) – Specify whether the field type is a dataclass.sequential (
bool
) – Switch to sequential rendering with other sequential siblingslist_element (
bool
) – Specify whether the field represents a list of elementsnamespaces (
List
[str
]) – Field list of the all the possible namespaces.
-
default
: Any = None¶
-
choices
: List[xsdata.formats.dataclass.models.elements.XmlVar]¶
-
types
: List[Type]¶
-
property
is_mixed_content
¶ Return whether the field is a mixed content list of of elements.
- Return type
-
matches
(qname)[source]¶ Match the field qualified local name to the given qname.
Return True automatically if the local name is a wildcard.
-
class
xsdata.formats.dataclass.models.elements.
XmlElement
(name, qname, init=True, mixed=False, tokens=False, derived=False, nillable=False, dataclass=False, sequential=False, list_element=False, default=None, choices=<factory>, types=<factory>, namespaces=<factory>)[source]¶ Bases:
xsdata.formats.dataclass.models.elements.XmlVar
Dataclass field bind metadata for xml elements.
- Parameters
-
choices
: List[xsdata.formats.dataclass.models.elements.XmlVar]¶
-
types
: List[Type]¶
-
class
xsdata.formats.dataclass.models.elements.
XmlElements
(name, qname, init=True, mixed=False, tokens=False, derived=False, nillable=False, dataclass=False, sequential=False, list_element=False, default=None, choices=<factory>, types=<factory>, namespaces=<factory>)[source]¶ Bases:
xsdata.formats.dataclass.models.elements.XmlVar
Dataclass field bind metadata for compound list of xml elements.
- Parameters
-
choices
: List[xsdata.formats.dataclass.models.elements.XmlVar]¶
-
types
: List[Type]¶
-
class
xsdata.formats.dataclass.models.elements.
XmlWildcard
(name, qname, init=True, mixed=False, tokens=False, derived=False, nillable=False, dataclass=False, sequential=False, list_element=False, default=None, choices=<factory>, types=<factory>, namespaces=<factory>)[source]¶ Bases:
xsdata.formats.dataclass.models.elements.XmlVar
Dataclass field bind metadata for xml wildcard elements.
- Parameters
-
property
is_mixed_content
¶ Return whether the field is a mixed content list of of elements.
- Return type
-
choices
: List[xsdata.formats.dataclass.models.elements.XmlVar]¶
-
types
: List[Type]¶
-
class
xsdata.formats.dataclass.models.elements.
XmlAttribute
(name, qname, init=True, mixed=False, tokens=False, derived=False, nillable=False, dataclass=False, sequential=False, list_element=False, default=None, choices=<factory>, types=<factory>, namespaces=<factory>)[source]¶ Bases:
xsdata.formats.dataclass.models.elements.XmlVar
Dataclass field bind metadata for xml attributes.
- Parameters
-
choices
: List[xsdata.formats.dataclass.models.elements.XmlVar]¶
-
types
: List[Type]¶
-
class
xsdata.formats.dataclass.models.elements.
XmlAttributes
(name, qname, init=True, mixed=False, tokens=False, derived=False, nillable=False, dataclass=False, sequential=False, list_element=False, default=None, choices=<factory>, types=<factory>, namespaces=<factory>)[source]¶ Bases:
xsdata.formats.dataclass.models.elements.XmlVar
Dataclass field bind metadata for xml wildcard attributes.
- Parameters
-
choices
: List[xsdata.formats.dataclass.models.elements.XmlVar]¶
-
types
: List[Type]¶
-
class
xsdata.formats.dataclass.models.elements.
XmlText
(name, qname, init=True, mixed=False, tokens=False, derived=False, nillable=False, dataclass=False, sequential=False, list_element=False, default=None, choices=<factory>, types=<factory>, namespaces=<factory>)[source]¶ Bases:
xsdata.formats.dataclass.models.elements.XmlVar
Dataclass field bind metadata for xml text content.
- Parameters
-
choices
: List[xsdata.formats.dataclass.models.elements.XmlVar]¶
-
types
: List[Type]¶
-
class
xsdata.formats.dataclass.models.elements.
FindMode
(value)[source]¶ Bases:
enum.IntEnum
Find switches to be used to find a specific var.
-
ALL
= 1¶
-
ATTRIBUTE
= 2¶
-
ATTRIBUTES
= 3¶
-
TEXT
= 4¶
-
WILDCARD
= 5¶
-
MIXED_CONTENT
= 0¶
-
NOT_WILDCARD
= 6¶
-
-
class
xsdata.formats.dataclass.models.elements.
XmlMeta
(clazz, qname, source_qname, nillable, vars=<factory>)[source]¶ Bases:
object
Dataclass model bind metadata.
- Parameters
-
clazz
: Type¶
-
vars
: List[xsdata.formats.dataclass.models.elements.XmlVar]¶
-
cache
: Dict¶