xsdata.models.elements module

xsdata.models.elements.attribute(default=<dataclasses._MISSING_TYPE object>, default_factory=<dataclasses._MISSING_TYPE object>, init=True, **kwargs)

xsdata.models.elements.element(default=<dataclasses._MISSING_TYPE object>, default_factory=<dataclasses._MISSING_TYPE object>, init=True, **kwargs)

xsdata.models.elements.any_element(default=<dataclasses._MISSING_TYPE object>, default_factory=<dataclasses._MISSING_TYPE object>, init=True, **kwargs)

class xsdata.models.elements.Documentation(index=<factory>, id=None, lang=None, source=None, elements=<factory>)

Bases: xsdata.models.mixins.ElementBase

The documentation element is used to enter text comments in a schema.

Reference: https://www.w3schools.com/xml/el_documentation.asp.

class Meta

Bases: object

mixed = True

lang: Optional[str] = None

source: Optional[str] = None

elements: ArrayList[object] = None

tostring()

Return type

Optional[str]

class xsdata.models.elements.Appinfo(index=<factory>, id=None, source=None, elements=<factory>)

Bases: xsdata.models.mixins.ElementBase

The appinfo element specifies information to be used by the application.

Reference: https://www.w3schools.com/xml/el_appinfo.asp.

class Meta

Bases: object

mixed = True

source: Optional[str] = None

elements: ArrayList[object] = None

class xsdata.models.elements.Annotation(index=<factory>, id=None, appinfo=None, documentations=<factory>)

Bases: xsdata.models.mixins.ElementBase

The annotation element is a top level element that specifies schema comments.

Reference: https://www.w3schools.com/xml/el_annotation.asp.

appinfo: Optional[xsdata.models.elements.Appinfo] = None

documentations: ArrayList[Documentation] = None

class xsdata.models.elements.AnnotationBase(index=<factory>, id=None, annotation=None)

Bases: xsdata.models.mixins.ElementBase

Base Class for elements that can contain annotations.

annotation: Optional[xsdata.models.elements.Annotation] = None

property display_help

Return type

Optional[str]

class xsdata.models.elements.SimpleType(index=<factory>, id=None, annotation=None, name=None, restriction=None, list=None, union=None)

Bases: xsdata.models.elements.AnnotationBase, xsdata.models.mixins.NamedField, xsdata.models.mixins.RestrictedField

The simpleType element defines a simple type and specifies the constraints and information about the values of attributes or text-only elements.

XSD Element reference : Reference: https://www.w3schools.com/xml/el_simpletype.asp.

name: Optional[str] = None

restriction: Optional[Restriction] = None

list: Optional[List] = None

union: Optional[Union] = None

property is_enumeration

property real_type

Return type

Optional[str]

get_restrictions()

Return type

Dict[str, Any]

class xsdata.models.elements.List(index=<factory>, id=None, annotation=None, simple_type=None, item_type=None)

Bases: xsdata.models.elements.AnnotationBase, xsdata.models.mixins.RestrictedField, xsdata.models.mixins.NamedField

The list element defines a simple type element as a list of values of a specified data type.

Reference: https://www.w3schools.com/xml/el_list.asp.

simple_type: Optional[xsdata.models.elements.SimpleType] = None

item_type: Optional[str] = None

property is_attribute

Return type

bool

property real_name

Return type

str

property real_type

Return type

Optional[str]

get_restrictions()

Return type

Dict[str, Any]

class xsdata.models.elements.Union(index=<factory>, id=None, annotation=None, member_types=None, simple_types=<factory>)

Bases: xsdata.models.elements.AnnotationBase, xsdata.models.mixins.NamedField, xsdata.models.mixins.RestrictedField

The union element defines a simple type as a collection (union) of values from specified simple data types.

Reference: https://www.w3schools.com/xml/el_union.asp.

member_types: Optional[str] = None

simple_types: ArrayList[SimpleType] = None

property extends

Return type

Optional[str]

