1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 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 156 157 158 159 160 161 162 163 164 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 208 209 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 236 237 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 276 277 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 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 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 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 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 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 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 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 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 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 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 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 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 861 862 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 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 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 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
|
import sys
import textwrap
from dataclasses import dataclass, field
from typing import Any as Anything
from typing import Dict, Iterator, Optional
from typing import List as Array
from typing import Union as UnionType
from xsdata.formats.dataclass.serializers import XmlSerializer
from xsdata.formats.dataclass.serializers.config import SerializerConfig
from xsdata.models.enums import (
DataType,
FormType,
Mode,
Namespace,
ProcessType,
UseType,
)
from xsdata.models.mixins import (
ElementBase,
array_any_element,
array_element,
attribute,
element,
)
from xsdata.utils import text
from xsdata.utils.collections import unique_sequence
from xsdata.utils.constants import DEFAULT_ATTR_NAME
from xsdata.utils.namespaces import clean_uri
docstring_serializer = XmlSerializer(
config=SerializerConfig(pretty_print=True, xml_declaration=False)
)
@dataclass(frozen=True)
class Docstring:
class Meta:
namespace = "http://www.w3.org/1999/xhtml"
elements: Array[object] = array_any_element()
@dataclass
class Documentation(ElementBase):
"""
Model representation of a schema xs:documentation element.
: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(mixed=True)
attributes: Optional["AnyAttribute"] = element()
def tostring(self) -> Optional[str]:
obj = Docstring(self.elements)
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()
@dataclass
class Appinfo(ElementBase):
"""
Model representation of a schema xs:appinfo element.
:param lang: language
:param source: anyURI
:param attributes: any attributes with non-schema namespace
"""
class Meta:
mixed = True
source: Optional[str] = attribute()
elements: Array[object] = array_any_element()
any_attribute: Optional["AnyAttribute"] = element(name="anyAttribute")
@dataclass
class Annotation(ElementBase):
"""
Model representation of a schema xs:annotation element.
:param appinfos:
:param documentations:
:param any_attribute: any attributes with non-schema namespace
"""
appinfos: Array[Appinfo] = array_element(name="appinfo")
documentations: Array[Documentation] = array_element(name="documentation")
any_attribute: Optional["AnyAttribute"] = element(name="anyAttribute")
@dataclass
class AnnotationBase(ElementBase):
"""
Base Class for elements that can contain annotations.
:param id: ID
:param annotations:
:param any_attribute: any attributes with non-schema namespace
"""
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]:
help_str = "\n".join(
documentation.tostring() or ""
for annotation in self.annotations
for documentation in annotation.documentations
).strip()
return help_str or None
@dataclass
class AnyAttribute(AnnotationBase):
"""
Model representation of a schema xs:anyAttribute element.
:param namespace: ##any | ##other) | List of anyURI |
(##targetNamespace | ##local)
:param process_contents: (lax | skip | strict) : strict
"""
namespace: str = attribute(default="##any")
process_contents: Optional[ProcessType] = attribute(name="processContents")
def __post_init__(self):
self.namespace = " ".join(unique_sequence(self.namespace.split()))
@property
def is_property(self) -> bool:
return True
@property
def raw_namespace(self) -> Optional[str]:
return self.namespace
@property
def real_name(self) -> str:
clean_ns = "_".join(map(clean_uri, self.namespace.split()))
return f"@{clean_ns}_attributes"
@property
def attr_types(self) -> Iterator[str]:
yield DataType.ANY_TYPE.prefixed(self.xs_prefix)
@dataclass
class Assertion(AnnotationBase):
"""
Model representation of a schema xs:assertion element.
:param test: an XPath expression
"""
test: Optional[str] = attribute()
@dataclass
class SimpleType(AnnotationBase):
"""
Model representation of a schema xs:simpleType element.
: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_property(self) -> bool:
return True
@property
def is_enumeration(self) -> bool:
return self.restriction is not None and len(self.restriction.enumerations) > 0
@property
def real_name(self) -> str:
if self.name:
return self.name
return DEFAULT_ATTR_NAME
@property
def attr_types(self) -> Iterator[str]:
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]:
if self.restriction:
return self.restriction.get_restrictions()
if self.list:
return self.list.get_restrictions()
return {}
@dataclass
class List(AnnotationBase):
"""
Model representation of a schema xs:list element.
:param simple_type:
:param item_type: QName
"""
simple_type: Optional[SimpleType] = element(name="simpleType")
item_type: str = attribute(name="itemType", default="")
@property
def is_property(self) -> bool:
return True
@property
def real_name(self) -> str:
return DEFAULT_ATTR_NAME
@property
def attr_types(self) -> Iterator[str]:
if self.item_type:
yield self.item_type
def get_restrictions(self) -> Dict[str, Anything]:
return {"tokens": True}
@dataclass
class Union(AnnotationBase):
"""
Model representation of a schema xs:union element.
: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 bases(self) -> Iterator[str]:
if self.member_types:
yield from self.member_types.split()
@property
def is_property(self) -> bool:
return True
@property
def real_name(self) -> str:
return DEFAULT_ATTR_NAME
@property
def attr_types(self) -> Iterator[str]:
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]:
restrictions = {}
for simple_type in self.simple_types:
restrictions.update(simple_type.get_restrictions())
return restrictions
@dataclass
class Attribute(AnnotationBase):
"""
Model representation of a schema xs:attribute element.
: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 bases(self) -> Iterator[str]:
if self.type:
yield self.type
elif not self.has_children:
yield DataType.STRING.prefixed(self.xs_prefix)
@property
def is_property(self) -> bool:
return True
@property
def attr_types(self) -> Iterator[str]:
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:
datatype = DataType.STRING if self.fixed else DataType.ANY_SIMPLE_TYPE
return datatype.prefixed(self.xs_prefix)
def get_restrictions(self) -> Dict[str, Anything]:
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
@dataclass
class AttributeGroup(AnnotationBase):
"""
Model representation of a schema xs:attributeGroup element.
:param name: NCName
:param ref: QName
:param attributes: any attributes with non-schema namespace
:param attribute_groups:
"""
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:
return True
@property
def attr_types(self) -> Iterator[str]:
if self.ref:
yield self.ref
@dataclass
class Any(AnnotationBase):
"""
Model representation of a schema xs:any element.
: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
"""
namespace: str = attribute(default="##any")
min_occurs: int = attribute(default=1, name="minOccurs")
max_occurs: UnionType[int, str] = attribute(default=1, name="maxOccurs")
process_contents: ProcessType = attribute(
default=ProcessType.STRICT, name="processContents"
)
def __post_init__(self):
self.namespace = " ".join(unique_sequence(self.namespace.split()))
@property
def is_property(self) -> bool:
return True
@property
def real_name(self) -> str:
clean_ns = "_".join(map(clean_uri, self.namespace.split()))
return f"@{clean_ns}_element"
@property
def raw_namespace(self) -> Optional[str]:
return self.namespace
@property
def attr_types(self) -> Iterator[str]:
yield DataType.ANY_TYPE.prefixed(self.xs_prefix)
def get_restrictions(self) -> Dict[str, Anything]:
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,
}
@dataclass
class All(AnnotationBase):
"""
Model representation of a schema xs:all element.
: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")
def get_restrictions(self) -> Dict[str, Anything]:
max_occurs = sys.maxsize if self.max_occurs == "unbounded" else self.max_occurs
return {
"path": [("a", id(self), self.min_occurs, max_occurs)],
}
@dataclass
class Sequence(AnnotationBase):
"""
Model representation of a schema xs:sequence element.
: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()
def get_restrictions(self) -> Dict[str, Anything]:
max_occurs = sys.maxsize if self.max_occurs == "unbounded" else self.max_occurs
return {
"path": [("s", id(self), self.min_occurs, max_occurs)],
}
@dataclass
class Choice(AnnotationBase):
"""
Model representation of a schema xs:choice element.
: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()
def get_restrictions(self) -> Dict[str, Anything]:
max_occurs = sys.maxsize if self.max_occurs == "unbounded" else self.max_occurs
return {
"path": [("c", id(self), self.min_occurs, max_occurs)],
}
@dataclass
class Group(AnnotationBase):
"""
Model representation of a schema xs:group element.
: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: str = attribute(default="")
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_property(self) -> bool:
return True
@property
def attr_types(self) -> Iterator[str]:
if self.ref:
yield self.ref
def get_restrictions(self) -> Dict[str, Anything]:
max_occurs = sys.maxsize if self.max_occurs == "unbounded" else self.max_occurs
return {
"path": [("g", id(self), self.min_occurs, max_occurs)],
}
@dataclass
class OpenContent(AnnotationBase):
"""
Model representation of a schema xs:openContent element.
: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()
@dataclass
class DefaultOpenContent(OpenContent):
"""Model representation of a schema xs:defaultOpenContent element."""
@dataclass
class Extension(AnnotationBase):
"""
Model representation of a schema xs:extension element.
: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 bases(self) -> Iterator[str]:
if self.base:
yield self.base
@dataclass
class Enumeration(AnnotationBase):
"""
Model representation of a schema xs:enumeration element.
:param value: anySimpleType
"""
value: str = attribute()
@property
def is_property(self) -> bool:
return True
@property
def real_name(self) -> str:
return self.value
@property
def default(self) -> str:
return self.value
@property
def is_fixed(self) -> bool:
return True
@dataclass
class FractionDigits(AnnotationBase):
"""
Model representation of a schema xs:fractionDigits element.
:param value: nonNegativeInteger
"""
value: int = attribute()
@dataclass
class Length(AnnotationBase):
"""
Model representation of a schema xs:length element.
:param value: nonNegativeInteger
"""
value: int = attribute()
@dataclass
class MaxExclusive(AnnotationBase):
"""
Model representation of a schema xs:maxExclusive element.
:param value: anySimpleType
"""
value: str = attribute()
@dataclass
class MaxInclusive(AnnotationBase):
"""
Model representation of a schema xs:maxInclusive element.
:param value: anySimpleType
"""
value: str = attribute()
@dataclass
class MaxLength(AnnotationBase):
"""
Model representation of a schema xs:maxLength element.
:param value: nonNegativeInteger
"""
value: int = attribute()
@dataclass
class MinExclusive(AnnotationBase):
"""
Model representation of a schema xs:minExclusive element.
:param value: anySimpleType
"""
value: str = attribute()
@dataclass
class MinInclusive(AnnotationBase):
"""
Model representation of a schema xs:minInclusive element.
:param value: anySimpleType
"""
value: str = attribute()
@dataclass
class MinLength(AnnotationBase):
"""
Model representation of a schema xs:minLength element.
:param value: nonNegativeInteger
"""
value: int = attribute()
@dataclass
class Pattern(AnnotationBase):
"""
Model representation of a schema xs:pattern element.
:param value: string
"""
value: str = attribute()
@dataclass
class TotalDigits(AnnotationBase):
"""
Model representation of a schema xs:totalDigits element.
:param value: positiveInteger
"""
value: int = attribute()
@dataclass
class WhiteSpace(AnnotationBase):
"""
Model representation of a schema xs:whiteSpace element.
:param value: (collapse | preserve | replace)
"""
value: str = attribute()
@dataclass
class ExplicitTimezone(AnnotationBase):
"""
Model representation of a schema xs:explicitTimezone element.
:param value: NCName
:param fixed: default false
"""
value: str = attribute()
fixed: bool = attribute(default=False)
@dataclass
class Restriction(AnnotationBase):
"""
Model representation of a schema xs:restriction element.
: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 attr_types(self) -> Iterator[str]:
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 DEFAULT_ATTR_NAME
@property
def bases(self) -> Iterator[str]:
if self.base:
yield self.base
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
@dataclass
class SimpleContent(AnnotationBase):
"""
Model representation of a schema xs:simpleContent element.
:param restriction:
:param extension:
"""
restriction: Optional[Restriction] = element()
extension: Optional[Extension] = element()
@dataclass
class ComplexContent(SimpleContent):
"""
Model representation of a schema xs:complexContent element.
:param fixed:
"""
mixed: bool = attribute(default=False)
@dataclass
class ComplexType(AnnotationBase):
"""
Model representation of a schema xs:complexType element.
: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
@dataclass
class Field(AnnotationBase):
"""
Model representation of a schema xs:field element.
:param xpath: a subset of XPath expression
"""
xpath: Optional[str] = attribute()
@dataclass
class Selector(Field):
"""Schema Model representation of a schema xs:selectorModel element.."""
@dataclass
class Unique(AnnotationBase):
"""
Model representation of a schema xs:unique element.
: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")
@dataclass
class Key(AnnotationBase):
"""
Model representation of a schema xs:key element.
: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")
@dataclass
class Keyref(AnnotationBase):
"""
Model representation of a schema xs:keyref element.
: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")
@dataclass
class Alternative(AnnotationBase):
"""
Model representation of a schema xs:alternative element.
: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 DEFAULT_ATTR_NAME
@property
def bases(self) -> Iterator[str]:
if self.type:
yield self.type
def get_restrictions(self) -> Dict[str, Anything]:
return {
"path": [("alt", id(self), 0, 1)],
}
@dataclass
class Element(AnnotationBase):
"""
Model representation of a schema xs:element element.
: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: Optional[int] = attribute(default=1, name="minOccurs")
max_occurs: UnionType[None, int, str] = attribute(default=1, name="maxOccurs")
nillable: bool = attribute(default=False)
abstract: bool = attribute(default=False)
@property
def bases(self) -> Iterator[str]:
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:
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) -> str:
datatype = DataType.STRING if self.fixed else DataType.ANY_TYPE
return datatype.prefixed(self.xs_prefix)
@property
def attr_types(self) -> Iterator[str]:
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 self.substitution_group.split() if self.substitution_group else []
def get_restrictions(self) -> Dict[str, Anything]:
max_occurs = sys.maxsize if self.max_occurs == "unbounded" else self.max_occurs
restrictions = {
"min_occurs": self.min_occurs,
"max_occurs": max_occurs,
}
if self.simple_type:
restrictions.update(self.simple_type.get_restrictions())
if self.nillable:
restrictions.update(nillable=True)
return restrictions
@dataclass
class Notation(AnnotationBase):
"""
Model representation of a schema xs:notation element.
:param name: NCName
:param public: token
:param system: anyURI
"""
name: Optional[str] = attribute()
public: Optional[str] = attribute()
system: Optional[str] = attribute()
@dataclass
class SchemaLocation(AnnotationBase):
"""
Model representation of a schema xs:schemaLocation element. Base schema
location.
:param location: any url with a urllib supported scheme file
: http:
"""
location: Optional[str] = field(default=None)
@dataclass
class Import(SchemaLocation):
"""
Model representation of a schema xs:import element.
:param namespace: anyURI
:param schema_location: anyURI
"""
namespace: Optional[str] = attribute()
schema_location: Optional[str] = attribute(name="schemaLocation")
@dataclass
class Include(SchemaLocation):
"""
Model representation of a schema xs:include element.
:param schema_location: anyURI
"""
schema_location: Optional[str] = attribute(name="schemaLocation")
@dataclass
class Redefine(SchemaLocation):
"""
Model representation of a schema xs:redefine element.
: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")
@dataclass
class Override(SchemaLocation):
"""
Model representation of a schema xs:override element.
: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")
@dataclass
class Schema(SchemaLocation):
"""
Model representation of a schema xs:schema element.
: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:
"""
class Meta:
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")
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
|