@autorest/python 6.28.1 → 6.28.3

package/autorest/codegen.py

@@ -40,7 +40,7 @@ class JinjaSerializerAutorest(JinjaSerializer, ReaderAndWriterAutorest):
 class CodeGeneratorAutorest(CodeGenerator, PluginAutorest):
     def get_options(self) -> Dict[str, Any]:
         if self._autorestapi.get_boolean_value("python3-only") is False:
-            _LOGGER.warning("You have passed in --python3-only=False. We have force overriden this to True.")
+            _LOGGER.warning("You have passed in --python3-only=False. We have force overridden this to True.")
         if self._autorestapi.get_boolean_value("add-python3-operation-files"):
             _LOGGER.warning(
                 "You have passed in --add-python3-operation-files. "
@@ -48,7 +48,7 @@ class CodeGeneratorAutorest(CodeGenerator, PluginAutorest):
             )
         if self._autorestapi.get_boolean_value("reformat-next-link"):
             _LOGGER.warning(
-                "You have passed in --reformat-next-link. We have force overriden "
+                "You have passed in --reformat-next-link. We have force overridden "
                 "this to False because we no longer reformat initial query parameters into next "
                 "calls unless explicitly defined in the service definition."
             )

package/autorest/jsonrpc/__init__.py

@@ -12,7 +12,7 @@ from pathlib import Path
 
 
 class Channel(Enum):
-    # Information is considered the mildest of responses; not necesarily actionable.
+    # Information is considered the mildest of responses; not necessarily actionable.
     Information = "information"
 
     # Warnings are considered important for best practices, but not catastrophic in nature.
@@ -27,7 +27,7 @@ class Channel(Enum):
     # Verbose messages give the user additional clarity on the process.
     Verbose = "verbose"
 
-    # Catastrophic failure, likely abending the process.
+    # Catastrophic failure, likely ending the process.
     Fatal = "fatal"
 
 

package/autorest/m4reformatter/__init__.py

@@ -492,7 +492,7 @@ class M4Reformatter(YamlUpdatePluginAutorest):  # pylint: disable=too-many-publi
         *,
         is_overload: bool = False,
     ) -> Dict[str, Any]:
-        in_overriden = body_parameter["type"]["type"] == "combined" if body_parameter else False
+        in_overridden = body_parameter["type"]["type"] == "combined" if body_parameter else False
         abstract = False
         if body_parameter and (body_parameter.get("entries") or len(body_parameter["type"].get("types", [])) > 2):
             # this means it's formdata or urlencoded, or there are more than 2 types of body
@@ -507,7 +507,7 @@ class M4Reformatter(YamlUpdatePluginAutorest):  # pylint: disable=too-many-publi
                 yaml_data,
                 body_parameter,
                 in_overload=is_overload,
-                in_overriden=in_overriden,
+                in_overridden=in_overridden,
             ),
             "bodyParameter": body_parameter,
             "responses": [update_response(r) for r in yaml_data.get("responses", [])],
@@ -723,7 +723,7 @@ class M4Reformatter(YamlUpdatePluginAutorest):  # pylint: disable=too-many-publi
         request_media_types: List[str],
         *,
         in_overload: bool = False,
-        in_overriden: bool = False,
+        in_overridden: bool = False,
     ) -> Dict[str, Any]:
         # override content type type to string
         if not body_parameter:
@@ -737,14 +737,14 @@ class M4Reformatter(YamlUpdatePluginAutorest):  # pylint: disable=too-many-publi
         description = param["language"]["default"]["description"]
         if description and description[-1] != ".":
             description += "."
-        if not (in_overriden or in_overload):
+        if not (in_overridden or in_overload):
             param["inDocstring"] = False
         elif in_overload:
             description += " Content type parameter for " f"{get_body_type_for_description(body_parameter)} body."
         if not in_overload or (body_parameter["type"]["type"] == "binary" and len(request_media_types) > 1):
             content_types = "'" + "', '".join(request_media_types) + "'"
             description += f" Known values are: {content_types}."
