@typespec/http-client-python 0.4.4 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (137) hide show
  1. package/dist/emitter/emitter.d.ts.map +1 -1
  2. package/dist/emitter/emitter.js +85 -24
  3. package/dist/emitter/emitter.js.map +1 -1
  4. package/dist/emitter/lib.d.ts +1 -0
  5. package/dist/emitter/lib.d.ts.map +1 -1
  6. package/dist/emitter/lib.js +1 -0
  7. package/dist/emitter/lib.js.map +1 -1
  8. package/dist/emitter/run-python3.d.ts +2 -0
  9. package/dist/emitter/run-python3.d.ts.map +1 -0
  10. package/dist/emitter/run-python3.js +19 -0
  11. package/dist/emitter/run-python3.js.map +1 -0
  12. package/dist/emitter/system-requirements.d.ts +17 -0
  13. package/dist/emitter/system-requirements.d.ts.map +1 -0
  14. package/dist/emitter/system-requirements.js +167 -0
  15. package/dist/emitter/system-requirements.js.map +1 -0
  16. package/emitter/src/emitter.ts +88 -23
  17. package/emitter/src/lib.ts +2 -0
  18. package/emitter/src/run-python3.ts +20 -0
  19. package/emitter/src/system-requirements.ts +261 -0
  20. package/emitter/temp/tsconfig.tsbuildinfo +1 -1
  21. package/eng/scripts/ci/regenerate.ts +16 -4
  22. package/eng/scripts/setup/__pycache__/venvtools.cpython-38.pyc +0 -0
  23. package/eng/scripts/setup/build.ts +16 -0
  24. package/eng/scripts/setup/build_pygen_wheel.py +40 -0
  25. package/eng/scripts/setup/install.py +9 -3
  26. package/eng/scripts/setup/install.ts +32 -0
  27. package/eng/scripts/setup/prepare.py +3 -1
  28. package/eng/scripts/setup/prepare.ts +11 -0
  29. package/eng/scripts/setup/run-python3.ts +1 -6
  30. package/generator/build/lib/pygen/__init__.py +107 -0
  31. package/generator/build/lib/pygen/_version.py +7 -0
  32. package/generator/build/lib/pygen/black.py +71 -0
  33. package/generator/build/lib/pygen/codegen/__init__.py +357 -0
  34. package/generator/build/lib/pygen/codegen/_utils.py +17 -0
  35. package/generator/build/lib/pygen/codegen/models/__init__.py +204 -0
  36. package/generator/build/lib/pygen/codegen/models/base.py +186 -0
  37. package/generator/build/lib/pygen/codegen/models/base_builder.py +118 -0
  38. package/generator/build/lib/pygen/codegen/models/client.py +435 -0
  39. package/generator/build/lib/pygen/codegen/models/code_model.py +237 -0
  40. package/generator/build/lib/pygen/codegen/models/combined_type.py +149 -0
  41. package/generator/build/lib/pygen/codegen/models/constant_type.py +129 -0
  42. package/generator/build/lib/pygen/codegen/models/credential_types.py +214 -0
  43. package/generator/build/lib/pygen/codegen/models/dictionary_type.py +127 -0
  44. package/generator/build/lib/pygen/codegen/models/enum_type.py +238 -0
  45. package/generator/build/lib/pygen/codegen/models/imports.py +291 -0
  46. package/generator/build/lib/pygen/codegen/models/list_type.py +143 -0
  47. package/generator/build/lib/pygen/codegen/models/lro_operation.py +142 -0
  48. package/generator/build/lib/pygen/codegen/models/lro_paging_operation.py +32 -0
  49. package/generator/build/lib/pygen/codegen/models/model_type.py +357 -0
  50. package/generator/build/lib/pygen/codegen/models/operation.py +509 -0
  51. package/generator/build/lib/pygen/codegen/models/operation_group.py +184 -0
  52. package/generator/build/lib/pygen/codegen/models/paging_operation.py +155 -0
  53. package/generator/build/lib/pygen/codegen/models/parameter.py +412 -0
  54. package/generator/build/lib/pygen/codegen/models/parameter_list.py +387 -0
  55. package/generator/build/lib/pygen/codegen/models/primitive_types.py +659 -0
  56. package/generator/build/lib/pygen/codegen/models/property.py +170 -0
  57. package/generator/build/lib/pygen/codegen/models/request_builder.py +189 -0
  58. package/generator/build/lib/pygen/codegen/models/request_builder_parameter.py +115 -0
  59. package/generator/build/lib/pygen/codegen/models/response.py +348 -0
  60. package/generator/build/lib/pygen/codegen/models/utils.py +21 -0
  61. package/generator/build/lib/pygen/codegen/serializers/__init__.py +574 -0
  62. package/generator/build/lib/pygen/codegen/serializers/base_serializer.py +21 -0
  63. package/generator/build/lib/pygen/codegen/serializers/builder_serializer.py +1533 -0
  64. package/generator/build/lib/pygen/codegen/serializers/client_serializer.py +294 -0
  65. package/generator/build/lib/pygen/codegen/serializers/enum_serializer.py +15 -0
  66. package/generator/build/lib/pygen/codegen/serializers/general_serializer.py +213 -0
  67. package/generator/build/lib/pygen/codegen/serializers/import_serializer.py +126 -0
  68. package/generator/build/lib/pygen/codegen/serializers/metadata_serializer.py +198 -0
  69. package/generator/build/lib/pygen/codegen/serializers/model_init_serializer.py +33 -0
  70. package/generator/build/lib/pygen/codegen/serializers/model_serializer.py +335 -0
  71. package/generator/build/lib/pygen/codegen/serializers/operation_groups_serializer.py +89 -0
  72. package/generator/build/lib/pygen/codegen/serializers/operations_init_serializer.py +44 -0
  73. package/generator/build/lib/pygen/codegen/serializers/parameter_serializer.py +221 -0
  74. package/generator/build/lib/pygen/codegen/serializers/patch_serializer.py +19 -0
  75. package/generator/build/lib/pygen/codegen/serializers/request_builders_serializer.py +52 -0
  76. package/generator/build/lib/pygen/codegen/serializers/sample_serializer.py +168 -0
  77. package/generator/build/lib/pygen/codegen/serializers/test_serializer.py +292 -0
  78. package/generator/build/lib/pygen/codegen/serializers/types_serializer.py +31 -0
  79. package/generator/build/lib/pygen/codegen/serializers/utils.py +68 -0
  80. package/generator/build/lib/pygen/codegen/templates/client.py.jinja2 +37 -0
  81. package/generator/build/lib/pygen/codegen/templates/client_container.py.jinja2 +12 -0
  82. package/generator/build/lib/pygen/codegen/templates/config.py.jinja2 +73 -0
  83. package/generator/build/lib/pygen/codegen/templates/config_container.py.jinja2 +16 -0
  84. package/generator/build/lib/pygen/codegen/templates/conftest.py.jinja2 +28 -0
  85. package/generator/build/lib/pygen/codegen/templates/enum.py.jinja2 +13 -0
  86. package/generator/build/lib/pygen/codegen/templates/enum_container.py.jinja2 +10 -0
  87. package/generator/build/lib/pygen/codegen/templates/init.py.jinja2 +24 -0
  88. package/generator/build/lib/pygen/codegen/templates/keywords.jinja2 +27 -0
  89. package/generator/build/lib/pygen/codegen/templates/lro_operation.py.jinja2 +16 -0
  90. package/generator/build/lib/pygen/codegen/templates/lro_paging_operation.py.jinja2 +18 -0
  91. package/generator/build/lib/pygen/codegen/templates/macros.jinja2 +12 -0
  92. package/generator/build/lib/pygen/codegen/templates/metadata.json.jinja2 +167 -0
  93. package/generator/build/lib/pygen/codegen/templates/model_base.py.jinja2 +1174 -0
  94. package/generator/build/lib/pygen/codegen/templates/model_container.py.jinja2 +15 -0
  95. package/generator/build/lib/pygen/codegen/templates/model_dpg.py.jinja2 +97 -0
  96. package/generator/build/lib/pygen/codegen/templates/model_init.py.jinja2 +33 -0
  97. package/generator/build/lib/pygen/codegen/templates/model_msrest.py.jinja2 +92 -0
  98. package/generator/build/lib/pygen/codegen/templates/operation.py.jinja2 +21 -0
  99. package/generator/build/lib/pygen/codegen/templates/operation_group.py.jinja2 +75 -0
  100. package/generator/build/lib/pygen/codegen/templates/operation_groups_container.py.jinja2 +19 -0
  101. package/generator/build/lib/pygen/codegen/templates/operation_tools.jinja2 +81 -0
  102. package/generator/build/lib/pygen/codegen/templates/operations_folder_init.py.jinja2 +17 -0
  103. package/generator/build/lib/pygen/codegen/templates/packaging_templates/CHANGELOG.md.jinja2 +6 -0
  104. package/generator/build/lib/pygen/codegen/templates/packaging_templates/LICENSE.jinja2 +21 -0
  105. package/generator/build/lib/pygen/codegen/templates/packaging_templates/MANIFEST.in.jinja2 +8 -0
  106. package/generator/build/lib/pygen/codegen/templates/packaging_templates/README.md.jinja2 +107 -0
  107. package/generator/build/lib/pygen/codegen/templates/packaging_templates/dev_requirements.txt.jinja2 +9 -0
  108. package/generator/build/lib/pygen/codegen/templates/packaging_templates/setup.py.jinja2 +108 -0
  109. package/generator/build/lib/pygen/codegen/templates/paging_operation.py.jinja2 +21 -0
  110. package/generator/build/lib/pygen/codegen/templates/patch.py.jinja2 +19 -0
  111. package/generator/build/lib/pygen/codegen/templates/pkgutil_init.py.jinja2 +1 -0
  112. package/generator/build/lib/pygen/codegen/templates/request_builder.py.jinja2 +28 -0
  113. package/generator/build/lib/pygen/codegen/templates/request_builders.py.jinja2 +10 -0
  114. package/generator/build/lib/pygen/codegen/templates/rest_init.py.jinja2 +12 -0
  115. package/generator/build/lib/pygen/codegen/templates/sample.py.jinja2 +44 -0
  116. package/generator/build/lib/pygen/codegen/templates/serialization.py.jinja2 +2117 -0
  117. package/generator/build/lib/pygen/codegen/templates/test.py.jinja2 +50 -0
  118. package/generator/build/lib/pygen/codegen/templates/testpreparer.py.jinja2 +26 -0
  119. package/generator/build/lib/pygen/codegen/templates/types.py.jinja2 +7 -0
  120. package/generator/build/lib/pygen/codegen/templates/validation.py.jinja2 +38 -0
  121. package/generator/build/lib/pygen/codegen/templates/vendor.py.jinja2 +96 -0
  122. package/generator/build/lib/pygen/codegen/templates/version.py.jinja2 +4 -0
  123. package/generator/build/lib/pygen/m2r.py +65 -0
  124. package/generator/build/lib/pygen/preprocess/__init__.py +515 -0
  125. package/generator/build/lib/pygen/preprocess/helpers.py +27 -0
  126. package/generator/build/lib/pygen/preprocess/python_mappings.py +226 -0
  127. package/generator/build/lib/pygen/utils.py +163 -0
  128. package/generator/component-detection-pip-report.json +134 -0
  129. package/generator/dev_requirements.txt +0 -1
  130. package/generator/dist/pygen-0.1.0-py3-none-any.whl +0 -0
  131. package/generator/pygen.egg-info/PKG-INFO +7 -4
  132. package/generator/pygen.egg-info/requires.txt +7 -4
  133. package/generator/requirements.txt +5 -10
  134. package/generator/setup.py +7 -4
  135. package/generator/test/azure/requirements.txt +1 -1
  136. package/generator/test/unbranded/requirements.txt +1 -1
  137. package/package.json +6 -5
