import sys
from dataclasses import dataclass
from dataclasses import field
from operator import methodcaller
from typing import Any as Anything
from typing import Dict
from typing import Iterator
from typing import List as Array
from typing import Optional
from typing import Union as UnionType
from xsdata.exceptions import SchemaValueError
from xsdata.formats.dataclass.models.constants import XmlType
from xsdata.formats.dataclass.serializers import XmlSerializer
from xsdata.models.enums import DataType
from xsdata.models.enums import FormType
from xsdata.models.enums import Mode
from xsdata.models.enums import Namespace
from xsdata.models.enums import NamespaceType
from xsdata.models.enums import ProcessType
from xsdata.models.enums import UseType
from xsdata.models.mixins import ElementBase
from xsdata.utils import text
from xsdata.utils.text import collapse_whitespace
[docs]def attribute(default: Anything = None, init: bool = True, **kwargs: str) -> Anything:
kwargs.update(type=XmlType.ATTRIBUTE)
return field(init=init, default=default, metadata=kwargs)
[docs]def element(init: bool = True, **kwargs: str) -> Anything:
kwargs.update(type=XmlType.ELEMENT)
return field(init=init, default=None, metadata=kwargs)
[docs]def array_element(init: bool = True, **kwargs: str) -> Anything:
kwargs.update(type=XmlType.ELEMENT)
return field(init=init, default_factory=list, metadata=kwargs)
[docs]def array_any_element(init: bool = True, **kwargs: str) -> Anything:
kwargs.update(type=XmlType.WILDCARD, namespace=NamespaceType.ANY.value)
return field(init=init, default_factory=list, metadata=kwargs)
[docs]def occurrences(min_value: int, max_value: UnionType[int, str]) -> Dict[str, int]:
max_value = sys.maxsize if max_value == "unbounded" else int(max_value)
return {"min_occurs": min_value, "max_occurs": max_value}
[docs]@dataclass(frozen=True)
class XmlString:
elements: Array[object] = array_any_element()
[docs] def render(self) -> str:
name = self.__class__.__name__
xml = XmlSerializer(pretty_print=True, xml_declaration=False).render(self)
start = xml.find(">") + 1
return xml[start:].replace(f"</{name}>", "").strip()
[docs]@dataclass
class Documentation(ElementBase):
"""
Schema Model.
:param lang: language
:param source: anyURI
:param elements: ({any})*
:param attributes: any attributes with non-schema namespace
"""
lang: Optional[str] = attribute()
source: Optional[str] = attribute()
elements: Array[object] = array_any_element()
attributes: Optional["AnyAttribute"] = element()
[docs] def tostring(self) -> Optional[str]:
return XmlString(self.elements).render() if self.elements else None
[docs]@dataclass
class Appinfo(ElementBase):
"""
Schema Model.
:param lang: language
:param source: anyURI
:param attributes: any attributes with non-schema namespace
"""
source: Optional[str] = attribute()
elements: Array[object] = array_any_element()
any_attribute: Optional["AnyAttribute"] = element(name="anyAttribute")
[docs]@dataclass
class Annotation(ElementBase):
"""
Schema Model.
:param appinfo:
:param documentations:
:param any_attribute: any attributes with non-schema namespace
"""
appinfo: Optional[Appinfo] = element()
documentations: Array[Documentation] = array_element(name="documentation")
any_attribute: Optional["AnyAttribute"] = element(name="anyAttribute")
[docs]@dataclass
class AnnotationBase(ElementBase):
"""
Base Class for elements that can contain annotations.
:param id: ID
:param annotation:
:param any_attribute: any attributes with non-schema namespace
"""
id: Optional[str] = attribute()
annotation: Optional[Annotation] = element()
any_attribute: Optional["AnyAttribute"] = element(name="anyAttribute")
@property
def display_help(self) -> Optional[str]:
if self.annotation and len(self.annotation.documentations) > 0:
to_string = methodcaller("tostring")
return "\n".join(
filter(None, map(to_string, self.annotation.documentations))
)
return None
[docs]@dataclass
class AnyAttribute(AnnotationBase):
"""
Schema Model.
:param namespace: ##any | ##other) | List of anyURI | (##targetNamespace | ##local)
:param process_contents: (lax | skip | strict) : strict
"""
namespace: Optional[str] = attribute(default="##any")
process_contents: Optional[ProcessType] = attribute(name="processContents")
def __post_init__(self):
self.namespace = collapse_whitespace(self.namespace)
@property
def is_attribute(self) -> bool:
return True
@property
def raw_namespace(self) -> Optional[str]:
return self.namespace
@property
def real_name(self) -> str:
if self.namespace is None:
raise SchemaValueError("Wildcards namespace can't be None.")
namespace = (
self.namespace[2:] if self.namespace.startswith("##") else self.namespace
)
return f"{namespace}_attributes"
@property
def real_type(self) -> Optional[str]:
prefix = self.schema_prefix()
suffix = DataType.QMAP.code
return f"{prefix}:{suffix}" if prefix else suffix
[docs]@dataclass
class Assertion(AnnotationBase):
"""
Schema Model.
:param test: an XPath expression
"""
test: Optional[str] = attribute()
[docs]@dataclass
class SimpleType(AnnotationBase):
"""
Schema Model.
:param name: NCName
:param restriction:
:param list:
:param union:
"""
name: Optional[str] = attribute()
restriction: Optional["Restriction"] = element()
list: Optional["List"] = element()
union: Optional["Union"] = element()
@property
def is_attribute(self) -> bool:
return True
@property
def is_enumeration(self) -> bool:
return (
True
if self.restriction and len(self.restriction.enumerations) > 0
else False
)
@property
def real_name(self) -> str:
if self.name:
return self.name
return "value"
@property
def real_type(self) -> Optional[str]:
if not self.is_enumeration and self.restriction:
return self.restriction.real_type
if self.list:
return self.list.real_type
if self.union:
return self.union.member_types
return None
[docs] def get_restrictions(self) -> Dict[str, Anything]:
if self.restriction:
return self.restriction.get_restrictions()
if self.list:
return self.list.get_restrictions()
return {}
[docs]@dataclass
class List(AnnotationBase):
"""
Schema Model.
:param simple_type:
:param item_type: QName
"""
simple_type: Optional[SimpleType] = element(name="simpleType")
item_type: Optional[str] = attribute(name="itemType")
@property
def is_attribute(self) -> bool:
return True
@property
def real_name(self) -> str:
return "value"
@property
def real_type(self) -> Optional[str]:
return self.item_type
[docs] def get_restrictions(self) -> Dict[str, Anything]:
return occurrences(0, sys.maxsize)
[docs]@dataclass
class Union(AnnotationBase):
"""
Schema Model.
:param member_types: List of QName
:param simple_types:
"""
member_types: Optional[str] = attribute(name="memberTypes")
simple_types: Array[SimpleType] = array_element(name="simpleType")
@property
def extends(self) -> Optional[str]:
if self.member_types:
return self.member_types
return None
@property
def is_attribute(self) -> bool:
return True
@property
def real_name(self) -> str:
return "value"
@property
def real_type(self) -> Optional[str]:
types = []
if self.simple_types:
types.extend(
[
simple_type.real_type
for simple_type in self.simple_types
if simple_type.real_type
]
)
if self.member_types:
types.extend([member for member in self.member_types.split(" ") if member])
return " ".join(types) if types else None
[docs] def get_restrictions(self) -> Dict[str, Anything]:
restrictions = {}
for simple_type in self.simple_types:
restrictions.update(simple_type.get_restrictions())
return restrictions
[docs]@dataclass
class Attribute(AnnotationBase):
"""
Schema Model.
:param default: string
:param fixed: string
:param form: qualified | unqualified
:param name: NCName
:param ref: QName
:param type: QName
:param target_namespace: anyURI
:param simple_type:
:param use: (optional | prohibited | required) : optional
"""
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 is_attribute(self) -> bool:
return True
@property
def real_type(self) -> Optional[str]:
if self.simple_type:
return self.simple_type.real_type
if self.type:
return self.type
if self.ref:
return self.ref
return None
[docs] def get_restrictions(self) -> Dict[str, Anything]:
restrictions = {}
if self.use == UseType.REQUIRED:
restrictions.update({"min_occurs": 1, "max_occurs": 1, "required": True})
elif self.use == UseType.PROHIBITED:
restrictions.update({"prohibited": True})
if self.simple_type:
restrictions.update(self.simple_type.get_restrictions())
return restrictions
[docs]@dataclass
class AttributeGroup(AnnotationBase):
"""
Schema Model.
:param name: NCName
:param ref: QName
:param attributes: any attributes with non-schema namespace
:param attribute_groups:
"""
name: Optional[str] = attribute()
ref: Optional[str] = attribute()
attributes: Array[Attribute] = array_element(name="attribute")
attribute_groups: Array["AttributeGroup"] = array_element(name="attributeGroup")
@property
def is_attribute(self) -> bool:
return True
@property
def real_type(self) -> Optional[str]:
return self.ref
[docs]@dataclass
class Any(AnnotationBase):
"""
Schema Model.
:param min_occurs: nonNegativeInteger : 1
:param max_occurs: (nonNegativeInteger | unbounded) : 1
:param namespace: List of (anyURI | (##targetNamespace | ##local))
:param process_contents: (lax | skip | strict) : strict
"""
min_occurs: int = attribute(default=1, name="minOccurs")
max_occurs: UnionType[int, str] = attribute(default=1, name="maxOccurs")
namespace: Optional[str] = attribute(default="##any")
process_contents: Optional[ProcessType] = attribute(name="processContents")
def __post_init__(self):
self.namespace = collapse_whitespace(self.namespace)
@property
def is_attribute(self) -> bool:
return True
@property
def real_name(self) -> str:
if self.namespace is None:
raise SchemaValueError("Wildcards namespace can't be None.")
namespace = (
self.namespace[2:] if self.namespace.startswith("##") else self.namespace
)
return f"{namespace}_element"
@property
def raw_namespace(self) -> Optional[str]:
return self.namespace
@property
def real_type(self) -> Optional[str]:
prefix = self.schema_prefix()
suffix = DataType.OBJECT.code
return f"{prefix}:{suffix}" if prefix else suffix
[docs] def get_restrictions(self) -> Dict[str, Anything]:
return occurrences(self.min_occurs, self.max_occurs)
[docs]@dataclass
class All(AnnotationBase):
"""
Schema Model.
:param min_occurs: nonNegativeInteger : 1
:param max_occurs: (nonNegativeInteger | unbounded) : 1
:param any:
:param elements:
:param groups:
"""
min_occurs: int = attribute(default=1, name="minOccurs")
max_occurs: UnionType[int, str] = 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")
[docs] def get_restrictions(self) -> Dict[str, Anything]:
return occurrences(self.min_occurs, self.max_occurs)
[docs]@dataclass
class Sequence(AnnotationBase):
"""
Schema Model.
:param min_occurs: nonNegativeInteger : 1
:param max_occurs: (nonNegativeInteger | unbounded) : 1
:param elements:
:param groups:
:param choices:
:param sequences:
:param any:
"""
min_occurs: int = attribute(default=1, name="minOccurs")
max_occurs: UnionType[int, str] = 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()
[docs] def get_restrictions(self) -> Dict[str, Anything]:
restrictions = occurrences(self.min_occurs, self.max_occurs)
restrictions.update(sequential=True)
return restrictions
[docs]@dataclass
class Choice(AnnotationBase):
"""
Schema Model.
:param min_occurs: nonNegativeInteger : 1
:param max_occurs: (nonNegativeInteger | unbounded) : 1
:param elements:
:param groups:
:param choices:
:param sequences:
:param any:
"""
min_occurs: int = attribute(default=1, name="minOccurs")
max_occurs: UnionType[int, str] = 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()
[docs] def get_restrictions(self) -> Dict[str, Anything]:
return occurrences(
self.min_occurs if self.min_occurs > 1 else 0, self.max_occurs
)
[docs]@dataclass
class Group(AnnotationBase):
"""
Schema Model.
:param name: NCName
:param ref: QName
:param min_occurs: nonNegativeInteger : 1
:param max_occurs: (nonNegativeInteger | unbounded) : 1
:param all:
:param choice:
:param sequence:
"""
name: Optional[str] = attribute()
ref: Optional[str] = attribute()
min_occurs: int = attribute(default=1, name="minOccurs")
max_occurs: UnionType[int, str] = attribute(default=1, name="maxOccurs")
all: Optional[All] = element()
choice: Optional[Choice] = element()
sequence: Optional[Sequence] = element()
@property
def is_attribute(self) -> bool:
return True
@property
def real_type(self) -> Optional[str]:
return self.ref
[docs] def get_restrictions(self) -> Dict[str, Anything]:
return occurrences(self.min_occurs, self.max_occurs)
[docs]@dataclass
class OpenContent(AnnotationBase):
"""
Schema Model.
:param applies_to_empty: default false
:param mode: (none | interleave | suffix) : interleave
:param any:
"""
applies_to_empty: bool = attribute(default=False, name="appliesToEmpty")
mode: Mode = attribute(default=Mode.INTERLEAVE)
any: Any = element()
[docs]@dataclass
class DefaultOpenContent(OpenContent):
"""Schema Model."""
[docs]@dataclass
class Extension(AnnotationBase):
"""
Schema Model.
:param base: QName
:param group:
:param all:
:param choice:
:param sequence:
:param any_attribute: any attributes with non-schema namespace
:param open_content:
:param attributes:
:param attribute_groups:
:param assertions:
"""
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 extends(self) -> Optional[str]:
return self.base
[docs]@dataclass
class Enumeration(AnnotationBase):
"""
Schema Model.
:param value: anySimpleType
"""
value: str = attribute()
@property
def is_attribute(self) -> bool:
return True
@property
def real_type(self) -> None:
return None
@property
def real_name(self) -> str:
return self.value
@property
def default(self) -> str:
return self.value
[docs]@dataclass
class FractionDigits(AnnotationBase):
"""
Schema Model.
:param value: nonNegativeInteger
"""
value: int = attribute()
[docs]@dataclass
class Length(AnnotationBase):
"""
Schema Model.
:param value: nonNegativeInteger
"""
value: int = attribute()
[docs]@dataclass
class MaxExclusive(AnnotationBase):
"""
Schema Model.
:param value: anySimpleType
"""
value: float = attribute()
[docs]@dataclass
class MaxInclusive(AnnotationBase):
"""
Schema Model.
:param value: anySimpleType
"""
value: float = attribute()
[docs]@dataclass
class MaxLength(AnnotationBase):
"""
Schema Model.
:param value: nonNegativeInteger
"""
value: float = attribute()
[docs]@dataclass
class MinExclusive(AnnotationBase):
"""
Schema Model.
:param value: anySimpleType
"""
value: float = attribute()
[docs]@dataclass
class MinInclusive(AnnotationBase):
"""
Schema Model.
:param value: anySimpleType
"""
value: float = attribute()
[docs]@dataclass
class MinLength(AnnotationBase):
"""
Schema Model.
:param value: nonNegativeInteger
"""
value: float = attribute()
[docs]@dataclass
class Pattern(AnnotationBase):
"""
Schema Model.
:param value: string
"""
value: str = attribute()
[docs]@dataclass
class TotalDigits(AnnotationBase):
"""
Schema Model.
:param value: positiveInteger
"""
value: int = attribute()
[docs]@dataclass
class WhiteSpace(AnnotationBase):
"""
Schema Model.
:param value: (collapse | preserve | replace)
"""
value: str = attribute()
[docs]@dataclass
class ExplicitTimezone(AnnotationBase):
"""
Schema Model.
:param value: NCName
:param fixed: default false
"""
value: str = attribute()
fixed: bool = attribute(default=False)
[docs]@dataclass
class Restriction(AnnotationBase):
"""
Schema Model.
:param base: QName
:param group:
:param all:
:param choice:
:param sequence:
:param open_content:
:param attributes:
:param attribute_groups:
:param enumerations:
:param asserts:
:param assertions:
:param any_element:
:param min_exclusive:
:param min_inclusive:
:param min_length:
:param max_exclusive:
:param max_inclusive:
:param max_length:
:param total_digits:
:param fraction_digits:
:param length:
:param white_space:
:param patterns:
:param explicit_timezone:
:param simple_type:
"""
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 real_type(self) -> Optional[str]:
if self.simple_type:
return self.simple_type.real_type
if self.enumerations:
return None
return self.base
@property
def real_name(self) -> str:
return "value"
@property
def extends(self) -> Optional[str]:
return self.base
[docs] def get_restrictions(self) -> Dict[str, Anything]:
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
[docs]@dataclass
class SimpleContent(AnnotationBase):
"""
Schema Model.
:param restriction:
:param extension:
"""
restriction: Optional[Restriction] = element()
extension: Optional[Extension] = element()
[docs]@dataclass
class ComplexContent(SimpleContent):
"""
Schema Model.
:param fixed:
"""
mixed: bool = attribute(default=False)
[docs]@dataclass
class ComplexType(AnnotationBase):
"""
Schema Model.
:param name: NCName
:param block: (#all | List of (extension | restriction))
:param final: (#all | List of (extension | restriction))
:param simple_content:
:param complex_content:
:param group:
:param all:
:param choice:
:param sequence:
:param any_attribute:
:param open_content:
:param attributes:
:param attribute_groups:
:param assertion:
:param abstract:
:param mixed:
:param default_attributes_apply:
"""
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:
if self.mixed:
return True
if self.complex_content:
return self.complex_content.mixed
return False
[docs]@dataclass
class Field(AnnotationBase):
"""
Schema Model.
:param xpath: a subset of XPath expression
"""
xpath: Optional[str] = attribute()
[docs]@dataclass
class Selector(Field):
"""Schema Model."""
[docs]@dataclass
class Unique(AnnotationBase):
"""
Schema Model.
:param name: NCName
:param ref: QName
:param selector:
:param fields:
"""
name: Optional[str] = attribute()
ref: Optional[str] = attribute()
selector: Optional[Selector] = element()
fields: Array[Field] = array_element(name="field")
[docs]@dataclass
class Key(AnnotationBase):
"""
Schema Model.
:param name: NCName
:param ref: QName
:param selector:
:param fields:
"""
name: Optional[str] = attribute()
ref: Optional[str] = attribute()
selector: Optional[Selector] = element()
fields: Array[Selector] = array_element(name="field")
[docs]@dataclass
class Keyref(AnnotationBase):
"""
Schema Model.
:param name: NCName
:param ref: QName
:param refer: QName
:param selector:
:param fields:
"""
name: Optional[str] = attribute()
ref: Optional[str] = attribute()
refer: Optional[str] = attribute()
selector: Optional[Selector] = element()
fields: Array[Selector] = array_element(name="field")
[docs]@dataclass
class Alternative(AnnotationBase):
"""
Schema Model.
:param type: QName
:param test: an XPath expression
:param simple_type:
:param complex_type:
"""
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:
if self.test:
return text.snake_case(self.test)
if self.id:
return self.id
return "value"
[docs]@dataclass
class Element(AnnotationBase):
"""
Schema Model.
:param name: NCName
:param ref: QName
:param type: QName
:param substitution_group: List of QName
:param default:
:param fixed:
:param form: qualified | unqualified
:param block: (#all | List of (extension | restriction | substitution))
:param final: (#all | List of (extension | restriction))
:param target_namespace: anyURI
:param simple_type:
:param complex_type:
:param alternatives:
:param uniques:
:param keys:
:param keyrefs:
:param min_occurs: nonNegativeInteger : 1
:param max_occurs: (nonNegativeInteger | unbounded) : 1
:param nillable:
:param abstract:
"""
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[int, str] = attribute(default=1, name="maxOccurs")
nillable: bool = attribute(default=False)
abstract: bool = attribute(default=False)
@property
def is_attribute(self) -> bool:
return True
@property
def is_mixed(self) -> bool:
return self.complex_type.is_mixed if self.complex_type else False
@property
def default_type(self) -> DataType:
return DataType.ANY_TYPE
@property
def raw_type(self) -> Optional[str]:
if self.type:
return self.type
if self.has_children:
return None
prefix = self.schema_prefix()
suffix = DataType.ANY_TYPE.code
return f"{prefix}:{suffix}" if prefix else suffix
@property
def real_type(self) -> Optional[str]:
types = {
alternative.type for alternative in self.alternatives if alternative.type
}
if self.type:
types.add(self.type)
elif self.ref:
types.add(self.ref)
elif self.simple_type and self.simple_type.real_type:
types.add(self.simple_type.real_type)
return " ".join(sorted(types)) or None
@property
def substitutions(self) -> Array[str]:
if self.substitution_group:
return list(filter(None, self.substitution_group.split(" ")))
return []
[docs] def get_restrictions(self) -> Dict[str, Anything]:
restrictions = occurrences(self.min_occurs, self.max_occurs)
if self.simple_type:
restrictions.update(self.simple_type.get_restrictions())
if self.nillable:
restrictions.update({"nillable": True})
return restrictions
[docs]@dataclass
class Notation(AnnotationBase):
"""
Schema Model.
:param name: NCName
:param public: token
:param system: anyURI
"""
name: Optional[str] = attribute()
public: Optional[str] = attribute()
system: Optional[str] = attribute()
[docs]@dataclass
class SchemaLocation(AnnotationBase):
"""
Base schema location.
:param location: any url with a urllib supported scheme file: http:
"""
location: Optional[str] = field(default=None)
[docs]@dataclass
class Import(SchemaLocation):
"""
Schema Model.
:param namespace: anyURI
:param schema_location: anyURI
"""
namespace: Optional[str] = attribute()
schema_location: Optional[str] = attribute(name="schemaLocation")
[docs]@dataclass
class Include(SchemaLocation):
"""
Schema Model.
:param schema_location: anyURI
"""
schema_location: Optional[str] = attribute(name="schemaLocation")
[docs]@dataclass
class Redefine(SchemaLocation):
"""
Schema Model.
:param schema_location: anyURI
:param simple_types:
:param complex_types:
:param groups:
:param attribute_groups:
"""
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")
[docs]@dataclass
class Override(SchemaLocation):
"""
Schema Model.
:param schema_location: anyURI
:param simple_types:
:param complex_types:
:param groups:
:param attribute_groups:
:param elements:
:param attributes:
:param notations:
"""
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")
[docs]@dataclass
class Schema(SchemaLocation):
"""
Schema Model.
:param target:
:param block_default: (#all | List of (extension | restriction | substitution))
:param default_attributes: QName
:param final_default: (#all | List of extension | restriction | list | union) : ''
:param target_namespace: anyURI
:param version: token
:param xmlns:
:param element_form_default: (qualified | unqualified) : unqualified
:param attribute_form_default: (qualified | unqualified) : unqualified
:param default_open_content:
:param imports:
:param redefines:
:param overrides:
:param annotations:
:param simple_types:
:param complex_types:
:param groups:
:param attribute_groups:
:param elements:
:param attributes:
:param notations:
"""
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")
[docs] def included(self) -> Iterator[UnionType[Import, Include, Redefine, Override]]:
yield from self.imports
yield from self.includes
yield from self.redefines
yield from self.overrides
@property
def module(self) -> str:
origin = self.location or self.target_namespace
if not origin:
raise SchemaValueError("Unknown schema module.")
module = origin.split("/")[-1]
return module[:-4] if module.endswith(".xsd") else module