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
|
import itertools
from typing import Dict, Iterator, List, Optional, Tuple
from xsdata.codegen.models import Attr, AttrType, Class, Restrictions, Status
from xsdata.formats.dataclass.models.generics import AnyElement
from xsdata.logger import logger
from xsdata.models.enums import DataType, Namespace, Tag
from xsdata.models.wsdl import (
Binding,
BindingMessage,
BindingOperation,
Definitions,
Part,
PortType,
PortTypeMessage,
PortTypeOperation,
ServicePort,
)
from xsdata.utils import collections, namespaces, text
class DefinitionsMapper:
"""
Map a definitions instance to message and service classes.
Currently, only SOAP 1.1 bindings with rpc/document style is
supported.
"""
@classmethod
def map(cls, definitions: Definitions) -> List[Class]:
"""Step 1: Main mapper entry point."""
return [
obj
for service in definitions.services
for port in service.ports
for obj in cls.map_port(definitions, port)
]
@classmethod
def map_port(cls, definitions: Definitions, port: ServicePort) -> Iterator[Class]:
"""Step 2: Match a ServicePort to a Binding and PortType object and
delegate the process to the next entry point."""
binding = definitions.find_binding(text.suffix(port.binding))
port_type = definitions.find_port_type(text.suffix(binding.type))
elements = itertools.chain(binding.extended_elements, port.extended_elements)
config = cls.attributes(elements)
yield from cls.map_binding(definitions, binding, port_type, config)
@classmethod
def map_binding(
cls,
definitions: Definitions,
binding: Binding,
port_type: PortType,
config: Dict,
) -> Iterator[Class]:
"""Step 3: Match every BindingOperation to a PortTypeOperation and
delegate the process for each operation to the next entry point."""
for operation in binding.unique_operations():
cfg = config.copy()
cfg.update(cls.attributes(operation.extended_elements))
port_operation = port_type.find_operation(operation.name)
yield from cls.map_binding_operation(
definitions, operation, port_operation, cfg, port_type.name
)
@classmethod
def map_binding_operation(
cls,
definitions: Definitions,
binding_operation: BindingOperation,
port_type_operation: PortTypeOperation,
config: Dict,
name: str,
) -> Iterator[Class]:
"""Step 4: Convert a BindingOperation to a service class and delegate
the process of all the message classes to the next entry point."""
attrs = [
cls.build_attr(key, str(DataType.STRING), native=True, default=config[key])
for key in sorted(config.keys(), key=len)
if config[key]
]
style = config.get("style", "document")
name = f"{name}_{binding_operation.name}"
namespace = cls.operation_namespace(config)
operation_messages = cls.map_binding_operation_messages(
definitions, binding_operation, port_type_operation, name, style, namespace
)
for message_class in operation_messages:
yield message_class
# Only Envelope classes need to be added in service input/output
if message_class.meta_name:
message_type = message_class.name.split("_")[-1]
attrs.append(cls.build_attr(message_type, message_class.qname))
assert binding_operation.location is not None
yield Class(
qname=namespaces.build_qname(definitions.target_namespace, name),
status=Status.FLATTENED,
tag=type(binding_operation).__name__,
location=binding_operation.location,
ns_map=binding_operation.ns_map,
attrs=attrs,
)
@classmethod
def map_binding_operation_messages(
cls,
definitions: Definitions,
operation: BindingOperation,
port_type_operation: PortTypeOperation,
name: str,
style: str,
namespace: Optional[str],
) -> Iterator[Class]:
"""Step 5: Map the BindingOperation messages to classes."""
messages: List[Tuple[str, BindingMessage, PortTypeMessage, Optional[str]]] = []
if operation.input:
messages.append(
("input", operation.input, port_type_operation.input, operation.name)
)
if operation.output:
messages.append(
("output", operation.output, port_type_operation.output, None)
)
for suffix, binding_message, port_type_message, operation_name in messages:
if style == "rpc":
yield cls.build_message_class(definitions, port_type_message)
target = cls.build_envelope_class(
definitions,
binding_message,
port_type_message,
f"{name}_{suffix}",
style,
namespace,
operation_name,
)
if suffix == "output":
cls.build_envelope_fault(definitions, port_type_operation, target)
yield target
@classmethod
def build_envelope_fault(
cls,
definitions: Definitions,
port_type_operation: PortTypeOperation,
target: Class,
):
"""Build inner fault class with default fields."""
ns_map: Dict = {}
body = next(inner for inner in target.inner if inner.name == "Body")
fault_class = cls.build_inner_class(body, "Fault", target.namespace)
detail_attrs: List[Attr] = []
for fault in port_type_operation.faults:
message = definitions.find_message(text.suffix(fault.message))
detail_attrs.extend(cls.build_parts_attributes(message.parts, ns_map))
default_fields = ["faultcode", "faultstring", "faultactor"]
if detail_attrs:
detail = cls.build_inner_class(fault_class, "detail", namespace="")
detail.attrs.extend(detail_attrs)
else:
default_fields.append("detail")
collections.prepend(
fault_class.attrs,
*(
cls.build_attr(f, str(DataType.STRING), native=True, namespace="")
for f in default_fields
),
)
@classmethod
def build_envelope_class(
cls,
definitions: Definitions,
binding_message: BindingMessage,
port_type_message: PortTypeMessage,
name: str,
style: str,
namespace: Optional[str],
operation: Optional[str],
) -> Class:
"""Step 6.1: Build Envelope class for the given binding message with
attributes from the port type message."""
assert binding_message.location is not None
target = Class(
qname=namespaces.build_qname(definitions.target_namespace, name),
meta_name="Envelope",
tag=Tag.BINDING_MESSAGE,
location=binding_message.location,
ns_map=binding_message.ns_map,
namespace=namespace,
)
message = port_type_message.message
for ext in binding_message.extended_elements:
assert ext.qname is not None
class_name = namespaces.local_name(ext.qname).title()
inner = cls.build_inner_class(target, class_name)
if style == "rpc" and class_name == "Body":
namespace = ext.attributes.get("namespace")
attrs = cls.map_port_type_message(
operation, port_type_message, namespace
)
else:
attrs = cls.map_binding_message_parts(
definitions, message, ext, inner.ns_map
)
inner.attrs.extend(attrs)
return target
@classmethod
def build_message_class(
cls, definitions: Definitions, port_type_message: PortTypeMessage
) -> Class:
"""Step 6.2: Build the input/output message class of an rpc style
operation."""
prefix, name = text.split(port_type_message.message)
definition_message = definitions.find_message(name)
ns_map = definition_message.ns_map.copy()
source_namespace = ns_map.get(prefix)
assert port_type_message.location is not None
return Class(
qname=namespaces.build_qname(source_namespace, name),
namespace=source_namespace,
status=Status.RAW,
tag=Tag.ELEMENT,
location=port_type_message.location,
ns_map=ns_map,
attrs=list(cls.build_parts_attributes(definition_message.parts, ns_map)),
)
@classmethod
def build_inner_class(
cls, target: Class, name: str, namespace: Optional[str] = None
) -> Class:
"""
Build or retrieve an inner class for the given target class by the
given name.
This helper will also create a forward reference attribute for
the parent class.
"""
inner = collections.first(inner for inner in target.inner if inner.name == name)
if not inner:
inner = Class(
qname=namespaces.build_qname(target.target_namespace, name),
tag=Tag.BINDING_MESSAGE,
location=target.location,
ns_map=target.ns_map.copy(),
)
attr = cls.build_attr(name, inner.qname, forward=True, namespace=namespace)
target.inner.append(inner)
target.attrs.append(attr)
return inner
@classmethod
def map_port_type_message(
cls,
operation: Optional[str],
message: PortTypeMessage,
namespace: Optional[str],
) -> Iterator[Attr]:
"""Build an attribute for the given port type message."""
prefix, name = text.split(message.message)
source_namespace = message.ns_map.get(prefix)
if operation is None:
operation = name
yield cls.build_attr(
operation,
qname=namespaces.build_qname(source_namespace, name),
namespace=namespace,
)
@classmethod
def map_binding_message_parts(
cls, definitions: Definitions, message: str, extended: AnyElement, ns_map: Dict
) -> Iterator[Attr]:
"""Find a Message instance and map its parts to attributes according to
the extensible element.."""
parts = []
if "part" in extended.attributes:
parts.append(extended.attributes["part"])
elif "parts" in extended.attributes:
parts.extend(extended.attributes["parts"].split())
if "message" in extended.attributes:
message_name = namespaces.local_name(extended.attributes["message"])
else:
message_name = text.suffix(message)
definition_message = definitions.find_message(message_name)
message_parts = definition_message.parts
if parts:
message_parts = [part for part in message_parts if part.name in parts]
yield from cls.build_parts_attributes(message_parts, ns_map)
@classmethod
def build_parts_attributes(cls, parts: List[Part], ns_map: Dict) -> Iterator[Attr]:
"""
Build attributes for the given list of parts.
:param parts: List of parts
:param ns_map: Namespace prefix-URI map
"""
for part in parts:
if part.element:
prefix, type_name = text.split(part.element)
name = type_name
elif part.type:
prefix, type_name = text.split(part.type)
name = part.name
else:
logger.warning("Skip untyped message part %s", part.name)
continue
ns_map.update(part.ns_map)
namespace = part.ns_map.get(prefix)
type_qname = namespaces.build_qname(namespace, type_name)
native = namespace == Namespace.XS.uri
# If part has a type it could reference an element or a complex type or
# a simple type, we can't make that detection yet, postpone it till the
# classes processing.
namespace = "##lazy" if part.type else namespace
yield cls.build_attr(name, type_qname, namespace=namespace, native=native)
@classmethod
def operation_namespace(cls, config: Dict) -> Optional[str]:
transport = config.get("transport")
namespace = None
if transport == "http://schemas.xmlsoap.org/soap/http":
namespace = "http://schemas.xmlsoap.org/soap/envelope/"
return namespace
@classmethod
def attributes(cls, elements: Iterator[AnyElement]) -> Dict:
"""Return all attributes from all extended elements as a dictionary."""
return {
namespaces.local_name(qname): value
for element in elements
if isinstance(element, AnyElement)
for qname, value in element.attributes.items()
}
@classmethod
def build_attr(
cls,
name: str,
qname: str,
native: bool = False,
forward: bool = False,
namespace: Optional[str] = None,
default: Optional[str] = None,
) -> Attr:
"""Builder method for attributes."""
occurs = 1 if default is not None else None
if native:
namespace = ""
return Attr(
tag=Tag.ELEMENT,
name=name,
namespace=namespace,
default=default,
types=[AttrType(qname=qname, forward=forward, native=native)],
restrictions=Restrictions(min_occurs=occurs, max_occurs=occurs),
)
|