Skip to content

# xsd

## `xsdata.models.xsd`

### `Docstring` `dataclass`

Docstring model representation.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`content` | `list[object]` | A list of mixed content elements | `array_any_element()`

Source code in `xsdata/models/xsd.py`

    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58

    @dataclass(frozen=True)
    class Docstring:
        """Docstring model representation.

        Args:
            content: A list of mixed content elements
        """

        class Meta:
            """Metadata options."""

            namespace = "http://www.w3.org/1999/xhtml"

        content: list[object] = array_any_element()

#### `Meta`

Metadata options.

Source code in `xsdata/models/xsd.py`

    53
    54
    55
    56

    class Meta:
        """Metadata options."""

        namespace = "http://www.w3.org/1999/xhtml"

### `Documentation` `dataclass`

Bases: `ElementBase`

XSD MinLength model representation.

Source code in `xsdata/models/xsd.py`

    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77

    @dataclass
    class Documentation(ElementBase):
        """XSD MinLength model representation."""

        lang: str | None = attribute()
        source: str | None = attribute()
        attributes: Optional["AnyAttribute"] = element()
        content: list[object] = array_any_element(mixed=True)

        def tostring(self) -> str | None:
            """Convert the content to a help string."""
            obj = Docstring(self.content)
            ns_map = {None: "http://www.w3.org/1999/xhtml"}
            xml = docstring_serializer.render(obj, ns_map=ns_map)
            start = xml.find(">") + 1
            end = xml.rfind("<")
            return textwrap.dedent(xml[start:end]).strip()

#### `tostring()`

Convert the content to a help string.

Source code in `xsdata/models/xsd.py`

    70
    71
    72
    73
    74
    75
    76
    77

    def tostring(self) -> str | None:
        """Convert the content to a help string."""
        obj = Docstring(self.content)
        ns_map = {None: "http://www.w3.org/1999/xhtml"}
        xml = docstring_serializer.render(obj, ns_map=ns_map)
        start = xml.find(">") + 1
        end = xml.rfind("<")
        return textwrap.dedent(xml[start:end]).strip()

### `Appinfo` `dataclass`

Bases: `ElementBase`

XSD Appinfo model representation.

Source code in `xsdata/models/xsd.py`

    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91

    @dataclass
    class Appinfo(ElementBase):
        """XSD Appinfo model representation."""

        class Meta:
            """Metadata options."""

            mixed = True

        source: str | None = attribute()
        any_attribute: Optional["AnyAttribute"] = element(name="anyAttribute")
        content: list[object] = array_any_element(mixed=True)

#### `Meta`

Metadata options.

Source code in `xsdata/models/xsd.py`

    84
    85
    86
    87

    class Meta:
        """Metadata options."""

        mixed = True

### `Annotation` `dataclass`

Bases: `ElementBase`

XSD Annotation model representation.

Source code in `xsdata/models/xsd.py`

     94
     95
     96
     97
     98
     99
    100

    @dataclass
    class Annotation(ElementBase):
        """XSD Annotation model representation."""

        app_infos: list[Appinfo] = array_element(name="appinfo")
        documentations: list[Documentation] = array_element(name="documentation")
        any_attribute: Optional["AnyAttribute"] = element(name="anyAttribute")

### `AnnotationBase` `dataclass`

Bases: `ElementBase`

XSD AnnotationBase model representation.

Source code in `xsdata/models/xsd.py`

    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120

    @dataclass
    class AnnotationBase(ElementBase):
        """XSD AnnotationBase model representation."""

        id: str | None = attribute()
        annotations: list[Annotation] = array_element(name="annotation")
        any_attribute: Optional["AnyAttribute"] = element(name="anyAttribute")

        @property
        def display_help(self) -> str | None:
            """Return all annotation documentations concatenated."""
            help_str = "\n".join(
                documentation.tostring() or ""
                for annotation in self.annotations
                for documentation in annotation.documentations
            ).strip()

            return help_str or None

#### `display_help` `property`

Return all annotation documentations concatenated.

### `AnyAttribute` `dataclass`

Bases: `AnnotationBase`

XSD AnyAttribute model representation.

Source code in `xsdata/models/xsd.py`

    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155

    @dataclass
    class AnyAttribute(AnnotationBase):
        """XSD AnyAttribute model representation."""

        namespace: str = attribute(default="##any")
        process_contents: ProcessType | None = attribute(
            name="processContents", default="strict"
        )

        def __post_init__(self):
            """Post initialization validations."""
            self.namespace = " ".join(unique_sequence(self.namespace.split()))

        @property
        def is_property(self) -> bool:
            """Specify it is qualified to be a class property."""
            return True

        @property
        def raw_namespace(self) -> str | None:
            """The element explicit namespace."""
            return self.namespace

        @property
        def real_name(self) -> str:
            """Return the real name for this element."""
            clean_ns = "_".join(map(clean_uri, self.namespace.split()))
            return f"@{clean_ns}_attributes"

        @property
        def attr_types(self) -> Iterator[str]:
            """Yields the attr types for this element."""
            yield DataType.ANY_TYPE.prefixed(self.xs_prefix)

#### `is_property` `property`

Specify it is qualified to be a class property.

#### `raw_namespace` `property`

The element explicit namespace.

#### `real_name` `property`

Return the real name for this element.

#### `attr_types` `property`

Yields the attr types for this element.

#### `__post_init__()`

Post initialization validations.

Source code in `xsdata/models/xsd.py`

    132
    133
    134

    def __post_init__(self):
        """Post initialization validations."""
        self.namespace = " ".join(unique_sequence(self.namespace.split()))

### `Assertion` `dataclass`

Bases: `AnnotationBase`

XSD Assertion model representation.

Source code in `xsdata/models/xsd.py`

    158
    159
    160
    161
    162

    @dataclass
    class Assertion(AnnotationBase):
        """XSD Assertion model representation."""

        test: str | None = attribute()

### `SimpleType` `dataclass`

Bases: `AnnotationBase`

XSD SimpleType model representation.

