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
|
from dataclasses import dataclass, field
from enum import Enum
from io import StringIO
from typing import (
Any,
Dict,
Generator,
Iterable,
Iterator,
List,
Optional,
TextIO,
Tuple,
Type,
)
from xml.etree.ElementTree import QName
from xsdata.exceptions import SerializerError
from xsdata.formats.bindings import AbstractSerializer
from xsdata.formats.converter import converter
from xsdata.formats.dataclass.context import XmlContext
from xsdata.formats.dataclass.models.elements import XmlMeta, XmlVar
from xsdata.formats.dataclass.serializers.config import SerializerConfig
from xsdata.formats.dataclass.serializers.mixins import XmlWriter, XmlWriterEvent
from xsdata.formats.dataclass.serializers.writers import default_writer
from xsdata.models.enums import DataType, QNames
from xsdata.utils import collections, namespaces
from xsdata.utils.constants import EMPTY_MAP
NoneStr = Optional[str]
@dataclass
class XmlSerializer(AbstractSerializer):
"""
Xml serializer for dataclasses.
:param config: Serializer configuration
:param context: Model context provider
:param writer: Override default XmlWriter
"""
config: SerializerConfig = field(default_factory=SerializerConfig)
context: XmlContext = field(default_factory=XmlContext)
writer: Type[XmlWriter] = field(default=default_writer())
def render(self, obj: Any, ns_map: Optional[Dict] = None) -> str:
"""
Convert and return the given object tree as xml string.
:param obj: The input dataclass instance
:param ns_map: User defined namespace prefix-URI map
"""
output = StringIO()
self.write(output, obj, ns_map)
return output.getvalue()
def write(self, out: TextIO, obj: Any, ns_map: Optional[Dict] = None):
"""
Write the given object tree to the output text stream.
:param out: The output stream
:param obj: The input dataclass instance
:param ns_map: User defined namespace prefix-URI map
"""
events = self.write_object(obj)
handler = self.writer(
config=self.config,
output=out,
ns_map=namespaces.clean_prefixes(ns_map) if ns_map else {},
)
handler.write(events)
def write_object(self, obj: Any):
"""Produce an events stream from a dataclass or a derived element."""
qname = xsi_type = None
if isinstance(obj, self.context.class_type.derived_element):
meta = self.context.build(
obj.value.__class__, globalns=self.config.globalns
)
qname = obj.qname
obj = obj.value
xsi_type = namespaces.real_xsi_type(qname, meta.target_qname)
yield from self.write_dataclass(obj, qname=qname, xsi_type=xsi_type)
def write_dataclass(
self,
obj: Any,
namespace: NoneStr = None,
qname: NoneStr = None,
nillable: bool = False,
xsi_type: Optional[str] = None,
) -> Generator:
"""
Produce an events stream from a dataclass.
Optionally override the qualified name and the xsi properties
type and nil.
"""
meta = self.context.build(
obj.__class__, namespace, globalns=self.config.globalns
)
qname = qname or meta.qname
nillable = nillable or meta.nillable
namespace, tag = namespaces.split_qname(qname)
yield XmlWriterEvent.START, qname
for key, value in self.next_attribute(
obj, meta, nillable, xsi_type, self.config.ignore_default_attributes
):
yield XmlWriterEvent.ATTR, key, value
for var, value in self.next_value(obj, meta):
yield from self.write_value(value, var, namespace)
yield XmlWriterEvent.END, qname
def write_xsi_type(self, value: Any, var: XmlVar, namespace: NoneStr) -> Generator:
"""Produce an events stream from a dataclass for the given var with xsi
abstract type check for non wildcards."""
if var.is_wildcard:
choice = var.find_value_choice(value, True)
if choice:
yield from self.write_value(value, choice, namespace)
else:
yield from self.write_dataclass(value, namespace)
elif var.is_element:
xsi_type = self.xsi_type(var, value, namespace)
yield from self.write_dataclass(
value, namespace, var.qname, var.nillable, xsi_type
)
else:
# var elements
meta = self.context.fetch(value.__class__, namespace)
yield from self.write_dataclass(value, qname=meta.target_qname)
def write_value(self, value: Any, var: XmlVar, namespace: NoneStr) -> Generator:
"""
Delegates the given value to the correct writer according to the
variable metadata.
The order of the checks is important as more than one condition
can be true.
"""
if var.mixed:
yield from self.write_mixed_content(value, var, namespace)
elif var.is_text:
yield from self.write_data(value, var, namespace)
elif var.tokens:
yield from self.write_tokens(value, var, namespace)
elif var.is_elements:
yield from self.write_elements(value, var, namespace)
elif var.list_element and collections.is_array(value):
yield from self.write_list(value, var, namespace)
else:
yield from self.write_any_type(value, var, namespace)
def write_list(
self, values: Iterable, var: XmlVar, namespace: NoneStr
) -> Generator:
"""Produce an events stream for the given list of values."""
if var.wrapper is not None:
yield XmlWriterEvent.START, var.wrapper
for value in values:
yield from self.write_value(value, var, namespace)
yield XmlWriterEvent.END, var.wrapper
else:
for value in values:
yield from self.write_value(value, var, namespace)
def write_tokens(self, value: Any, var: XmlVar, namespace: NoneStr) -> Generator:
"""Produce an events stream for the given tokens list or list of tokens
lists."""
if value or var.nillable or var.required:
if value and collections.is_array(value[0]):
for val in value:
yield from self.write_element(val, var, namespace)
else:
yield from self.write_element(value, var, namespace)
def write_mixed_content(
self, values: List, var: XmlVar, namespace: NoneStr
) -> Generator:
"""Produce an events stream for the given list of mixed type
objects."""
for value in values:
yield from self.write_any_type(value, var, namespace)
def write_any_type(self, value: Any, var: XmlVar, namespace: NoneStr) -> Generator:
"""
Produce an events stream for the given object.
The object can be a dataclass or a generic object or any other
simple type.
"""
if isinstance(value, self.context.class_type.any_element):
yield from self.write_wildcard(value, var, namespace)
elif isinstance(value, self.context.class_type.derived_element):
yield from self.write_derived_element(value, namespace)
elif self.context.class_type.is_model(value):
yield from self.write_xsi_type(value, var, namespace)
elif var.is_element:
yield from self.write_element(value, var, namespace)
else:
yield from self.write_data(value, var, namespace)
def write_derived_element(self, value: Any, namespace: NoneStr) -> Generator:
if self.context.class_type.is_model(value.value):
meta = self.context.fetch(value.value.__class__)
qname = value.qname
xsi_type = namespaces.real_xsi_type(qname, meta.target_qname)
yield from self.write_dataclass(
value.value, namespace, qname=qname, xsi_type=xsi_type
)
else:
datatype = DataType.from_value(value.value)
yield XmlWriterEvent.START, value.qname
yield XmlWriterEvent.ATTR, QNames.XSI_TYPE, QName(str(datatype))
yield XmlWriterEvent.DATA, value.value
yield XmlWriterEvent.END, value.qname
def write_wildcard(self, value: Any, var: XmlVar, namespace: NoneStr) -> Generator:
"""Produce an element events stream for the given generic object."""
if value.qname:
namespace, tag = namespaces.split_qname(value.qname)
yield XmlWriterEvent.START, value.qname
for key, val in value.attributes.items():
yield XmlWriterEvent.ATTR, key, val
yield XmlWriterEvent.DATA, value.text
for child in value.children:
yield from self.write_any_type(child, var, namespace)
if value.qname:
yield XmlWriterEvent.END, value.qname
if value.tail:
yield XmlWriterEvent.DATA, value.tail
def xsi_type(self, var: XmlVar, value: Any, namespace: NoneStr) -> Optional[str]:
"""Get xsi:type if the given value is a derived instance."""
if not value or value.__class__ in var.types:
return None
clazz = var.clazz
if clazz is None or self.context.is_derived(value, clazz):
meta = self.context.fetch(value.__class__, namespace)
return namespaces.real_xsi_type(var.qname, meta.target_qname)
raise SerializerError(
f"{value.__class__.__name__} is not derived from {clazz.__name__}"
)
def write_elements(self, value: Any, var: XmlVar, namespace: NoneStr) -> Generator:
"""Produce an events stream from compound elements field."""
if collections.is_array(value):
for choice in value:
yield from self.write_choice(choice, var, namespace)
else:
yield from self.write_choice(value, var, namespace)
def write_choice(self, value: Any, var: XmlVar, namespace: NoneStr) -> Generator:
"""
Produce an events stream for the given value of a compound elements
field.
The value can be anything as long as we can match the qualified
name or its type to a choice.
"""
if isinstance(value, self.context.class_type.derived_element):
choice = var.find_choice(value.qname)
value = value.value
if self.context.class_type.is_model(value):
func = self.write_xsi_type
else:
func = self.write_element
elif isinstance(value, self.context.class_type.any_element) and value.qname:
choice = var.find_choice(value.qname)
func = self.write_any_type
else:
check_subclass = self.context.class_type.is_model(value)
choice = var.find_value_choice(value, check_subclass)
func = self.write_value
if not choice and check_subclass:
func = self.write_xsi_type
choice = var
if not choice:
raise SerializerError(
f"XmlElements undefined choice: `{var.name}` for `{type(value)}`"
)
yield from func(value, choice, namespace)
def write_element(self, value: Any, var: XmlVar, namespace: NoneStr) -> Generator:
"""Produce an element events stream for the given simple type value."""
yield XmlWriterEvent.START, var.qname
if var.nillable:
yield XmlWriterEvent.ATTR, QNames.XSI_NIL, "true"
if value is not None and value != "" and var.any_type:
datatype = DataType.from_value(value)
if datatype != DataType.STRING:
yield XmlWriterEvent.ATTR, QNames.XSI_TYPE, QName(str(datatype))
yield XmlWriterEvent.DATA, self.encode(value, var)
yield XmlWriterEvent.END, var.qname
@classmethod
def write_data(cls, value: Any, var: XmlVar, namespace: NoneStr) -> Generator:
"""Produce a data event for the given value."""
yield XmlWriterEvent.DATA, cls.encode(value, var)
@classmethod
def next_value(cls, obj: Any, meta: XmlMeta) -> Iterator[Tuple[XmlVar, Any]]:
"""
Return the non attribute variables with their object values in the
correct order according to their definition and the sequential metadata
property.
Sequential fields need to be rendered together in parallel order
eg: <a1/><a2/><a1/><a/2></a1>
"""
index = 0
attrs = meta.get_element_vars()
stop = len(attrs)
while index < stop:
var = attrs[index]
if var.sequence is None:
value = getattr(obj, var.name)
if value is not None or var.nillable:
yield var, value
index += 1
continue
indices = range(index, stop)
end = next(
i for i in indices[::-1] if attrs[i].sequence == var.sequence
) # pragma: no cover
sequence = attrs[index : end + 1]
index = end + 1
j = 0
rolling = True
while rolling:
rolling = False
for var in sequence:
values = getattr(obj, var.name)
if collections.is_array(values):
if j < len(values):
rolling = True
value = values[j]
if value is not None or var.nillable:
yield var, value
elif j == 0:
rolling = True
if values is not None or var.nillable:
yield var, values
j += 1
@classmethod
def next_attribute(
cls,
obj: Any,
meta: XmlMeta,
nillable: bool,
xsi_type: Optional[str],
ignore_optionals: bool,
) -> Iterator[Tuple[str, Any]]:
"""
Return the attribute variables with their object values if set and not
empty iterables.
:param obj: Input object
:param meta: Object metadata
:param nillable: Is model nillable
:param xsi_type: The true xsi:type of the object
:param ignore_optionals: Skip optional attributes with default
value
:return:
"""
for var in meta.get_attribute_vars():
if var.is_attribute:
value = getattr(obj, var.name)
if (
value is None
or (collections.is_array(value) and not value)
or (ignore_optionals and var.is_optional(value))
):
continue
yield var.qname, cls.encode(value, var)
else:
yield from getattr(obj, var.name, EMPTY_MAP).items()
if xsi_type:
yield QNames.XSI_TYPE, QName(xsi_type)
if nillable:
yield QNames.XSI_NIL, "true"
@classmethod
def encode(cls, value: Any, var: XmlVar) -> Any:
"""
Encode values for xml serialization.
Converts values to strings. QName instances is an exception,
those values need to wait until the XmlWriter assigns prefixes
to namespaces per element node. Enums and Tokens may contain
QName(s) so they also get a special treatment.
We can't do all the conversions in the writer because we would
need to carry the xml vars inside the writer. Instead of that we
do the easy encoding here and leave the qualified names for
later.
"""
if isinstance(value, (str, QName)) or var is None:
return value
if collections.is_array(value):
return [cls.encode(v, var) for v in value]
if isinstance(value, Enum):
return cls.encode(value.value, var)
return converter.serialize(value, format=var.format)
|