property is_attribute

Return type

bool

property real_type

Return type

Optional[str]

property real_name

Return type

str

get_restrictions()

Return type

Dict[str, Any]

class xsdata.models.elements.AnyAttribute(index=<factory>, id=None, annotation=None, namespace=None, process_contents=None)

Bases: xsdata.models.elements.AnnotationBase, xsdata.models.mixins.NamedField, xsdata.models.mixins.RestrictedField

The anyAttribute element enables the author to extend the XML document with attributes not specified by the schema.

XSD Element reference

: Reference: https://www.w3schools.com/xml/el_anyattribute.asp.

namespace: Optional[str] = None

process_contents: Optional[xsdata.models.enums.ProcessType] = None

property is_attribute

Return type

bool

property real_type

Return type

Optional[str]

property real_name

Return type

str

get_restrictions()

Return type

Dict[str, Any]

class xsdata.models.elements.Attribute(index=<factory>, id=None, annotation=None, default=None, fixed=None, form=None, name=None, ref=None, type=None, simple_type=None, use=<UseType.OPTIONAL: 'optional'>)

Bases: xsdata.models.elements.AnnotationBase, xsdata.models.mixins.NamedField, xsdata.models.mixins.RestrictedField

The attribute element defines an attribute.

Reference: https://www.w3schools.com/xml/el_attribute.asp.

default: Optional[str] = None

fixed: Optional[str] = None

form: Optional[xsdata.models.enums.FormType] = None

name: Optional[str] = None

ref: Optional[str] = None

type: Optional[str] = None

simple_type: Optional[xsdata.models.elements.SimpleType] = None

use: Optional[xsdata.models.enums.UseType] = 'optional'

property is_attribute

Return type

bool

property real_type

Return type

Optional[str]

get_restrictions()

Return type

Dict[str, Any]

class xsdata.models.elements.AttributeGroup(index=<factory>, id=None, annotation=None, name=None, ref=None, any_attribute=None, attributes=<factory>, attribute_groups=<factory>)

Bases: xsdata.models.elements.AnnotationBase, xsdata.models.mixins.NamedField

The attributeGroup element is used to group a set of attribute declarations so that they can be incorporated as a group into complex type definitions.

XSD Element reference

: Reference: https://www.w3schools.com/xml/el_attributegroup.asp.

name: Optional[str] = None

ref: Optional[str] = None

any_attribute: Optional[xsdata.models.elements.AnyAttribute] = None

attributes: ArrayList[Attribute] = None

attribute_groups: ArrayList['AttributeGroup'] = None

property extends

Return type

Optional[str]

class xsdata.models.elements.All(index=<factory>, id=None, annotation=None, min_occurs=1, max_occurs=1, elements=<factory>)

Bases: xsdata.models.elements.AnnotationBase, xsdata.models.mixins.OccurrencesMixin

The all element specifies that the child elements can appear in any order and that each child element can occur zero or one time.

Reference: https://www.w3schools.com/xml/el_all.asp.

min_occurs: int = 1

max_occurs: int = 1

elements: ArrayList['Element'] = None

class xsdata.models.elements.Sequence(index=<factory>, id=None, annotation=None, min_occurs=1, max_occurs=1, elements=<factory>, groups=<factory>, choices=<factory>, sequences=<factory>, any=<factory>)

Bases: xsdata.models.elements.AnnotationBase, xsdata.models.mixins.OccurrencesMixin

The sequence element specifies that the child elements must appear in a sequence. Each child element can occur from 0 to any number of times.

Reference: https://www.w3schools.com/xml/el_sequence.asp.

min_occurs: int = 1

max_occurs: int = 1

elements: ArrayList['Element'] = None

groups: ArrayList['Group'] = None

choices: ArrayList['Choice'] = None

sequences: ArrayList['Sequence'] = None

any: ArrayList['Any'] = None

class xsdata.models.elements.Choice(index=<factory>, id=None, annotation=None, min_occurs=1, max_occurs=1, elements=<factory>, groups=<factory>, choices=<factory>, sequences=<factory>)