Source code in `xsdata/models/xsd.py`

    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207

    @dataclass
    class SimpleType(AnnotationBase):
        """XSD SimpleType model representation."""

        name: str | None = attribute()
        restriction: Optional["Restriction"] = element()
        list: Optional["List"] = element()
        union: Optional["Union"] = element()

        @property
        def is_property(self) -> bool:
            """Specify it is qualified to be a class property."""
            return True

        @property
        def is_enumeration(self) -> bool:
            """Return whether it is an enumeration restriction."""
            return self.restriction is not None and len(self.restriction.enumerations) > 0

        @property
        def real_name(self) -> str:
            """Return the real name for this element."""
            if self.name:
                return self.name
            return DEFAULT_ATTR_NAME

        @property
        def attr_types(self) -> Iterator[str]:
            """Return the attr types for this element."""
            if not self.is_enumeration and self.restriction:
                yield from self.restriction.attr_types
            elif self.list:
                yield from self.list.attr_types
            elif self.union:
                yield from self.union.bases

        def get_restrictions(self) -> dict[str, Anything]:
            """Return the restrictions dictionary of this element."""
            if self.restriction:
                return self.restriction.get_restrictions()
            if self.list:
                return self.list.get_restrictions()
            return {}

#### `is_property` `property`

Specify it is qualified to be a class property.

#### `is_enumeration` `property`

Return whether it is an enumeration restriction.

#### `real_name` `property`

Return the real name for this element.

#### `attr_types` `property`

Return the attr types for this element.

#### `get_restrictions()`

Return the restrictions dictionary of this element.

Source code in `xsdata/models/xsd.py`

    201
    202
    203
    204
    205
    206
    207

    def get_restrictions(self) -> dict[str, Anything]:
        """Return the restrictions dictionary of this element."""
        if self.restriction:
            return self.restriction.get_restrictions()
        if self.list:
            return self.list.get_restrictions()
        return {}

### `List` `dataclass`

Bases: `AnnotationBase`

XSD List model representation.

Source code in `xsdata/models/xsd.py`

    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235

    @dataclass
    class List(AnnotationBase):
        """XSD List model representation."""

        simple_type: SimpleType | None = element(name="simpleType")
        item_type: str = attribute(name="itemType", default="")

        @property
        def is_property(self) -> bool:
            """Specify it is qualified to be a class property."""
            return True

        @property
        def real_name(self) -> str:
            """Return the real name for this element."""
            return DEFAULT_ATTR_NAME

        @property
        def attr_types(self) -> Iterator[str]:
            """Return the attr types for this element."""
            if self.item_type:
                yield self.item_type

        def get_restrictions(self) -> dict[str, Anything]:
            """Return the restrictions dictionary of this element."""
            return {"tokens": True}

#### `is_property` `property`

Specify it is qualified to be a class property.

#### `real_name` `property`

Return the real name for this element.

#### `attr_types` `property`

Return the attr types for this element.

#### `get_restrictions()`

Return the restrictions dictionary of this element.

Source code in `xsdata/models/xsd.py`

    233
    234
    235

    def get_restrictions(self) -> dict[str, Anything]:
        """Return the restrictions dictionary of this element."""
        return {"tokens": True}

### `Union` `dataclass`

Bases: `AnnotationBase`

XSD Union model representation.

Source code in `xsdata/models/xsd.py`

    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275

    @dataclass
    class Union(AnnotationBase):
        """XSD Union model representation."""

        member_types: str | None = attribute(name="memberTypes")
        simple_types: list[SimpleType] = array_element(name="simpleType")

        @property
        def bases(self) -> Iterator[str]:
            """Return an iterator of all the base types."""
            if self.member_types:
                yield from self.member_types.split()

        @property
        def is_property(self) -> bool:
            """Specify it is qualified to be a class property."""
            return True

        @property
        def real_name(self) -> str:
            """Return the real name for this element."""
            return DEFAULT_ATTR_NAME

        @property
        def attr_types(self) -> Iterator[str]:
            """Return the attr types for this element."""
            for simple_type in self.simple_types:
                yield from simple_type.attr_types

            if self.member_types:
                yield from self.member_types.split()

        def get_restrictions(self) -> dict[str, Anything]:
            """Return the restrictions dictionary of this element."""
            restrictions = {}
            for simple_type in self.simple_types:
                restrictions.update(simple_type.get_restrictions())
            return restrictions

#### `bases` `property`

Return an iterator of all the base types.

#### `is_property` `property`

Specify it is qualified to be a class property.

#### `real_name` `property`

Return the real name for this element.

#### `attr_types` `property`

Return the attr types for this element.

#### `get_restrictions()`

Return the restrictions dictionary of this element.

Source code in `xsdata/models/xsd.py`

    270
    271
    272
    273
    274
    275

    def get_restrictions(self) -> dict[str, Anything]:
        """Return the restrictions dictionary of this element."""
        restrictions = {}
        for simple_type in self.simple_types:
            restrictions.update(simple_type.get_restrictions())
        return restrictions

### `Attribute` `dataclass`

Bases: `AnnotationBase`

XSD Attribute model representation.

Source code in `xsdata/models/xsd.py`

    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333

    @dataclass
    class Attribute(AnnotationBase):
        """XSD Attribute model representation."""

        default: str | None = attribute()
        fixed: str | None = attribute()
        form: FormType | None = attribute()
        name: str | None = attribute()
        ref: str | None = attribute()
        type: str | None = attribute()
        target_namespace: str | None = attribute(name="targetNamespace")
        simple_type: SimpleType | None = element(name="simpleType")
        use: UseType | None = attribute(default=UseType.OPTIONAL)

        @property
        def bases(self) -> Iterator[str]:
            """Return an iterator of all the base types."""
            if self.type:
                yield self.type
            elif not self.has_children:
                yield DataType.STRING.prefixed(self.xs_prefix)

        @property
        def is_property(self) -> bool:
            """Specify it is qualified to be a class property."""
            return True

        @property
        def attr_types(self) -> Iterator[str]:
            """Return the attr types for this element."""
            if self.simple_type:
                yield from self.simple_type.attr_types
            elif self.type:
                yield self.type
            elif self.ref:
                yield self.ref

        @property
        def default_type(self) -> str:
            """Returned the inferred default type qname."""
            datatype = DataType.STRING if self.fixed else DataType.ANY_SIMPLE_TYPE
            return datatype.prefixed(self.xs_prefix)

        def get_restrictions(self) -> dict[str, Anything]:
            """Return the restrictions dictionary of this element."""
            if self.use == UseType.REQUIRED:
                restrictions = {"min_occurs": 1, "max_occurs": 1}
            elif self.use == UseType.PROHIBITED:
                restrictions = {"max_occurs": 0, "min_occurs": 0}
            else:
                restrictions = {"max_occurs": 1, "min_occurs": 0}

            if self.simple_type:
                restrictions.update(self.simple_type.get_restrictions())

            return restrictions

