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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
@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: Array[object] = array_any_element()

Meta

Metadata options.

Source code in xsdata/models/xsd.py
54
55
56
57
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
@dataclass
class Documentation(ElementBase):
    """XSD MinLength model representation."""

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

    def tostring(self) -> Optional[str]:
        """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
71
72
73
74
75
76
77
78
def tostring(self) -> Optional[str]:
    """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
81
82
83
84
85
86
87
88
89
90
91
92
@dataclass
class Appinfo(ElementBase):
    """XSD Appinfo model representation."""

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

        mixed = True

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

Meta

Metadata options.

Source code in xsdata/models/xsd.py
85
86
87
88
class Meta:
    """Metadata options."""

    mixed = True

Annotation dataclass

Bases: ElementBase

XSD Annotation model representation.

Source code in xsdata/models/xsd.py
 95
 96
 97
 98
 99
100
101
@dataclass
class Annotation(ElementBase):
    """XSD Annotation model representation."""

    app_infos: Array[Appinfo] = array_element(name="appinfo")
    documentations: Array[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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
@dataclass
class AnnotationBase(ElementBase):
    """XSD AnnotationBase model representation."""

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

    @property
    def display_help(self) -> Optional[str]:
        """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: Optional[str] property

Return all annotation documentations concatenated.

AnyAttribute dataclass

Bases: AnnotationBase

XSD AnyAttribute model representation.

Source code in xsdata/models/xsd.py
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
156
@dataclass
class AnyAttribute(AnnotationBase):
    """XSD AnyAttribute model representation."""

    namespace: str = attribute(default="##any")
    process_contents: Optional[ProcessType] = 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) -> Optional[str]:
        """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: bool property

Specify it is qualified to be a class property.

raw_namespace: Optional[str] property

The element explicit namespace.

real_name: str property

Return the real name for this element.

attr_types: Iterator[str] property

Yields the attr types for this element.

__post_init__()

Post initialization validations.

Source code in xsdata/models/xsd.py
133
134
135
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
159
160
161
162
163
@dataclass
class Assertion(AnnotationBase):
    """XSD Assertion model representation."""

    test: Optional[str] = attribute()

SimpleType dataclass

Bases: AnnotationBase

XSD SimpleType model representation.

Source code in xsdata/models/xsd.py
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
208
@dataclass
class SimpleType(AnnotationBase):
    """XSD SimpleType model representation."""

    name: Optional[str] = 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: bool property

Specify it is qualified to be a class property.

is_enumeration: bool property

Return whether it is an enumeration restriction.

real_name: str property

Return the real name for this element.

attr_types: Iterator[str] property

Return the attr types for this element.

get_restrictions()

Return the restrictions dictionary of this element.

Source code in xsdata/models/xsd.py
202
203
204
205
206
207
208
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
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
236
@dataclass
class List(AnnotationBase):
    """XSD List model representation."""

    simple_type: Optional[SimpleType] = 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: bool property

Specify it is qualified to be a class property.

real_name: str property

Return the real name for this element.

attr_types: Iterator[str] property

Return the attr types for this element.

get_restrictions()

Return the restrictions dictionary of this element.

Source code in xsdata/models/xsd.py
234
235
236
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
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
276
@dataclass
class Union(AnnotationBase):
    """XSD Union model representation."""

    member_types: Optional[str] = attribute(name="memberTypes")
    simple_types: Array[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: Iterator[str] property

Return an iterator of all the base types.

is_property: bool property

Specify it is qualified to be a class property.

real_name: str property

Return the real name for this element.

attr_types: Iterator[str] property

Return the attr types for this element.

get_restrictions()

Return the restrictions dictionary of this element.

Source code in xsdata/models/xsd.py
271
272
273
274
275
276
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
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
334
@dataclass
class Attribute(AnnotationBase):
    """XSD Attribute model representation."""

    default: Optional[str] = attribute()
    fixed: Optional[str] = attribute()
    form: Optional[FormType] = attribute()
    name: Optional[str] = attribute()
    ref: Optional[str] = attribute()
    type: Optional[str] = attribute()
    target_namespace: Optional[str] = attribute(name="targetNamespace")
    simple_type: Optional[SimpleType] = element(name="simpleType")
    use: Optional[UseType] = 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: Iterator[str] property

Return an iterator of all the base types.

is_property: bool property

Specify it is qualified to be a class property.

attr_types: Iterator[str] property

Return the attr types for this element.

default_type: str property

Returned the inferred default type qname.

get_restrictions()

Return the restrictions dictionary of this element.

Source code in xsdata/models/xsd.py
322
323
324
325
326
327
328
329
330
331
332
333
334
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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
@dataclass
class AttributeGroup(AnnotationBase):
    """XSD AttributeGroup model representation."""

    ref: str = attribute(default="")
    name: Optional[str] = attribute()
    attributes: Array[Attribute] = array_element(name="attribute")
    attribute_groups: Array["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: bool property

Specify it is qualified to be a class property.

attr_types: Iterator[str] property

Return the attr types for this element.

Any dataclass

Bases: AnnotationBase

XSD Any model representation.

Source code in xsdata/models/xsd.py
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
403
@dataclass
class Any(AnnotationBase):
    """XSD Any model representation."""

    namespace: str = attribute(default="##any")
    min_occurs: int = attribute(default=1, name="minOccurs")
    max_occurs: UnionType[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) -> Optional[str]:
        """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: bool property

Specify it is qualified to be a class property.

real_name: str property

Return the real name for this element.

raw_namespace: Optional[str] property

The element explicit namespace.

attr_types: Iterator[str] property

Return the attr types for this element.

__post_init__()

Post initialization validations.

Source code in xsdata/models/xsd.py
369
370
371
372
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
395
396
397
398
399
400
401
402
403
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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
@dataclass
class All(AnnotationBase):
    """XSD All model representation."""

    min_occurs: int = attribute(default=1, name="minOccurs")
    max_occurs: UnionType[str, int] = attribute(default=1, name="maxOccurs")
    any: Array[Any] = array_element(name="any")
    elements: Array["Element"] = array_element(name="element")
    groups: Array["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
416
417
418
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
420
421
422
423
424
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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
@dataclass
class Sequence(AnnotationBase):
    """XSD Sequence model representation."""

    min_occurs: int = attribute(default=1, name="minOccurs")
    max_occurs: UnionType[str, int] = attribute(default=1, name="maxOccurs")
    elements: Array["Element"] = array_element(name="element")
    groups: Array["Group"] = array_element(name="group")
    choices: Array["Choice"] = array_element(name="choice")
    sequences: Array["Sequence"] = array_element(name="sequence")
    any: Array["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
439
440
441
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
443
444
445
446
447
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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
@dataclass
class Choice(AnnotationBase):
    """XSD Choice model representation."""

    min_occurs: int = attribute(default=1, name="minOccurs")
    max_occurs: UnionType[str, int] = attribute(default=1, name="maxOccurs")
    elements: Array["Element"] = array_element(name="element")
    groups: Array["Group"] = array_element(name="group")
    choices: Array["Choice"] = array_element(name="choice")
    sequences: Array[Sequence] = array_element(name="sequence")
    any: Array["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
462
463
464
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
466
467
468
469
470
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
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
504
@dataclass
class Group(AnnotationBase):
    """XSD Group model representation."""

    name: Optional[str] = attribute()
    ref: str = attribute(default="")
    min_occurs: int = attribute(default=1, name="minOccurs")
    max_occurs: UnionType[str, int] = attribute(default=1, name="maxOccurs")
    all: Optional[All] = element()
    choice: Optional[Choice] = element()
    sequence: Optional[Sequence] = 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: bool property

Specify it is qualified to be a class property.

attr_types: Iterator[str] property

Return the attr types for this element.

__post_init__()

Post initialization validations.

Source code in xsdata/models/xsd.py
485
486
487
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
500
501
502
503
504
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
507
508
509
510
511
512
513
@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
516
517
518
@dataclass
class DefaultOpenContent(OpenContent):
    """XSD DefaultOpenContent model representation."""

Extension dataclass

Bases: AnnotationBase

XSD Extension model representation.

Source code in xsdata/models/xsd.py
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
@dataclass
class Extension(AnnotationBase):
    """XSD Extension model representation."""

    base: Optional[str] = attribute()
    group: Optional[Group] = element()
    all: Optional[All] = element()
    choice: Optional[Choice] = element()
    sequence: Optional[Sequence] = element()
    any_attribute: Optional[AnyAttribute] = element(name="anyAttribute")
    open_content: Optional[OpenContent] = element(name="openContent")
    attributes: Array[Attribute] = array_element(name="attribute")
    attribute_groups: Array[AttributeGroup] = array_element(name="attributeGroup")
    assertions: Array[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: Iterator[str] property

Return an iterator of all the base types.

Enumeration dataclass

Bases: AnnotationBase

XSD Enumeration model representation.

Source code in xsdata/models/xsd.py
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
@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: bool property

Specify it is qualified to be a class property.

real_name: str property

Return the enumeration value as its name.

default: str property

Return the enumeration value as its default value.

is_fixed: bool property

Specify this element has a fixed value.

FractionDigits dataclass

Bases: AnnotationBase

XSD FractionDigits model representation.

Source code in xsdata/models/xsd.py
570
571
572
573
574
@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
577
578
579
580
581
@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
584
585
586
587
588
@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
591
592
593
594
595
@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
598
599
600
601
602
@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
605
606
607
608
609
@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
612
613
614
615
616
@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
619
620
621
622
623
@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
626
627
628
629
630
@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
633
634
635
636
637
@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
640
641
642
643
644
@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
647
648
649
650
651
652
@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
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
736
@dataclass
class Restriction(AnnotationBase):
    """XSD Restriction model representation."""

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

Return the attr types for this element.

real_name: str property

Return the real name for this element.

bases: Iterator[str] 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
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
736
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
739
740
741
742
743
744
@dataclass
class SimpleContent(AnnotationBase):
    """XSD SimpleContent model representation."""

    restriction: Optional[Restriction] = element()
    extension: Optional[Extension] = element()

ComplexContent dataclass

Bases: SimpleContent

XSD ComplexContent model representation.

Source code in xsdata/models/xsd.py
747
748
749
750
751
@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
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
787
@dataclass
class ComplexType(AnnotationBase):
    """XSD ComplexType model representation."""

    name: Optional[str] = attribute()
    block: Optional[str] = attribute()
    final: Optional[str] = attribute()
    simple_content: Optional[SimpleContent] = element(name="simpleContent")
    complex_content: Optional[ComplexContent] = element(name="complexContent")
    group: Optional[Group] = element()
    all: Optional[All] = element()
    choice: Optional[Choice] = element()
    sequence: Optional[Sequence] = element()
    any_attribute: Optional[AnyAttribute] = element(name="anyAttribute")
    open_content: Optional[OpenContent] = element(name="openContent")
    attributes: Array[Attribute] = array_element(name="attribute")
    attribute_groups: Array[AttributeGroup] = array_element(name="attributeGroup")
    assertion: Array[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: bool property

Return whether this element accepts mixed content value.

Field dataclass

Bases: AnnotationBase

XSD Field model representation.

Source code in xsdata/models/xsd.py
790
791
792
793
794
@dataclass
class Field(AnnotationBase):
    """XSD Field model representation."""

    xpath: Optional[str] = attribute()

Selector dataclass

Bases: Field

XSD Selector model representation.

Source code in xsdata/models/xsd.py
797
798
799
@dataclass
class Selector(Field):
    """XSD Selector model representation."""

Unique dataclass

Bases: AnnotationBase

XSD Unique model representation.

Source code in xsdata/models/xsd.py
802
803
804
805
806
807
808
809
@dataclass
class Unique(AnnotationBase):
    """XSD Unique model representation."""

    name: Optional[str] = attribute()
    ref: Optional[str] = attribute()
    selector: Optional[Selector] = element()
    fields: Array[Field] = array_element(name="field")

Key dataclass

Bases: AnnotationBase

XSD Key model representation.

Source code in xsdata/models/xsd.py
812
813
814
815
816
817
818
819
@dataclass
class Key(AnnotationBase):
    """XSD Key model representation."""

    name: Optional[str] = attribute()
    ref: Optional[str] = attribute()
    selector: Optional[Selector] = element()
    fields: Array[Selector] = array_element(name="field")

Keyref dataclass

Bases: AnnotationBase

XSD Keyref model representation.

Source code in xsdata/models/xsd.py
822
823
824
825
826
827
828
829
830
@dataclass
class Keyref(AnnotationBase):
    """XSD Keyref model representation."""

    name: Optional[str] = attribute()
    ref: Optional[str] = attribute()
    refer: Optional[str] = attribute()
    selector: Optional[Selector] = element()
    fields: Array[Selector] = array_element(name="field")

Alternative dataclass

Bases: AnnotationBase

XSD Alternative model representation.

Source code in xsdata/models/xsd.py
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
861
@dataclass
class Alternative(AnnotationBase):
    """XSD Alternative model representation."""

    type: Optional[str] = attribute()
    test: Optional[str] = attribute()
    simple_type: Optional[SimpleType] = element(name="simpleType")
    complex_type: Optional[ComplexType] = 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: str property

Return the real name for this element.

bases: Iterator[str] 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
857
858
859
860
861
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
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
947
@dataclass
class Element(AnnotationBase):
    """XSD Element model representation."""

    name: Optional[str] = attribute()
    ref: Optional[str] = attribute()
    type: Optional[str] = attribute()
    substitution_group: Optional[str] = attribute(name="substitutionGroup")
    default: Optional[str] = attribute()
    fixed: Optional[str] = attribute()
    form: Optional[FormType] = attribute()
    block: Optional[str] = attribute()
    final: Optional[str] = attribute()
    target_namespace: Optional[str] = attribute(name="targetNamespace")
    simple_type: Optional[SimpleType] = element(name="simpleType")
    complex_type: Optional[ComplexType] = element(name="complexType")
    alternatives: Array[Alternative] = array_element(name="alternative")
    uniques: Array[Unique] = array_element(name="unique")
    keys: Array[Key] = array_element(name="key")
    keyrefs: Array[Keyref] = array_element(name="keyref")
    min_occurs: int = attribute(default=1, name="minOccurs")
    max_occurs: UnionType[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) -> Array[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: Iterator[str] property

Return an iterator of all the base types.

is_property: bool property

Specify it is qualified to be a class property.

is_mixed: bool property

Return whether this element accepts mixed content value.

default_type: str property

Returned the inferred default type qname.

attr_types: Iterator[str] property

Return the attr types for this element.

substitutions: Array[str] property

Return a list of the substitution groups.

__post_init__()

Post initialization validations.

Source code in xsdata/models/xsd.py
889
890
891
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
934
935
936
937
938
939
940
941
942
943
944
945
946
947
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
950
951
952
953
954
955
956
@dataclass
class Notation(AnnotationBase):
    """XSD Notation model representation."""

    name: Optional[str] = attribute()
    public: Optional[str] = attribute()
    system: Optional[str] = attribute()

Import dataclass

Bases: AnnotationBase

XSD Import model representation.

Source code in xsdata/models/xsd.py
959
960
961
962
963
964
965
@dataclass
class Import(AnnotationBase):
    """XSD Import model representation."""

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

Include dataclass

Bases: AnnotationBase

XSD Include model representation.

Source code in xsdata/models/xsd.py
968
969
970
971
972
973
@dataclass
class Include(AnnotationBase):
    """XSD Include model representation."""

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

Redefine dataclass

Bases: AnnotationBase

XSD Redefine model representation.

Source code in xsdata/models/xsd.py
976
977
978
979
980
981
982
983
984
985
@dataclass
class Redefine(AnnotationBase):
    """XSD Redefine model representation."""

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

Override dataclass

Bases: AnnotationBase

XSD Override model representation.

Source code in xsdata/models/xsd.py
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
@dataclass
class Override(AnnotationBase):
    """XSD Override model representation."""

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

Schema dataclass

Bases: AnnotationBase

XSD Schema model representation.

Source code in xsdata/models/xsd.py
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
1051
1052
1053
@dataclass
class Schema(AnnotationBase):
    """XSD Schema model representation."""

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

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

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

    def included(self) -> Iterator[UnionType[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
1007
1008
1009
1010
1011
class Meta:
    """Metadata options."""

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

included()

Yields an iterator of included resources.

Source code in xsdata/models/xsd.py
1045
1046
1047
1048
1049
1050
1051
1052
1053
def included(self) -> Iterator[UnionType[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
36
37
38
39
40
41
42
43
def validate_max_occurs(min_occurs: int, max_occurs: UnionType[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)