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
|
#
# Copyright (c), 2016-2021, SISSA (International School for Advanced Studies).
# All rights reserved.
# This file is distributed under the terms of the MIT License.
# See the file 'LICENSE' in the root directory of the present
# distribution, or http://opensource.org/licenses/MIT.
#
# @author Davide Brunato <brunato@sissa.it>
#
from collections.abc import MutableMapping, MutableSequence
from typing import TYPE_CHECKING, Any, Optional, Type
from xmlschema.exceptions import XMLSchemaTypeError, XMLSchemaValueError
from xmlschema.aliases import NsmapType, BaseXsdType
from .base import ElementData, stackable, XMLSchemaConverter
if TYPE_CHECKING:
from xmlschema.validators import XsdElement
class JsonMLConverter(XMLSchemaConverter):
"""
XML Schema based converter class for JsonML (JSON Mark-up Language) convention.
ref: http://www.jsonml.org/
ref: https://www.ibm.com/developerworks/library/x-jsonml/
:param namespaces: Map from namespace prefixes to URI.
:param dict_class: dictionary class to use for decoded data. Default is `dict`.
:param list_class: list class to use for decoded data. Default is `list`.
"""
__slots__ = ()
def __init__(self, namespaces: Optional[NsmapType] = None,
dict_class: Optional[Type[dict[str, Any]]] = None,
list_class: Optional[Type[list[Any]]] = None,
**kwargs: Any) -> None:
kwargs.update(attr_prefix='', text_key='', cdata_prefix='')
super().__init__(namespaces, dict_class, list_class, **kwargs)
@property
def lossy(self) -> bool:
return False
@property
def losslessly(self) -> bool:
return True
def get_xmlns_from_data(self, obj: Any) -> Optional[list[tuple[str, str]]]:
if not self._use_namespaces or not isinstance(obj, MutableSequence) \
or len(obj) < 2 or not isinstance(obj[1], MutableMapping):
return None
xmlns = []
for k, v in obj[1].items():
if k == 'xmlns':
xmlns.append(('', v))
elif k.startswith('xmlns:'):
xmlns.append((k.split('xmlns:')[1], v))
return xmlns
@stackable
def element_decode(self, data: ElementData, xsd_element: 'XsdElement',
xsd_type: Optional[BaseXsdType] = None, level: int = 0) -> Any:
xsd_type = xsd_type or xsd_element.type
result_list = self.list()
xmlns = self.get_effective_xmlns(data.xmlns, level, xsd_element)
result_list.append(self.map_qname(data.tag))
attributes = self.dict(self.map_attributes(data.attributes))
if xmlns and self._use_namespaces:
attributes.update(
(f'{self.ns_prefix}:{k}' if k else self.ns_prefix, v) for k, v in xmlns
)
if attributes:
result_list.append(attributes)
if data.text is not None:
result_list.append(data.text)
if xsd_type.model_group is not None:
result_list.extend([
value if value is not None else self.list([name])
for name, value, _ in self.map_content(data.content)
])
return result_list
@stackable
def element_encode(self, obj: Any, xsd_element: 'XsdElement', level: int = 0) -> ElementData:
if not isinstance(obj, MutableSequence):
msg = "The first argument must be a sequence, {} provided"
raise XMLSchemaTypeError(msg.format(type(obj)))
elif not obj:
raise XMLSchemaValueError("The first argument is an empty sequence")
xmlns = self.set_context(obj, level)
tag = self.unmap_qname(obj[0])
if not xsd_element.is_matching(tag):
raise XMLSchemaValueError("Unmatched tag")
data_len = len(obj)
if data_len == 1:
return ElementData(tag, None, None, {}, None)
attributes: dict[str, Any] = {}
if isinstance(obj[1], MutableMapping):
content_index = 2
for k, v in obj[1].items():
if k != 'xmlns' and not k.startswith('xmlns:'):
attributes[self.unmap_qname(k, xsd_element.attributes)] = v
else:
content_index = 1
if data_len <= content_index:
return ElementData(tag, None, [], attributes, xmlns)
elif data_len == content_index + 1 and \
(xsd_element.type.simple_type is not None or not
xsd_element.type.content and xsd_element.type.mixed):
return ElementData(tag, obj[content_index], [], attributes, xmlns)
else:
cdata_num = iter(range(1, data_len))
content = [
(self.unmap_qname(e[0], xmlns=self.get_xmlns_from_data(e)), e)
if isinstance(e, MutableSequence)
else (next(cdata_num), e) for e in obj[content_index:]
]
return ElementData(tag, None, content, attributes, xmlns)
|