@autorest/python 5.16.0 → 5.19.0

package/autorest/codegen/models/lro_operation.py

@@ -3,218 +3,141 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-import logging
-from typing import Dict, List, Any, Optional, Set, cast, TYPE_CHECKING
+from typing import Any, Dict, Optional, List, TYPE_CHECKING, TypeVar, Union
 from .imports import FileImport
-from .operation import Operation
-from .parameter_list import ParameterList
-from .schema_response import SchemaResponse
+from .operation import OperationBase, Operation
+from .response import LROPagingResponse, LROResponse, Response
 from .imports import ImportType, TypingSection
-from .base_schema import BaseSchema
-from .schema_request import SchemaRequest
 from .request_builder import RequestBuilder
+from .parameter_list import ParameterList
 
 if TYPE_CHECKING:
     from .code_model import CodeModel
 
-_LOGGER = logging.getLogger(__name__)
+LROResponseType = TypeVar(
+    "LROResponseType", bound=Union[LROResponse, LROPagingResponse]
+)
 
 
-class LROOperation(Operation):
+class LROOperationBase(OperationBase[LROResponseType]):
     def __init__(
         self,
         yaml_data: Dict[str, Any],
         code_model: "CodeModel",
-        request_builder: RequestBuilder,
         name: str,
-        description: str,
-        api_versions: Set[str],
+        request_builder: RequestBuilder,
         parameters: ParameterList,
-        multiple_content_type_parameters: ParameterList,
-        schema_requests: List[SchemaRequest],
-        summary: Optional[str] = None,
-        responses: Optional[List[SchemaResponse]] = None,
-        exceptions: Optional[List[SchemaResponse]] = None,
-        want_description_docstring: bool = True,
-        want_tracing: bool = True,
+        responses: List[LROResponseType],
+        exceptions: List[Response],
         *,
+        overloads: Optional[List[Operation]] = None,
+        public: bool = True,
+        want_tracing: bool = True,
         abstract: bool = False,
     ) -> None:
         super().__init__(
-            yaml_data,
-            code_model,
-            request_builder,
-            name,
-            description,
-            api_versions,
-            parameters,
-            multiple_content_type_parameters,
-            schema_requests,
-            summary,
-            responses,
-            exceptions,
-            want_description_docstring,
+            code_model=code_model,
+            yaml_data=yaml_data,
+            name=name,
+            request_builder=request_builder,
+            parameters=parameters,
+            responses=responses,
+            exceptions=exceptions,
+            overloads=overloads,
+            public=public,
             want_tracing=want_tracing,
             abstract=abstract,
         )
-        self.lro_options = yaml_data.get("extensions", {}).get(
-            "x-ms-long-running-operation-options", {}
-        )
         self.name = "begin_" + self.name
+        self.lro_options: Dict[str, Any] = self.yaml_data.get("lroOptions", {})
 
     @property
-    def lro_response(self) -> Optional[SchemaResponse]:
-        if not self.responses:
-            return None
-        responses_with_bodies = [r for r in self.responses if r.has_body]
-        num_response_schemas = {r.schema for r in responses_with_bodies}
+    def operation_type(self) -> str:
+        return "lro"
+
+    @property
+    def has_optional_return_type(self) -> bool:
+        return False
+
+    @property
+    def lro_response(self) -> Optional[LROResponseType]:
+        responses_with_bodies = [r for r in self.responses if r.type]
+        num_response_schemas = {
+            id(r.type.yaml_data) for r in responses_with_bodies if r.type
+        }
         response = None
         if len(num_response_schemas) > 1:
             # choose the response that has a status code of 200
-            responses_with_200_status_codes = [
-                r for r in responses_with_bodies if 200 in r.status_codes
-            ]
             try:
