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