#### `bases` `property`

Return an iterator of all the base types.

#### `is_property` `property`

Specify it is qualified to be a class property.

#### `attr_types` `property`

Return the attr types for this element.

#### `default_type` `property`

Returned the inferred default type qname.

#### `get_restrictions()`

Return the restrictions dictionary of this element.

Source code in `xsdata/models/xsd.py`

    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333

    def get_restrictions(self) -> dict[str, Anything]:
        """Return the restrictions dictionary of this element."""
        if self.use == UseType.REQUIRED:
            restrictions = {"min_occurs": 1, "max_occurs": 1}
        elif self.use == UseType.PROHIBITED:
            restrictions = {"max_occurs": 0, "min_occurs": 0}
        else:
            restrictions = {"max_occurs": 1, "min_occurs": 0}

        if self.simple_type:
            restrictions.update(self.simple_type.get_restrictions())

        return restrictions

### `AttributeGroup` `dataclass`

Bases: `AnnotationBase`

XSD AttributeGroup model representation.

Source code in `xsdata/models/xsd.py`

    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354

    @dataclass
    class AttributeGroup(AnnotationBase):
        """XSD AttributeGroup model representation."""

        ref: str = attribute(default="")
        name: str | None = attribute()
        attributes: list[Attribute] = array_element(name="attribute")
        attribute_groups: list["AttributeGroup"] = array_element(name="attributeGroup")

        @property
        def is_property(self) -> bool:
            """Specify it is qualified to be a class property."""
            return True

        @property
        def attr_types(self) -> Iterator[str]:
            """Return the attr types for this element."""
            if self.ref:
                yield self.ref

#### `is_property` `property`

Specify it is qualified to be a class property.

#### `attr_types` `property`

Return the attr types for this element.

### `Any` `dataclass`

Bases: `AnnotationBase`

XSD Any model representation.

Source code in `xsdata/models/xsd.py`

    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402

    @dataclass
    class Any(AnnotationBase):
        """XSD Any model representation."""

        namespace: str = attribute(default="##any")
        min_occurs: int = attribute(default=1, name="minOccurs")
        max_occurs: str | int = attribute(default=1, name="maxOccurs")
        process_contents: ProcessType = attribute(
            default=ProcessType.STRICT, name="processContents"
        )

        def __post_init__(self):
            """Post initialization validations."""
            self.namespace = " ".join(unique_sequence(self.namespace.split()))
            self.max_occurs = validate_max_occurs(self.min_occurs, self.max_occurs)

        @property
        def is_property(self) -> bool:
            """Specify it is qualified to be a class property."""
            return True

        @property
        def real_name(self) -> str:
            """Return the real name for this element."""
            clean_ns = "_".join(map(clean_uri, self.namespace.split()))
            return f"@{clean_ns}_element"

        @property
        def raw_namespace(self) -> str | None:
            """The element explicit namespace."""
            return self.namespace

        @property
        def attr_types(self) -> Iterator[str]:
            """Return the attr types for this element."""
            yield DataType.ANY_TYPE.prefixed(self.xs_prefix)

        def get_restrictions(self) -> dict[str, Anything]:
            """Return the restrictions dictionary of this element."""
            max_occurs = sys.maxsize if self.max_occurs == "unbounded" else self.max_occurs

            return {
                "min_occurs": 0,
                "max_occurs": max_occurs,
                "process_contents": self.process_contents.value,
            }

#### `is_property` `property`

Specify it is qualified to be a class property.

#### `real_name` `property`

Return the real name for this element.

#### `raw_namespace` `property`

The element explicit namespace.

#### `attr_types` `property`

Return the attr types for this element.

#### `__post_init__()`

Post initialization validations.

Source code in `xsdata/models/xsd.py`

    368
    369
    370
    371

    def __post_init__(self):
        """Post initialization validations."""
        self.namespace = " ".join(unique_sequence(self.namespace.split()))
        self.max_occurs = validate_max_occurs(self.min_occurs, self.max_occurs)

#### `get_restrictions()`

Return the restrictions dictionary of this element.

Source code in `xsdata/models/xsd.py`

    394
    395
    396
    397
    398
    399
    400
    401
    402

    def get_restrictions(self) -> dict[str, Anything]:
        """Return the restrictions dictionary of this element."""
        max_occurs = sys.maxsize if self.max_occurs == "unbounded" else self.max_occurs

        return {
            "min_occurs": 0,
            "max_occurs": max_occurs,
            "process_contents": self.process_contents.value,
        }

### `All` `dataclass`

Bases: `AnnotationBase`

XSD All model representation.

Source code in `xsdata/models/xsd.py`

    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423

    @dataclass
    class All(AnnotationBase):
        """XSD All model representation."""

        min_occurs: int = attribute(default=1, name="minOccurs")
        max_occurs: str | int = attribute(default=1, name="maxOccurs")
        any: list[Any] = array_element(name="any")
        elements: list["Element"] = array_element(name="element")
        groups: list["Group"] = array_element(name="group")

        def __post_init__(self):
            """Post initialization validations."""
            self.max_occurs = validate_max_occurs(self.min_occurs, self.max_occurs)

        def get_restrictions(self) -> dict[str, Anything]:
            """Return the restrictions dictionary of this element."""
            return {
                "path": [("a", id(self), self.min_occurs, self.max_occurs)],
            }

#### `__post_init__()`

Post initialization validations.

Source code in `xsdata/models/xsd.py`

    415
    416
    417

    def __post_init__(self):
        """Post initialization validations."""
        self.max_occurs = validate_max_occurs(self.min_occurs, self.max_occurs)

#### `get_restrictions()`

Return the restrictions dictionary of this element.

Source code in `xsdata/models/xsd.py`

    419
    420
    421
    422
    423

    def get_restrictions(self) -> dict[str, Anything]:
        """Return the restrictions dictionary of this element."""
        return {
            "path": [("a", id(self), self.min_occurs, self.max_occurs)],
        }

### `Sequence` `dataclass`

Bases: `AnnotationBase`

XSD Sequence model representation.