-        if not in_overload and not in_overriden:
+        if not in_overload and not in_overridden:
             param["clientDefaultValue"] = body_parameter["defaultContentType"]
         param["language"]["default"]["description"] = description
         return param
@@ -758,7 +758,7 @@ class M4Reformatter(YamlUpdatePluginAutorest):  # pylint: disable=too-many-publi
         request_media_types: List[str],
         *,
         in_overload: bool = False,
-        in_overriden: bool = False,
+        in_overridden: bool = False,
     ) -> List[Dict[str, Any]]:
         retval: List[Dict[str, Any]] = []
         has_flattened_body = body_parameter and body_parameter.get("flattened")
@@ -785,9 +785,9 @@ class M4Reformatter(YamlUpdatePluginAutorest):  # pylint: disable=too-many-publi
                     body_parameter,
                     request_media_types,
                     in_overload=in_overload,
-                    in_overriden=in_overriden,
+                    in_overridden=in_overridden,
                 )
-            updated_param = self.update_parameter(param, in_overload=in_overload, in_overriden=in_overriden)
+            updated_param = self.update_parameter(param, in_overload=in_overload, in_overridden=in_overridden)
             retval.append(updated_param)
         return retval
 
@@ -797,7 +797,7 @@ class M4Reformatter(YamlUpdatePluginAutorest):  # pylint: disable=too-many-publi
         body_parameter: Optional[Dict[str, Any]],
         *,
         in_overload: bool = False,
-        in_overriden: bool = False,
+        in_overridden: bool = False,
     ) -> List[Dict[str, Any]]:
         retval: List[Dict[str, Any]] = []
         seen_client_names: Set[str] = set()
@@ -812,7 +812,7 @@ class M4Reformatter(YamlUpdatePluginAutorest):  # pylint: disable=too-many-publi
                 groupers,
                 request_media_types,
                 in_overload=in_overload,
-                in_overriden=in_overriden,
+                in_overridden=in_overridden,
             )
         )
         # now we handle content type and accept headers.
@@ -831,7 +831,7 @@ class M4Reformatter(YamlUpdatePluginAutorest):  # pylint: disable=too-many-publi
                     groupers,
                     request_media_types,
                     in_overload=in_overload,
-                    in_overriden=in_overriden,
+                    in_overridden=in_overridden,
                 )
             )
         all_params = (retval + [body_parameter]) if body_parameter else retval
@@ -853,7 +853,7 @@ class M4Reformatter(YamlUpdatePluginAutorest):  # pylint: disable=too-many-publi
         *,
         override_client_name: Optional[str] = None,
         in_overload: bool = False,
-        in_overriden: bool = False,
+        in_overridden: bool = False,
     ) -> Dict[str, Any]:
         param_base = self.update_parameter_base(yaml_data, override_client_name=override_client_name)
         type = get_type(yaml_data["schema"])
@@ -869,7 +869,7 @@ class M4Reformatter(YamlUpdatePluginAutorest):  # pylint: disable=too-many-publi
                 "inOverload": in_overload,
                 "skipUrlEncoding": yaml_data.get("extensions", {}).get("x-ms-skip-url-encoding", False),
                 "inDocstring": yaml_data.get("inDocstring", True),
-                "inOverriden": in_overriden,
+                "inOverridden": in_overridden,
                 "delimiter": update_parameter_delimiter(protocol_http.get("style")),
             }
         )

package/autorest/multiapi/templates/multiapi_service_client.py.jinja2

