@autorest/python 6.1.11 → 6.2.1

package/autorest/codegen/models/response.py

@@ -5,8 +5,8 @@
 # --------------------------------------------------------------------------
 from typing import Dict, Optional, List, Any, TYPE_CHECKING, Union
 
-from .base_model import BaseModel
-from .base_type import BaseType
+from .base import BaseModel
+from .base import BaseType
 from .imports import FileImport, ImportType
 from .primitive_types import BinaryType, BinaryIteratorType
 from .dictionary_type import DictionaryType
@@ -19,7 +19,10 @@ if TYPE_CHECKING:
 
 class ResponseHeader(BaseModel):
     def __init__(
-        self, yaml_data: Dict[str, Any], code_model: "CodeModel", type: BaseType
+        self,
+        yaml_data: Dict[str, Any],
+        code_model: "CodeModel",
+        type: BaseType,
     ) -> None:
         super().__init__(yaml_data, code_model)
         self.rest_api_name: str = yaml_data["restApiName"]

package/autorest/codegen/serializers/__init__.py

@@ -3,16 +3,20 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-from typing import Dict, List, Optional, Any, Union, cast
+import logging
+from typing import List, Optional, Any, Union, cast
 from pathlib import Path
 from jinja2 import PackageLoader, Environment, FileSystemLoader, StrictUndefined
-from autorest.codegen.models.operation_group import OperationGroup
-from autorest.codegen.models.request_builder import OverloadedRequestBuilder
 
 from ... import ReaderAndWriter, ReaderAndWriterAutorest
 from ...jsonrpc import AutorestAPI
-from ..models import CodeModel, OperationGroup, RequestBuilder
-from ..models import TokenCredentialType
+from ..models import (
+    OperationGroup,
+    RequestBuilder,
+    OverloadedRequestBuilder,
+    CodeModel,
+    Client,
+)
 from .enum_serializer import EnumSerializer
 from .general_serializer import GeneralSerializer
 from .model_init_serializer import ModelInitSerializer
@@ -22,6 +26,10 @@ from .operation_groups_serializer import OperationGroupsSerializer
 from .metadata_serializer import MetadataSerializer
 from .request_builders_serializer import RequestBuildersSerializer
 from .patch_serializer import PatchSerializer
