hide operations with > 2 body types

ChangeLog.md

@@ -14,6 +14,10 @@
 - Only generate Python3 SDKs  #1297
 - Don't reformat initial query parameters into the next link  #1297
 
+**Breaking Changes in Version Tolerant**
+
+- Don't generate operations with more than two body types. SDK authors need to implement this operation themselves  #1300
+
 ### 2022-07-13 - 5.19.0
 
 | Library                                                                 | Min Version |

autorest/codegen/models/base_builder.py

@@ -3,6 +3,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
+import logging
 from abc import abstractmethod
 from typing import Any, Dict, List, Optional, TypeVar, Union, TYPE_CHECKING, Generic
 from .base_model import BaseModel
@@ -27,6 +28,8 @@
     from .operation import Operation
     from .request_builder import RequestBuilder
 
+_LOGGER = logging.getLogger(__name__)
+
 
 class BaseBuilder(Generic[ParameterListType], BaseModel):
     """Base class for Operations and Request Builders"""
@@ -39,7 +42,6 @@ def __init__(
         parameters: ParameterListType,
         *,
         overloads=None,
-        abstract: bool = False,
         want_tracing: bool = True,
     ) -> None:
         super().__init__(yaml_data=yaml_data, code_model=code_model)
@@ -50,14 +52,23 @@ def __init__(
             overloads or []
         )
         self._summary: str = yaml_data.get("summary", "")
-        # for operations where we don't know what to do, we mark them as abstract so users implement
-        # in patch.py
-        self.abstract = abstract
         self.want_tracing = want_tracing
         self.group_name: str = yaml_data["groupName"]
         self.is_overload: bool = yaml_data["isOverload"]
         self.api_versions: List[str] = yaml_data["apiVersions"]
 
+        if code_model.options["version_tolerant"] and yaml_data.get("abstract"):
+            _LOGGER.warning(
+                'Not going to generate operation "%s" because we are unable to generate this '
+                "type of operation right now. "
+                'Please write your own custom operation in the "_patch.py" file '
+                "following https://aka.ms/azsdk/python/dpcodegen/python/customize",
+                name,
+            )
+            self.abstract = True
+        else:
+            self.abstract = False
+
     @property
     def summary(self) -> Optional[str]:
         if self.abstract:

autorest/codegen/models/lro_operation.py