Source code in `xsdata/models/xsd.py`

    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446

    @dataclass
    class Sequence(AnnotationBase):
        """XSD Sequence model representation."""

        min_occurs: int = attribute(default=1, name="minOccurs")
        max_occurs: str | int = attribute(default=1, name="maxOccurs")
        elements: list["Element"] = array_element(name="element")
        groups: list["Group"] = array_element(name="group")
        choices: list["Choice"] = array_element(name="choice")
        sequences: list["Sequence"] = array_element(name="sequence")
        any: list["Any"] = array_element()

        def __post_init__(self):
            """Post initialization validations."""
            self.max_occurs = validate_max_occurs(self.min_occurs, self.max_occurs)

        def get_restrictions(self) -> dict[str, Anything]:
            """Return the restrictions dictionary of this element."""
            return {
                "path": [("s", id(self), self.min_occurs, self.max_occurs)],
            }

#### `__post_init__()`

Post initialization validations.

Source code in `xsdata/models/xsd.py`

    438
    439
    440

    def __post_init__(self):
        """Post initialization validations."""
        self.max_occurs = validate_max_occurs(self.min_occurs, self.max_occurs)

#### `get_restrictions()`

Return the restrictions dictionary of this element.

Source code in `xsdata/models/xsd.py`

    442
    443
    444
    445
    446

    def get_restrictions(self) -> dict[str, Anything]:
        """Return the restrictions dictionary of this element."""
        return {
            "path": [("s", id(self), self.min_occurs, self.max_occurs)],
        }

### `Choice` `dataclass`

Bases: `AnnotationBase`

XSD Choice model representation.

Source code in `xsdata/models/xsd.py`

    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469

    @dataclass
    class Choice(AnnotationBase):
        """XSD Choice model representation."""

        min_occurs: int = attribute(default=1, name="minOccurs")
        max_occurs: str | int = attribute(default=1, name="maxOccurs")
        elements: list["Element"] = array_element(name="element")
        groups: list["Group"] = array_element(name="group")
        choices: list["Choice"] = array_element(name="choice")
        sequences: list[Sequence] = array_element(name="sequence")
        any: list["Any"] = array_element()

        def __post_init__(self):
            """Post initialization validations."""
            self.max_occurs = validate_max_occurs(self.min_occurs, self.max_occurs)

        def get_restrictions(self) -> dict[str, Anything]:
            """Return the restrictions dictionary of this element."""
            return {
                "path": [("c", id(self), self.min_occurs, self.max_occurs)],
            }

#### `__post_init__()`

Post initialization validations.

Source code in `xsdata/models/xsd.py`

    461
    462
    463

    def __post_init__(self):
        """Post initialization validations."""
        self.max_occurs = validate_max_occurs(self.min_occurs, self.max_occurs)

#### `get_restrictions()`

Return the restrictions dictionary of this element.

Source code in `xsdata/models/xsd.py`

    465
    466
    467
    468
    469

    def get_restrictions(self) -> dict[str, Anything]:
        """Return the restrictions dictionary of this element."""
        return {
            "path": [("c", id(self), self.min_occurs, self.max_occurs)],
        }

### `Group` `dataclass`

Bases: `AnnotationBase`

XSD Group model representation.

Source code in `xsdata/models/xsd.py`

    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503

    @dataclass
    class Group(AnnotationBase):
        """XSD Group model representation."""

        name: str | None = attribute()
        ref: str = attribute(default="")
        min_occurs: int = attribute(default=1, name="minOccurs")
        max_occurs: str | int = attribute(default=1, name="maxOccurs")
        all: All | None = element()
        choice: Choice | None = element()
        sequence: Sequence | None = element()

        def __post_init__(self):
            """Post initialization validations."""
            self.max_occurs = validate_max_occurs(self.min_occurs, self.max_occurs)

        @property
        def is_property(self) -> bool:
            """Specify it is qualified to be a class property."""
            return True

        @property
        def attr_types(self) -> Iterator[str]:
            """Return the attr types for this element."""
            if self.ref:
                yield self.ref

        def get_restrictions(self) -> dict[str, Anything]:
            """Return the restrictions dictionary of this element."""
            return {
                "path": [("g", id(self), self.min_occurs, self.max_occurs)],
            }

#### `is_property` `property`

Specify it is qualified to be a class property.

#### `attr_types` `property`

Return the attr types for this element.

#### `__post_init__()`

Post initialization validations.

Source code in `xsdata/models/xsd.py`

    484
    485
    486

    def __post_init__(self):
        """Post initialization validations."""
        self.max_occurs = validate_max_occurs(self.min_occurs, self.max_occurs)

#### `get_restrictions()`

Return the restrictions dictionary of this element.

Source code in `xsdata/models/xsd.py`

    499
    500
    501
    502
    503

    def get_restrictions(self) -> dict[str, Anything]:
        """Return the restrictions dictionary of this element."""
        return {
            "path": [("g", id(self), self.min_occurs, self.max_occurs)],
        }

### `OpenContent` `dataclass`

Bases: `AnnotationBase`

XSD OpenContent model representation.

Source code in `xsdata/models/xsd.py`

    506
    507
    508
    509
    510
    511
    512

    @dataclass
    class OpenContent(AnnotationBase):
        """XSD OpenContent model representation."""

        applies_to_empty: bool = attribute(default=False, name="appliesToEmpty")
        mode: Mode = attribute(default=Mode.INTERLEAVE)
        any: Any = element()

### `DefaultOpenContent` `dataclass`

Bases: `OpenContent`

XSD DefaultOpenContent model representation.

Source code in `xsdata/models/xsd.py`

    515
    516
    517

    @dataclass
    class DefaultOpenContent(OpenContent):
        """XSD DefaultOpenContent model representation."""

### `Extension` `dataclass`

Bases: `AnnotationBase`

XSD Extension model representation.

Source code in `xsdata/models/xsd.py`

    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539

    @dataclass
    class Extension(AnnotationBase):
        """XSD Extension model representation."""

        base: str | None = attribute()
        group: Group | None = element()
        all: All | None = element()
        choice: Choice | None = element()
        sequence: Sequence | None = element()
        any_attribute: AnyAttribute | None = element(name="anyAttribute")
        open_content: OpenContent | None = element(name="openContent")
        attributes: list[Attribute] = array_element(name="attribute")
        attribute_groups: list[AttributeGroup] = array_element(name="attributeGroup")
        assertions: list[Assertion] = array_element(name="assert")

        @property
        def bases(self) -> Iterator[str]:
            """Return an iterator of all the base types."""
            if self.base:
                yield self.base

#### `bases` `property`

Return an iterator of all the base types.

### `Enumeration` `dataclass`