Bases: xsdata.models.elements.AnnotationBase, xsdata.models.mixins.OccurrencesMixin

XML Schema choice element allows only one of the elements contained in the.

<choice> declaration to be present within the containing element.

Reference: https://www.w3schools.com/xml/el_choice.asp.

min_occurs: int = 1

max_occurs: int = 1

elements: ArrayList['Element'] = None

groups: ArrayList['Group'] = None

choices: ArrayList['Choice'] = None

sequences: ArrayList[Sequence] = None

class xsdata.models.elements.Group(index=<factory>, id=None, annotation=None, name=None, ref=None, min_occurs=1, max_occurs=1, all=None, choice=None, sequence=None)

Bases: xsdata.models.elements.AnnotationBase, xsdata.models.mixins.OccurrencesMixin, xsdata.models.mixins.NamedField

The group element is used to define a group of elements to be used in complex type definitions.

Reference: https://www.w3schools.com/xml/el_group.asp.

name: Optional[str] = None

ref: Optional[str] = None

min_occurs: int = 1

max_occurs: int = 1

all: Optional[xsdata.models.elements.All] = None

choice: Optional[xsdata.models.elements.Choice] = None

sequence: Optional[xsdata.models.elements.Sequence] = None

property extends

Return type

Optional[str]

class xsdata.models.elements.Extension(index=<factory>, id=None, annotation=None, base=None, group=None, all=None, choice=None, sequence=None, any_attribute=None, attributes=<factory>, attribute_groups=<factory>)

Bases: xsdata.models.elements.AnnotationBase

The extension element extends an existing simpleType or complexType element.

Reference: https://www.w3schools.com/xml/el_extension.asp.

base: Optional[str] = None

group: Optional[xsdata.models.elements.Group] = None

all: Optional[xsdata.models.elements.All] = None

choice: Optional[xsdata.models.elements.Choice] = None

sequence: Optional[xsdata.models.elements.Sequence] = None

any_attribute: Optional[xsdata.models.elements.AnyAttribute] = None

attributes: ArrayList[Attribute] = None

attribute_groups: ArrayList[AttributeGroup] = None

property extends

Return type

Optional[str]

class xsdata.models.elements.Enumeration(index=<factory>, id=None, annotation=None, value=None)

Bases: xsdata.models.elements.AnnotationBase, xsdata.models.mixins.NamedField, xsdata.models.mixins.RestrictedField

Defines a list of acceptable values.

Schema Facet: Reference: https://www.w3schools.com/xml/schema_facets.asp.

value: Optional[str] = None

property is_attribute

Return type

bool

property real_type

property real_name

property default

get_restrictions()

class xsdata.models.elements.FractionDigits(index=<factory>, id=None, annotation=None, value=None)

Bases: xsdata.models.elements.AnnotationBase

Specifies the maximum number of decimal places allowed. Must be equal to or greater than zero.

Schema Facet: Reference: https://www.w3schools.com/xml/schema_facets.asp.

value: Optional[int] = None

class xsdata.models.elements.Length(index=<factory>, id=None, annotation=None, value=None)

Bases: xsdata.models.elements.AnnotationBase

Specifies the exact number of characters or list items allowed. Must be equal to or greater than zero.

Schema Facet: Reference: https://www.w3schools.com/xml/schema_facets.asp.

value: Optional[int] = None

class xsdata.models.elements.MaxExclusive(index=<factory>, id=None, annotation=None, value=None)

Bases: xsdata.models.elements.AnnotationBase

Specifies the upper bounds for numeric values (the value must be less than this value)

Schema Facet: Reference: https://www.w3schools.com/xml/schema_facets.asp.

value: Optional[float] = None

class xsdata.models.elements.MaxInclusive(index=<factory>, id=None, annotation=None, value=None)

Bases: xsdata.models.elements.AnnotationBase