-                response = responses_with_200_status_codes[0]
-                schema_types = {r.schema for r in responses_with_bodies}
-                response_schema = cast(BaseSchema, response.schema).serialization_type
-                _LOGGER.warning(
-                    "Multiple schema types in responses: %s. Choosing: %s",
-                    schema_types,
-                    response_schema,
+                response = next(
+                    r for r in responses_with_bodies if 200 in r.status_codes
                 )
-            except IndexError:
+            except StopIteration:
                 raise ValueError(
                     f"Your swagger is invalid because you have multiple response schemas for LRO"
-                    + f" method {self.python_name} and none of them have a 200 status code."
+                    + f" method {self.name} and none of them have a 200 status code."
                 )
 
         elif num_response_schemas:
             response = responses_with_bodies[0]
         return response
 
+    def cls_type_annotation(self, *, async_mode: bool) -> str:
+        """We don't want the poller to show up in ClsType, so we call super() on resposne type annotation"""
+        return f"ClsType[{Response.type_annotation(self.responses[0], async_mode=async_mode)}]"
+
     @property
     def initial_operation(self) -> Operation:
-        operation = Operation(
-            yaml_data={},
+        """Initial operation that creates the first call for LRO polling"""
+        return Operation(
+            yaml_data=self.yaml_data,
             code_model=self.code_model,
             request_builder=self.code_model.lookup_request_builder(id(self.yaml_data)),
             name=self.name[5:] + "_initial",
-            description="",
-            api_versions=self.api_versions,
+            overloads=self.overloads,
             parameters=self.parameters,
-            schema_requests=self.schema_requests,
-            multiple_content_type_parameters=self.multiple_content_type_parameters,
-            summary=self.summary,
-            responses=self.responses,
-            want_description_docstring=False,
+            responses=[
+                Response(r.yaml_data, self.code_model, headers=r.headers, type=r.type)
+                for r in self.responses
+            ],
+            exceptions=self.exceptions,
+            public=False,
             want_tracing=False,
         )
-        operation.request_builder = self.request_builder
-        return operation
-
-    @property
-    def has_optional_return_type(self) -> bool:
-        """An LROOperation will never have an optional return type, we will always return a poller"""
-        return False
-
-    def _get_lro_extension(self, extension_base, async_mode, *, azure_arm=None):
-        extension_name = extension_base + ("-async" if async_mode else "-sync")
-        extension = self.yaml_data["extensions"][extension_name]
-        arm_extension = None
-        if azure_arm is not None:
-            arm_extension = "azure-arm" if azure_arm else "data-plane"
-        return extension[arm_extension] if arm_extension else extension
-
-    def get_poller_path(self, async_mode: bool) -> str:
-        return self._get_lro_extension("poller", async_mode)
 
     def get_poller(self, async_mode: bool) -> str:
-        return self.get_poller_path(async_mode).split(".")[-1]
-
-    def get_default_polling_method_path(self, async_mode: bool, azure_arm: bool) -> str:
-        return self._get_lro_extension(
-            "default-polling-method", async_mode, azure_arm=azure_arm
-        )
+        return self.responses[0].get_poller(async_mode)
 
-    def get_default_polling_method(self, async_mode: bool, azure_arm: bool) -> str:
-        return self.get_default_polling_method_path(async_mode, azure_arm).split(".")[
-            -1
-        ]
-
-    def get_default_no_polling_method_path(self, async_mode: bool) -> str:
-        return self._get_lro_extension("default-no-polling-method", async_mode)
-
-    def get_default_no_polling_method(self, async_mode: bool) -> str:
-        return self.get_default_no_polling_method_path(async_mode).split(".")[-1]
-
-    def get_base_polling_method_path(self, async_mode: bool) -> str:
-        return self._get_lro_extension("base-polling-method", async_mode)
+    def get_polling_method(self, async_mode: bool) -> str:
+        return self.responses[0].get_polling_method(async_mode)
 
     def get_base_polling_method(self, async_mode: bool) -> str:
-        return self.get_base_polling_method_path(async_mode).split(".")[-1]
+        return self.responses[0].get_base_polling_method(async_mode)
 
-    def imports_for_multiapi(self, async_mode: bool) -> FileImport:
-        file_import = super().imports_for_multiapi(async_mode)
-        poller_import_path = ".".join(self.get_poller_path(async_mode).split(".")[:-1])
-        poller = self.get_poller(async_mode)
-        file_import.add_submodule_import(
-            poller_import_path, poller, ImportType.AZURECORE, TypingSection.CONDITIONAL
-        )
-        return file_import
-
-    def imports(self, async_mode: bool, is_python3_file: bool) -> FileImport:
-        file_import = self._imports_base(async_mode, is_python3_file)
-        file_import.add_submodule_import(
-            "typing", "Union", ImportType.STDLIB, TypingSection.CONDITIONAL
-        )
-
-        poller_import_path = ".".join(self.get_poller_path(async_mode).split(".")[:-1])
-        poller = self.get_poller(async_mode)
-        file_import.add_submodule_import(
-            poller_import_path, poller, ImportType.AZURECORE
-        )
-
-        default_polling_method_import_path = ".".join(
-            self.get_default_polling_method_path(
-                async_mode, self.code_model.options["azure_arm"]
-            ).split(".")[:-1]
-        )
-        default_polling_method = self.get_default_polling_method(
-            async_mode, self.code_model.options["azure_arm"]
-        )
-        file_import.add_submodule_import(
-            default_polling_method_import_path,
-            default_polling_method,
-            ImportType.AZURECORE,
-        )
+    def get_base_polling_method_path(self, async_mode: bool) -> str:
+        return self.responses[0].get_base_polling_method_path(async_mode)
 
-        default_no_polling_method_import_path = ".".join(
-            self.get_default_no_polling_method_path(async_mode).split(".")[:-1]
-        )
-        default_no_polling_method = self.get_default_no_polling_method(async_mode)
-        file_import.add_submodule_import(
-            default_no_polling_method_import_path,
-            default_no_polling_method,
-            ImportType.AZURECORE,
-        )
+    def get_no_polling_method(self, async_mode: bool) -> str:
+        return self.responses[0].get_no_polling_method(async_mode)
 
-        base_polling_method_import_path = ".".join(
-            self.get_base_polling_method_path(async_mode).split(".")[:-1]
-        )
-        base_polling_method = self.get_base_polling_method(async_mode)
-        file_import.add_submodule_import(
-            base_polling_method_import_path, base_polling_method, ImportType.AZURECORE
-        )
-        file_import.add_submodule_import("typing", "cast", ImportType.STDLIB)
+    def imports(
+        self, async_mode: bool, is_python3_file: bool, **kwargs: Any
+    ) -> FileImport:
+        file_import = super().imports(async_mode, is_python3_file, **kwargs)
+        if self.abstract:
+            return file_import
         if async_mode:
             file_import.add_submodule_import(
-                "typing", "Optional", ImportType.STDLIB, TypingSection.CONDITIONAL
-            )
-        if self.code_model.options["tracing"] and self.want_tracing:
-            file_import.add_submodule_import(
-                f"azure.core.tracing.decorator{'_async' if async_mode else ''}",
-                f"distributed_trace{'_async' if async_mode else ''}",
+                f"azure.core.tracing.decorator_async",
+                f"distributed_trace_async",
                 ImportType.AZURECORE,
             )
+        file_import.add_submodule_import(
+            "typing", "Union", ImportType.STDLIB, TypingSection.CONDITIONAL
+        )
+        file_import.add_submodule_import("typing", "cast", ImportType.STDLIB)
         return file_import
+
+
+class LROOperation(LROOperationBase[LROResponse]):
+    ...

package/autorest/codegen/models/lro_paging_operation.py

@@ -3,21 +3,38 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
+from typing import Any
 from .imports import FileImport
-from .lro_operation import LROOperation
-from .paging_operation import PagingOperation
+from .lro_operation import LROOperationBase
+from .paging_operation import PagingOperationBase
+from .response import LROPagingResponse, Response
 
 
-class LROPagingOperation(PagingOperation, LROOperation):
-    def imports(self, async_mode: bool, is_python3_file: bool) -> FileImport:
-        lro_imports = LROOperation.imports(self, async_mode, is_python3_file)
-        paging_imports = PagingOperation.imports(self, async_mode, is_python3_file)
+class LROPagingOperation(
+    LROOperationBase[LROPagingResponse], PagingOperationBase[LROPagingResponse]
+):
+    @property
+    def success_status_codes(self):
+        """The list of all successfull status code."""
+        return [200]
+
+    @property
+    def operation_type(self) -> str:
+        return "lropaging"
+
+    def cls_type_annotation(self, *, async_mode: bool) -> str:
+        return f"ClsType[{Response.type_annotation(self.responses[0], async_mode=async_mode)}]"  # pylint: disable=no-member
+
+    def imports(
+        self, async_mode: bool, is_python3_file: bool, **kwargs: Any
+    ) -> FileImport:
+        lro_imports = LROOperationBase.imports(
+            self, async_mode, is_python3_file, **kwargs
+        )
+        paging_imports = PagingOperationBase.imports(
+            self, async_mode, is_python3_file, **kwargs
+        )
 
         file_import = lro_imports
         file_import.merge(paging_imports)
         return file_import
-
-    @property
-    def success_status_code(self):
-        """The list of all successfull status code."""
-        return [200]

package/autorest/codegen/models/model_type.py

@@ -0,0 +1,262 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+from typing import Any, Dict, List, Optional, TYPE_CHECKING, cast
+
+from autorest.codegen.models.utils import add_to_pylint_disable
+from .base_type import BaseType
+from .property import Property
+from .imports import FileImport, ImportType, TypingSection
+
+if TYPE_CHECKING:
+    from .code_model import CodeModel
+
+
+def _get_properties(type: "ModelType", properties: List[Property]) -> List[Property]:
+    for parent in type.parents:
+        # here we're adding the properties from our parents
+
+        # need to make sure that the properties we choose from our parent also don't contain
+        # any of our own properties
+        property_names = set(
+            [p.client_name for p in properties]
+            + [p.client_name for p in type.properties]
+        )
+        chosen_parent_properties = [
+            p for p in parent.properties if p.client_name not in property_names
+        ]
+        properties = _get_properties(parent, chosen_parent_properties) + properties
+    return properties
+
+
+class ModelType(BaseType):  # pylint: disable=too-many-instance-attributes
+    """Represents a class ready to be serialized in Python.
+
+    :param str name: The name of the class.
+    :param str description: The description of the class.
+    :param properties: the optional properties of the class.
+    :type properties: dict(str, str)
+    """
+
+    def __init__(
+        self,
+        yaml_data: Dict[str, Any],
+        code_model: "CodeModel",
+        *,
+        properties: Optional[List[Property]] = None,
+        parents: Optional[List["ModelType"]] = None,
+        discriminated_subtypes: Optional[Dict[str, "ModelType"]] = None,
+    ) -> None:
+        super().__init__(yaml_data=yaml_data, code_model=code_model)
+        self.name: str = self.yaml_data["name"]
+        self.max_properties: Optional[int] = self.yaml_data.get("maxProperties")
+        self.min_properties: Optional[int] = self.yaml_data.get("minProperties")
+        self.properties = properties or []
+        self.parents = parents or []
+        self.discriminated_subtypes = discriminated_subtypes or {}
+        self.discriminator_value: Optional[str] = self.yaml_data.get(
+            "discriminatorValue"
+        )
+        self._created_json_template_representation = False
+        self.is_public: bool = self.yaml_data.get("isPublic", True)
+        self.snake_case_name: str = self.yaml_data["snakeCaseName"]
+
+    @property
+    def is_xml(self) -> bool:
+        return self.yaml_data.get("isXml", False)
+
+    @property
+    def serialization_type(self) -> str:
+        if self.code_model.options["models_mode"]:
+            return self.name
+        return "object"
+
+    def type_annotation(self, **kwargs: Any) -> str:
+        if self.code_model.options["models_mode"]:
+            is_operation_file = kwargs.pop("is_operation_file", False)
+            if self.is_public:
+                retval = f"_models.{self.name}"
+                return retval if is_operation_file else f'"{retval}"'
+            return self.name if is_operation_file else f'"{self.name}"'
+        return "ET.Element" if self.is_xml else "JSON"
+
+    def docstring_type(self, **kwargs: Any) -> str:
+        if self.code_model.options["models_mode"]:
+            return f"~{self.code_model.namespace}.models.{self.name}"
+        return "ET.Element" if self.is_xml else "JSON"
+
+    def description(self, *, is_operation_file: bool = False) -> str:
+        return "" if is_operation_file else self.yaml_data.get("description", self.name)
+
+    def docstring_text(self, **kwargs: Any) -> str:
+        if self.code_model.options["models_mode"]:
+            return self.name
+        return "XML Element" if self.is_xml else "JSON object"
+
+    def get_declaration(self, value: Any) -> str:
+        return f"{self.name}()"
+
+    def __repr__(self) -> str:
+        return f"<{self.__class__.__name__} {self.name}>"
+
+    @property
+    def xml_serialization_ctxt(self) -> Optional[str]:
+        # object schema contains _xml_map, they don't need serialization context
+        return ""
+
+    @property
+    def xml_map_content(self) -> Optional[str]:
+        # This is NOT an error on the super call, we use the serialization context for "xml_map",
+        # but we don't want to write a serialization context for an object.
+        return super().xml_serialization_ctxt
+
+    @property
+    def discriminated_subtypes_name_mapping(self) -> Dict[str, str]:
+        return {k: v.name for k, v in self.discriminated_subtypes.items()}
+
+    def get_json_template_representation(
+        self,
+        *,
+        optional: bool = True,
+        client_default_value_declaration: Optional[str] = None,
+        description: Optional[str] = None,
+    ) -> Any:
+        if self._created_json_template_representation:
+            return "..."  # do this to avoid loop
+        self._created_json_template_representation = True
+        if self.discriminated_subtypes:
+            # we will instead print the discriminated subtypes
+            self._created_json_template_representation = False
+            return self.snake_case_name
+
+        # don't add additional properties, because there's not really a concept of
+        # additional properties in the template
+        representation = {
+            f'"{prop.rest_api_name}"': prop.get_json_template_representation(
+                optional=optional,
+                client_default_value_declaration=client_default_value_declaration,
+                description=description,
+            )
+            for prop in [
+                p
+                for p in self.properties
+                if not (p.is_discriminator or p.client_name == "additional_properties")
+            ]
+        }
+        if self.discriminator and self.discriminator_value:
+            representation[
+                f'"{self.discriminator.rest_api_name}"'
+            ] = f'"{self.discriminator_value}"'
+
+        # once we've finished, we want to reset created_json_template_representation to false
+        # so we can call it again
+        self._created_json_template_representation = False
+        return representation
+
+    def get_polymorphic_subtypes(self, polymorphic_subtypes: List["ModelType"]) -> None:
+        is_polymorphic_subtype = (
+            self.discriminator_value and not self.discriminated_subtypes
+        )
+        if (
+            self.name not in (m.name for m in polymorphic_subtypes)
+            and is_polymorphic_subtype
+        ):
+            polymorphic_subtypes.append(self)
+        for discriminated_subtype in self.discriminated_subtypes.values():
+            discriminated_subtype.get_polymorphic_subtypes(polymorphic_subtypes)
+        for property in self.properties:
+            property.get_polymorphic_subtypes(polymorphic_subtypes)
+
+    @classmethod
+    def from_yaml(
+        cls, yaml_data: Dict[str, Any], code_model: "CodeModel"
+    ) -> "ModelType":
+        raise ValueError(
+            "You shouldn't call from_yaml for ModelType to avoid recursion. "
+            "Please initial a blank ModelType, then call .fill_instance_from_yaml on the created type."
+        )
+
+    def fill_instance_from_yaml(
+        self, yaml_data: Dict[str, Any], code_model: "CodeModel"
+    ) -> None:
+        from . import build_type
+
+        self.parents = [
+            cast(ModelType, build_type(bm, code_model))
+            for bm in yaml_data.get("parents", [])
+        ]
+        properties = [
+            Property.from_yaml(p, code_model) for p in yaml_data["properties"]
+        ]
+        self.properties = _get_properties(self, properties)
+        # checking to see if this is a polymorphic class
+        self.discriminated_subtypes = {
+            k: cast(ModelType, build_type(v, code_model))
+            for k, v in self.yaml_data.get("discriminatedSubtypes", {}).items()
+        }
+
+    @property
+    def has_readonly_or_constant_property(self) -> bool:
+        return any(x.readonly or x.constant for x in self.properties)
+
+    @property
+    def discriminator(self) -> Optional[Property]:
+        try:
+            return next(p for p in self.properties if p.is_discriminator)
+        except StopIteration:
+            return None
+
+    @property
+    def instance_check_template(self) -> str:
+        if self.code_model.options["models_mode"]:
+            return "isinstance({}, msrest.Model)"
+        return "isinstance({}, MutableMapping)"
+
+    @property
+    def pylint_disable(self) -> str:
+        retval: str = ""
+        if len(self.properties) > 10:
+            retval = add_to_pylint_disable(retval, "too-many-instance-attributes")
+        return retval
+
+    @property
+    def init_pylint_disable(self) -> str:
+        retval: str = ""
+        if len(self.properties) > 23:
+            retval = add_to_pylint_disable(retval, "too-many-locals")
+        return retval
+
+    def imports(self, **kwargs: Any) -> FileImport:
+        file_import = FileImport()
+        relative_path = kwargs.pop("relative_path", None)
+        if self.code_model.options["models_mode"] and relative_path:
+            # add import for models in operations file
+            if self.is_public:
+                file_import.add_submodule_import(
+                    relative_path, "models", ImportType.LOCAL, alias="_models"
+                )
+            else:
+                # a little hacky, but we only do this for version tolerant
+                # models files, which are all python3 only
+                models_filename = self.code_model.get_models_filename(
+                    is_python3_file=True
+                )
+                file_import.add_submodule_import(
+                    f"{relative_path}models.{models_filename}",
+                    self.name,
+                    ImportType.LOCAL,
+                )
+        if self.code_model.options["models_mode"]:
+            return file_import
+        file_import.add_submodule_import(
+            "typing", "Any", ImportType.STDLIB, TypingSection.CONDITIONAL
+        )
+        file_import.add_import("sys", ImportType.STDLIB)
+        file_import.define_mutable_mapping_type()
+        if self.is_xml:
+            file_import.add_submodule_import(
+                "xml.etree", "ElementTree", ImportType.STDLIB, alias="ET"
+            )
+        return file_import