@@ -0,0 +1,2117 @@
1
+ # --------------------------------------------------------------------------
2
+ #
3
+ # Copyright (c) {{ code_model.options["company_name"] }} Corporation. All rights reserved.
4
+ #
5
+ # The MIT License (MIT)
6
+ #
7
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ # of this software and associated documentation files (the ""Software""), to
9
+ # deal in the Software without restriction, including without limitation the
10
+ # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
11
+ # sell copies of the Software, and to permit persons to whom the Software is
12
+ # furnished to do so, subject to the following conditions:
13
+ #
14
+ # The above copyright notice and this permission notice shall be included in
15
+ # all copies or substantial portions of the Software.
16
+ #
17
+ # THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22
+ # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
23
+ # IN THE SOFTWARE.
24
+ #
25
+ # --------------------------------------------------------------------------
26
+
27
+ # pyright: reportUnnecessaryTypeIgnoreComment=false
28
+
29
+ from base64 import b64decode, b64encode
30
+ import calendar
31
+ import datetime
32
+ import decimal
33
+ import email
34
+ from enum import Enum
35
+ import json
36
+ import logging
37
+ import re
38
+ import sys
39
+ import codecs
40
+ from typing import (
41
+ Dict,
42
+ Any,
43
+ cast,
44
+ Optional,
45
+ Union,
46
+ AnyStr,
47
+ IO,
48
+ Mapping,
49
+ Callable,
50
+ TypeVar,
51
+ MutableMapping,
52
+ Type,
53
+ List,
54
+ )
55
+
56
+ try:
57
+ from urllib import quote # type: ignore
58
+ except ImportError:
59
+ from urllib.parse import quote
60
+ import xml.etree.ElementTree as ET
61
+
62
+ import isodate # type: ignore
63
+
64
+ from {{ code_model.core_library }}.exceptions import DeserializationError, SerializationError
65
+ from {{ code_model.core_library }}.serialization import NULL as CoreNull
66
+
67
+ _BOM = codecs.BOM_UTF8.decode(encoding="utf-8")
68
+
69
+ ModelType = TypeVar("ModelType", bound="Model")
70
+ JSON = MutableMapping[str, Any]
71
+
72
+
73
+ class RawDeserializer:
74
+
75
+ # Accept "text" because we're open minded people...
76
+ JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$")
77
+
78
+ # Name used in context
79
+ CONTEXT_NAME = "deserialized_data"
80
+
81
+ @classmethod
82
+ def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any:
83
+ """Decode data according to content-type.
84
+
85
+ Accept a stream of data as well, but will be load at once in memory for now.
86
+
87
+ If no content-type, will return the string version (not bytes, not stream)
88
+
89
+ :param data: Input, could be bytes or stream (will be decoded with UTF8) or text
90
+ :type data: str or bytes or IO
91
+ :param str content_type: The content type.
92
+ :return: The deserialized data.
93
+ :rtype: object
94
+ """
95
+ if hasattr(data, "read"):
96
+ # Assume a stream
97
+ data = cast(IO, data).read()
98
+
99
+ if isinstance(data, bytes):
100
+ data_as_str = data.decode(encoding="utf-8-sig")
101
+ else:
102
+ # Explain to mypy the correct type.
103
+ data_as_str = cast(str, data)
104
+
105
+ # Remove Byte Order Mark if present in string
106
+ data_as_str = data_as_str.lstrip(_BOM)
107
+
108
+ if content_type is None:
109
+ return data
110
+
111
+ if cls.JSON_REGEXP.match(content_type):
112
+ try:
113
+ return json.loads(data_as_str)
114
+ except ValueError as err:
115
+ raise DeserializationError("JSON is invalid: {}".format(err), err) from err
116
+ elif "xml" in (content_type or []):
117
+ try:
118
+
119
+ try:
120
+ if isinstance(data, unicode): # type: ignore
121
+ # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string
122
+ data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore
123
+ except NameError:
124
+ pass
125
+
126
+ return ET.fromstring(data_as_str) # nosec
127
+ except ET.ParseError as err:
128
+ # It might be because the server has an issue, and returned JSON with
129
+ # content-type XML....
130
+ # So let's try a JSON load, and if it's still broken
131
+ # let's flow the initial exception
132
+ def _json_attemp(data):
133
+ try:
134
+ return True, json.loads(data)
135
+ except ValueError:
136
+ return False, None # Don't care about this one
137
+
138
+ success, json_result = _json_attemp(data)
139
+ if success:
140
+ return json_result
141
+ # If i'm here, it's not JSON, it's not XML, let's scream
142
+ # and raise the last context in this block (the XML exception)
143
+ # The function hack is because Py2.7 messes up with exception
144
+ # context otherwise.
145
+ _LOGGER.critical("Wasn't XML not JSON, failing")
146
+ raise DeserializationError("XML is invalid") from err
147
+ elif content_type.startswith("text/"):
148
+ return data_as_str
149
+ raise DeserializationError("Cannot deserialize content-type: {}".format(content_type))
150
+
151
+ @classmethod
152
+ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any:
153
+ """Deserialize from HTTP response.
154
+
155
+ Use bytes and headers to NOT use any requests/aiohttp or whatever
156
+ specific implementation.
157
+ Headers will tested for "content-type"
158
+
159
+ :param bytes body_bytes: The body of the response.
160
+ :param dict headers: The headers of the response.
161
+ :returns: The deserialized data.
162
+ :rtype: object
163
+ """
164
+ # Try to use content-type from headers if available
165
+ content_type = None
166
+ if "content-type" in headers:
167
+ content_type = headers["content-type"].split(";")[0].strip().lower()
168
+ # Ouch, this server did not declare what it sent...
169
+ # Let's guess it's JSON...
170
+ # Also, since Autorest was considering that an empty body was a valid JSON,
171
+ # need that test as well....
172
+ else:
173
+ content_type = "application/json"
174
+
175
+ if body_bytes:
176
+ return cls.deserialize_from_text(body_bytes, content_type)
177
+ return None
178
+
179
+
180
+ _LOGGER = logging.getLogger(__name__)
181
+
182
+ try:
183
+ _long_type = long # type: ignore
184
+ except NameError:
185
+ _long_type = int
186
+
187
+
188
+ class UTC(datetime.tzinfo):
189
+ """Time Zone info for handling UTC"""
190
+
191
+ def utcoffset(self, dt):
192
+ """UTF offset for UTC is 0.
193
+
194
+ :param datetime.datetime dt: The datetime
195
+ :returns: The offset
196
+ :rtype: datetime.timedelta
197
+ """
198
+ return datetime.timedelta(0)
199
+
200
+ def tzname(self, dt):
201
+ """Timestamp representation.
202
+
203
+ :param datetime.datetime dt: The datetime
204
+ :returns: The timestamp representation
205
+ :rtype: str
206
+ """
207
+ return "Z"
208
+
209
+ def dst(self, dt):
210
+ """No daylight saving for UTC.
211
+
212
+ :param datetime.datetime dt: The datetime
213
+ :returns: The daylight saving time
214
+ :rtype: datetime.timedelta
215
+ """
216
+ return datetime.timedelta(hours=1)
217
+
218
+
219
+ try:
220
+ from datetime import timezone as _FixedOffset # type: ignore
221
+ except ImportError: # Python 2.7
222
+
223
+ class _FixedOffset(datetime.tzinfo): # type: ignore
224
+ """Fixed offset in minutes east from UTC.
225
+ Copy/pasted from Python doc
226
+ :param datetime.timedelta offset: offset in timedelta format
227
+ """
228
+
229
+ def __init__(self, offset) -> None:
230
+ self.__offset = offset
231
+
232
+ def utcoffset(self, dt):
233
+ return self.__offset
234
+
235
+ def tzname(self, dt):
236
+ return str(self.__offset.total_seconds() / 3600)
237
+
238
+ def __repr__(self):
239
+ return "<FixedOffset {}>".format(self.tzname(None))
240
+
241
+ def dst(self, dt):
242
+ return datetime.timedelta(0)
243
+
244
+ def __getinitargs__(self):
245
+ return (self.__offset,)
246
+
247
+
248
+ try:
249
+ from datetime import timezone
250
+
251
+ TZ_UTC = timezone.utc
252
+ except ImportError:
253
+ TZ_UTC = UTC() # type: ignore
254
+
255
+ _FLATTEN = re.compile(r"(?<!\\)\.")
256
+
257
+
258
+ def attribute_transformer(key, attr_desc, value): # pylint: disable=unused-argument
259
+ """A key transformer that returns the Python attribute.
260
+
261
+ :param str key: The attribute name
262
+ :param dict attr_desc: The attribute metadata
263
+ :param object value: The value
264
+ :returns: A key using attribute name
265
+ :rtype: str
266
+ """
267
+ return (key, value)
268
+
269
+
270
+ def full_restapi_key_transformer(key, attr_desc, value): # pylint: disable=unused-argument
271
+ """A key transformer that returns the full RestAPI key path.
272
+
273
+ :param str key: The attribute name
274
+ :param dict attr_desc: The attribute metadata
275
+ :param object value: The value
276
+ :returns: A list of keys using RestAPI syntax.
277
+ :rtype: list
278
+ """
279
+ keys = _FLATTEN.split(attr_desc["key"])
280
+ return ([_decode_attribute_map_key(k) for k in keys], value)
281
+
282
+
283
+ def last_restapi_key_transformer(key, attr_desc, value):
284
+ """A key transformer that returns the last RestAPI key.
285
+
286
+ :param str key: The attribute name
287
+ :param dict attr_desc: The attribute metadata
288
+ :param object value: The value
289
+ :returns: The last RestAPI key.
290
+ :rtype: str
291
+ """
292
+ key, value = full_restapi_key_transformer(key, attr_desc, value)
293
+ return (key[-1], value)
294
+
295
+
296
+ def _create_xml_node(tag, prefix=None, ns=None):
297
+ """Create a XML node.
298
+
299
+ :param str tag: The tag name
300
+ :param str prefix: The prefix
301
+ :param str ns: The namespace
302
+ :return: The XML node
303
+ :rtype: xml.etree.ElementTree.Element
304
+ """
305
+ if prefix and ns:
306
+ ET.register_namespace(prefix, ns)
307
+ if ns:
308
+ return ET.Element("{" + ns + "}" + tag)
309
+ return ET.Element(tag)
310
+
311
+
312
+ class Model:
313
+ """Mixin for all client request body/response body models to support
314
+ serialization and deserialization.
315
+ """
316
+
317
+ _subtype_map: Dict[str, Dict[str, Any]] = {}
318
+ _attribute_map: Dict[str, Dict[str, Any]] = {}
319
+ _validation: Dict[str, Dict[str, Any]] = {}
320
+
321
+ def __init__(self, **kwargs: Any) -> None:
322
+ self.additional_properties: Optional[Dict[str, Any]] = {}
323
+ for k in kwargs: # pylint: disable=consider-using-dict-items
324
+ if k not in self._attribute_map:
325
+ _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__)
326
+ elif k in self._validation and self._validation[k].get("readonly", False):
327
+ _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__)
328
+ else:
329
+ setattr(self, k, kwargs[k])
330
+
331
+ def __eq__(self, other: Any) -> bool:
332
+ """Compare objects by comparing all attributes.
333
+
334
+ :param object other: The object to compare
335
+ :returns: True if objects are equal
336
+ :rtype: bool
337
+ """
338
+ if isinstance(other, self.__class__):
339
+ return self.__dict__ == other.__dict__
340
+ return False
341
+
342
+ def __ne__(self, other: Any) -> bool:
343
+ """Compare objects by comparing all attributes.
344
+
345
+ :param object other: The object to compare
346
+ :returns: True if objects are not equal
347
+ :rtype: bool
348
+ """
349
+ return not self.__eq__(other)
350
+
351
+ def __str__(self) -> str:
352
+ return str(self.__dict__)
353
+
354
+ @classmethod
355
+ def enable_additional_properties_sending(cls) -> None:
356
+ cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"}
357
+
358
+ @classmethod
359
+ def is_xml_model(cls) -> bool:
360
+ try:
361
+ cls._xml_map # type: ignore
362
+ except AttributeError:
363
+ return False
364
+ return True
365
+
366
+ @classmethod
367
+ def _create_xml_node(cls):
368
+ """Create XML node.
369
+
370
+ :returns: The XML node
371
+ :rtype: xml.etree.ElementTree.Element
372
+ """
373
+ try:
374
+ xml_map = cls._xml_map # type: ignore
375
+ except AttributeError:
376
+ xml_map = {}
377
+
378
+ return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None))
379
+
380
+ def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON:
381
+ """Return the JSON that would be sent to server from this model.
382
+
383
+ This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`.
384
+
385
+ If you want XML serialization, you can pass the kwargs is_xml=True.
386
+
387
+ :param bool keep_readonly: If you want to serialize the readonly attributes
388
+ :returns: A dict JSON compatible object
389
+ :rtype: dict
390
+ """
391
+ serializer = Serializer(self._infer_class_models())
392
+ return serializer._serialize( # type: ignore # pylint: disable=protected-access
393
+ self, keep_readonly=keep_readonly, **kwargs
394
+ )
395
+
396
+ def as_dict(
397
+ self,
398
+ keep_readonly: bool = True,
399
+ key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer,
400
+ **kwargs: Any
401
+ ) -> JSON:
402
+ """Return a dict that can be serialized using json.dump.
403
+
404
+ Advanced usage might optionally use a callback as parameter:
405
+
406
+ .. code::python
407
+
408
+ def my_key_transformer(key, attr_desc, value):
409
+ return key
410
+
411
+ Key is the attribute name used in Python. Attr_desc
412
+ is a dict of metadata. Currently contains 'type' with the
413
+ msrest type and 'key' with the RestAPI encoded key.
414
+ Value is the current value in this object.
415
+
416
+ The string returned will be used to serialize the key.
417
+ If the return type is a list, this is considered hierarchical
418
+ result dict.
419
+
420
+ See the three examples in this file:
421
+
422
+ - attribute_transformer
423
+ - full_restapi_key_transformer
424
+ - last_restapi_key_transformer
425
+
426
+ If you want XML serialization, you can pass the kwargs is_xml=True.
427
+
428
+ :param bool keep_readonly: If you want to serialize the readonly attributes
429
+ :param function key_transformer: A key transformer function.
430
+ :returns: A dict JSON compatible object
431
+ :rtype: dict
432
+ """
433
+ serializer = Serializer(self._infer_class_models())
434
+ return serializer._serialize( # type: ignore # pylint: disable=protected-access
435
+ self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs
436
+ )
437
+
438
+ @classmethod
439
+ def _infer_class_models(cls):
440
+ try:
441
+ str_models = cls.__module__.rsplit(".", 1)[0]
442
+ models = sys.modules[str_models]
443
+ client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)}
444
+ if cls.__name__ not in client_models:
445
+ raise ValueError("Not Autorest generated code")
446
+ except Exception: # pylint: disable=broad-exception-caught
447
+ # Assume it's not Autorest generated (tests?). Add ourselves as dependencies.
448
+ client_models = {cls.__name__: cls}
449
+ return client_models
450
+
451
+ @classmethod
452
+ def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = None) -> ModelType:
453
+ """Parse a str using the RestAPI syntax and return a model.
454
+
455
+ :param str data: A str using RestAPI structure. JSON by default.
456
+ :param str content_type: JSON by default, set application/xml if XML.
457
+ :returns: An instance of this model
458
+ :raises: DeserializationError if something went wrong
459
+ :rtype: ModelType
460
+ """
461
+ deserializer = Deserializer(cls._infer_class_models())
462
+ return deserializer(cls.__name__, data, content_type=content_type) # type: ignore
463
+
464
+ @classmethod
465
+ def from_dict(
466
+ cls: Type[ModelType],
467
+ data: Any,
468
+ key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None,
469
+ content_type: Optional[str] = None,
470
+ ) -> ModelType:
471
+ """Parse a dict using given key extractor return a model.
472
+
473
+ By default consider key
474
+ extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor
475
+ and last_rest_key_case_insensitive_extractor)
476
+
477
+ :param dict data: A dict using RestAPI structure
478
+ :param function key_extractors: A key extractor function.
479
+ :param str content_type: JSON by default, set application/xml if XML.
480
+ :returns: An instance of this model
481
+ :raises: DeserializationError if something went wrong
482
+ :rtype: ModelType
483
+ """
484
+ deserializer = Deserializer(cls._infer_class_models())
485
+ deserializer.key_extractors = ( # type: ignore
486
+ [ # type: ignore
487
+ attribute_key_case_insensitive_extractor,
488
+ rest_key_case_insensitive_extractor,
489
+ last_rest_key_case_insensitive_extractor,
490
+ ]
491
+ if key_extractors is None
492
+ else key_extractors
493
+ )
494
+ return deserializer(cls.__name__, data, content_type=content_type) # type: ignore
495
+
496
+ @classmethod
497
+ def _flatten_subtype(cls, key, objects):
498
+ if "_subtype_map" not in cls.__dict__:
499
+ return {}
500
+ result = dict(cls._subtype_map[key])
501
+ for valuetype in cls._subtype_map[key].values():
502
+ result.update(objects[valuetype]._flatten_subtype(key, objects)) # pylint: disable=protected-access
503
+ return result
504
+
505
+ @classmethod
506
+ def _classify(cls, response, objects):
507
+ """Check the class _subtype_map for any child classes.
508
+ We want to ignore any inherited _subtype_maps.
509
+
510
+ :param dict response: The initial data
511
+ :param dict objects: The class objects
512
+ :returns: The class to be used
513
+ :rtype: class
514
+ """
515
+ for subtype_key in cls.__dict__.get("_subtype_map", {}).keys():
516
+ subtype_value = None
517
+
518
+ if not isinstance(response, ET.Element):
519
+ rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1]
520
+ subtype_value = response.get(rest_api_response_key, None) or response.get(subtype_key, None)
521
+ else:
522
+ subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response)
523
+ if subtype_value:
524
+ # Try to match base class. Can be class name only
525
+ # (bug to fix in Autorest to support x-ms-discriminator-name)
526
+ if cls.__name__ == subtype_value:
527
+ return cls
528
+ flatten_mapping_type = cls._flatten_subtype(subtype_key, objects)
529
+ try:
530
+ return objects[flatten_mapping_type[subtype_value]] # type: ignore
531
+ except KeyError:
532
+ _LOGGER.warning(
533
+ "Subtype value %s has no mapping, use base class %s.",
534
+ subtype_value,
535
+ cls.__name__,
536
+ )
537
+ break
538
+ else:
539
+ _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__)
540
+ break
541
+ return cls
542
+
543
+ @classmethod
544
+ def _get_rest_key_parts(cls, attr_key):
545
+ """Get the RestAPI key of this attr, split it and decode part
546
+ :param str attr_key: Attribute key must be in attribute_map.
547
+ :returns: A list of RestAPI part
548
+ :rtype: list
549
+ """
550
+ rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"])
551
+ return [_decode_attribute_map_key(key_part) for key_part in rest_split_key]
552
+
553
+
554
+ def _decode_attribute_map_key(key):
555
+ """This decode a key in an _attribute_map to the actual key we want to look at
556
+ inside the received data.
557
+
558
+ :param str key: A key string from the generated code
559
+ :returns: The decoded key
560
+ :rtype: str
561
+ """
562
+ return key.replace("\\.", ".")
563
+
564
+
565
+ class Serializer: # pylint: disable=too-many-public-methods
566
+ """Request object model serializer."""
567
+
568
+ basic_types = {str: "str", int: "int", bool: "bool", float: "float"}
569
+
570
+ _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()}
571
+ days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"}
572
+ months = {
573
+ 1: "Jan",
574
+ 2: "Feb",
575
+ 3: "Mar",
576
+ 4: "Apr",
577
+ 5: "May",
578
+ 6: "Jun",
579
+ 7: "Jul",
580
+ 8: "Aug",
581
+ 9: "Sep",
582
+ 10: "Oct",
583
+ 11: "Nov",
584
+ 12: "Dec",
585
+ }
586
+ validation = {
587
+ "min_length": lambda x, y: len(x) < y,
588
+ "max_length": lambda x, y: len(x) > y,
589
+ "minimum": lambda x, y: x < y,
590
+ "maximum": lambda x, y: x > y,
591
+ "minimum_ex": lambda x, y: x <= y,
592
+ "maximum_ex": lambda x, y: x >= y,
593
+ "min_items": lambda x, y: len(x) < y,
594
+ "max_items": lambda x, y: len(x) > y,
595
+ "pattern": lambda x, y: not re.match(y, x, re.UNICODE),
596
+ "unique": lambda x, y: len(x) != len(set(x)),
597
+ "multiple": lambda x, y: x % y != 0,
598
+ }
599
+
600
+ def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None:
601
+ self.serialize_type = {
602
+ "iso-8601": Serializer.serialize_iso,
603
+ "rfc-1123": Serializer.serialize_rfc,
604
+ "unix-time": Serializer.serialize_unix,
605
+ "duration": Serializer.serialize_duration,
606
+ "date": Serializer.serialize_date,
607
+ "time": Serializer.serialize_time,
608
+ "decimal": Serializer.serialize_decimal,
609
+ "long": Serializer.serialize_long,
610
+ "bytearray": Serializer.serialize_bytearray,
611
+ "base64": Serializer.serialize_base64,
612
+ "object": self.serialize_object,
613
+ "[]": self.serialize_iter,
614
+ "{}": self.serialize_dict,
615
+ }
616
+ self.dependencies: Dict[str, type] = dict(classes) if classes else {}
617
+ self.key_transformer = full_restapi_key_transformer
618
+ self.client_side_validation = True
619
+
620
+ def _serialize( # pylint: disable=too-many-nested-blocks, too-many-branches, too-many-statements, too-many-locals
621
+ self, target_obj, data_type=None, **kwargs
622
+ ):
623
+ """Serialize data into a string according to type.
624
+
625
+ :param object target_obj: The data to be serialized.
626
+ :param str data_type: The type to be serialized from.
627
+ :rtype: str, dict
628
+ :raises: SerializationError if serialization fails.
629
+ :returns: The serialized data.
630
+ """
631
+ key_transformer = kwargs.get("key_transformer", self.key_transformer)
632
+ keep_readonly = kwargs.get("keep_readonly", False)
633
+ if target_obj is None:
634
+ return None
635
+
636
+ attr_name = None
637
+ class_name = target_obj.__class__.__name__
638
+
639
+ if data_type:
640
+ return self.serialize_data(target_obj, data_type, **kwargs)
641
+
642
+ if not hasattr(target_obj, "_attribute_map"):
643
+ data_type = type(target_obj).__name__
644
+ if data_type in self.basic_types.values():
645
+ return self.serialize_data(target_obj, data_type, **kwargs)
646
+
647
+ # Force "is_xml" kwargs if we detect a XML model
648
+ try:
649
+ is_xml_model_serialization = kwargs["is_xml"]
650
+ except KeyError:
651
+ is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model())
652
+
653
+ serialized = {}
654
+ if is_xml_model_serialization:
655
+ serialized = target_obj._create_xml_node() # pylint: disable=protected-access
656
+ try:
657
+ attributes = target_obj._attribute_map # pylint: disable=protected-access
658
+ for attr, attr_desc in attributes.items():
659
+ attr_name = attr
660
+ if not keep_readonly and target_obj._validation.get( # pylint: disable=protected-access
661
+ attr_name, {}
662
+ ).get("readonly", False):
663
+ continue
664
+
665
+ if attr_name == "additional_properties" and attr_desc["key"] == "":
666
+ if target_obj.additional_properties is not None:
667
+ serialized.update(target_obj.additional_properties)
668
+ continue
669
+ try:
670
+
671
+ orig_attr = getattr(target_obj, attr)
672
+ if is_xml_model_serialization:
673
+ pass # Don't provide "transformer" for XML for now. Keep "orig_attr"
674
+ else: # JSON
675
+ keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr)
676
+ keys = keys if isinstance(keys, list) else [keys]
677
+
678
+ kwargs["serialization_ctxt"] = attr_desc
679
+ new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs)
680
+
681
+ if is_xml_model_serialization:
682
+ xml_desc = attr_desc.get("xml", {})
683
+ xml_name = xml_desc.get("name", attr_desc["key"])
684
+ xml_prefix = xml_desc.get("prefix", None)
685
+ xml_ns = xml_desc.get("ns", None)
686
+ if xml_desc.get("attr", False):
687
+ if xml_ns:
688
+ ET.register_namespace(xml_prefix, xml_ns)
689
+ xml_name = "{% raw %}{{{}}}{}{% endraw %}".format(xml_ns, xml_name)
690
+ serialized.set(xml_name, new_attr) # type: ignore
691
+ continue
692
+ if xml_desc.get("text", False):
693
+ serialized.text = new_attr # type: ignore
694
+ continue
695
+ if isinstance(new_attr, list):
696
+ serialized.extend(new_attr) # type: ignore
697
+ elif isinstance(new_attr, ET.Element):
698
+ # If the down XML has no XML/Name,
699
+ # we MUST replace the tag with the local tag. But keeping the namespaces.
700
+ if "name" not in getattr(orig_attr, "_xml_map", {}):
701
+ splitted_tag = new_attr.tag.split("}")
702
+ if len(splitted_tag) == 2: # Namespace
703
+ new_attr.tag = "}".join([splitted_tag[0], xml_name])
704
+ else:
705
+ new_attr.tag = xml_name
706
+ serialized.append(new_attr) # type: ignore
707
+ else: # That's a basic type
708
+ # Integrate namespace if necessary
709
+ local_node = _create_xml_node(xml_name, xml_prefix, xml_ns)
710
+ local_node.text = str(new_attr)
711
+ serialized.append(local_node) # type: ignore
712
+ else: # JSON
713
+ for k in reversed(keys): # type: ignore
714
+ new_attr = {k: new_attr}
715
+
716
+ _new_attr = new_attr
717
+ _serialized = serialized
718
+ for k in keys: # type: ignore
719
+ if k not in _serialized:
720
+ _serialized.update(_new_attr) # type: ignore
721
+ _new_attr = _new_attr[k] # type: ignore
722
+ _serialized = _serialized[k]
723
+ except ValueError as err:
724
+ if isinstance(err, SerializationError):
725
+ raise
726
+
727
+ except (AttributeError, KeyError, TypeError) as err:
728
+ msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj))
729
+ raise SerializationError(msg) from err
730
+ return serialized
731
+
732
+ def body(self, data, data_type, **kwargs):
733
+ """Serialize data intended for a request body.
734
+
735
+ :param object data: The data to be serialized.
736
+ :param str data_type: The type to be serialized from.
737
+ :rtype: dict
738
+ :raises: SerializationError if serialization fails.
739
+ :raises: ValueError if data is None
740
+ :returns: The serialized request body
741
+ """
742
+
743
+ # Just in case this is a dict
744
+ internal_data_type_str = data_type.strip("[]{}")
745
+ internal_data_type = self.dependencies.get(internal_data_type_str, None)
746
+ try:
747
+ is_xml_model_serialization = kwargs["is_xml"]
748
+ except KeyError:
749
+ if internal_data_type and issubclass(internal_data_type, Model):
750
+ is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model())
751
+ else:
752
+ is_xml_model_serialization = False
753
+ if internal_data_type and not isinstance(internal_data_type, Enum):
754
+ try:
755
+ deserializer = Deserializer(self.dependencies)
756
+ # Since it's on serialization, it's almost sure that format is not JSON REST
757
+ # We're not able to deal with additional properties for now.
758
+ deserializer.additional_properties_detection = False
759
+ if is_xml_model_serialization:
760
+ deserializer.key_extractors = [ # type: ignore
761
+ attribute_key_case_insensitive_extractor,
762
+ ]
763
+ else:
764
+ deserializer.key_extractors = [
765
+ rest_key_case_insensitive_extractor,
766
+ attribute_key_case_insensitive_extractor,
767
+ last_rest_key_case_insensitive_extractor,
768
+ ]
769
+ data = deserializer._deserialize(data_type, data) # pylint: disable=protected-access
770
+ except DeserializationError as err:
771
+ raise SerializationError("Unable to build a model: " + str(err)) from err
772
+
773
+ return self._serialize(data, data_type, **kwargs)
774
+
775
+ def url(self, name, data, data_type, **kwargs):
776
+ """Serialize data intended for a URL path.
777
+
778
+ :param str name: The name of the URL path parameter.
779
+ :param object data: The data to be serialized.
780
+ :param str data_type: The type to be serialized from.
781
+ :rtype: str
782
+ :returns: The serialized URL path
783
+ :raises: TypeError if serialization fails.
784
+ :raises: ValueError if data is None
785
+ """
786
+ try:
787
+ output = self.serialize_data(data, data_type, **kwargs)
788
+ if data_type == "bool":
789
+ output = json.dumps(output)
790
+
791
+ if kwargs.get("skip_quote") is True:
792
+ output = str(output)
793
+ output = output.replace("{", quote("{")).replace("}", quote("}"))
794
+ else:
795
+ output = quote(str(output), safe="")
796
+ except SerializationError as exc:
797
+ raise TypeError("{} must be type {}.".format(name, data_type)) from exc
798
+ return output
799
+
800
+ def query(self, name, data, data_type, **kwargs):
801
+ """Serialize data intended for a URL query.
802
+
803
+ :param str name: The name of the query parameter.
804
+ :param object data: The data to be serialized.
805
+ :param str data_type: The type to be serialized from.
806
+ :rtype: str, list
807
+ :raises: TypeError if serialization fails.
808
+ :raises: ValueError if data is None
809
+ :returns: The serialized query parameter
810
+ """
811
+ try:
812
+ # Treat the list aside, since we don't want to encode the div separator
813
+ if data_type.startswith("["):
814
+ internal_data_type = data_type[1:-1]
815
+ do_quote = not kwargs.get("skip_quote", False)
816
+ return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs)
817
+
818
+ # Not a list, regular serialization
819
+ output = self.serialize_data(data, data_type, **kwargs)
820
+ if data_type == "bool":
821
+ output = json.dumps(output)
822
+ if kwargs.get("skip_quote") is True:
823
+ output = str(output)
824
+ else:
825
+ output = quote(str(output), safe="")
826
+ except SerializationError as exc:
827
+ raise TypeError("{} must be type {}.".format(name, data_type)) from exc
828
+ return str(output)
829
+
830
+ def header(self, name, data, data_type, **kwargs):
831
+ """Serialize data intended for a request header.
832
+
833
+ :param str name: The name of the header.
834
+ :param object data: The data to be serialized.
835
+ :param str data_type: The type to be serialized from.
836
+ :rtype: str
837
+ :raises: TypeError if serialization fails.
838
+ :raises: ValueError if data is None
839
+ :returns: The serialized header
840
+ """
841
+ try:
842
+ if data_type in ["[str]"]:
843
+ data = ["" if d is None else d for d in data]
844
+
845
+ output = self.serialize_data(data, data_type, **kwargs)
846
+ if data_type == "bool":
847
+ output = json.dumps(output)
848
+ except SerializationError as exc:
849
+ raise TypeError("{} must be type {}.".format(name, data_type)) from exc
850
+ return str(output)
851
+
852
+ def serialize_data(self, data, data_type, **kwargs):
853
+ """Serialize generic data according to supplied data type.
854
+
855
+ :param object data: The data to be serialized.
856
+ :param str data_type: The type to be serialized from.
857
+ :raises: AttributeError if required data is None.
858
+ :raises: ValueError if data is None
859
+ :raises: SerializationError if serialization fails.
860
+ :returns: The serialized data.
861
+ :rtype: str, int, float, bool, dict, list
862
+ """
863
+ if data is None:
864
+ raise ValueError("No value for given attribute")
865
+
866
+ try:
867
+ if data is CoreNull:
868
+ return None
869
+ if data_type in self.basic_types.values():
870
+ return self.serialize_basic(data, data_type, **kwargs)
871
+
872
+ if data_type in self.serialize_type:
873
+ return self.serialize_type[data_type](data, **kwargs)
874
+
875
+ # If dependencies is empty, try with current data class
876
+ # It has to be a subclass of Enum anyway
877
+ enum_type = self.dependencies.get(data_type, data.__class__)
878
+ if issubclass(enum_type, Enum):
879
+ return Serializer.serialize_enum(data, enum_obj=enum_type)
880
+
881
+ iter_type = data_type[0] + data_type[-1]
882
+ if iter_type in self.serialize_type:
883
+ return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs)
884
+
885
+ except (ValueError, TypeError) as err:
886
+ msg = "Unable to serialize value: {!r} as type: {!r}."
887
+ raise SerializationError(msg.format(data, data_type)) from err
888
+ return self._serialize(data, **kwargs)
889
+
890
+ @classmethod
891
+ def _get_custom_serializers(cls, data_type, **kwargs): # pylint: disable=inconsistent-return-statements
892
+ custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type)
893
+ if custom_serializer:
894
+ return custom_serializer
895
+ if kwargs.get("is_xml", False):
896
+ return cls._xml_basic_types_serializers.get(data_type)
897
+
898
+ @classmethod
899
+ def serialize_basic(cls, data, data_type, **kwargs):
900
+ """Serialize basic builting data type.
901
+ Serializes objects to str, int, float or bool.
902
+
903
+ Possible kwargs:
904
+ - basic_types_serializers dict[str, callable] : If set, use the callable as serializer
905
+ - is_xml bool : If set, use xml_basic_types_serializers
906
+
907
+ :param obj data: Object to be serialized.
908
+ :param str data_type: Type of object in the iterable.
909
+ :rtype: str, int, float, bool
910
+ :return: serialized object
911
+ """
912
+ custom_serializer = cls._get_custom_serializers(data_type, **kwargs)
913
+ if custom_serializer:
914
+ return custom_serializer(data)
915
+ if data_type == "str":
916
+ return cls.serialize_unicode(data)
917
+ return eval(data_type)(data) # nosec # pylint: disable=eval-used
918
+
919
+ @classmethod
920
+ def serialize_unicode(cls, data):
921
+ """Special handling for serializing unicode strings in Py2.
922
+ Encode to UTF-8 if unicode, otherwise handle as a str.
923
+
924
+ :param str data: Object to be serialized.
925
+ :rtype: str
926
+ :return: serialized object
927
+ """
928
+ try: # If I received an enum, return its value
929
+ return data.value
930
+ except AttributeError:
931
+ pass
932
+
933
+ try:
934
+ if isinstance(data, unicode): # type: ignore
935
+ # Don't change it, JSON and XML ElementTree are totally able
936
+ # to serialize correctly u'' strings
937
+ return data
938
+ except NameError:
939
+ return str(data)
940
+ return str(data)
941
+
942
+ def serialize_iter(self, data, iter_type, div=None, **kwargs):
943
+ """Serialize iterable.
944
+
945
+ Supported kwargs:
946
+ - serialization_ctxt dict : The current entry of _attribute_map, or same format.
947
+ serialization_ctxt['type'] should be same as data_type.
948
+ - is_xml bool : If set, serialize as XML
949
+
950
+ :param list data: Object to be serialized.
951
+ :param str iter_type: Type of object in the iterable.
952
+ :param str div: If set, this str will be used to combine the elements
953
+ in the iterable into a combined string. Default is 'None'.
954
+ Defaults to False.
955
+ :rtype: list, str
956
+ :return: serialized iterable
957
+ """
958
+ if isinstance(data, str):
959
+ raise SerializationError("Refuse str type as a valid iter type.")
960
+
961
+ serialization_ctxt = kwargs.get("serialization_ctxt", {})
962
+ is_xml = kwargs.get("is_xml", False)
963
+
964
+ serialized = []
965
+ for d in data:
966
+ try:
967
+ serialized.append(self.serialize_data(d, iter_type, **kwargs))
968
+ except ValueError as err:
969
+ if isinstance(err, SerializationError):
970
+ raise
971
+ serialized.append(None)
972
+
973
+ if kwargs.get("do_quote", False):
974
+ serialized = ["" if s is None else quote(str(s), safe="") for s in serialized]
975
+
976
+ if div:
977
+ serialized = ["" if s is None else str(s) for s in serialized]
978
+ serialized = div.join(serialized)
979
+
980
+ if "xml" in serialization_ctxt or is_xml:
981
+ # XML serialization is more complicated
982
+ xml_desc = serialization_ctxt.get("xml", {})
983
+ xml_name = xml_desc.get("name")
984
+ if not xml_name:
985
+ xml_name = serialization_ctxt["key"]
986
+
987
+ # Create a wrap node if necessary (use the fact that Element and list have "append")
988
+ is_wrapped = xml_desc.get("wrapped", False)
989
+ node_name = xml_desc.get("itemsName", xml_name)
990
+ if is_wrapped:
991
+ final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None))
992
+ else:
993
+ final_result = []
994
+ # All list elements to "local_node"
995
+ for el in serialized:
996
+ if isinstance(el, ET.Element):
997
+ el_node = el
998
+ else:
999
+ el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None))
1000
+ if el is not None: # Otherwise it writes "None" :-p
1001
+ el_node.text = str(el)
1002
+ final_result.append(el_node)
1003
+ return final_result
1004
+ return serialized
1005
+
1006
+ def serialize_dict(self, attr, dict_type, **kwargs):
1007
+ """Serialize a dictionary of objects.
1008
+
1009
+ :param dict attr: Object to be serialized.
1010
+ :param str dict_type: Type of object in the dictionary.
1011
+ :rtype: dict
1012
+ :return: serialized dictionary
1013
+ """
1014
+ serialization_ctxt = kwargs.get("serialization_ctxt", {})
1015
+ serialized = {}
1016
+ for key, value in attr.items():
1017
+ try:
1018
+ serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs)
1019
+ except ValueError as err:
1020
+ if isinstance(err, SerializationError):
1021
+ raise
1022
+ serialized[self.serialize_unicode(key)] = None
1023
+
1024
+ if "xml" in serialization_ctxt:
1025
+ # XML serialization is more complicated
1026
+ xml_desc = serialization_ctxt["xml"]
1027
+ xml_name = xml_desc["name"]
1028
+
1029
+ final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None))
1030
+ for key, value in serialized.items():
1031
+ ET.SubElement(final_result, key).text = value
1032
+ return final_result
1033
+
1034
+ return serialized
1035
+
1036
+ def serialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements
1037
+ """Serialize a generic object.
1038
+ This will be handled as a dictionary. If object passed in is not
1039
+ a basic type (str, int, float, dict, list) it will simply be
1040
+ cast to str.
1041
+
1042
+ :param dict attr: Object to be serialized.
1043
+ :rtype: dict or str
1044
+ :return: serialized object
1045
+ """
1046
+ if attr is None:
1047
+ return None
1048
+ if isinstance(attr, ET.Element):
1049
+ return attr
1050
+ obj_type = type(attr)
1051
+ if obj_type in self.basic_types:
1052
+ return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs)
1053
+ if obj_type is _long_type:
1054
+ return self.serialize_long(attr)
1055
+ if obj_type is str:
1056
+ return self.serialize_unicode(attr)
1057
+ if obj_type is datetime.datetime:
1058
+ return self.serialize_iso(attr)
1059
+ if obj_type is datetime.date:
1060
+ return self.serialize_date(attr)
1061
+ if obj_type is datetime.time:
1062
+ return self.serialize_time(attr)
1063
+ if obj_type is datetime.timedelta:
1064
+ return self.serialize_duration(attr)
1065
+ if obj_type is decimal.Decimal:
1066
+ return self.serialize_decimal(attr)
1067
+
1068
+ # If it's a model or I know this dependency, serialize as a Model
1069
+ if obj_type in self.dependencies.values() or isinstance(attr, Model):
1070
+ return self._serialize(attr)
1071
+
1072
+ if obj_type == dict:
1073
+ serialized = {}
1074
+ for key, value in attr.items():
1075
+ try:
1076
+ serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs)
1077
+ except ValueError:
1078
+ serialized[self.serialize_unicode(key)] = None
1079
+ return serialized
1080
+
1081
+ if obj_type == list:
1082
+ serialized = []
1083
+ for obj in attr:
1084
+ try:
1085
+ serialized.append(self.serialize_object(obj, **kwargs))
1086
+ except ValueError:
1087
+ pass
1088
+ return serialized
1089
+ return str(attr)
1090
+
1091
+ @staticmethod
1092
+ def serialize_enum(attr, enum_obj=None):
1093
+ try:
1094
+ result = attr.value
1095
+ except AttributeError:
1096
+ result = attr
1097
+ try:
1098
+ enum_obj(result) # type: ignore
1099
+ return result
1100
+ except ValueError as exc:
1101
+ for enum_value in enum_obj: # type: ignore
1102
+ if enum_value.value.lower() == str(attr).lower():
1103
+ return enum_value.value
1104
+ error = "{!r} is not valid value for enum {!r}"
1105
+ raise SerializationError(error.format(attr, enum_obj)) from exc
1106
+
1107
+ @staticmethod
1108
+ def serialize_bytearray(attr, **kwargs): # pylint: disable=unused-argument
1109
+ """Serialize bytearray into base-64 string.
1110
+
1111
+ :param str attr: Object to be serialized.
1112
+ :rtype: str
1113
+ :return: serialized base64
1114
+ """
1115
+ return b64encode(attr).decode()
1116
+
1117
+ @staticmethod
1118
+ def serialize_base64(attr, **kwargs): # pylint: disable=unused-argument
1119
+ """Serialize str into base-64 string.
1120
+
1121
+ :param str attr: Object to be serialized.
1122
+ :rtype: str
1123
+ :return: serialized base64
1124
+ """
1125
+ encoded = b64encode(attr).decode("ascii")
1126
+ return encoded.strip("=").replace("+", "-").replace("/", "_")
1127
+
1128
+ @staticmethod
1129
+ def serialize_decimal(attr, **kwargs): # pylint: disable=unused-argument
1130
+ """Serialize Decimal object to float.
1131
+
1132
+ :param decimal attr: Object to be serialized.
1133
+ :rtype: float
1134
+ :return: serialized decimal
1135
+ """
1136
+ return float(attr)
1137
+
1138
+ @staticmethod
1139
+ def serialize_long(attr, **kwargs): # pylint: disable=unused-argument
1140
+ """Serialize long (Py2) or int (Py3).
1141
+
1142
+ :param int attr: Object to be serialized.
1143
+ :rtype: int/long
1144
+ :return: serialized long
1145
+ """
1146
+ return _long_type(attr)
1147
+
1148
+ @staticmethod
1149
+ def serialize_date(attr, **kwargs): # pylint: disable=unused-argument
1150
+ """Serialize Date object into ISO-8601 formatted string.
1151
+
1152
+ :param Date attr: Object to be serialized.
1153
+ :rtype: str
1154
+ :return: serialized date
1155
+ """
1156
+ if isinstance(attr, str):
1157
+ attr = isodate.parse_date(attr)
1158
+ t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day)
1159
+ return t
1160
+
1161
+ @staticmethod
1162
+ def serialize_time(attr, **kwargs): # pylint: disable=unused-argument
1163
+ """Serialize Time object into ISO-8601 formatted string.
1164
+
1165
+ :param datetime.time attr: Object to be serialized.
1166
+ :rtype: str
1167
+ :return: serialized time
1168
+ """
1169
+ if isinstance(attr, str):
1170
+ attr = isodate.parse_time(attr)
1171
+ t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second)
1172
+ if attr.microsecond:
1173
+ t += ".{:02}".format(attr.microsecond)
1174
+ return t
1175
+
1176
+ @staticmethod
1177
+ def serialize_duration(attr, **kwargs): # pylint: disable=unused-argument
1178
+ """Serialize TimeDelta object into ISO-8601 formatted string.
1179
+
1180
+ :param TimeDelta attr: Object to be serialized.
1181
+ :rtype: str
1182
+ :return: serialized duration
1183
+ """
1184
+ if isinstance(attr, str):
1185
+ attr = isodate.parse_duration(attr)
1186
+ return isodate.duration_isoformat(attr)
1187
+
1188
+ @staticmethod
1189
+ def serialize_rfc(attr, **kwargs): # pylint: disable=unused-argument
1190
+ """Serialize Datetime object into RFC-1123 formatted string.
1191
+
1192
+ :param Datetime attr: Object to be serialized.
1193
+ :rtype: str
1194
+ :raises: TypeError if format invalid.
1195
+ :return: serialized rfc
1196
+ """
1197
+ try:
1198
+ if not attr.tzinfo:
1199
+ _LOGGER.warning("Datetime with no tzinfo will be considered UTC.")
1200
+ utc = attr.utctimetuple()
1201
+ except AttributeError as exc:
1202
+ raise TypeError("RFC1123 object must be valid Datetime object.") from exc
1203
+
1204
+ return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format(
1205
+ Serializer.days[utc.tm_wday],
1206
+ utc.tm_mday,
1207
+ Serializer.months[utc.tm_mon],
1208
+ utc.tm_year,
1209
+ utc.tm_hour,
1210
+ utc.tm_min,
1211
+ utc.tm_sec,
1212
+ )
1213
+
1214
+ @staticmethod
1215
+ def serialize_iso(attr, **kwargs): # pylint: disable=unused-argument
1216
+ """Serialize Datetime object into ISO-8601 formatted string.
1217
+
1218
+ :param Datetime attr: Object to be serialized.
1219
+ :rtype: str
1220
+ :raises: SerializationError if format invalid.
1221
+ :return: serialized iso
1222
+ """
1223
+ if isinstance(attr, str):
1224
+ attr = isodate.parse_datetime(attr)
1225
+ try:
1226
+ if not attr.tzinfo:
1227
+ _LOGGER.warning("Datetime with no tzinfo will be considered UTC.")
1228
+ utc = attr.utctimetuple()
1229
+ if utc.tm_year > 9999 or utc.tm_year < 1:
1230
+ raise OverflowError("Hit max or min date")
1231
+
1232
+ microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0")
1233
+ if microseconds:
1234
+ microseconds = "." + microseconds
1235
+ date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format(
1236
+ utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec
1237
+ )
1238
+ return date + microseconds + "Z"
1239
+ except (ValueError, OverflowError) as err:
1240
+ msg = "Unable to serialize datetime object."
1241
+ raise SerializationError(msg) from err
1242
+ except AttributeError as err:
1243
+ msg = "ISO-8601 object must be valid Datetime object."
1244
+ raise TypeError(msg) from err
1245
+
1246
+ @staticmethod
1247
+ def serialize_unix(attr, **kwargs): # pylint: disable=unused-argument
1248
+ """Serialize Datetime object into IntTime format.
1249
+ This is represented as seconds.
1250
+
1251
+ :param Datetime attr: Object to be serialized.
1252
+ :rtype: int
1253
+ :raises: SerializationError if format invalid
1254
+ :return: serialied unix
1255
+ """
1256
+ if isinstance(attr, int):
1257
+ return attr
1258
+ try:
1259
+ if not attr.tzinfo:
1260
+ _LOGGER.warning("Datetime with no tzinfo will be considered UTC.")
1261
+ return int(calendar.timegm(attr.utctimetuple()))
1262
+ except AttributeError as exc:
1263
+ raise TypeError("Unix time object must be valid Datetime object.") from exc
1264
+
1265
+
1266
+ def rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument
1267
+ key = attr_desc["key"]
1268
+ working_data = data
1269
+
1270
+ while "." in key:
1271
+ # Need the cast, as for some reasons "split" is typed as list[str | Any]
1272
+ dict_keys = cast(List[str], _FLATTEN.split(key))
1273
+ if len(dict_keys) == 1:
1274
+ key = _decode_attribute_map_key(dict_keys[0])
1275
+ break
1276
+ working_key = _decode_attribute_map_key(dict_keys[0])
1277
+ working_data = working_data.get(working_key, data)
1278
+ if working_data is None:
1279
+ # If at any point while following flatten JSON path see None, it means
1280
+ # that all properties under are None as well
1281
+ return None
1282
+ key = ".".join(dict_keys[1:])
1283
+
1284
+ return working_data.get(key)
1285
+
1286
+
1287
+ def rest_key_case_insensitive_extractor( # pylint: disable=unused-argument, inconsistent-return-statements
1288
+ attr, attr_desc, data
1289
+ ):
1290
+ key = attr_desc["key"]
1291
+ working_data = data
1292
+
1293
+ while "." in key:
1294
+ dict_keys = _FLATTEN.split(key)
1295
+ if len(dict_keys) == 1:
1296
+ key = _decode_attribute_map_key(dict_keys[0])
1297
+ break
1298
+ working_key = _decode_attribute_map_key(dict_keys[0])
1299
+ working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data)
1300
+ if working_data is None:
1301
+ # If at any point while following flatten JSON path see None, it means
1302
+ # that all properties under are None as well
1303
+ return None
1304
+ key = ".".join(dict_keys[1:])
1305
+
1306
+ if working_data:
1307
+ return attribute_key_case_insensitive_extractor(key, None, working_data)
1308
+
1309
+
1310
+ def last_rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument
1311
+ """Extract the attribute in "data" based on the last part of the JSON path key.
1312
+
1313
+ :param str attr: The attribute to extract
1314
+ :param dict attr_desc: The attribute description
1315
+ :param dict data: The data to extract from
1316
+ :rtype: object
1317
+ :returns: The extracted attribute
1318
+ """
1319
+ key = attr_desc["key"]
1320
+ dict_keys = _FLATTEN.split(key)
1321
+ return attribute_key_extractor(dict_keys[-1], None, data)
1322
+
1323
+
1324
+ def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): # pylint: disable=unused-argument
1325
+ """Extract the attribute in "data" based on the last part of the JSON path key.
1326
+
1327
+ This is the case insensitive version of "last_rest_key_extractor"
1328
+ :param str attr: The attribute to extract
1329
+ :param dict attr_desc: The attribute description
1330
+ :param dict data: The data to extract from
1331
+ :rtype: object
1332
+ :returns: The extracted attribute
1333
+ """
1334
+ key = attr_desc["key"]
1335
+ dict_keys = _FLATTEN.split(key)
1336
+ return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data)
1337
+
1338
+
1339
+ def attribute_key_extractor(attr, _, data):
1340
+ return data.get(attr)
1341
+
1342
+
1343
+ def attribute_key_case_insensitive_extractor(attr, _, data):
1344
+ found_key = None
1345
+ lower_attr = attr.lower()
1346
+ for key in data:
1347
+ if lower_attr == key.lower():
1348
+ found_key = key
1349
+ break
1350
+
1351
+ return data.get(found_key)
1352
+
1353
+
1354
+ def _extract_name_from_internal_type(internal_type):
1355
+ """Given an internal type XML description, extract correct XML name with namespace.
1356
+
1357
+ :param dict internal_type: An model type
1358
+ :rtype: tuple
1359
+ :returns: A tuple XML name + namespace dict
1360
+ """
1361
+ internal_type_xml_map = getattr(internal_type, "_xml_map", {})
1362
+ xml_name = internal_type_xml_map.get("name", internal_type.__name__)
1363
+ xml_ns = internal_type_xml_map.get("ns", None)
1364
+ if xml_ns:
1365
+ xml_name = "{% raw %}{{{}}}{}{% endraw %}".format(xml_ns, xml_name)
1366
+ return xml_name
1367
+
1368
+
1369
+ def xml_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument,too-many-return-statements
1370
+ if isinstance(data, dict):
1371
+ return None
1372
+
1373
+ # Test if this model is XML ready first
1374
+ if not isinstance(data, ET.Element):
1375
+ return None
1376
+
1377
+ xml_desc = attr_desc.get("xml", {})
1378
+ xml_name = xml_desc.get("name", attr_desc["key"])
1379
+
1380
+ # Look for a children
1381
+ is_iter_type = attr_desc["type"].startswith("[")
1382
+ is_wrapped = xml_desc.get("wrapped", False)
1383
+ internal_type = attr_desc.get("internalType", None)
1384
+ internal_type_xml_map = getattr(internal_type, "_xml_map", {})
1385
+
1386
+ # Integrate namespace if necessary
1387
+ xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None))
1388
+ if xml_ns:
1389
+ xml_name = "{% raw %}{{{}}}{}{% endraw %}".format(xml_ns, xml_name)
1390
+
1391
+ # If it's an attribute, that's simple
1392
+ if xml_desc.get("attr", False):
1393
+ return data.get(xml_name)
1394
+
1395
+ # If it's x-ms-text, that's simple too
1396
+ if xml_desc.get("text", False):
1397
+ return data.text
1398
+
1399
+ # Scenario where I take the local name:
1400
+ # - Wrapped node
1401
+ # - Internal type is an enum (considered basic types)
1402
+ # - Internal type has no XML/Name node
1403
+ if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)):
1404
+ children = data.findall(xml_name)
1405
+ # If internal type has a local name and it's not a list, I use that name
1406
+ elif not is_iter_type and internal_type and "name" in internal_type_xml_map:
1407
+ xml_name = _extract_name_from_internal_type(internal_type)
1408
+ children = data.findall(xml_name)
1409
+ # That's an array
1410
+ else:
1411
+ if internal_type: # Complex type, ignore itemsName and use the complex type name
1412
+ items_name = _extract_name_from_internal_type(internal_type)
1413
+ else:
1414
+ items_name = xml_desc.get("itemsName", xml_name)
1415
+ children = data.findall(items_name)
1416
+
1417
+ if len(children) == 0:
1418
+ if is_iter_type:
1419
+ if is_wrapped:
1420
+ return None # is_wrapped no node, we want None
1421
+ return [] # not wrapped, assume empty list
1422
+ return None # Assume it's not there, maybe an optional node.
1423
+
1424
+ # If is_iter_type and not wrapped, return all found children
1425
+ if is_iter_type:
1426
+ if not is_wrapped:
1427
+ return children
1428
+ # Iter and wrapped, should have found one node only (the wrap one)
1429
+ if len(children) != 1:
1430
+ raise DeserializationError(
1431
+ "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( # pylint: disable=line-too-long
1432
+ xml_name
1433
+ )
1434
+ )
1435
+ return list(children[0]) # Might be empty list and that's ok.
1436
+
1437
+ # Here it's not a itertype, we should have found one element only or empty
1438
+ if len(children) > 1:
1439
+ raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name))
1440
+ return children[0]
1441
+
1442
+
1443
+ class Deserializer:
1444
+ """Response object model deserializer.
1445
+
1446
+ :param dict classes: Class type dictionary for deserializing complex types.
1447
+ :ivar list key_extractors: Ordered list of extractors to be used by this deserializer.
1448
+ """
1449
+
1450
+ basic_types = {str: "str", int: "int", bool: "bool", float: "float"}
1451
+
1452
+ valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?")
1453
+
1454
+ def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None:
1455
+ self.deserialize_type = {
1456
+ "iso-8601": Deserializer.deserialize_iso,
1457
+ "rfc-1123": Deserializer.deserialize_rfc,
1458
+ "unix-time": Deserializer.deserialize_unix,
1459
+ "duration": Deserializer.deserialize_duration,
1460
+ "date": Deserializer.deserialize_date,
1461
+ "time": Deserializer.deserialize_time,
1462
+ "decimal": Deserializer.deserialize_decimal,
1463
+ "long": Deserializer.deserialize_long,
1464
+ "bytearray": Deserializer.deserialize_bytearray,
1465
+ "base64": Deserializer.deserialize_base64,
1466
+ "object": self.deserialize_object,
1467
+ "[]": self.deserialize_iter,
1468
+ "{}": self.deserialize_dict,
1469
+ }
1470
+ self.deserialize_expected_types = {
1471
+ "duration": (isodate.Duration, datetime.timedelta),
1472
+ "iso-8601": (datetime.datetime),
1473
+ }
1474
+ self.dependencies: Dict[str, type] = dict(classes) if classes else {}
1475
+ self.key_extractors = [rest_key_extractor, xml_key_extractor]
1476
+ # Additional properties only works if the "rest_key_extractor" is used to
1477
+ # extract the keys. Making it to work whatever the key extractor is too much
1478
+ # complicated, with no real scenario for now.
1479
+ # So adding a flag to disable additional properties detection. This flag should be
1480
+ # used if your expect the deserialization to NOT come from a JSON REST syntax.
1481
+ # Otherwise, result are unexpected
1482
+ self.additional_properties_detection = True
1483
+
1484
+ def __call__(self, target_obj, response_data, content_type=None):
1485
+ """Call the deserializer to process a REST response.
1486
+
1487
+ :param str target_obj: Target data type to deserialize to.
1488
+ :param requests.Response response_data: REST response object.
1489
+ :param str content_type: Swagger "produces" if available.
1490
+ :raises: DeserializationError if deserialization fails.
1491
+ :return: Deserialized object.
1492
+ :rtype: object
1493
+ """
1494
+ data = self._unpack_content(response_data, content_type)
1495
+ return self._deserialize(target_obj, data)
1496
+
1497
+ def _deserialize(self, target_obj, data): # pylint: disable=inconsistent-return-statements
1498
+ """Call the deserializer on a model.
1499
+
1500
+ Data needs to be already deserialized as JSON or XML ElementTree
1501
+
1502
+ :param str target_obj: Target data type to deserialize to.
1503
+ :param object data: Object to deserialize.
1504
+ :raises: DeserializationError if deserialization fails.
1505
+ :return: Deserialized object.
1506
+ :rtype: object
1507
+ """
1508
+ # This is already a model, go recursive just in case
1509
+ if hasattr(data, "_attribute_map"):
1510
+ constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")]
1511
+ try:
1512
+ for attr, mapconfig in data._attribute_map.items(): # pylint: disable=protected-access
1513
+ if attr in constants:
1514
+ continue
1515
+ value = getattr(data, attr)
1516
+ if value is None:
1517
+ continue
1518
+ local_type = mapconfig["type"]
1519
+ internal_data_type = local_type.strip("[]{}")
1520
+ if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum):
1521
+ continue
1522
+ setattr(data, attr, self._deserialize(local_type, value))
1523
+ return data
1524
+ except AttributeError:
1525
+ return
1526
+
1527
+ response, class_name = self._classify_target(target_obj, data)
1528
+
1529
+ if isinstance(response, str):
1530
+ return self.deserialize_data(data, response)
1531
+ if isinstance(response, type) and issubclass(response, Enum):
1532
+ return self.deserialize_enum(data, response)
1533
+
1534
+ if data is None or data is CoreNull:
1535
+ return data
1536
+ try:
1537
+ attributes = response._attribute_map # type: ignore # pylint: disable=protected-access
1538
+ d_attrs = {}
1539
+ for attr, attr_desc in attributes.items():
1540
+ # Check empty string. If it's not empty, someone has a real "additionalProperties"...
1541
+ if attr == "additional_properties" and attr_desc["key"] == "":
1542
+ continue
1543
+ raw_value = None
1544
+ # Enhance attr_desc with some dynamic data
1545
+ attr_desc = attr_desc.copy() # Do a copy, do not change the real one
1546
+ internal_data_type = attr_desc["type"].strip("[]{}")
1547
+ if internal_data_type in self.dependencies:
1548
+ attr_desc["internalType"] = self.dependencies[internal_data_type]
1549
+
1550
+ for key_extractor in self.key_extractors:
1551
+ found_value = key_extractor(attr, attr_desc, data)
1552
+ if found_value is not None:
1553
+ if raw_value is not None and raw_value != found_value:
1554
+ msg = (
1555
+ "Ignoring extracted value '%s' from %s for key '%s'"
1556
+ " (duplicate extraction, follow extractors order)"
1557
+ )
1558
+ _LOGGER.warning(msg, found_value, key_extractor, attr)
1559
+ continue
1560
+ raw_value = found_value
1561
+
1562
+ value = self.deserialize_data(raw_value, attr_desc["type"])
1563
+ d_attrs[attr] = value
1564
+ except (AttributeError, TypeError, KeyError) as err:
1565
+ msg = "Unable to deserialize to object: " + class_name # type: ignore
1566
+ raise DeserializationError(msg) from err
1567
+ additional_properties = self._build_additional_properties(attributes, data)
1568
+ return self._instantiate_model(response, d_attrs, additional_properties)
1569
+
1570
+ def _build_additional_properties(self, attribute_map, data):
1571
+ if not self.additional_properties_detection:
1572
+ return None
1573
+ if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "":
1574
+ # Check empty string. If it's not empty, someone has a real "additionalProperties"
1575
+ return None
1576
+ if isinstance(data, ET.Element):
1577
+ data = {el.tag: el.text for el in data}
1578
+
1579
+ known_keys = {
1580
+ _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0])
1581
+ for desc in attribute_map.values()
1582
+ if desc["key"] != ""
1583
+ }
1584
+ present_keys = set(data.keys())
1585
+ missing_keys = present_keys - known_keys
1586
+ return {key: data[key] for key in missing_keys}
1587
+
1588
+ def _classify_target(self, target, data):
1589
+ """Check to see whether the deserialization target object can
1590
+ be classified into a subclass.
1591
+ Once classification has been determined, initialize object.
1592
+
1593
+ :param str target: The target object type to deserialize to.
1594
+ :param str/dict data: The response data to deserialize.
1595
+ :return: The classified target object and its class name.
1596
+ :rtype: tuple
1597
+ """
1598
+ if target is None:
1599
+ return None, None
1600
+
1601
+ if isinstance(target, str):
1602
+ try:
1603
+ target = self.dependencies[target]
1604
+ except KeyError:
1605
+ return target, target
1606
+
1607
+ try:
1608
+ target = target._classify(data, self.dependencies) # type: ignore # pylint: disable=protected-access
1609
+ except AttributeError:
1610
+ pass # Target is not a Model, no classify
1611
+ return target, target.__class__.__name__ # type: ignore
1612
+
1613
+ def failsafe_deserialize(self, target_obj, data, content_type=None):
1614
+ """Ignores any errors encountered in deserialization,
1615
+ and falls back to not deserializing the object. Recommended
1616
+ for use in error deserialization, as we want to return the
1617
+ HttpResponseError to users, and not have them deal with
1618
+ a deserialization error.
1619
+
1620
+ :param str target_obj: The target object type to deserialize to.
1621
+ :param str/dict data: The response data to deserialize.
1622
+ :param str content_type: Swagger "produces" if available.
1623
+ :return: Deserialized object.
1624
+ :rtype: object
1625
+ """
1626
+ try:
1627
+ return self(target_obj, data, content_type=content_type)
1628
+ except: # pylint: disable=bare-except
1629
+ _LOGGER.debug(
1630
+ "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True
1631
+ )
1632
+ return None
1633
+
1634
+ @staticmethod
1635
+ def _unpack_content(raw_data, content_type=None):
1636
+ """Extract the correct structure for deserialization.
1637
+
1638
+ If raw_data is a PipelineResponse, try to extract the result of RawDeserializer.
1639
+ if we can't, raise. Your Pipeline should have a RawDeserializer.
1640
+
1641
+ If not a pipeline response and raw_data is bytes or string, use content-type
1642
+ to decode it. If no content-type, try JSON.
1643
+
1644
+ If raw_data is something else, bypass all logic and return it directly.
1645
+
1646
+ :param obj raw_data: Data to be processed.
1647
+ :param str content_type: How to parse if raw_data is a string/bytes.
1648
+ :raises JSONDecodeError: If JSON is requested and parsing is impossible.
1649
+ :raises UnicodeDecodeError: If bytes is not UTF8
1650
+ :rtype: object
1651
+ :return: Unpacked content.
1652
+ """
1653
+ # Assume this is enough to detect a Pipeline Response without importing it
1654
+ context = getattr(raw_data, "context", {})
1655
+ if context:
1656
+ if RawDeserializer.CONTEXT_NAME in context:
1657
+ return context[RawDeserializer.CONTEXT_NAME]
1658
+ raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize")
1659
+
1660
+ # Assume this is enough to recognize universal_http.ClientResponse without importing it
1661
+ if hasattr(raw_data, "body"):
1662
+ return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers)
1663
+
1664
+ # Assume this enough to recognize requests.Response without importing it.
1665
+ if hasattr(raw_data, "_content_consumed"):
1666
+ return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers)
1667
+
1668
+ if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"):
1669
+ return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore
1670
+ return raw_data
1671
+
1672
+ def _instantiate_model(self, response, attrs, additional_properties=None):
1673
+ """Instantiate a response model passing in deserialized args.
1674
+
1675
+ :param Response response: The response model class.
1676
+ :param dict attrs: The deserialized response attributes.
1677
+ :param dict additional_properties: Additional properties to be set.
1678
+ :rtype: Response
1679
+ :return: The instantiated response model.
1680
+ """
1681
+ if callable(response):
1682
+ subtype = getattr(response, "_subtype_map", {})
1683
+ try:
1684
+ readonly = [
1685
+ k
1686
+ for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore
1687
+ if v.get("readonly")
1688
+ ]
1689
+ const = [
1690
+ k
1691
+ for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore
1692
+ if v.get("constant")
1693
+ ]
1694
+ kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const}
1695
+ response_obj = response(**kwargs)
1696
+ for attr in readonly:
1697
+ setattr(response_obj, attr, attrs.get(attr))
1698
+ if additional_properties:
1699
+ response_obj.additional_properties = additional_properties # type: ignore
1700
+ return response_obj
1701
+ except TypeError as err:
1702
+ msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore
1703
+ raise DeserializationError(msg + str(err)) from err
1704
+ else:
1705
+ try:
1706
+ for attr, value in attrs.items():
1707
+ setattr(response, attr, value)
1708
+ return response
1709
+ except Exception as exp:
1710
+ msg = "Unable to populate response model. "
1711
+ msg += "Type: {}, Error: {}".format(type(response), exp)
1712
+ raise DeserializationError(msg) from exp
1713
+
1714
+ def deserialize_data(self, data, data_type): # pylint: disable=too-many-return-statements
1715
+ """Process data for deserialization according to data type.
1716
+
1717
+ :param str data: The response string to be deserialized.
1718
+ :param str data_type: The type to deserialize to.
1719
+ :raises: DeserializationError if deserialization fails.
1720
+ :return: Deserialized object.
1721
+ :rtype: object
1722
+ """
1723
+ if data is None:
1724
+ return data
1725
+
1726
+ try:
1727
+ if not data_type:
1728
+ return data
1729
+ if data_type in self.basic_types.values():
1730
+ return self.deserialize_basic(data, data_type)
1731
+ if data_type in self.deserialize_type:
1732
+ if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())):
1733
+ return data
1734
+
1735
+ is_a_text_parsing_type = lambda x: x not in [ # pylint: disable=unnecessary-lambda-assignment
1736
+ "object",
1737
+ "[]",
1738
+ r"{}",
1739
+ ]
1740
+ if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text:
1741
+ return None
1742
+ data_val = self.deserialize_type[data_type](data)
1743
+ return data_val
1744
+
1745
+ iter_type = data_type[0] + data_type[-1]
1746
+ if iter_type in self.deserialize_type:
1747
+ return self.deserialize_type[iter_type](data, data_type[1:-1])
1748
+
1749
+ obj_type = self.dependencies[data_type]
1750
+ if issubclass(obj_type, Enum):
1751
+ if isinstance(data, ET.Element):
1752
+ data = data.text
1753
+ return self.deserialize_enum(data, obj_type)
1754
+
1755
+ except (ValueError, TypeError, AttributeError) as err:
1756
+ msg = "Unable to deserialize response data."
1757
+ msg += " Data: {}, {}".format(data, data_type)
1758
+ raise DeserializationError(msg) from err
1759
+ return self._deserialize(obj_type, data)
1760
+
1761
+ def deserialize_iter(self, attr, iter_type):
1762
+ """Deserialize an iterable.
1763
+
1764
+ :param list attr: Iterable to be deserialized.
1765
+ :param str iter_type: The type of object in the iterable.
1766
+ :return: Deserialized iterable.
1767
+ :rtype: list
1768
+ """
1769
+ if attr is None:
1770
+ return None
1771
+ if isinstance(attr, ET.Element): # If I receive an element here, get the children
1772
+ attr = list(attr)
1773
+ if not isinstance(attr, (list, set)):
1774
+ raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr)))
1775
+ return [self.deserialize_data(a, iter_type) for a in attr]
1776
+
1777
+ def deserialize_dict(self, attr, dict_type):
1778
+ """Deserialize a dictionary.
1779
+
1780
+ :param dict/list attr: Dictionary to be deserialized. Also accepts
1781
+ a list of key, value pairs.
1782
+ :param str dict_type: The object type of the items in the dictionary.
1783
+ :return: Deserialized dictionary.
1784
+ :rtype: dict
1785
+ """
1786
+ if isinstance(attr, list):
1787
+ return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr}
1788
+
1789
+ if isinstance(attr, ET.Element):
1790
+ # Transform <Key>value</Key> into {"Key": "value"}
1791
+ attr = {el.tag: el.text for el in attr}
1792
+ return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()}
1793
+
1794
+ def deserialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements
1795
+ """Deserialize a generic object.
1796
+ This will be handled as a dictionary.
1797
+
1798
+ :param dict attr: Dictionary to be deserialized.
1799
+ :return: Deserialized object.
1800
+ :rtype: dict
1801
+ :raises: TypeError if non-builtin datatype encountered.
1802
+ """
1803
+ if attr is None:
1804
+ return None
1805
+ if isinstance(attr, ET.Element):
1806
+ # Do no recurse on XML, just return the tree as-is
1807
+ return attr
1808
+ if isinstance(attr, str):
1809
+ return self.deserialize_basic(attr, "str")
1810
+ obj_type = type(attr)
1811
+ if obj_type in self.basic_types:
1812
+ return self.deserialize_basic(attr, self.basic_types[obj_type])
1813
+ if obj_type is _long_type:
1814
+ return self.deserialize_long(attr)
1815
+
1816
+ if obj_type == dict:
1817
+ deserialized = {}
1818
+ for key, value in attr.items():
1819
+ try:
1820
+ deserialized[key] = self.deserialize_object(value, **kwargs)
1821
+ except ValueError:
1822
+ deserialized[key] = None
1823
+ return deserialized
1824
+
1825
+ if obj_type == list:
1826
+ deserialized = []
1827
+ for obj in attr:
1828
+ try:
1829
+ deserialized.append(self.deserialize_object(obj, **kwargs))
1830
+ except ValueError:
1831
+ pass
1832
+ return deserialized
1833
+
1834
+ error = "Cannot deserialize generic object with type: "
1835
+ raise TypeError(error + str(obj_type))
1836
+
1837
+ def deserialize_basic(self, attr, data_type): # pylint: disable=too-many-return-statements
1838
+ """Deserialize basic builtin data type from string.
1839
+ Will attempt to convert to str, int, float and bool.
1840
+ This function will also accept '1', '0', 'true' and 'false' as
1841
+ valid bool values.
1842
+
1843
+ :param str attr: response string to be deserialized.
1844
+ :param str data_type: deserialization data type.
1845
+ :return: Deserialized basic type.
1846
+ :rtype: str, int, float or bool
1847
+ :raises: TypeError if string format is not valid.
1848
+ """
1849
+ # If we're here, data is supposed to be a basic type.
1850
+ # If it's still an XML node, take the text
1851
+ if isinstance(attr, ET.Element):
1852
+ attr = attr.text
1853
+ if not attr:
1854
+ if data_type == "str":
1855
+ # None or '', node <a/> is empty string.
1856
+ return ""
1857
+ # None or '', node <a/> with a strong type is None.
1858
+ # Don't try to model "empty bool" or "empty int"
1859
+ return None
1860
+
1861
+ if data_type == "bool":
1862
+ if attr in [True, False, 1, 0]:
1863
+ return bool(attr)
1864
+ if isinstance(attr, str):
1865
+ if attr.lower() in ["true", "1"]:
1866
+ return True
1867
+ if attr.lower() in ["false", "0"]:
1868
+ return False
1869
+ raise TypeError("Invalid boolean value: {}".format(attr))
1870
+
1871
+ if data_type == "str":
1872
+ return self.deserialize_unicode(attr)
1873
+ return eval(data_type)(attr) # nosec # pylint: disable=eval-used
1874
+
1875
+ @staticmethod
1876
+ def deserialize_unicode(data):
1877
+ """Preserve unicode objects in Python 2, otherwise return data
1878
+ as a string.
1879
+
1880
+ :param str data: response string to be deserialized.
1881
+ :return: Deserialized string.
1882
+ :rtype: str or unicode
1883
+ """
1884
+ # We might be here because we have an enum modeled as string,
1885
+ # and we try to deserialize a partial dict with enum inside
1886
+ if isinstance(data, Enum):
1887
+ return data
1888
+
1889
+ # Consider this is real string
1890
+ try:
1891
+ if isinstance(data, unicode): # type: ignore
1892
+ return data
1893
+ except NameError:
1894
+ return str(data)
1895
+ return str(data)
1896
+
1897
+ @staticmethod
1898
+ def deserialize_enum(data, enum_obj):
1899
+ """Deserialize string into enum object.
1900
+
1901
+ If the string is not a valid enum value it will be returned as-is
1902
+ and a warning will be logged.
1903
+
1904
+ :param str data: Response string to be deserialized. If this value is
1905
+ None or invalid it will be returned as-is.
1906
+ :param Enum enum_obj: Enum object to deserialize to.
1907
+ :return: Deserialized enum object.
1908
+ :rtype: Enum
1909
+ """
1910
+ if isinstance(data, enum_obj) or data is None:
1911
+ return data
1912
+ if isinstance(data, Enum):
1913
+ data = data.value
1914
+ if isinstance(data, int):
1915
+ # Workaround. We might consider remove it in the future.
1916
+ try:
1917
+ return list(enum_obj.__members__.values())[data]
1918
+ except IndexError as exc:
1919
+ error = "{!r} is not a valid index for enum {!r}"
1920
+ raise DeserializationError(error.format(data, enum_obj)) from exc
1921
+ try:
1922
+ return enum_obj(str(data))
1923
+ except ValueError:
1924
+ for enum_value in enum_obj:
1925
+ if enum_value.value.lower() == str(data).lower():
1926
+ return enum_value
1927
+ # We don't fail anymore for unknown value, we deserialize as a string
1928
+ _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj)
1929
+ return Deserializer.deserialize_unicode(data)
1930
+
1931
+ @staticmethod
1932
+ def deserialize_bytearray(attr):
1933
+ """Deserialize string into bytearray.
1934
+
1935
+ :param str attr: response string to be deserialized.
1936
+ :return: Deserialized bytearray
1937
+ :rtype: bytearray
1938
+ :raises: TypeError if string format invalid.
1939
+ """
1940
+ if isinstance(attr, ET.Element):
1941
+ attr = attr.text
1942
+ return bytearray(b64decode(attr)) # type: ignore
1943
+
1944
+ @staticmethod
1945
+ def deserialize_base64(attr):
1946
+ """Deserialize base64 encoded string into string.
1947
+
1948
+ :param str attr: response string to be deserialized.
1949
+ :return: Deserialized base64 string
1950
+ :rtype: bytearray
1951
+ :raises: TypeError if string format invalid.
1952
+ """
1953
+ if isinstance(attr, ET.Element):
1954
+ attr = attr.text
1955
+ padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore
1956
+ attr = attr + padding # type: ignore
1957
+ encoded = attr.replace("-", "+").replace("_", "/")
1958
+ return b64decode(encoded)
1959
+
1960
+ @staticmethod
1961
+ def deserialize_decimal(attr):
1962
+ """Deserialize string into Decimal object.
1963
+
1964
+ :param str attr: response string to be deserialized.
1965
+ :return: Deserialized decimal
1966
+ :raises: DeserializationError if string format invalid.
1967
+ :rtype: decimal
1968
+ """
1969
+ if isinstance(attr, ET.Element):
1970
+ attr = attr.text
1971
+ try:
1972
+ return decimal.Decimal(str(attr)) # type: ignore
1973
+ except decimal.DecimalException as err:
1974
+ msg = "Invalid decimal {}".format(attr)
1975
+ raise DeserializationError(msg) from err
1976
+
1977
+ @staticmethod
1978
+ def deserialize_long(attr):
1979
+ """Deserialize string into long (Py2) or int (Py3).
1980
+
1981
+ :param str attr: response string to be deserialized.
1982
+ :return: Deserialized int
1983
+ :rtype: long or int
1984
+ :raises: ValueError if string format invalid.
1985
+ """
1986
+ if isinstance(attr, ET.Element):
1987
+ attr = attr.text
1988
+ return _long_type(attr) # type: ignore
1989
+
1990
+ @staticmethod
1991
+ def deserialize_duration(attr):
1992
+ """Deserialize ISO-8601 formatted string into TimeDelta object.
1993
+
1994
+ :param str attr: response string to be deserialized.
1995
+ :return: Deserialized duration
1996
+ :rtype: TimeDelta
1997
+ :raises: DeserializationError if string format invalid.
1998
+ """
1999
+ if isinstance(attr, ET.Element):
2000
+ attr = attr.text
2001
+ try:
2002
+ duration = isodate.parse_duration(attr)
2003
+ except (ValueError, OverflowError, AttributeError) as err:
2004
+ msg = "Cannot deserialize duration object."
2005
+ raise DeserializationError(msg) from err
2006
+ return duration
2007
+
2008
+ @staticmethod
2009
+ def deserialize_date(attr):
2010
+ """Deserialize ISO-8601 formatted string into Date object.
2011
+
2012
+ :param str attr: response string to be deserialized.
2013
+ :return: Deserialized date
2014
+ :rtype: Date
2015
+ :raises: DeserializationError if string format invalid.
2016
+ """
2017
+ if isinstance(attr, ET.Element):
2018
+ attr = attr.text
2019
+ if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore
2020
+ raise DeserializationError("Date must have only digits and -. Received: %s" % attr)
2021
+ # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception.
2022
+ return isodate.parse_date(attr, defaultmonth=0, defaultday=0)
2023
+
2024
+ @staticmethod
2025
+ def deserialize_time(attr):
2026
+ """Deserialize ISO-8601 formatted string into time object.
2027
+
2028
+ :param str attr: response string to be deserialized.
2029
+ :return: Deserialized time
2030
+ :rtype: datetime.time
2031
+ :raises: DeserializationError if string format invalid.
2032
+ """
2033
+ if isinstance(attr, ET.Element):
2034
+ attr = attr.text
2035
+ if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore
2036
+ raise DeserializationError("Date must have only digits and -. Received: %s" % attr)
2037
+ return isodate.parse_time(attr)
2038
+
2039
+ @staticmethod
2040
+ def deserialize_rfc(attr):
2041
+ """Deserialize RFC-1123 formatted string into Datetime object.
2042
+
2043
+ :param str attr: response string to be deserialized.
2044
+ :return: Deserialized RFC datetime
2045
+ :rtype: Datetime
2046
+ :raises: DeserializationError if string format invalid.
2047
+ """
2048
+ if isinstance(attr, ET.Element):
2049
+ attr = attr.text
2050
+ try:
2051
+ parsed_date = email.utils.parsedate_tz(attr) # type: ignore
2052
+ date_obj = datetime.datetime(
2053
+ *parsed_date[:6], tzinfo=_FixedOffset(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60))
2054
+ )
2055
+ if not date_obj.tzinfo:
2056
+ date_obj = date_obj.astimezone(tz=TZ_UTC)
2057
+ except ValueError as err:
2058
+ msg = "Cannot deserialize to rfc datetime object."
2059
+ raise DeserializationError(msg) from err
2060
+ return date_obj
2061
+
2062
+ @staticmethod
2063
+ def deserialize_iso(attr):
2064
+ """Deserialize ISO-8601 formatted string into Datetime object.
2065
+
2066
+ :param str attr: response string to be deserialized.
2067
+ :return: Deserialized ISO datetime
2068
+ :rtype: Datetime
2069
+ :raises: DeserializationError if string format invalid.
2070
+ """
2071
+ if isinstance(attr, ET.Element):
2072
+ attr = attr.text
2073
+ try:
2074
+ attr = attr.upper() # type: ignore
2075
+ match = Deserializer.valid_date.match(attr)
2076
+ if not match:
2077
+ raise ValueError("Invalid datetime string: " + attr)
2078
+
2079
+ check_decimal = attr.split(".")
2080
+ if len(check_decimal) > 1:
2081
+ decimal_str = ""
2082
+ for digit in check_decimal[1]:
2083
+ if digit.isdigit():
2084
+ decimal_str += digit
2085
+ else:
2086
+ break
2087
+ if len(decimal_str) > 6:
2088
+ attr = attr.replace(decimal_str, decimal_str[0:6])
2089
+
2090
+ date_obj = isodate.parse_datetime(attr)
2091
+ test_utc = date_obj.utctimetuple()
2092
+ if test_utc.tm_year > 9999 or test_utc.tm_year < 1:
2093
+ raise OverflowError("Hit max or min date")
2094
+ except (ValueError, OverflowError, AttributeError) as err:
2095
+ msg = "Cannot deserialize datetime object."
2096
+ raise DeserializationError(msg) from err
2097
+ return date_obj
2098
+
2099
+ @staticmethod
2100
+ def deserialize_unix(attr):
2101
+ """Serialize Datetime object into IntTime format.
2102
+ This is represented as seconds.
2103
+
2104
+ :param int attr: Object to be serialized.
2105
+ :return: Deserialized datetime
2106
+ :rtype: Datetime
2107
+ :raises: DeserializationError if format invalid
2108
+ """
2109
+ if isinstance(attr, ET.Element):
2110
+ attr = int(attr.text) # type: ignore
2111
+ try:
2112
+ attr = int(attr)
2113
+ date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC)
2114
+ except ValueError as err:
2115
+ msg = "Cannot deserialize to unix datetime object."
2116
+ raise DeserializationError(msg) from err
2117
+ return date_obj