+from .sample_serializer import SampleSerializer
+from ..._utils import to_snake_case
+
+_LOGGER = logging.getLogger(__name__)
 
 __all__ = [
     "JinjaSerializer",
@@ -41,7 +49,11 @@ _REGENERATE_FILES = {"setup.py", "MANIFEST.in"}
 
 class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
     def __init__(
-        self, code_model: CodeModel, *, output_folder: Union[str, Path], **kwargs: Any
+        self,
+        code_model: CodeModel,
+        *,
+        output_folder: Union[str, Path],
+        **kwargs: Any,
     ) -> None:
         super().__init__(output_folder=output_folder, **kwargs)
         self.code_model = code_model
@@ -49,39 +61,24 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
     @property
     def has_aio_folder(self) -> bool:
         return not self.code_model.options["no_async"] and bool(
-            self.code_model.request_builders
+            self.code_model.has_operations
         )
 
-    def serialize(self) -> None:
-        env = Environment(
-            loader=PackageLoader("autorest.codegen", "templates"),
-            keep_trailing_newline=True,
-            line_statement_prefix="##",
-            line_comment_prefix="###",
-            trim_blocks=True,
-            lstrip_blocks=True,
+    @property
+    def has_operations_folder(self) -> bool:
+        return self.code_model.options["show_operations"] and bool(
+            self.code_model.has_operations
         )
 
-        namespace_path = (
-            Path(".")
-            if self.code_model.options["no_namespace_folders"]
-            else Path(*(self.code_model.namespace.split(".")))
-        )
+    def _serialize_namespace_level(
+        self, env: Environment, namespace_path: Path, clients: List[Client]
+    ) -> None:
         # if there was a patch file before, we keep it
         self._keep_patch_file(namespace_path / Path("_patch.py"), env)
         if self.has_aio_folder:
             self._keep_patch_file(namespace_path / Path("aio") / Path("_patch.py"), env)
 
-        if self.code_model.options["models_mode"] and (
-            self.code_model.model_types or self.code_model.enums
-        ):
-            self._keep_patch_file(
-                namespace_path / Path("models") / Path("_patch.py"), env
-            )
-        if (
-            self.code_model.options["show_operations"]
-            and self.code_model.operation_groups
-        ):
+        if self.has_operations_folder:
             self._keep_patch_file(
                 namespace_path
                 / Path(self.code_model.operations_folder_name)
@@ -96,12 +93,11 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
                     / Path("_patch.py"),
                     env,
                 )
-
         self._serialize_and_write_top_level_folder(
-            env=env, namespace_path=namespace_path
+            env=env, namespace_path=namespace_path, clients=clients
         )
 
-        if self.code_model.request_builders:
+        if any(c for c in self.code_model.clients if c.operation_groups):
             if self.code_model.options["builders_visibility"] != "embedded":
                 self._serialize_and_write_rest_layer(
                     env=env, namespace_path=namespace_path
@@ -110,19 +106,78 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
                 self._serialize_and_write_aio_top_level_folder(
                     env=env,
                     namespace_path=namespace_path,
+                    clients=clients,
                 )
 
-        if (
-            self.code_model.options["show_operations"]
-            and self.code_model.operation_groups
-        ):
+        if self.has_operations_folder:
             self._serialize_and_write_operations_folder(
-                env=env, namespace_path=namespace_path
+                clients, env=env, namespace_path=namespace_path
             )
             if self.code_model.options["multiapi"]:
                 self._serialize_and_write_metadata(
                     env=env, namespace_path=namespace_path
                 )
+        if self.code_model.options["package_mode"]:
+            self._serialize_and_write_package_files(namespace_path=namespace_path)
+
+        if (
+            self.code_model.options["show_operations"]
+            and self.code_model.has_operations
+            and self.code_model.options["generate_sample"]
+            and not self.code_model.options["multiapi"]
+        ):
+            self._serialize_and_write_sample(env, namespace_path)
+
+    def serialize(self) -> None:
+        env = Environment(
+            loader=PackageLoader("autorest.codegen", "templates"),
+            keep_trailing_newline=True,
+            line_statement_prefix="##",
+            line_comment_prefix="###",
+            trim_blocks=True,
+            lstrip_blocks=True,
+        )
+
+        namespace_path = (
+            Path(".")
+            if self.code_model.options["no_namespace_folders"]
+            else Path(*(self.code_model.namespace.split(".")))
+        )
+
+        p = namespace_path.parent
+        general_serializer = GeneralSerializer(
+            code_model=self.code_model, env=env, async_mode=False
+        )
+        while p != Path("."):
+            # write pkgutil init file
+            self.write_file(
+                p / Path("__init__.py"),
+                general_serializer.serialize_pkgutil_init_file(),
+            )
+            p = p.parent
+
+        # serialize main module
+        self._serialize_namespace_level(
+            env,
+            namespace_path,
+            [c for c in self.code_model.clients if c.has_operations],
+        )
+        # serialize sub modules
+        for (
+            subnamespace,
+            clients,
+        ) in self.code_model.subnamespace_to_clients.items():
+            subnamespace_path = namespace_path / Path(subnamespace)
+            self._serialize_namespace_level(
+                env, subnamespace_path, [c for c in clients if c.has_operations]
+            )
+
+        if self.code_model.options["models_mode"] and (
+            self.code_model.model_types or self.code_model.enums
+        ):
+            self._keep_patch_file(
+                namespace_path / Path("models") / Path("_patch.py"), env
+            )
 
         if self.code_model.options["models_mode"] and (
             self.code_model.model_types or self.code_model.enums
@@ -138,57 +193,17 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
                     cast(str, self.read_file(namespace_path / Path("models.py"))),
                 )
 
-        if self.code_model.options["package_mode"]:
-            self._serialize_and_write_package_files(out_path=namespace_path)
-
-    def _serialize_and_write_package_files(self, out_path: Path) -> None:
-        def _serialize_and_write_package_files_proc(**kwargs: Any):
-            for template_name in package_files:
-                file = template_name.replace(".jinja2", "")
-                output_name = out_path / file
-                if not self.read_file(output_name) or file in _REGENERATE_FILES:
-                    template = env.get_template(template_name)
-                    render_result = template.render(**kwargs)
-                    self.write_file(output_name, render_result)
-
-        def _prepare_params() -> Dict[Any, Any]:
-            package_parts = (self.code_model.options["package_name"] or "").split("-")[
-                :-1
-            ]
-            token_cred = isinstance(
-                getattr(self.code_model.credential, "type", None), TokenCredentialType
-            )
-            version = self.code_model.options["package_version"]
-            if any(x in version for x in ["a", "b", "rc"]) or version[0] == "0":
-                dev_status = "4 - Beta"
-            else:
-                dev_status = "5 - Production/Stable"
-            params = {
-                "token_credential": token_cred,
-                "pkgutil_names": [
-                    ".".join(package_parts[: i + 1]) for i in range(len(package_parts))
-                ],
-                "init_names": [
-                    "/".join(package_parts[: i + 1]) + "/__init__.py"
-                    for i in range(len(package_parts))
-                ],
-                "dev_status": dev_status,
-                "client_name": self.code_model.client.name,
-                "namespace": self.code_model.namespace,
-                "code_model": self.code_model,
-            }
-            params.update(self.code_model.options)
-            params.update(self.code_model.package_dependency)
-            return params
-
-        out_path = out_path / Path("../" * (self.code_model.namespace.count(".") + 1))
+    def _serialize_and_write_package_files(self, namespace_path: Path) -> None:
+        root_of_sdk = self._package_root_folder(namespace_path)
         if self.code_model.options["package_mode"] in ("dataplane", "mgmtplane"):
             env = Environment(
-                loader=PackageLoader("autorest.codegen", "templates"),
+                loader=PackageLoader(
+                    "autorest.codegen", "templates/packaging_templates"
+                ),
                 undefined=StrictUndefined,
             )
+
             package_files = _PACKAGE_FILES
-            _serialize_and_write_package_files_proc(**_prepare_params())
         elif Path(self.code_model.options["package_mode"]).exists():
             env = Environment(
                 loader=FileSystemLoader(
@@ -198,8 +213,18 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
                 undefined=StrictUndefined,
             )
             package_files = env.list_templates()
-            params = self.code_model.options["package_configuration"] or {}
-            _serialize_and_write_package_files_proc(**params)
+        else:
+            return
+        serializer = GeneralSerializer(self.code_model, env, async_mode=False)
+        params = self.code_model.options["package_configuration"] or {}
+        for template_name in package_files:
+            file = template_name.replace(".jinja2", "")
+            output_name = root_of_sdk / file
+            if not self.read_file(output_name) or file in _REGENERATE_FILES:
+                self.write_file(
+                    output_name,
+                    serializer.serialize_package_file(template_name, **params),
+                )
 
     def _keep_patch_file(self, path_file: Path, env: Environment):
         if self.read_file(path_file):
@@ -239,12 +264,15 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
         self, env: Environment, namespace_path: Path
     ) -> None:
         rest_path = namespace_path / Path(self.code_model.rest_layer_name)
-        group_names = {rb.group_name for rb in self.code_model.request_builders}
+        group_names = {
+            rb.group_name for c in self.code_model.clients for rb in c.request_builders
+        }
 
         for group_name in group_names:
             request_builders = [
                 r
-                for r in self.code_model.request_builders
+                for c in self.code_model.clients
+                for r in c.request_builders
                 if r.group_name == group_name
             ]
             self._serialize_and_write_single_rest_layer(
@@ -287,6 +315,7 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
     def _serialize_and_write_operations_file(
         self,
         env: Environment,
+        clients: List[Client],
         namespace_path: Path,
         operation_group: Optional[OperationGroup] = None,
     ) -> None:
@@ -294,6 +323,7 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
         # write first sync file
         operation_group_serializer = OperationGroupsSerializer(
             code_model=self.code_model,
+            clients=clients,
             env=env,
             async_mode=False,
             operation_group=operation_group,
@@ -309,6 +339,7 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
             # write async operation group and operation files
             operation_group_async_serializer = OperationGroupsSerializer(
                 code_model=self.code_model,
+                clients=clients,
                 env=env,
                 async_mode=True,
                 operation_group=operation_group,
@@ -324,11 +355,11 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
             )
 
     def _serialize_and_write_operations_folder(
-        self, env: Environment, namespace_path: Path
+        self, clients: List[Client], env: Environment, namespace_path: Path
     ) -> None:
         # write sync operations init file
         operations_init_serializer = OperationsInitSerializer(
-            code_model=self.code_model, env=env, async_mode=False
+            code_model=self.code_model, clients=clients, env=env, async_mode=False
         )
         self.write_file(
             namespace_path
@@ -340,7 +371,7 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
         # write async operations init file
         if self.has_aio_folder:
             operations_async_init_serializer = OperationsInitSerializer(
-                code_model=self.code_model, env=env, async_mode=True
+                code_model=self.code_model, clients=clients, env=env, async_mode=True
             )
             self.write_file(
                 namespace_path
@@ -354,17 +385,22 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
             self._serialize_and_write_operations_file(
                 env=env,
                 namespace_path=namespace_path,
+                clients=clients,
             )
         else:
-            for operation_group in self.code_model.operation_groups:
-                self._serialize_and_write_operations_file(
-                    env=env,
-                    namespace_path=namespace_path,
-                    operation_group=operation_group,
-                )
+            for client in self.code_model.clients:
+                for operation_group in client.operation_groups:
+                    self._serialize_and_write_operations_file(
+                        env=env,
+                        namespace_path=namespace_path,
+                        operation_group=operation_group,
+                        clients=self.code_model.clients,
+                    )
 
     def _serialize_and_write_version_file(
-        self, namespace_path: Path, general_serializer: GeneralSerializer
+        self,
+        namespace_path: Path,
+        general_serializer: GeneralSerializer,
     ):
         def _read_version_file(original_version_file_name: str) -> str:
             return self.read_file(namespace_path / original_version_file_name)
@@ -386,8 +422,28 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
                 general_serializer.serialize_version_file(),
             )
 
+    def _serialize_client_and_config_files(
+        self,
+        namespace_path: Path,
+        general_serializer: GeneralSerializer,
+        async_mode: bool,
+        clients: List[Client],
+    ) -> None:
+        if self.code_model.has_operations:
+            namespace_path = (
+                namespace_path / Path("aio") if async_mode else namespace_path
+            )
+            self.write_file(
+                namespace_path / Path(f"{self.code_model.client_filename}.py"),
+                general_serializer.serialize_service_client_file(clients),
+            )
+            self.write_file(
+                namespace_path / Path("_configuration.py"),
+                general_serializer.serialize_config_file(clients),
+            )
+
     def _serialize_and_write_top_level_folder(
-        self, env: Environment, namespace_path: Path
+        self, env: Environment, namespace_path: Path, clients: List[Client]
     ) -> None:
         general_serializer = GeneralSerializer(
             code_model=self.code_model, env=env, async_mode=False
@@ -395,24 +451,13 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
 
         self.write_file(
             namespace_path / Path("__init__.py"),
-            general_serializer.serialize_init_file(),
+            general_serializer.serialize_init_file(clients),
         )
-        p = namespace_path.parent
-        while p != Path("."):
-            # write pkgutil init file
-            self.write_file(
-                p / Path("__init__.py"),
-                general_serializer.serialize_pkgutil_init_file(),
-            )
-            p = p.parent
 
         # Write the service client
-        if self.code_model.request_builders:
-            self.write_file(
-                namespace_path / Path(f"{self.code_model.client.filename}.py"),
-                general_serializer.serialize_service_client_file(),
-            )
-
+        self._serialize_client_and_config_files(
+            namespace_path, general_serializer, async_mode=False, clients=clients
+        )
         if self.code_model.need_vendored_code(async_mode=False):
             self.write_file(
                 namespace_path / Path("_vendor.py"),
@@ -438,25 +483,23 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
                 general_serializer.serialize_model_base_file(),
             )
 
-        if any(og for og in self.code_model.operation_groups if og.need_validation):
+        if any(
+            og
+            for client in self.code_model.clients
+            for og in client.operation_groups
+            if og.need_validation
+        ):
             self.write_file(
                 namespace_path / Path("_validation.py"),
                 general_serializer.serialize_validation_file(),
             )
 
-        # Write the config file
-        if self.code_model.request_builders:
-            self.write_file(
-                namespace_path / Path("_configuration.py"),
-                general_serializer.serialize_config_file(),
-            )
-
         # Write the setup file
         if self.code_model.options["basic_setup_py"]:
             self.write_file(Path("setup.py"), general_serializer.serialize_setup_file())
 
     def _serialize_and_write_aio_top_level_folder(
-        self, env: Environment, namespace_path: Path
+        self, env: Environment, namespace_path: Path, clients: List[Client]
     ) -> None:
         aio_general_serializer = GeneralSerializer(
             code_model=self.code_model, env=env, async_mode=True
@@ -466,20 +509,13 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
 
         # Write the __init__ file
         self.write_file(
-            aio_path / Path("__init__.py"), aio_general_serializer.serialize_init_file()
+            aio_path / Path("__init__.py"),
+            aio_general_serializer.serialize_init_file(clients),
         )
 
         # Write the service client
-        if self.code_model.request_builders:
-            self.write_file(
-                aio_path / Path(f"{self.code_model.client.filename}.py"),
-                aio_general_serializer.serialize_service_client_file(),
-            )
-
-        # Write the config file
-        self.write_file(
-            aio_path / Path("_configuration.py"),
-            aio_general_serializer.serialize_config_file(),
+        self._serialize_client_and_config_files(
+            namespace_path, aio_general_serializer, async_mode=True, clients=clients
         )
         if self.code_model.need_vendored_code(async_mode=True):
             self.write_file(
@@ -495,6 +531,38 @@ class JinjaSerializer(ReaderAndWriter):  # pylint: disable=abstract-method
             namespace_path / Path("_metadata.json"), metadata_serializer.serialize()
         )
 
+    # find root folder where "setup.py" is
+    def _package_root_folder(self, namespace_path: Path) -> Path:
+        return namespace_path / Path("../" * (self.code_model.namespace.count(".") + 1))
+
+    def _serialize_and_write_sample(self, env: Environment, namespace_path: Path):
+        out_path = self._package_root_folder(namespace_path) / Path("generated_samples")
+        for client in self.code_model.clients:
+            for op_group in client.operation_groups:
+                for operation in op_group.operations:
+                    samples = operation.yaml_data["samples"]
+                    if not samples or operation.name.startswith("_"):
+                        continue
+                    for key, value in samples.items():
+                        file_name = to_snake_case(key) + ".py"
+                        try:
+                            self.write_file(
+                                out_path / file_name,
+                                SampleSerializer(
+                                    code_model=self.code_model,
+                                    env=env,
+                                    operation_group=op_group,
+                                    operation=operation,
+                                    sample=value,
+                                    file_name=file_name,
+                                    sample_origin_name=key,
+                                ).serialize(),
+                            )
+                        except Exception as e:  # pylint: disable=broad-except
+                            # sample generation shall not block code generation, so just log error
+                            log_error = f"error happens in sample {key}: {e}"
+                            _LOGGER.error(log_error)
+
 
 class JinjaSerializerAutorest(JinjaSerializer, ReaderAndWriterAutorest):
     def __init__(
@@ -503,7 +571,11 @@ class JinjaSerializerAutorest(JinjaSerializer, ReaderAndWriterAutorest):
         code_model: CodeModel,
         *,
         output_folder: Union[str, Path],
+        **kwargs: Any,
     ) -> None:
         super().__init__(
-            autorestapi=autorestapi, code_model=code_model, output_folder=output_folder
+            autorestapi=autorestapi,
+            code_model=code_model,
+            output_folder=output_folder,
+            **kwargs,
         )

package/autorest/codegen/serializers/builder_serializer.py

@@ -12,8 +12,8 @@ from typing import Any, Generic, List, Type, TypeVar, Dict, Union, Optional, cas
 
 from ..models import (
     Operation,
-    CodeModel,
     PagingOperation,
+    CodeModel,
     LROOperation,
     LROPagingOperation,
     ModelType,
@@ -1203,9 +1203,7 @@ class _PagingOperationSerializer(
         next_link_str = "next_link"
         try:
             api_version_param = next(
-                p
-                for p in self.code_model.client.parameters
-                if p.rest_api_name == "api-version"
+                p for p in builder.client.parameters if p.rest_api_name == "api-version"
             )
             retval.append("# make call to next link with the client's api-version")
             retval.append("_parsed_next_link = urllib.parse.urlparse(next_link)")