xsdata.codegen.models module¶
-
class
xsdata.codegen.models.
Restrictions
(required=None, prohibited=None, min_occurs=None, max_occurs=None, min_exclusive=None, min_inclusive=None, min_length=None, max_exclusive=None, max_inclusive=None, max_length=None, total_digits=None, fraction_digits=None, length=None, white_space=None, pattern=None, explicit_timezone=None, nillable=None, sequential=None, tokens=None, choice=None)[source]¶ Bases:
object
Model representation of a dataclass field validation and type metadata.
- Parameters
-
merge
(source)[source]¶ Update properties from another instance.
- Parameters
source (
Restrictions
) –
-
asdict
(types=None)[source]¶ Return the initialized only properties as a dictionary.
Skip None or implied values, and optionally use the parent attribute types to convert relevant options.
-
classmethod
from_element
(element)[source]¶ Static constructor from an xsd model.
- Parameters
element (
ElementBase
) –- Return type
-
class
xsdata.codegen.models.
AttrType
(qname, alias=None, native=False, forward=False, circular=False)[source]¶ Bases:
object
Model representation for the typing information for fields and extensions.
-
property
is_dependency
¶ Return true if attribute is not a forward/circular references and it’s not a native python time.
- Return type
-
property
native_name
¶ Return the python build-in type name: ‘str’, ‘int’ if it’s native type.
-
property
-
class
xsdata.codegen.models.
AttrChoice
(tag, name, default=None, namespace=None, types=<factory>, restrictions=<factory>)[source]¶ Bases:
object
Model representation for a dataclass field choice.
- Parameters
-
default
: Any = None¶
-
types
: List[xsdata.codegen.models.AttrType]¶
-
restrictions
: xsdata.codegen.models.Restrictions¶
-
class
xsdata.codegen.models.
Attr
(tag, name, local_name, index=<factory>, default=None, fixed=False, mixed=False, types=<factory>, choices=<factory>, namespace=None, help=None, restrictions=<factory>)[source]¶ Bases:
object
Model representation for a dataclass field.
- Parameters
-
default
: Any = None¶
-
types
: List[xsdata.codegen.models.AttrType]¶
-
choices
: List[xsdata.codegen.models.AttrChoice]¶
-
restrictions
: xsdata.codegen.models.Restrictions¶
-
property
is_attribute
¶ Return whether this attribute is derived from an xs:attribute or xs:anyAttribute.
- Return type
-
property
is_enumeration
¶ Return whether this attribute is derived from an xs:enumeration.
- Return type
-
property
is_factory
¶ Return whether this attribute is a list of items or a mapping.
- Return type
-
property
is_group
¶ Return whether this attribute is derived from an xs:group or xs:attributeGroup.
- Return type
-
property
is_nameless
¶ Return whether this attribute has a local name that will be used during parsing/serialization.
- Return type
-
property
is_suffix
¶ Return whether this attribute is not derived from an xs element with mode suffix.
- Return type
-
property
is_xsi_type
¶ Return whether this attribute qualified name is equal to xsi:type.
- Return type
-
property
is_wildcard
¶ Return whether this attribute is derived from xs:anyAttribute or xs:any.
- Return type
-
class
xsdata.codegen.models.
Extension
(type, restrictions)[source]¶ Bases:
object
Model representation of a dataclass base class.
- Parameters
type (
AttrType
) –restrictions (
Restrictions
) –
-
restrictions
: xsdata.codegen.models.Restrictions¶
-
class
xsdata.codegen.models.
Status
(value)[source]¶ Bases:
enum.IntEnum
An enumeration.
-
RAW
= 0¶
-
PROCESSING
= 1¶
-
PROCESSED
= 2¶
-
-
class
xsdata.codegen.models.
Class
(qname, type, module, mixed=False, abstract=False, nillable=False, strict_type=False, status=<Status.RAW: 0>, container=None, package=None, namespace=None, help=None, meta_name=None, substitutions=<factory>, extensions=<factory>, attrs=<factory>, inner=<factory>, ns_map=<factory>)[source]¶ Bases:
object
Model representation of a dataclass with fields, base/inner classes and additional metadata settings.
- Parameters
-
type
: Type¶
-
status
: xsdata.codegen.models.Status = 0¶
-
extensions
: List[xsdata.codegen.models.Extension]¶
-
attrs
: List[xsdata.codegen.models.Attr]¶
-
inner
: List[xsdata.codegen.models.Class]¶
-
ns_map
: Dict¶
-
property
is_complex
¶ Return whether this instance is derived from an xs:element or xs:complexType.
- Return type
-
property
is_element
¶ Return whether this instance is derived from an non abstract xs:element.
- Return type
-
property
is_enumeration
¶ Return whether all attributes are derived from xs:enumeration.
- Return type