@@ -33,7 +33,7 @@ def __init__(
 
 class _SDKClient(object):
     def __init__(self, *args, **kwargs):
-        """This is a fake class to support current implemetation of MultiApiClientMixin."
+        """This is a fake class to support current implementation of MultiApiClientMixin."
         Will be removed in final version of multiapi azure-core based client
         """
         pass

package/generator/build/lib/pygen/codegen/models/code_model.py

@@ -313,7 +313,7 @@ class CodeModel:  # pylint: disable=too-many-public-methods, disable=too-many-in
         :param int schema_id: The yaml id of the schema
         :return: If created, we return the created schema, otherwise, we throw.
         :rtype: ~autorest.models.BaseType
-        :raises: KeyError if schema is not found
+        :raises KeyError: if schema is not found
         """
         try:
             return next(type for id, type in self.types_map.items() if id == schema_id)

package/generator/build/lib/pygen/codegen/models/operation.py

@@ -456,7 +456,7 @@ class OperationBase(  # pylint: disable=too-many-public-methods,too-many-instanc
                         ImportType.LOCAL,
                     )
                     file_import.add_import("json", ImportType.STDLIB)
-            if any(xml_serializable(str(r.default_content_type)) for r in self.responses):
+            if any(xml_serializable(str(r.default_content_type)) for r in self.responses + self.exceptions):
                 file_import.add_submodule_import(relative_path, "_deserialize_xml", ImportType.LOCAL)
             elif self.need_deserialize:
                 file_import.add_submodule_import(relative_path, "_deserialize", ImportType.LOCAL)

package/generator/build/lib/pygen/codegen/serializers/__init__.py

@@ -130,10 +130,10 @@ class JinjaSerializer(ReaderAndWriter):
                 if self.code_model.options["package_mode"]:
                     self._serialize_and_write_package_files(client_namespace)
 
-                # write apiview_mapping_python.json
+                # write apiview-properties.json
                 if self.code_model.options.get("emit_cross_language_definition_file"):
                     self.write_file(
-                        exec_path / Path("apiview_mapping_python.json"),
+                        exec_path / Path("apiview-properties.json"),
                         general_serializer.serialize_cross_language_definition_file(),
                     )
 
@@ -238,7 +238,7 @@ class JinjaSerializer(ReaderAndWriter):
         self, env: Environment, namespace: str, models: List[ModelType], enums: List[EnumType]
     ) -> None:
         # Write the models folder
-        models_path = self.exec_path(namespace + ".models")
+        models_path = self.exec_path(namespace) / "models"
         serializer = DpgModelSerializer if self.code_model.options["models_mode"] == "dpg" else MsrestModelSerializer
         if self.code_model.has_non_json_models(models):
             self.write_file(
@@ -479,7 +479,12 @@ class JinjaSerializer(ReaderAndWriter):
             else Path(".")
         )
 
+    def exec_path_for_test_sample(self, namespace: str) -> Path:
+        return self.exec_path_compensation / Path(*namespace.split("."))
+
     def exec_path(self, namespace: str) -> Path:
+        if self.code_model.options["no_namespace_folders"] and not self.code_model.options["multiapi"]:
+            return Path(".")
         return self.exec_path_compensation / Path(*namespace.split("."))
 
     @property
@@ -492,7 +497,7 @@ class JinjaSerializer(ReaderAndWriter):
         return Path("")
 
     def _serialize_and_write_sample(self, env: Environment, namespace: str):
-        out_path = self.exec_path(namespace) / Path("generated_samples")
+        out_path = self.exec_path_for_test_sample(namespace) / Path("generated_samples")
         for client in self.code_model.clients:
             for op_group in client.operation_groups:
                 for operation in op_group.operations:
@@ -526,7 +531,7 @@ class JinjaSerializer(ReaderAndWriter):
 
     def _serialize_and_write_test(self, env: Environment, namespace: str):
         self.code_model.for_test = True
-        out_path = self.exec_path(namespace) / Path("generated_tests")
+        out_path = self.exec_path_for_test_sample(namespace) / Path("generated_tests")
         general_serializer = TestGeneralSerializer(code_model=self.code_model, env=env)
         self.write_file(out_path / "conftest.py", general_serializer.serialize_conftest())
         if not self.code_model.options["azure_arm"]:

package/generator/build/lib/pygen/codegen/serializers/builder_serializer.py