Specifies the upper bounds for numeric values (the value must be less than or equal to this value)

Schema Facet: Reference: https://www.w3schools.com/xml/schema_facets.asp.

value: Optional[float] = None

class xsdata.models.elements.MaxLength(index=<factory>, id=None, annotation=None, value=None)

Bases: xsdata.models.elements.AnnotationBase

Specifies the maximum number of characters or list items allowed. Must be equal to or greater than zero.

Schema Facet: Reference: https://www.w3schools.com/xml/schema_facets.asp.

value: Optional[float] = None

class xsdata.models.elements.MinExclusive(index=<factory>, id=None, annotation=None, value=None)

Bases: xsdata.models.elements.AnnotationBase

Schema Facet: Reference:

https://www.w3schools.com/xml/schema_facets.asp.

value: Optional[float] = None

class xsdata.models.elements.MinInclusive(index=<factory>, id=None, annotation=None, value=None)

Bases: xsdata.models.elements.AnnotationBase

Specifies the lower bounds for numeric values (the value must be greater than this value)

Schema Facet: Reference: https://www.w3schools.com/xml/schema_facets.asp.

value: Optional[float] = None

class xsdata.models.elements.MinLength(index=<factory>, id=None, annotation=None, value=None)

Bases: xsdata.models.elements.AnnotationBase

Specifies the lower bounds for numeric values (the value must be greater than or equal to this value)

Schema Facet: Reference: https://www.w3schools.com/xml/schema_facets.asp.

value: Optional[float] = None

class xsdata.models.elements.Pattern(index=<factory>, id=None, annotation=None, value=None)

Bases: xsdata.models.elements.AnnotationBase

Defines the exact sequence of characters that are acceptable.

Schema Facet: Reference: https://www.w3schools.com/xml/schema_facets.asp.

value: Optional[str] = None

class xsdata.models.elements.TotalDigits(index=<factory>, id=None, annotation=None, value=None)

Bases: xsdata.models.elements.AnnotationBase

Specifies the exact number of digits allowed. Must be greater than zero.

Schema Facet: Reference: https://www.w3schools.com/xml/schema_facets.asp.

value: Optional[int] = None

class xsdata.models.elements.WhiteSpace(index=<factory>, id=None, annotation=None, value=None)

Bases: xsdata.models.elements.AnnotationBase

Specifies how white space (line feeds, tabs, spaces, and carriage returns) is handled.

Schema Facet: Reference: https://www.w3schools.com/xml/schema_facets.asp.

value: Optional[str] = None

class xsdata.models.elements.Assertion(index=<factory>, id=None, annotation=None, test=None)

Bases: xsdata.models.elements.AnnotationBase

test: Optional[str] = None

class xsdata.models.elements.ExplicitTimezone(index=<factory>, id=None, annotation=None, value=None, fixed=None)

Bases: xsdata.models.elements.AnnotationBase

value: Optional[xsdata.models.enums.UseType] = None

fixed: Optional[str] = None

class xsdata.models.elements.Restriction(index=<factory>, id=None, annotation=None, base=None, group=None, all=None, choice=None, sequence=None, any_attribute=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, simple_type=None, enumerations=<factory>, assertions=<factory>, attributes=<factory>, attribute_groups=<factory>)

Bases: xsdata.models.mixins.RestrictedField, xsdata.models.elements.AnnotationBase, xsdata.models.mixins.NamedField

The restriction element defines restrictions on a simpleType, simpleContent, or complexContent definition.

XSD Element reference

: Reference: https://www.w3schools.com/xml/el_restriction.asp.

VALUE_FIELDS = ('min_exclusive', 'min_inclusive', 'min_length', 'max_exclusive', 'max_inclusive', 'max_length', 'total_digits', 'fraction_digits', 'length', 'white_space', 'pattern', 'explicit_timezone')

CONTAINER_FIELDS = ('group', 'all', 'choice', 'sequence', 'any_attribute', 'attributes', 'attribute_groups', 'enumerations')

