@autorest/python 5.15.0 → 5.16.0

package/autorest/codegen/models/base_builder.py

@@ -3,14 +3,18 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-from typing import Any, Callable, Dict, List, Optional, Union
+from typing import Any, Callable, Dict, List, Optional, Union, TYPE_CHECKING
 from .base_model import BaseModel
 from .schema_response import SchemaResponse
 from .schema_request import SchemaRequest
 
+if TYPE_CHECKING:
+    from .code_model import CodeModel
+
 
 _M4_HEADER_PARAMETERS = ["content_type", "accept"]
 
+
 def create_parameters(
     yaml_data: Dict[str, Any], code_model, parameter_creator: Callable
 ):
@@ -40,9 +44,8 @@ def create_parameters(
         )
         if len(body_parameters_name_set) > 1:
             raise ValueError(
-            f"The body parameter with multiple media types has different names: {body_parameters_name_set}"
-        )
-
+                f"The body parameter with multiple media types has different names: {body_parameters_name_set}"
+            )
 
     parameters_index = {id(parameter.yaml_data): parameter for parameter in parameters}
 
@@ -58,34 +61,58 @@ def create_parameters(
 
     return parameters, multiple_content_type_parameters
 
+
 class BaseBuilder(BaseModel):
     """Base class for Operations and Request Builders"""
 
     def __init__(
         self,
-        code_model,
         yaml_data: Dict[str, Any],
+        code_model: "CodeModel",
         name: str,
         description: str,
         parameters,
         schema_requests: List[SchemaRequest],
         responses: Optional[List[SchemaResponse]] = None,
         summary: Optional[str] = None,
+        *,
+        abstract: bool = False,
+        want_tracing: bool = True,
     ) -> None:
-        super().__init__(yaml_data=yaml_data)
-        self.code_model = code_model
+        super().__init__(yaml_data=yaml_data, code_model=code_model)
         self.name = name
-        self.description = description
+        self._description = description
         self.parameters = parameters
         self.responses = responses or []
-        self.summary = summary
+        self._summary = summary
         self.schema_requests = schema_requests
+        # 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
+
+    @property
+    def summary(self) -> Optional[str]:
+        if self.abstract:
+            return None
+        return self._summary
+
+    @property
+    def description(self) -> str:
+        if self.abstract:
+            return (
+                f'You need to write a custom operation for "{self.name}". Please refer to '
+                "https://aka.ms/azsdk/python/dpcodegen/python/customize to learn how to customize."
+            )
+        return self._description
 
     @property
     def default_content_type_declaration(self) -> str:
         return f'"{self.parameters.default_content_type}"'
 
-    def get_response_from_status(self, status_code: Optional[Union[str, int]]) -> SchemaResponse:
+    def get_response_from_status(
+        self, status_code: Optional[Union[str, int]]
+    ) -> SchemaResponse:
         for response in self.responses:
             if status_code in response.status_codes:
                 return response
@@ -94,4 +121,14 @@ class BaseBuilder(BaseModel):
     @property
     def success_status_code(self) -> List[Union[str, int]]:
         """The list of all successfull status code."""
-        return [code for response in self.responses for code in response.status_codes if code != "default"]
+        return [
+            code
+            for response in self.responses
+            for code in response.status_codes
+            if code != "default"
+        ]
+
+    def method_signature(self, is_python3_file: bool) -> List[str]:
+        if self.abstract:
+            return ["*args,", "**kwargs"]
+        return self.parameters.method_signature(is_python3_file)

package/autorest/codegen/models/base_model.py

@@ -3,7 +3,10 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-from typing import Any, Dict
+from typing import Any, Dict, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .code_model import CodeModel
 
 
 class BaseModel:
@@ -13,10 +16,9 @@ class BaseModel:
     :type yaml_data: dict[str, Any]
     """
 
-    def __init__(
-        self, yaml_data: Dict[str, Any],
-    ) -> None:
+    def __init__(self, yaml_data: Dict[str, Any], code_model: "CodeModel") -> None:
         self.yaml_data = yaml_data
+        self.code_model = code_model
 
     @property
     def id(self) -> int:

package/autorest/codegen/models/base_schema.py

@@ -4,11 +4,14 @@
 # license information.
 # --------------------------------------------------------------------------
 from abc import ABC, abstractmethod
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union, TYPE_CHECKING
 
 from .base_model import BaseModel
 from .imports import FileImport
 
+if TYPE_CHECKING:
+    from .code_model import CodeModel
+
 
 class BaseSchema(BaseModel, ABC):
     """This is the base class for all schema models.
@@ -17,18 +20,19 @@ class BaseSchema(BaseModel, ABC):
     :type yaml_data: dict[str, Any]
     """
 
-    def __init__(self, namespace: str, yaml_data: Dict[str, Any]) -> None:
-        super().__init__(yaml_data)
-        self.namespace = namespace
+    def __init__(self, yaml_data: Dict[str, Any], code_model: "CodeModel") -> None:
+        super().__init__(yaml_data, code_model)
         self.default_value = yaml_data.get("defaultValue", None)
         self.xml_metadata = yaml_data.get("serialization", {}).get("xml", {})
-        self.api_versions = set(value_dict["version"] for value_dict in yaml_data.get("apiVersions", []))
+        self.api_versions = set(
+            value_dict["version"] for value_dict in yaml_data.get("apiVersions", [])
+        )
 
     @classmethod
     def from_yaml(
-        cls, namespace: str, yaml_data: Dict[str, Any], **kwargs  # pylint: disable=unused-argument
+        cls, yaml_data: Dict[str, Any], code_model: "CodeModel"
     ) -> "BaseSchema":
-        return cls(namespace=namespace, yaml_data=yaml_data)
+        return cls(yaml_data=yaml_data, code_model=code_model)
 
     @property
     def extra_description_information(self) -> str:
@@ -77,8 +81,7 @@ class BaseSchema(BaseModel, ABC):
     @property
     @abstractmethod
     def docstring_text(self) -> str:
-        """The names used in rtype documentation
-        """
+        """The names used in rtype documentation"""
         ...
 
     @property
@@ -113,26 +116,24 @@ class BaseSchema(BaseModel, ABC):
 
     @property
     def default_value_declaration(self) -> str:
-        """Return the default value as string using get_declaration.
-        """
+        """Return the default value as string using get_declaration."""
         if self.default_value is None:
             return "None"
         return self.get_declaration(self.default_value)
 
     @property
-    def validation_map(self) -> Optional[Dict[str, Union[bool, int, str]]]:  # pylint: disable=no-self-use
+    def validation_map(
+        self,
+    ) -> Optional[Dict[str, Union[bool, int, str]]]:  # pylint: disable=no-self-use
         return None
 
     @property
-    def serialization_constraints(self) -> Optional[List[str]]:  # pylint: disable=no-self-use
+    def serialization_constraints(
+        self,
+    ) -> Optional[List[str]]:  # pylint: disable=no-self-use
         return None
 
     @abstractmethod
     def get_json_template_representation(self, **kwargs: Any) -> Any:
         """Template of what this schema would look like as JSON input"""
         ...
-
-    @abstractmethod
-    def get_files_and_data_template_representation(self, **kwargs: Any) -> Any:
-        """Template of what this schema would look like as files input"""
-        ...

package/autorest/codegen/models/client.py

@@ -3,15 +3,18 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-from typing import List, Optional
+from typing import List, Optional, TYPE_CHECKING
 from .parameter_list import GlobalParameterList
 from .imports import FileImport, ImportType, TypingSection
 
+if TYPE_CHECKING:
+    from .code_model import CodeModel
+
+
 class Client:
-    """A service client.
-    """
+    """A service client."""
 
-    def __init__(self, code_model, parameters: GlobalParameterList):
+    def __init__(self, code_model: "CodeModel", parameters: GlobalParameterList):
         self.code_model = code_model
         self.parameters = parameters
         self.parameterized_host_template: Optional[str] = None
@@ -34,14 +37,26 @@ class Client:
         file_import = FileImport()
 
         file_import.add_submodule_import("msrest", "Serializer", ImportType.THIRDPARTY)
-        file_import.add_submodule_import("msrest", "Deserializer", ImportType.THIRDPARTY)
-        file_import.add_submodule_import("typing", "Any", ImportType.STDLIB, TypingSection.CONDITIONAL)
+        file_import.add_submodule_import(
+            "msrest", "Deserializer", ImportType.THIRDPARTY
+        )
+        file_import.add_submodule_import(
+            "typing", "Any", ImportType.STDLIB, TypingSection.CONDITIONAL
+        )
 
         any_optional_gp = any(not gp.required for gp in self.parameters)
 
-        legacy = not any(g for g in ["low_level_client", "version_tolerant"] if g in self.code_model.options)
-        if any_optional_gp or (legacy and self.code_model.service_client.parameters.host):
-            file_import.add_submodule_import("typing", "Optional", ImportType.STDLIB, TypingSection.CONDITIONAL)
+        legacy = not any(
+            g
+            for g in ["low_level_client", "version_tolerant"]
+            if g in self.code_model.options
+        )
+        if any_optional_gp or (
+            legacy and self.code_model.service_client.parameters.host
+        ):
+            file_import.add_submodule_import(
+                "typing", "Optional", ImportType.STDLIB, TypingSection.CONDITIONAL
+            )
 
         if self.code_model.options["azure_arm"]:
             file_import.add_submodule_import(
@@ -55,8 +70,9 @@ class Client:
         for gp in self.code_model.global_parameters:
             file_import.merge(gp.imports())
         file_import.add_submodule_import(
-            "._configuration", f"{self.code_model.class_name}Configuration",
-            ImportType.LOCAL
+            "._configuration",
+            f"{self.code_model.class_name}Configuration",
+            ImportType.LOCAL,
         )
 
         return file_import
@@ -66,18 +82,29 @@ class Client:
         if async_mode:
             file_import.add_submodule_import("typing", "Awaitable", ImportType.STDLIB)
             file_import.add_submodule_import(
-                "azure.core.rest", "AsyncHttpResponse", ImportType.AZURECORE, TypingSection.CONDITIONAL
+                "azure.core.rest",
+                "AsyncHttpResponse",
+                ImportType.AZURECORE,
+                TypingSection.CONDITIONAL,
             )
         else:
             file_import.add_submodule_import(
-                "azure.core.rest", "HttpResponse", ImportType.AZURECORE, TypingSection.CONDITIONAL
+                "azure.core.rest",
+                "HttpResponse",
+                ImportType.AZURECORE,
+                TypingSection.CONDITIONAL,
             )
         file_import.add_submodule_import(
-            "azure.core.rest", "HttpRequest", ImportType.AZURECORE, TypingSection.CONDITIONAL
+            "azure.core.rest",
+            "HttpRequest",
+            ImportType.AZURECORE,
+            TypingSection.CONDITIONAL,
         )
         for og in self.code_model.operation_groups:
             file_import.add_submodule_import(
-                f".{self.code_model.operations_folder_name}", og.class_name, ImportType.LOCAL
+                f".{self.code_model.operations_folder_name}",
+                og.class_name,
+                ImportType.LOCAL,
             )
 
         if self.code_model.sorted_schemas:
@@ -86,25 +113,42 @@ class Client:
         else:
             # in this case, we have client_models = {} in the service client, which needs a type annotation
             # this import will always be commented, so will always add it to the typing section
-            file_import.add_submodule_import("typing", "Dict", ImportType.STDLIB, TypingSection.TYPING)
+            file_import.add_submodule_import(
+                "typing", "Dict", ImportType.STDLIB, TypingSection.TYPING
+            )
         file_import.add_submodule_import("copy", "deepcopy", ImportType.STDLIB)
         return file_import
 
     def imports_for_multiapi(self, async_mode: bool) -> FileImport:
         file_import = self._imports_shared(async_mode)
         try:
-            mixin_operation = next(og for og in self.code_model.operation_groups if og.is_empty_operation_group)
-            file_import.add_submodule_import("._operations_mixin", mixin_operation.class_name, ImportType.LOCAL)
+            mixin_operation = next(
+                og
+                for og in self.code_model.operation_groups
+                if og.is_empty_operation_group
+            )
+            file_import.add_submodule_import(
+                "._operations_mixin", mixin_operation.class_name, ImportType.LOCAL
+            )
         except StopIteration:
             pass
         return file_import
 
     def send_request_signature(self, is_python3_file: bool) -> List[str]:
-        request_signature = ["request: HttpRequest," if is_python3_file else "request,  # type: HttpRequest"]
-        return request_signature + self.parameters.method_signature_kwargs(is_python3_file)
+        request_signature = [
+            "request: HttpRequest,"
+            if is_python3_file
+            else "request,  # type: HttpRequest"
+        ]
+        return request_signature + self.parameters.method_signature_kwargs(
+            is_python3_file
+        )
 
     @property
     def filename(self) -> str:
-        if self.code_model.options["version_tolerant"] or self.code_model.options["low_level_client"]:
+        if (
+            self.code_model.options["version_tolerant"]
+            or self.code_model.options["low_level_client"]
+        ):
             return "_client"
         return f"_{self.code_model.module_name}"