Bases: `AnnotationBase`

XSD Enumeration model representation.

Source code in `xsdata/models/xsd.py`

    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566

    @dataclass
    class Enumeration(AnnotationBase):
        """XSD Enumeration model representation."""

        value: str = attribute()

        @property
        def is_property(self) -> bool:
            """Specify it is qualified to be a class property."""
            return True

        @property
        def real_name(self) -> str:
            """Return the enumeration value as its name."""
            return self.value

        @property
        def default(self) -> str:
            """Return the enumeration value as its default value."""
            return self.value

        @property
        def is_fixed(self) -> bool:
            """Specify this element has a fixed value."""
            return True

#### `is_property` `property`

Specify it is qualified to be a class property.

#### `real_name` `property`

Return the enumeration value as its name.

#### `default` `property`

Return the enumeration value as its default value.

#### `is_fixed` `property`

Specify this element has a fixed value.

### `FractionDigits` `dataclass`

Bases: `AnnotationBase`

XSD FractionDigits model representation.

Source code in `xsdata/models/xsd.py`

    569
    570
    571
    572
    573

    @dataclass
    class FractionDigits(AnnotationBase):
        """XSD FractionDigits model representation."""

        value: int = attribute()

### `Length` `dataclass`

Bases: `AnnotationBase`

XSD Length model representation.

Source code in `xsdata/models/xsd.py`

    576
    577
    578
    579
    580

    @dataclass
    class Length(AnnotationBase):
        """XSD Length model representation."""

        value: int = attribute()

### `MaxExclusive` `dataclass`

Bases: `AnnotationBase`

XSD MaxExclusive model representation.

Source code in `xsdata/models/xsd.py`

    583
    584
    585
    586
    587

    @dataclass
    class MaxExclusive(AnnotationBase):
        """XSD MaxExclusive model representation."""

        value: str = attribute()

### `MaxInclusive` `dataclass`

Bases: `AnnotationBase`

XSD MaxInclusive model representation.

Source code in `xsdata/models/xsd.py`

    590
    591
    592
    593
    594

    @dataclass
    class MaxInclusive(AnnotationBase):
        """XSD MaxInclusive model representation."""

        value: str = attribute()

### `MaxLength` `dataclass`

Bases: `AnnotationBase`

XSD MaxLength model representation.

Source code in `xsdata/models/xsd.py`

    597
    598
    599
    600
    601

    @dataclass
    class MaxLength(AnnotationBase):
        """XSD MaxLength model representation."""

        value: int = attribute()

### `MinExclusive` `dataclass`

Bases: `AnnotationBase`

XSD MinExclusive model representation.

Source code in `xsdata/models/xsd.py`

    604
    605
    606
    607
    608

    @dataclass
    class MinExclusive(AnnotationBase):
        """XSD MinExclusive model representation."""

        value: str = attribute()

### `MinInclusive` `dataclass`

Bases: `AnnotationBase`

XSD MinInclusive model representation.

Source code in `xsdata/models/xsd.py`

    611
    612
    613
    614
    615

    @dataclass
    class MinInclusive(AnnotationBase):
        """XSD MinInclusive model representation."""

        value: str = attribute()

### `MinLength` `dataclass`

Bases: `AnnotationBase`

XSD MinLength model representation.

Source code in `xsdata/models/xsd.py`

    618
    619
    620
    621
    622

    @dataclass
    class MinLength(AnnotationBase):
        """XSD MinLength model representation."""

        value: int = attribute()

### `Pattern` `dataclass`

Bases: `AnnotationBase`

XSD Pattern model representation.

Source code in `xsdata/models/xsd.py`

    625
    626
    627
    628
    629

    @dataclass
    class Pattern(AnnotationBase):
        """XSD Pattern model representation."""

        value: str = attribute()

### `TotalDigits` `dataclass`

Bases: `AnnotationBase`

XSD TotalDigits model representation.

Source code in `xsdata/models/xsd.py`

    632
    633
    634
    635
    636

    @dataclass
    class TotalDigits(AnnotationBase):
        """XSD TotalDigits model representation."""

        value: int = attribute()

### `WhiteSpace` `dataclass`

Bases: `AnnotationBase`

XSD WhiteSpace model representation.

Source code in `xsdata/models/xsd.py`

    639
    640
    641
    642
    643

    @dataclass
    class WhiteSpace(AnnotationBase):
        """XSD WhiteSpace model representation."""

        value: str = attribute()

### `ExplicitTimezone` `dataclass`

Bases: `AnnotationBase`

XSD ExplicitTimezone model representation.

Source code in `xsdata/models/xsd.py`

    646
    647
    648
    649
    650
    651

    @dataclass
    class ExplicitTimezone(AnnotationBase):
        """XSD ExplicitTimezone model representation."""

        value: str = attribute()
        fixed: bool = attribute(default=False)

### `Restriction` `dataclass`

Bases: `AnnotationBase`

XSD Restriction model representation.

Source code in `xsdata/models/xsd.py`

    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    708
    709
    710
    711
    712
    713
    714
    715
    716
    717
    718
    719
    720
    721
    722
    723
    724
    725
    726
    727
    728
    729
    730
    731
    732
    733
    734
    735

    @dataclass
    class Restriction(AnnotationBase):
        """XSD Restriction model representation."""

        base: str | None = attribute()
        group: Group | None = element()
        all: All | None = element()
        choice: Choice | None = element()
        sequence: Sequence | None = element()
        open_content: OpenContent | None = element(name="openContent")
        attributes: list[Attribute] = array_element(name="attribute")
        attribute_groups: list[AttributeGroup] = array_element(name="attributeGroup")
        enumerations: list[Enumeration] = array_element(name="enumeration")
        asserts: list[Assertion] = array_element(name="assert")
        assertions: list[Assertion] = array_element(name="assertion")
        any_element: list[object] = array_any_element()
        min_exclusive: MinExclusive | None = element(name="minExclusive")
        min_inclusive: MinInclusive | None = element(name="minInclusive")
        min_length: MinLength | None = element(name="minLength")
        max_exclusive: MaxExclusive | None = element(name="maxExclusive")
        max_inclusive: MaxInclusive | None = element(name="maxInclusive")
        max_length: MaxLength | None = element(name="maxLength")
        total_digits: TotalDigits | None = element(name="totalDigits")
        fraction_digits: FractionDigits | None = element(name="fractionDigits")
        length: Length | None = element()
        white_space: WhiteSpace | None = element(name="whiteSpace")
        patterns: list[Pattern] = array_element(name="pattern")
        explicit_timezone: ExplicitTimezone | None = element(name="explicitTimezone")
        simple_type: SimpleType | None = element(name="simpleType")

        @property
        def attr_types(self) -> Iterator[str]:
            """Return the attr types for this element."""
            if self.simple_type:
                yield from self.simple_type.attr_types
            elif self.base and not self.enumerations:
                yield self.base

        @property
        def real_name(self) -> str:
            """Return the real name for this element."""
            return DEFAULT_ATTR_NAME

        @property
        def bases(self) -> Iterator[str]:
            """Return an iterator of all the base types."""
            if self.base:
                yield self.base

        def get_restrictions(self) -> dict[str, Anything]:
            """Return the restrictions dictionary of this element."""
            restrictions = {}
            if self.simple_type:
                restrictions.update(self.simple_type.get_restrictions())

            keys = (
                "min_exclusive",
                "min_inclusive",
                "min_length",
                "max_exclusive",
                "max_inclusive",
                "max_length",
                "total_digits",
                "fraction_digits",
                "length",
                "white_space",
                "explicit_timezone",
            )
            restrictions.update(
                {
                    key: getattr(self, key).value
                    for key in keys
                    if getattr(self, key) is not None
                }
            )

            if self.patterns:
                restrictions["pattern"] = "|".join(
                    pattern.value for pattern in self.patterns
                )

            return restrictions