base: Optional[str] = None

group: Optional[xsdata.models.elements.Group] = None

all: Optional[xsdata.models.elements.All] = None

choice: Optional[xsdata.models.elements.Choice] = None

sequence: Optional[xsdata.models.elements.Sequence] = None

any_attribute: Optional[xsdata.models.elements.AnyAttribute] = None

min_exclusive: Optional[xsdata.models.elements.MinExclusive] = None

min_inclusive: Optional[xsdata.models.elements.MinInclusive] = None

min_length: Optional[xsdata.models.elements.MinLength] = None

max_exclusive: Optional[xsdata.models.elements.MaxExclusive] = None

max_inclusive: Optional[xsdata.models.elements.MaxInclusive] = None

max_length: Optional[xsdata.models.elements.MaxLength] = None

total_digits: Optional[xsdata.models.elements.TotalDigits] = None

fraction_digits: Optional[xsdata.models.elements.FractionDigits] = None

length: Optional[xsdata.models.elements.Length] = None

white_space: Optional[xsdata.models.elements.WhiteSpace] = None

pattern: Optional[xsdata.models.elements.Pattern] = None

explicit_timezone: Optional[xsdata.models.elements.ExplicitTimezone] = None

simple_type: Optional[xsdata.models.elements.SimpleType] = None

enumerations: ArrayList[Enumeration] = None

assertions: ArrayList[Assertion] = None

attributes: ArrayList[Attribute] = None

attribute_groups: ArrayList[AttributeGroup] = None

property is_attribute

Return type

bool

property real_type

Return type

Optional[str]

property real_name

Return type

str

property extends

Return type

Optional[str]

get_restrictions()

Return type

Dict[str, Any]

class xsdata.models.elements.SimpleContent(index=<factory>, id=None, annotation=None, restriction=None, extension=None)

Bases: xsdata.models.elements.AnnotationBase

The simpleContent element contains extensions or restrictions on a text- only complex type or on a simple type as content and contains no elements.

XSD Element reference

: Reference: https://www.w3schools.com/xml/el_simplecontent.asp.

restriction: Optional[xsdata.models.elements.Restriction] = None

extension: Optional[xsdata.models.elements.Extension] = None

class xsdata.models.elements.ComplexContent(index=<factory>, id=None, annotation=None, restriction=None, extension=None, mixed=False)

Bases: xsdata.models.elements.SimpleContent

The complexContent element defines extensions or restrictions on a complex type that contains mixed content or elements only.

XSD Element reference

: Reference: https://www.w3schools.com/xml/el_complexcontent.asp.

mixed: bool = False

class xsdata.models.elements.ComplexType(index=<factory>, id=None, annotation=None, name=None, block=None, final=None, simple_content=None, complex_content=None, group=None, all=None, choice=None, sequence=None, any_attribute=None, attributes=<factory>, attribute_groups=<factory>, abstract=False, mixed=False)

Bases: xsdata.models.elements.AnnotationBase, xsdata.models.mixins.NamedField

The complexType element defines a complex type. A complex type element is an XML element that contains other elements and/or attributes.

XSD Element reference

: Reference: https://www.w3schools.com/xml/el_complextype.asp.

name: Optional[str] = None

block: Optional[str] = None

final: Optional[str] = None

simple_content: Optional[xsdata.models.elements.SimpleContent] = None

complex_content: Optional[xsdata.models.elements.ComplexContent] = None

group: Optional[xsdata.models.elements.Group] = None

all: Optional[xsdata.models.elements.All] = None

choice: Optional[xsdata.models.elements.Choice] = None

sequence: Optional[xsdata.models.elements.Sequence] = None

any_attribute: Optional[xsdata.models.elements.AnyAttribute] = None

attributes: ArrayList[Attribute] = None

attribute_groups: ArrayList[AttributeGroup] = None

abstract: bool = False

mixed: bool = False

property is_mixed

Return type

bool