@@ -33,7 +33,6 @@ def __init__(
         overloads: Optional[List[Operation]] = None,
         public: bool = True,
         want_tracing: bool = True,
-        abstract: bool = False,
     ) -> None:
         super().__init__(
             code_model=code_model,
@@ -46,7 +45,6 @@ def __init__(
             overloads=overloads,
             public=public,
             want_tracing=want_tracing,
-            abstract=abstract,
         )
         self.name = "begin_" + self.name
         self.lro_options: Dict[str, Any] = self.yaml_data.get("lroOptions", {})

autorest/codegen/models/operation.py

@@ -3,7 +3,6 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-import logging
 from itertools import chain
 from typing import (
     Dict,
@@ -43,8 +42,6 @@
 if TYPE_CHECKING:
     from .code_model import CodeModel
 
-_LOGGER = logging.getLogger(__name__)
-
 ResponseType = TypeVar(
     "ResponseType",
     bound=Union[Response, PagingResponse, LROResponse, LROPagingResponse],
@@ -67,15 +64,13 @@ def __init__(
         overloads: Optional[List["Operation"]] = None,
         public: bool = True,
         want_tracing: bool = True,
-        abstract: bool = False,
     ) -> None:
         super().__init__(
             code_model=code_model,
             yaml_data=yaml_data,
             name=name,
             parameters=parameters,
             overloads=overloads,
-            abstract=abstract,
             want_tracing=want_tracing,
         )
         self.overloads: List["Operation"] = overloads or []
@@ -429,20 +424,6 @@ def from_yaml(cls, yaml_data: Dict[str, Any], code_model: "CodeModel"):
             cls.from_yaml(overload, code_model)
             for overload in yaml_data.get("overloads", [])
         ]
-        abstract = False
-        if (
-            code_model.options["version_tolerant"]
-            and parameter_list.has_body
-            and isinstance(parameter_list.body_parameter, MultipartBodyParameter)
-        ):
-            _LOGGER.warning(
-                'Not going to generate operation "%s" because it has multipart / urlencoded body parameters. '
-                "Multipart / urlencoded body parameters are not supported for version tolerant generation right now. "
-                'Please write your own custom operation in the "_patch.py" file '
-                "following https://aka.ms/azsdk/python/dpcodegen/python/customize",
-                name,
-            )
-            abstract = True
 
         return cls(
             yaml_data=yaml_data,
@@ -454,7 +435,6 @@ def from_yaml(cls, yaml_data: Dict[str, Any], code_model: "CodeModel"):
             responses=responses,
             exceptions=exceptions,
             want_tracing=not yaml_data["isOverload"],
-            abstract=abstract,
         )
 
 

autorest/codegen/models/paging_operation.py

@@ -38,7 +38,6 @@ def __init__(
         overloads: Optional[List[Operation]] = None,
         public: bool = True,
         want_tracing: bool = True,
-        abstract: bool = False,
         override_success_response_to_200: bool = False,
     ) -> None:
         super().__init__(
@@ -52,7 +51,6 @@ def __init__(
             overloads=overloads,
             public=public,
             want_tracing=want_tracing,
-            abstract=abstract,
         )
         self.next_request_builder: Optional[
             Union[RequestBuilder, OverloadedRequestBuilder]

autorest/codegen/models/request_builder.py

@@ -3,7 +3,6 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-import logging
 from typing import (
     Any,
     Callable,
@@ -22,12 +21,10 @@
     OverloadedRequestBuilderParameterList,
 )
 from .imports import FileImport, ImportType, TypingSection, MsrestImportType
-from .request_builder_parameter import RequestBuilderMultipartBodyParameter
 
 if TYPE_CHECKING:
     from .code_model import CodeModel
 
-_LOGGER = logging.getLogger(__name__)
 ParameterListType = TypeVar(
     "ParameterListType",
     bound=Union[RequestBuilderParameterList, OverloadedRequestBuilderParameterList],
@@ -43,15 +40,13 @@ def __init__(
         parameters: ParameterListType,
         *,
         overloads: Optional[List["RequestBuilder"]] = None,
-        abstract: bool = False,
     ) -> None:
         super().__init__(
             code_model=code_model,
             yaml_data=yaml_data,
             name=name,
             parameters=parameters,
             overloads=overloads,
-            abstract=abstract,
             want_tracing=False,
         )
         self.overloads: List["RequestBuilder"] = overloads or []
@@ -147,31 +142,14 @@ def from_yaml(cls, yaml_data: Dict[str, Any], code_model: "CodeModel"):
             RequestBuilder.from_yaml(rb_yaml_data, code_model)
             for rb_yaml_data in yaml_data.get("overloads", [])
         ]
-        abstract = False
         parameter_list = cls.parameter_list_type()(yaml_data, code_model)
-        if (
-            code_model.options["version_tolerant"]
-            and parameter_list.has_body
-            and isinstance(
-                parameter_list.body_parameter, RequestBuilderMultipartBodyParameter
-            )
-        ):
-            _LOGGER.warning(
-                'Not going to generate operation "%s" because it has multipart / urlencoded body parameters. '
-                "Multipart / urlencoded body parameters are not supported for version tolerant generation right now. "
-                'Please write your own custom operation in the "_patch.py" file '
-                "following https://aka.ms/azsdk/python/dpcodegen/python/customize",
-                name,
-            )
-            abstract = True
 
         return cls(
             yaml_data=yaml_data,
             code_model=code_model,
             name=name,
             parameters=parameter_list,
             overloads=overloads,
-            abstract=abstract,
         )
 
 

autorest/codegen/serializers/builder_serializer.py

@@ -825,10 +825,15 @@ def _create_request_builder_call(
                 f"    {parameter.client_name}={parameter.name_in_high_level_operation},"
             )
         if request_builder.overloads:
+            seen_body_params = set()
             for overload in request_builder.overloads:
                 body_param = cast(
                     RequestBuilderBodyParameter, overload.parameters.body_parameter
                 )
+                if body_param.client_name in seen_body_params:
+                    continue
+                seen_body_params.add(body_param.client_name)
+
                 retval.append(
                     f"    {body_param.client_name}={body_param.name_in_high_level_operation},"
                 )

autorest/m4reformatter/__init__.py

@@ -494,6 +494,13 @@ def _update_operation_helper(
         in_overriden = (
             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
+            abstract = True
         return {
             "name": yaml_data["language"]["default"]["name"],
             "description": yaml_data["language"]["default"]["description"],
@@ -520,6 +527,7 @@ def _update_operation_helper(
             "discriminator": "operation",
             "isOverload": is_overload,
             "apiVersions": _get_api_versions(yaml_data.get("apiVersions", [])),
+            "abstract": abstract,
         }
 
     def get_operation_creator(

package.json

@@ -27,7 +27,7 @@
         "@autorest/system-requirements": "~1.0.0"
     },
     "devDependencies": {
-        "@microsoft.azure/autorest.testserver": "^3.3.28"
+        "@microsoft.azure/autorest.testserver": "^3.3.29"
     },
     "files": [
         "autorest/**/*.py",

test/unittests/test_optional_return_type.py

@@ -21,7 +21,8 @@ def code_model():
         }},
         options={
             "show_send_request": True,
-            "builders_visibility": "public"
+            "builders_visibility": "public",
+            "version_tolerant": True
         },
     )
 

test/vanilla/legacy/AcceptanceTests/asynctests/test_media_types.py

@@ -83,3 +83,11 @@ async def test_binary_body_three_content_types(self, client):
 
         content = "hello, world"
         await client.binary_body_with_three_content_types(content, content_type="text/plain")
+
+    @pytest.mark.asyncio
+    async def test_body_three_types(self, client):
+        json_input = {"hello":"world"}
+        await client.body_three_types(json_input)
+
+        content = b"hello, world"
+        await client.body_three_types(content)

test/vanilla/legacy/AcceptanceTests/test_media_types.py

@@ -75,6 +75,13 @@ def test_binary_body_three_content_types(self, client):
         content = "hello, world"
         client.binary_body_with_three_content_types(content, content_type="text/plain")
 
+    def test_body_three_types(self, client):
+        json_input = {"hello":"world"}
+        client.body_three_types(json_input)
+
+        content = b"hello, world"
+        client.body_three_types(content)
+
     def test_models(self):
         from mediatypes.models import SourcePath