#### `attr_types` `property`

Return the attr types for this element.

#### `real_name` `property`

Return the real name for this element.

#### `bases` `property`

Return an iterator of all the base types.

#### `get_restrictions()`

Return the restrictions dictionary of this element.

Source code in `xsdata/models/xsd.py`

    703
    704
    705
    706
    707
    708
    709
    710
    711
    712
    713
    714
    715
    716
    717
    718
    719
    720
    721
    722
    723
    724
    725
    726
    727
    728
    729
    730
    731
    732
    733
    734
    735

    def get_restrictions(self) -> dict[str, Anything]:
        """Return the restrictions dictionary of this element."""
        restrictions = {}
        if self.simple_type:
            restrictions.update(self.simple_type.get_restrictions())

        keys = (
            "min_exclusive",
            "min_inclusive",
            "min_length",
            "max_exclusive",
            "max_inclusive",
            "max_length",
            "total_digits",
            "fraction_digits",
            "length",
            "white_space",
            "explicit_timezone",
        )
        restrictions.update(
            {
                key: getattr(self, key).value
                for key in keys
                if getattr(self, key) is not None
            }
        )

        if self.patterns:
            restrictions["pattern"] = "|".join(
                pattern.value for pattern in self.patterns
            )

        return restrictions

### `SimpleContent` `dataclass`

Bases: `AnnotationBase`

XSD SimpleContent model representation.

Source code in `xsdata/models/xsd.py`

    738
    739
    740
    741
    742
    743

    @dataclass
    class SimpleContent(AnnotationBase):
        """XSD SimpleContent model representation."""

        restriction: Restriction | None = element()
        extension: Extension | None = element()

### `ComplexContent` `dataclass`

Bases: `SimpleContent`

XSD ComplexContent model representation.

Source code in `xsdata/models/xsd.py`

    746
    747
    748
    749
    750

    @dataclass
    class ComplexContent(SimpleContent):
        """XSD ComplexContent model representation."""

        mixed: bool = attribute(default=False)

### `ComplexType` `dataclass`

Bases: `AnnotationBase`

XSD ComplexType model representation.

Source code in `xsdata/models/xsd.py`

    753
    754
    755
    756
    757
    758
    759
    760
    761
    762
    763
    764
    765
    766
    767
    768
    769
    770
    771
    772
    773
    774
    775
    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    786

    @dataclass
    class ComplexType(AnnotationBase):
        """XSD ComplexType model representation."""

        name: str | None = attribute()
        block: str | None = attribute()
        final: str | None = attribute()
        simple_content: SimpleContent | None = element(name="simpleContent")
        complex_content: ComplexContent | None = element(name="complexContent")
        group: Group | None = element()
        all: All | None = element()
        choice: Choice | None = element()
        sequence: Sequence | None = element()
        any_attribute: AnyAttribute | None = element(name="anyAttribute")
        open_content: OpenContent | None = element(name="openContent")
        attributes: list[Attribute] = array_element(name="attribute")
        attribute_groups: list[AttributeGroup] = array_element(name="attributeGroup")
        assertion: list[Assertion] = array_element(name="assert")
        abstract: bool = attribute(default=False)
        mixed: bool = attribute(default=False)
        default_attributes_apply: bool = attribute(
            default=True, name="defaultAttributesApply"
        )

        @property
        def is_mixed(self) -> bool:
            """Return whether this element accepts mixed content value."""
            if self.mixed:
                return True

            if self.complex_content:
                return self.complex_content.mixed

            return False

#### `is_mixed` `property`

Return whether this element accepts mixed content value.

### `Field` `dataclass`

Bases: `AnnotationBase`

XSD Field model representation.

Source code in `xsdata/models/xsd.py`

    789
    790
    791
    792
    793

    @dataclass
    class Field(AnnotationBase):
        """XSD Field model representation."""

        xpath: str | None = attribute()

### `Selector` `dataclass`

Bases: `Field`

XSD Selector model representation.

Source code in `xsdata/models/xsd.py`

    796
    797
    798

    @dataclass
    class Selector(Field):
        """XSD Selector model representation."""

### `Unique` `dataclass`

Bases: `AnnotationBase`

XSD Unique model representation.

Source code in `xsdata/models/xsd.py`

    801
    802
    803
    804
    805
    806
    807
    808

    @dataclass
    class Unique(AnnotationBase):
        """XSD Unique model representation."""

        name: str | None = attribute()
        ref: str | None = attribute()
        selector: Selector | None = element()
        fields: list[Field] = array_element(name="field")

### `Key` `dataclass`

Bases: `AnnotationBase`

XSD Key model representation.

Source code in `xsdata/models/xsd.py`

    811
    812
    813
    814
    815
    816
    817
    818

    @dataclass
    class Key(AnnotationBase):
        """XSD Key model representation."""

        name: str | None = attribute()
        ref: str | None = attribute()
        selector: Selector | None = element()
        fields: list[Selector] = array_element(name="field")