class xsdata.models.elements.Field(index=<factory>, id=None, annotation=None, xpath=None)

Bases: xsdata.models.elements.AnnotationBase

Reference: https://www.w3schools.com/xml/el_field.asp.

xpath: Optional[str] = None

class xsdata.models.elements.Selector(index=<factory>, id=None, annotation=None, xpath=None)

Bases: xsdata.models.elements.Field

The field element specifies an XPath expression that specifies the value used to define an identity constraint.

Reference: https://www.w3schools.com/xml/el_selector.asp.

class xsdata.models.elements.Unique(index=<factory>, id=None, annotation=None, name=None, selector=None, field=None)

Bases: xsdata.models.elements.AnnotationBase

The unique element defines that an element or an attribute value must be unique within the scope. The unique element MUST contain the following (in order):

• one and only one selector element

• one or more field elements

Reference: https://www.w3schools.com/xml/el_unique.asp.

name: Optional[str] = None

selector: Optional[xsdata.models.elements.Selector] = None

field: Optional[xsdata.models.elements.Field] = None

class xsdata.models.elements.Key(index=<factory>, id=None, annotation=None, name=None, selector=None, fields=<factory>)

Bases: xsdata.models.elements.AnnotationBase

Reference: https://www.w3schools.com/xml/el_key.asp.

name: Optional[str] = None

selector: Optional[xsdata.models.elements.Selector] = None

fields: ArrayList[Selector] = None

class xsdata.models.elements.Keyref(index=<factory>, id=None, annotation=None, name=None, refer=None, selector=None, fields=<factory>)

Bases: xsdata.models.elements.AnnotationBase

The key element specifies an attribute or element value as a key (unique, non-nullable, and always present) within the containing element in an instance document.

The key element MUST contain the following (in order):

• one and only one selector element

• one or more field elements

Reference: https://www.w3schools.com/xml/el_keyref.asp.

name: Optional[str] = None

refer: Optional[str] = None

selector: Optional[xsdata.models.elements.Selector] = None

fields: ArrayList[Selector] = None

class xsdata.models.elements.Element(index=<factory>, id=None, annotation=None, name=None, ref=None, type=None, substitution_group=None, default=None, fixed=None, form=None, block=None, final=None, simple_type=None, complex_type=None, uniques=<factory>, keys=<factory>, keyrefs=<factory>, min_occurs=None, max_occurs=None, nillable=False, abstract=False)

Bases: xsdata.models.elements.AnnotationBase, xsdata.models.mixins.NamedField, xsdata.models.mixins.OccurrencesMixin

The element element defines an element.

Reference: https://www.w3schools.com/xml/el_element.asp.

name: Optional[str] = None

id: Optional[str] = None

ref: Optional[str] = None

type: Optional[str] = None

substitution_group: Optional[str] = None

default: Optional[str] = None

fixed: Optional[str] = None

form: Optional[xsdata.models.enums.FormType] = None

block: Optional[xsdata.models.elements.List] = None

final: Optional[xsdata.models.elements.List] = None

simple_type: Optional[xsdata.models.elements.SimpleType] = None

complex_type: Optional[xsdata.models.elements.ComplexType] = None

uniques: ArrayList[Unique] = None

keys: ArrayList[Key] = None

keyrefs: ArrayList[Keyref] = None

min_occurs: Optional[int] = None

max_occurs: Optional[int] = None

nillable: bool = False

abstract: bool = False

property is_attribute

Return type

bool

property real_type

Return type

Optional[str]

get_restrictions()

Return type

Dict[str, Any]

class xsdata.models.elements.Any(index=<factory>, id=None, annotation=None, min_occurs=1, max_occurs=1, namespace=None, process_contents=None)

Bases: xsdata.models.elements.AnnotationBase, xsdata.models.mixins.OccurrencesMixin, xsdata.models.mixins.NamedField

The any element enables the author to extend the XML document with elements not specified by the schema.

Reference: https://www.w3schools.com/xml/el_any.asp.