@@ -1005,7 +1005,7 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
                 retval.extend(deserialize_code)
         return retval
 
-    def handle_error_response(self, builder: OperationType) -> List[str]:
+    def handle_error_response(self, builder: OperationType) -> List[str]:   # pylint: disable=too-many-statements, too-many-branches
         async_await = "await " if self.async_mode else ""
         retval = [f"if response.status_code not in {str(builder.success_status_codes)}:"]
         response_read = [
@@ -1079,7 +1079,14 @@ class _OperationSerializer(_BuilderBaseSerializer[OperationType]):
                         is_operation_file=True, skip_quote=True, serialize_namespace=self.serialize_namespace
                     )
                     if self.code_model.options["models_mode"] == "dpg":
-                        retval.append(f"        error = _failsafe_deserialize({type_annotation},  response.json())")
+                        if xml_serializable(str(e.default_content_type)):
+                            retval.append(
+                                f"        error = _failsafe_deserialize_xml({type_annotation},  response.text())"
+                            )
+                        else:
+                            retval.append(
+                                f"        error = _failsafe_deserialize({type_annotation},  response.json())"
+                            )
                     else:
                         retval.append(
                             f"        error = self._deserialize.failsafe_deserialize({type_annotation}, "

package/generator/build/lib/pygen/codegen/templates/macros.jinja2

@@ -2,11 +2,12 @@
 {% set original_result = doc_string | wordwrap(width=95, break_long_words=False, break_on_hyphens=False, wrapstring=wrap_string) %}
 {% set list_result = original_result.split('\n') %}
 {% for line in list_result %}
+    {% set prefix = "" if loop.index == 1 else " " %}
     {% set suffix = suffix_string if list_result | length == loop.index %}
     {% if line | length > 120 %}
-{{ line + "  # pylint: disable=line-too-long" }}{{ suffix }}
+{{ prefix }}{{ line + "  # pylint: disable=line-too-long" }}{{ suffix }}
     {% else %}
-{{ line }}{{ suffix }}
+{{ prefix }}{{ line }}{{ suffix }}
     {% endif %}
 {% endfor %}
 {% endmacro %}

package/generator/build/lib/pygen/codegen/templates/model_base.py.jinja2

@@ -372,15 +372,34 @@ class _MyMutableMapping(MutableMapping[str, typing.Any]):  # pylint: disable=uns
         return not self.__eq__(other)
 
     def keys(self) -> typing.KeysView[str]:
+        """
+        :returns: a set-like object providing a view on D's keys
+        :rtype: ~typing.KeysView
+        """
         return self._data.keys()
 
     def values(self) -> typing.ValuesView[typing.Any]:
+        """
+        :returns: an object providing a view on D's values
+        :rtype: ~typing.ValuesView
+        """
         return self._data.values()
 
     def items(self) -> typing.ItemsView[str, typing.Any]:
+        """
+        :returns: set-like object providing a view on D's items
+        :rtype: ~typing.ItemsView
+        """
         return self._data.items()
 
     def get(self, key: str, default: typing.Any = None) -> typing.Any:
+        """
+        Get the value for key if key is in the dictionary, else default.
+        :param str key: The key to look up.
+        :param any default: The value to return if key is not in the dictionary. Defaults to None
+        :returns: D[k] if k in D, else d.
+        :rtype: any
+        """
         try:
             return self[key]
         except KeyError:
@@ -396,17 +415,38 @@ class _MyMutableMapping(MutableMapping[str, typing.Any]):  # pylint: disable=uns
     def pop(self, key: str, default: typing.Any) -> typing.Any: ...
 
     def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any:
+        """
+        Removes specified key and return the corresponding value.
+        :param str key: The key to pop.
+        :param any default: The value to return if key is not in the dictionary
+        :returns: The value corresponding to the key.
+        :rtype: any
+        :raises KeyError: If key is not found and default is not given.
+        """
         if default is _UNSET:
             return self._data.pop(key)
         return self._data.pop(key, default)
 
     def popitem(self) -> typing.Tuple[str, typing.Any]:
+        """
+        Removes and returns some (key, value) pair
+        :returns: The (key, value) pair.
+        :rtype: tuple
+        :raises KeyError: if D is empty.
+        """
         return self._data.popitem()
 
     def clear(self) -> None:
+        """
+        Remove all items from D.
+        """
         self._data.clear()
 
     def update(self, *args: typing.Any, **kwargs: typing.Any) -> None:
+        """
+        Updates D from mapping/iterable E and F.
+        :param any args: Either a mapping object or an iterable of key-value pairs.
+        """
         self._data.update(*args, **kwargs)
 
     @typing.overload
@@ -416,6 +456,13 @@ class _MyMutableMapping(MutableMapping[str, typing.Any]):  # pylint: disable=uns
     def setdefault(self, key: str, default: typing.Any) -> typing.Any: ...
 
     def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any:
+        """
+        Same as calling D.get(k, d), and setting D[k]=d if k not found
+        :param str key: The key to look up.
+        :param any default: The value to set if key is not in the dictionary
+        :returns: D[k] if k in D, else d.
+        :rtype: any
+        """
         if default is _UNSET:
             return self._data.setdefault(key)
         return self._data.setdefault(key, default)
@@ -909,6 +956,20 @@ def _failsafe_deserialize(
       return None
 
 
+def _failsafe_deserialize_xml(
+  deserializer: typing.Any,
+  value: typing.Any,
+) -> typing.Any:
+  try:
+      return _deserialize_xml(deserializer, value)
+  except DeserializationError:
+      _LOGGER.warning(
+          "Ran into a deserialization error. Ignoring since this is failsafe deserialization",
+          exc_info=True
+      )
+      return None
+
+
 class _RestField:
     def __init__(
         self,

package/generator/build/lib/pygen/codegen/templates/model_dpg.py.jinja2

@@ -22,9 +22,7 @@
     {% if model.properties != None %}
         {% for p in model.properties %}
             {% for line in serializer.variable_documentation_string(p) %}
-                {% for doc_string in line.replace('\n', '\n ').split('\n') %}
-    {{ macros.wrap_model_string(doc_string, '\n     ') -}}
-                {% endfor %}
+    {{ macros.wrap_model_string(line, '\n    ') -}}
             {% endfor %}
         {% endfor %}
     {% endif %}
@@ -37,7 +35,7 @@
     {{ serializer.declare_property(p) }}
         {% set prop_description = p.description(is_operation_file=False).replace('"', '\\"') %}
         {% if prop_description %}
-    """{{ macros.wrap_model_string(prop_description, '\n     ', '\"\"\"') -}}
+    """{{ macros.wrap_model_string(prop_description, '\n    ', '\"\"\"') -}}
         {% endif %}
     {% endfor %}
 

package/generator/build/lib/pygen/codegen/templates/model_msrest.py.jinja2

@@ -21,9 +21,7 @@
     {% if model.properties != None %}
         {% for p in model.properties %}
             {% for line in serializer.variable_documentation_string(p) %}
-                {% for doc_string in line.replace('\n', '\n ').split('\n') %}
-    {{ macros.wrap_model_string(doc_string, '\n     ') -}}
-                {% endfor %}
+    {{ macros.wrap_model_string(line, '\n    ') -}}
             {% endfor %}
         {% endfor %}
     {% endif %}
@@ -75,9 +73,7 @@
         {% for p in model.properties %}
             {% if p.is_input %}
                 {% for line in serializer.input_documentation_string(p) %}
-                    {% for doc_string in line.replace('\n', '\n ').split('\n') %}
-        {{ macros.wrap_model_string(doc_string, '\n         ') -}}
-                    {% endfor %}
+        {{ macros.wrap_model_string(line, '\n        ') -}}
                 {% endfor %}
             {% endif %}
         {% endfor %}