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
|
from typing import Dict, Iterator, List, Optional, Tuple
from xsdata.codegen.models import Attr, AttrType, Class, Extension, Restrictions
from xsdata.models.enums import DataType, Tag
from xsdata.models.mixins import ElementBase
from xsdata.models.xsd import (
Attribute,
AttributeGroup,
ComplexType,
Element,
Group,
Schema,
SimpleType,
)
from xsdata.utils import collections, text
from xsdata.utils.namespaces import build_qname, is_default, prefix_exists
class SchemaMapper:
"""Map a schema instance to classes, extensions and attributes."""
@classmethod
def map(cls, schema: Schema) -> List[Class]:
"""Map schema children elements to classes."""
assert schema.location is not None
location = schema.location
target_namespace = schema.target_namespace
return [
cls.build_class(element, container, location, target_namespace)
for container, element in cls.root_elements(schema)
]
@classmethod
def root_elements(cls, schema: Schema):
"""Return all valid schema elements that can be converted to
classes."""
for override in schema.overrides:
for child in override.children(condition=cls.is_class):
yield Tag.OVERRIDE, child
for redefine in schema.redefines:
for child in redefine.children(condition=cls.is_class):
yield Tag.REDEFINE, child
for child in schema.children(condition=cls.is_class):
yield Tag.SCHEMA, child
@classmethod
def build_class(
cls,
obj: ElementBase,
container: str,
location: str,
target_namespace: Optional[str],
) -> Class:
"""Build and return a class instance."""
instance = Class(
qname=build_qname(target_namespace, obj.real_name),
abstract=obj.is_abstract,
namespace=cls.element_namespace(obj, target_namespace),
mixed=obj.is_mixed,
nillable=obj.is_nillable,
tag=obj.class_name,
container=container,
help=obj.display_help,
ns_map=obj.ns_map,
location=location,
default=obj.default_value,
fixed=obj.is_fixed,
substitutions=cls.build_substitutions(obj, target_namespace),
)
cls.build_class_extensions(obj, instance)
cls.build_class_attributes(obj, instance)
return instance
@classmethod
def build_substitutions(
cls, obj: ElementBase, target_namespace: Optional[str]
) -> List[str]:
return [
build_qname(obj.ns_map.get(prefix, target_namespace), suffix)
for prefix, suffix in map(text.split, obj.substitutions)
]
@classmethod
def build_class_attributes(cls, obj: ElementBase, target: Class):
"""Build the target class attributes from the given ElementBase
children."""
base_restrictions = Restrictions.from_element(obj)
for child, restrictions in cls.element_children(obj, base_restrictions):
cls.build_class_attribute(target, child, restrictions)
target.attrs.sort(key=lambda x: x.index)
@classmethod
def build_class_extensions(cls, obj: ElementBase, target: Class):
"""Build the item class extensions from the given ElementBase
children."""
restrictions = obj.get_restrictions()
extensions = [
cls.build_class_extension(obj.class_name, target, base, restrictions)
for base in obj.bases
]
extensions.extend(cls.children_extensions(obj, target))
target.extensions = collections.unique_sequence(extensions)
@classmethod
def build_data_type(
cls, target: Class, name: str, forward: bool = False
) -> AttrType:
"""Create an attribute type for the target class."""
prefix, suffix = text.split(name)
namespace = target.ns_map.get(prefix, target.target_namespace)
qname = build_qname(namespace, suffix)
datatype = DataType.from_qname(qname)
return AttrType(
qname=qname,
native=datatype is not None,
forward=forward,
)
@classmethod
def element_children(
cls, obj: ElementBase, parent_restrictions: Restrictions
) -> Iterator[Tuple[ElementBase, Restrictions]]:
"""Recursively find and return all child elements that are qualified to
be class attributes, with all their restrictions."""
for child in obj.children():
if child.is_property:
yield child, parent_restrictions
else:
restrictions = Restrictions.from_element(child)
restrictions.merge(parent_restrictions)
yield from cls.element_children(child, restrictions)
@classmethod
def element_namespace(
cls, obj: ElementBase, target_namespace: Optional[str]
) -> Optional[str]:
"""
Return the target namespace for the given schema element.
In order:
- elements/attributes with specific target namespace
- prefixed elements returns the namespace from schema ns_map
- qualified elements returns the schema target namespace
- unqualified elements return an empty string
- unqualified attributes return None
"""
raw_namespace = obj.raw_namespace
if raw_namespace:
return raw_namespace
prefix = obj.prefix
if prefix:
return obj.ns_map.get(prefix)
if obj.is_qualified and (
not obj.is_ref
or not target_namespace
or not prefix_exists(target_namespace, obj.ns_map)
or is_default(target_namespace, obj.ns_map)
):
return target_namespace
return "" if isinstance(obj, Element) else None
@classmethod
def children_extensions(
cls, obj: ElementBase, target: Class
) -> Iterator[Extension]:
"""
Recursively find and return all target's Extension classes.
If the initial given obj has a type attribute include it in
result.
"""
for child in obj.children():
if child.is_property:
continue
for ext in child.bases:
yield cls.build_class_extension(
child.class_name, target, ext, child.get_restrictions()
)
yield from cls.children_extensions(child, target)
@classmethod
def build_class_extension(
cls, tag: str, target: Class, name: str, restrictions: Dict
) -> Extension:
"""Create an extension for the target class."""
return Extension(
type=cls.build_data_type(target, name),
tag=tag,
restrictions=Restrictions(**restrictions),
)
@classmethod
def build_class_attribute(
cls,
target: Class,
obj: ElementBase,
parent_restrictions: Restrictions,
):
"""Generate and append an attribute field to the target class."""
target.ns_map.update(obj.ns_map)
types = cls.build_class_attribute_types(target, obj)
restrictions = Restrictions.from_element(obj)
if obj.class_name in (Tag.ELEMENT, Tag.ANY, Tag.GROUP):
restrictions.merge(parent_restrictions)
name = obj.real_name
target.attrs.append(
Attr(
index=obj.index,
name=name,
default=obj.default_value,
fixed=obj.is_fixed,
types=types,
tag=obj.class_name,
help=obj.display_help,
namespace=cls.element_namespace(obj, target.target_namespace),
restrictions=restrictions,
)
)
@classmethod
def build_class_attribute_types(
cls, target: Class, obj: ElementBase
) -> List[AttrType]:
"""Convert real type and anonymous inner types to an attribute type
list."""
types = [cls.build_data_type(target, tp) for tp in obj.attr_types]
location = target.location
namespace = target.target_namespace
for inner in cls.build_inner_classes(obj, location, namespace):
target.inner.append(inner)
types.append(AttrType(qname=inner.qname, forward=True))
if len(types) == 0:
types.append(cls.build_data_type(target, name=obj.default_type))
return collections.unique_sequence(types)
@classmethod
def build_inner_classes(
cls, obj: ElementBase, location: str, namespace: Optional[str]
) -> Iterator[Class]:
"""Find and convert anonymous types to a class instances."""
if isinstance(obj, SimpleType) and obj.is_enumeration:
yield cls.build_class(obj, obj.class_name, location, namespace)
else:
for child in obj.children():
if isinstance(child, ComplexType) or (
isinstance(child, SimpleType) and child.is_enumeration
):
child.name = obj.real_name
yield cls.build_class(child, obj.class_name, location, namespace)
else:
yield from cls.build_inner_classes(child, location, namespace)
@classmethod
def is_class(cls, item: ElementBase) -> bool:
return isinstance(
item, (SimpleType, ComplexType, Group, AttributeGroup, Element, Attribute)
)
|