min_occurs: int = 1

max_occurs: int = 1

namespace: Optional[str] = None

process_contents: Optional[xsdata.models.enums.ProcessType] = None

annotation: Optional[xsdata.models.elements.Annotation] = None

property is_attribute

Return type

bool

property real_type

Return type

Optional[str]

property real_name

Return type

str

class xsdata.models.elements.Import(index=<factory>, id=None, annotation=None, namespace=None, schema_location=None)

Bases: xsdata.models.elements.AnnotationBase

The import element is used to add multiple schemas with different target namespace to a document.

Reference: https://www.w3schools.com/xml/el_import.asp.

namespace: Optional[str] = None

schema_location: Optional[str] = None

class xsdata.models.elements.Include(index=<factory>, id=None, annotation=None, schema_location=None)

Bases: xsdata.models.elements.AnnotationBase

The include element is used to add multiple schemas with the same target namespace to a document.

Reference: https://www.w3schools.com/xml/el_include.asp.

schema_location: Optional[str] = None

property namespace

class xsdata.models.elements.Notation(index=<factory>, id=None, annotation=None, name=None, public=None, system=None)

Bases: xsdata.models.elements.AnnotationBase

The notation element describes the format of non-XML data within an XML document.

Reference: https://www.w3schools.com/xml/el_notation.asp.

name: Optional[str] = None

public: Optional[str] = None

system: Optional[str] = None

class xsdata.models.elements.Redefine(index=<factory>, id=None, annotation=None, schema_location=None, simple_type=None, complex_type=None, group=None, attribute_group=None)

Bases: xsdata.models.elements.AnnotationBase

The redefine element redefines simple and complex types, groups, and attribute groups from an external schema.

Reference: https://www.w3schools.com/xml/el_redefine.asp.

schema_location: Optional[str] = None

simple_type: Optional[xsdata.models.elements.SimpleType] = None

complex_type: Optional[xsdata.models.elements.ComplexType] = None

group: Optional[xsdata.models.elements.Group] = None

attribute_group: Optional[xsdata.models.elements.AttributeGroup] = None

class xsdata.models.elements.Schema(index=<factory>, id=None, annotation=None, target=None, block_default=None, final_default=None, target_namespace=None, version=None, xmlns=None, nsmap=<factory>, location=None, element_form_default=<FormType.UNQUALIFIED: 'unqualified'>, attribute_form_default=<FormType.UNQUALIFIED: 'unqualified'>, includes=<factory>, imports=<factory>, redefines=<factory>, annotations=<factory>, simple_types=<factory>, complex_types=<factory>, groups=<factory>, attribute_groups=<factory>, elements=<factory>, attributes=<factory>, notations=<factory>)

Bases: xsdata.models.elements.AnnotationBase

The schema element defines the root element of a schema.

Reference: https://www.w3schools.com/xml/el_schema.asp.

class Meta

Bases: object

namespace = 'http://www.w3.org/2001/XMLSchema'

target: Optional[str] = None

block_default: Optional[str] = None

final_default: Optional[str] = None

target_namespace: Optional[str] = None

version: Optional[str] = None

xmlns: Optional[str] = None

nsmap: Dict = None

location: Optional[pathlib.Path] = None

element_form_default: xsdata.models.enums.FormType = 'unqualified'

attribute_form_default: xsdata.models.enums.FormType = 'unqualified'

includes: ArrayList[Include] = None

imports: ArrayList[Import] = None

redefines: ArrayList[Redefine] = None

annotations: ArrayList[Annotation] = None

simple_types: ArrayList[SimpleType] = None

complex_types: ArrayList[ComplexType] = None

groups: ArrayList[Group] = None

attribute_groups: ArrayList[AttributeGroup] = None

elements: ArrayList[Element] = None

attributes: ArrayList[Attribute] = None

notations: ArrayList[Notation] = None

sub_schemas()

Return type

Iterator[Union[Import, Include]]

property module

property target_prefix