### `Keyref` `dataclass`

Bases: `AnnotationBase`

XSD Keyref model representation.

Source code in `xsdata/models/xsd.py`

    821
    822
    823
    824
    825
    826
    827
    828
    829

    @dataclass
    class Keyref(AnnotationBase):
        """XSD Keyref model representation."""

        name: str | None = attribute()
        ref: str | None = attribute()
        refer: str | None = attribute()
        selector: Selector | None = element()
        fields: list[Selector] = array_element(name="field")

### `Alternative` `dataclass`

Bases: `AnnotationBase`

XSD Alternative model representation.

Source code in `xsdata/models/xsd.py`

    832
    833
    834
    835
    836
    837
    838
    839
    840
    841
    842
    843
    844
    845
    846
    847
    848
    849
    850
    851
    852
    853
    854
    855
    856
    857
    858
    859
    860

    @dataclass
    class Alternative(AnnotationBase):
        """XSD Alternative model representation."""

        type: str | None = attribute()
        test: str | None = attribute()
        simple_type: SimpleType | None = element(name="simpleType")
        complex_type: ComplexType | None = element(name="complexType")

        @property
        def real_name(self) -> str:
            """Return the real name for this element."""
            if self.test:
                return text.snake_case(self.test)
            if self.id:
                return self.id
            return DEFAULT_ATTR_NAME

        @property
        def bases(self) -> Iterator[str]:
            """Return an iterator of all the base types."""
            if self.type:
                yield self.type

        def get_restrictions(self) -> dict[str, Anything]:
            """Return the restrictions dictionary of this element."""
            return {
                "path": [("alt", id(self), 0, 1)],
            }

#### `real_name` `property`

Return the real name for this element.

#### `bases` `property`

Return an iterator of all the base types.

#### `get_restrictions()`

Return the restrictions dictionary of this element.

Source code in `xsdata/models/xsd.py`

    856
    857
    858
    859
    860

    def get_restrictions(self) -> dict[str, Anything]:
        """Return the restrictions dictionary of this element."""
        return {
            "path": [("alt", id(self), 0, 1)],
        }

### `Element` `dataclass`

Bases: `AnnotationBase`

XSD Element model representation.

Source code in `xsdata/models/xsd.py`

    863
    864
    865
    866
    867
    868
    869
    870
    871
    872
    873
    874
    875
    876
    877
    878
    879
    880
    881
    882
    883
    884
    885
    886
    887
    888
    889
    890
    891
    892
    893
    894
    895
    896
    897
    898
    899
    900
    901
    902
    903
    904
    905
    906
    907
    908
    909
    910
    911
    912
    913
    914
    915
    916
    917
    918
    919
    920
    921
    922
    923
    924
    925
    926
    927
    928
    929
    930
    931
    932
    933
    934
    935
    936
    937
    938
    939
    940
    941
    942
    943
    944
    945
    946

    @dataclass
    class Element(AnnotationBase):
        """XSD Element model representation."""

        name: str | None = attribute()
        ref: str | None = attribute()
        type: str | None = attribute()
        substitution_group: str | None = attribute(name="substitutionGroup")
        default: str | None = attribute()
        fixed: str | None = attribute()
        form: FormType | None = attribute()
        block: str | None = attribute()
        final: str | None = attribute()
        target_namespace: str | None = attribute(name="targetNamespace")
        simple_type: SimpleType | None = element(name="simpleType")
        complex_type: ComplexType | None = element(name="complexType")
        alternatives: list[Alternative] = array_element(name="alternative")
        uniques: list[Unique] = array_element(name="unique")
        keys: list[Key] = array_element(name="key")
        keyrefs: list[Keyref] = array_element(name="keyref")
        min_occurs: int = attribute(default=1, name="minOccurs")
        max_occurs: str | int = attribute(default=1, name="maxOccurs")
        nillable: bool = attribute(default=False)
        abstract: bool = attribute(default=False)

        def __post_init__(self):
            """Post initialization validations."""
            self.max_occurs = validate_max_occurs(self.min_occurs, self.max_occurs)

        @property
        def bases(self) -> Iterator[str]:
            """Return an iterator of all the base types."""
            if self.type:
                yield self.type
            elif not self.has_children:
                yield DataType.ANY_TYPE.prefixed(self.xs_prefix)

        @property
        def is_property(self) -> bool:
            """Specify it is qualified to be a class property."""
            return True

        @property
        def is_mixed(self) -> bool:
            """Return whether this element accepts mixed content value."""
            return self.complex_type.is_mixed if self.complex_type else False

        @property
        def default_type(self) -> str:
            """Returned the inferred default type qname."""
            datatype = DataType.STRING if self.fixed else DataType.ANY_TYPE
            return datatype.prefixed(self.xs_prefix)

        @property
        def attr_types(self) -> Iterator[str]:
            """Return the attr types for this element."""
            if self.type:
                yield self.type
            elif self.ref:
                yield self.ref
            elif self.simple_type:
                yield from self.simple_type.attr_types

            yield from (alt.type for alt in self.alternatives if alt.type)

        @property
        def substitutions(self) -> list[str]:
            """Return a list of the substitution groups."""
            return self.substitution_group.split() if self.substitution_group else []

        def get_restrictions(self) -> dict[str, Anything]:
            """Return the restrictions dictionary of this element."""
            restrictions = {
                "min_occurs": self.min_occurs,
                "max_occurs": self.max_occurs,
            }

            if self.simple_type:
                restrictions.update(self.simple_type.get_restrictions())

            if self.nillable:
                restrictions.update(nillable=True)

            return restrictions

#### `bases` `property`

Return an iterator of all the base types.

#### `is_property` `property`

Specify it is qualified to be a class property.

#### `is_mixed` `property`

Return whether this element accepts mixed content value.

#### `default_type` `property`

Returned the inferred default type qname.

#### `attr_types` `property`

Return the attr types for this element.

#### `substitutions` `property`

Return a list of the substitution groups.

#### `__post_init__()`

Post initialization validations.

Source code in `xsdata/models/xsd.py`

    888
    889
    890

    def __post_init__(self):
        """Post initialization validations."""
        self.max_occurs = validate_max_occurs(self.min_occurs, self.max_occurs)

#### `get_restrictions()`

Return the restrictions dictionary of this element.

Source code in `xsdata/models/xsd.py`

    933
    934
    935
    936
    937
    938
    939
    940
    941
    942
    943
    944
    945
    946

    def get_restrictions(self) -> dict[str, Anything]:
        """Return the restrictions dictionary of this element."""
        restrictions = {
            "min_occurs": self.min_occurs,
            "max_occurs": self.max_occurs,
        }

        if self.simple_type:
            restrictions.update(self.simple_type.get_restrictions())

        if self.nillable:
            restrictions.update(nillable=True)

        return restrictions

### `Notation` `dataclass`

Bases: `AnnotationBase`

XSD Notation model representation.

Source code in `xsdata/models/xsd.py`

    949
    950
    951
    952
    953
    954
    955

    @dataclass
    class Notation(AnnotationBase):
        """XSD Notation model representation."""

        name: str | None = attribute()
        public: str | None = attribute()
        system: str | None = attribute()

### `Import` `dataclass`

Bases: `AnnotationBase`

XSD Import model representation.

Source code in `xsdata/models/xsd.py`

    958
    959
    960
    961
    962
    963
    964

    @dataclass
    class Import(AnnotationBase):
        """XSD Import model representation."""

        namespace: str | None = attribute()
        schema_location: str | None = attribute(name="schemaLocation")
        location: str | None = field(default=None, metadata={"type": "Ignore"})

### `Include` `dataclass`

Bases: `AnnotationBase`

XSD Include model representation.

Source code in `xsdata/models/xsd.py`

    967
    968
    969
    970
    971
    972

    @dataclass
    class Include(AnnotationBase):
        """XSD Include model representation."""

        schema_location: str | None = attribute(name="schemaLocation")
        location: str | None = field(default=None, metadata={"type": "Ignore"})

### `Redefine` `dataclass`

Bases: `AnnotationBase`

XSD Redefine model representation.

Source code in `xsdata/models/xsd.py`

    975
    976
    977
    978
    979
    980
    981
    982
    983
    984

    @dataclass
    class Redefine(AnnotationBase):
        """XSD Redefine model representation."""

        schema_location: str | None = attribute(name="schemaLocation")
        simple_types: list[SimpleType] = array_element(name="simpleType")
        complex_types: list[ComplexType] = array_element(name="complexType")
        groups: list[Group] = array_element(name="group")
        attribute_groups: list[AttributeGroup] = array_element(name="attributeGroup")
        location: str | None = field(default=None, metadata={"type": "Ignore"})

### `Override` `dataclass`

Bases: `AnnotationBase`

XSD Override model representation.

Source code in `xsdata/models/xsd.py`

    987
    988
    989
    990
    991
    992
    993
    994
    995
    996
    997
    998
    999

    @dataclass
    class Override(AnnotationBase):
        """XSD Override model representation."""

        schema_location: str | None = attribute(name="schemaLocation")
        simple_types: list[SimpleType] = array_element(name="simpleType")
        complex_types: list[ComplexType] = array_element(name="complexType")
        groups: list[Group] = array_element(name="group")
        attribute_groups: list[AttributeGroup] = array_element(name="attributeGroup")
        elements: list[Element] = array_element(name="element")
        attributes: list[Attribute] = array_element(name="attribute")
        notations: list[Notation] = array_element(name="notation")
        location: str | None = field(default=None, metadata={"type": "Ignore"})

### `Schema` `dataclass`

Bases: `AnnotationBase`

XSD Schema model representation.

Source code in `xsdata/models/xsd.py`

    1002
    1003
    1004
    1005
    1006
    1007
    1008
    1009
    1010
    1011
    1012
    1013
    1014
    1015
    1016
    1017
    1018
    1019
    1020
    1021
    1022
    1023
    1024
    1025
    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050

    @dataclass
    class Schema(AnnotationBase):
        """XSD Schema model representation."""

        class Meta:
            """Metadata options."""

            name = "schema"
            namespace = Namespace.XS.uri

        target: str | None = attribute()
        block_default: str | None = attribute(name="blockDefault")
        default_attributes: str | None = attribute(name="defaultAttributes")
        final_default: str | None = attribute(name="finalDefault")
        target_namespace: str | None = attribute(name="targetNamespace")
        version: str | None = attribute()
        xmlns: str | None = attribute()
        element_form_default: FormType = attribute(
            default=FormType.UNQUALIFIED,
            name="elementFormDefault",
        )
        attribute_form_default: FormType = attribute(
            default=FormType.UNQUALIFIED,
            name="attributeFormDefault",
        )
        default_open_content: DefaultOpenContent | None = element(name="defaultOpenContent")
        includes: list[Include] = array_element(name="include")
        imports: list[Import] = array_element(name="import")
        redefines: list[Redefine] = array_element(name="redefine")
        overrides: list[Override] = array_element(name="override")
        annotations: list[Annotation] = array_element(name="annotation")
        simple_types: list[SimpleType] = array_element(name="simpleType")
        complex_types: list[ComplexType] = array_element(name="complexType")
        groups: list[Group] = array_element(name="group")
        attribute_groups: list[AttributeGroup] = array_element(name="attributeGroup")
        elements: list[Element] = array_element(name="element")
        attributes: list[Attribute] = array_element(name="attribute")
        notations: list[Notation] = array_element(name="notation")
        location: str | None = field(default=None, metadata={"type": "Ignore"})

        def included(self) -> Iterator[Import | Include | Redefine | Override]:
            """Yields an iterator of included resources."""
            yield from self.imports

            yield from self.includes

            yield from self.redefines

            yield from self.overrides

#### `Meta`

Metadata options.

Source code in `xsdata/models/xsd.py`

    1006
    1007
    1008
    1009
    1010

    class Meta:
        """Metadata options."""

        name = "schema"
        namespace = Namespace.XS.uri

#### `included()`

Yields an iterator of included resources.

Source code in `xsdata/models/xsd.py`

    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050

    def included(self) -> Iterator[Import | Include | Redefine | Override]:
        """Yields an iterator of included resources."""
        yield from self.imports

        yield from self.includes

        yield from self.redefines

        yield from self.overrides

### `validate_max_occurs(min_occurs, max_occurs)`

Validate max occurs.

Source code in `xsdata/models/xsd.py`

    35
    36
    37
    38
    39
    40
    41
    42

    def validate_max_occurs(min_occurs: int, max_occurs: str | int) -> int:
        """Validate max occurs."""
        if max_occurs == "unbounded":
            max_occurs = sys.maxsize

        assert isinstance(max_occurs, int)

        return max(max_occurs, min_occurs)