[Package mode] add new flag --package-mode

autorest/codegen/__init__.py

@@ -6,6 +6,7 @@
 import logging
 import sys
 from typing import Dict, Any, Set, Union, List, Type
+from pathlib import Path
 import yaml
 
 from .. import Plugin
@@ -76,6 +77,12 @@ def _validate_code_model_options(options: Dict[str, Any]) -> None:
             "If you want operation files, pass in flag --show-operations"
         )
 
+    if options["package_mode"] not in ("mgmtplane", "dataplane", None) and not Path(options["package_mode"]).exists():
+        raise ValueError(
+            "--package-mode can only be 'mgmtplane' or 'dataplane' or directory which contains template files"
+        )
+
+
 _LOGGER = logging.getLogger(__name__)
 class CodeGenerator(Plugin):
     @staticmethod
@@ -289,6 +296,9 @@ def _build_code_model_options(self) -> Dict[str, Any]:
             "low_level_client": low_level_client,
             "combine_operation_files": self._autorestapi.get_boolean_value("combine-operation-files", version_tolerant),
             "python3_only": python3_only,
+            "package_mode": self._autorestapi.get_value("package-mode"),
+            "package_pprint_name": self._autorestapi.get_value("package-pprint-name"),
+            "package_configuration": self._autorestapi.get_value("package-configuration")
         }
 
         if options["builders_visibility"] is None:

autorest/codegen/serializers/__init__.py

@@ -3,9 +3,10 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-from typing import List, Optional
+import time
+from typing import Dict, List, Optional, Any
 from pathlib import Path
-from jinja2 import PackageLoader, Environment
+from jinja2 import PackageLoader, Environment, FileSystemLoader, StrictUndefined
 from autorest.codegen.models.operation_group import OperationGroup
 
 from ...jsonrpc import AutorestAPI
@@ -71,6 +72,45 @@ def serialize(self, code_model: CodeModel) -> None:
         if code_model.options["models_mode"] and (code_model.schemas or code_model.enums):
             self._serialize_and_write_models_folder(code_model=code_model, env=env, namespace_path=namespace_path)
 
+        if code_model.options["package_mode"]:
+            self._serialize_and_write_package_files(code_model=code_model, out_path=namespace_path)
+
+
+    def _serialize_and_write_package_files(self, code_model: CodeModel, out_path: Path) -> None:
+        def _serialize_and_write_package_files_proc(**kwargs: Any):
+            for template_name in env.list_templates():
+                template = env.get_template(template_name)
+                render_result = template.render(**kwargs)
+                output_name = template_name.replace(".jinja2", "")
+                self._autorestapi.write_file(out_path / output_name, render_result)
+
+        def _prepare_params() -> Dict[Any, Any]:
+            package_parts = code_model.options["package_name"].split("-")[:-1]
+            params = {
+                "release_time": time.strftime('%Y-%m-%d', time.localtime()),
+                "nspkg_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))]
+            }
+            params.update(code_model.options)
+            return params
+
+        count = code_model.options["package_name"].count("-") + 1
+        for _ in range(count):
+            out_path = out_path / Path("..")
+
+        if code_model.options["package_mode"] in ("dataplane", "mgmtplane"):
+            env = Environment(
+                loader=PackageLoader("autorest.codegen", "templates/templates_package"),
+                undefined=StrictUndefined)
+            _serialize_and_write_package_files_proc(**_prepare_params())
+        elif Path(code_model.options["package_mode"]).exists():
+            env = Environment(
+                loader=FileSystemLoader(str(Path(code_model.options["package_mode"]))),
+                keep_trailing_newline=True,
+                undefined=StrictUndefined
+            )
+            params = code_model.options["package_configuration"] or {}
+            _serialize_and_write_package_files_proc(**params)
 
 
     def _keep_patch_file(self, path_file: Path, env: Environment):

autorest/codegen/templates/templates_package/CHANGELOG.md.jinja2

@@ -0,0 +1,6 @@
+# Release History
+
+## {{ package_version }} ({{ release_time }})
+
+- Initial version
+

autorest/codegen/templates/templates_package/LICENSE.jinja2

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

autorest/codegen/templates/templates_package/MANIFEST.in.jinja2

@@ -0,0 +1,10 @@
+include *.md
+include LICENSE
+recursive-include tests *.py
+recursive-include samples *.py *.md
+{%- for init_name in init_names %}
+include {{ init_name }}
+{%- endfor %}
+{%- if package_mode == "mgmtplane" %}
+include _meta.json
+{%- endif %}

autorest/codegen/templates/templates_package/dev_requirements.txt.jinja2

@@ -0,0 +1,9 @@
+-e ../../../tools/azure-devtools
+-e ../../../tools/azure-sdk-tools
+../../core/azure-core
+{% if package_mode == "mgmtplane" -%}
+../../identity/azure-identity
+{% endif -%}
+aiohttp>=3.0
+typing_extensions>=3.7.2
+asyncio

autorest/codegen/templates/templates_package/setup.py.jinja2

@@ -0,0 +1,73 @@
+#!/usr/bin/env python
+
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import os
+import re
+from setuptools import setup, find_packages
+
+# Change the PACKAGE_NAME only to change folder and different name
+PACKAGE_NAME = "{{ package_name }}"
+PACKAGE_PPRINT_NAME = "{{ package_pprint_name }}"
+
+# a-b-c => a/b/c
+package_folder_path = PACKAGE_NAME.replace("-", "/")
+
+# Version extraction inspired from 'requests'
+with open(os.path.join(package_folder_path, "_version.py"), "r") as fd:
+    version = re.search(
+        r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE
+    ).group(1)
+
+if not version:
+    raise RuntimeError("Cannot find version information")
+
+setup(
+    name=PACKAGE_NAME,
+    version=version,
+    description="Microsoft {{ package_pprint_name }} Client Library for Python",
+    long_description=open("README.md", "r").read(),
+    long_description_content_type="text/markdown",
+    license="MIT License",
+    author="Microsoft Corporation",
+    author_email="azpysdkhelp@microsoft.com",
+    url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk",
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3 :: Only",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "License :: OSI Approved :: MIT License",
+    ],
+    zip_safe=False,
+    packages=find_packages(
+        exclude=[
+            "tests",
+            "samples",
+            # Exclude packages that will be covered by PEP420 or nspkg
+            {%- for nspkg_name in nspkg_names %}
+            '{{ nspkg_name }}',
+            {%- endfor %}
+        ]
+    ),
+    install_requires=[
+        "msrest>=0.6.21",
+        {%- if package_mode == "mgmtplane" %}
+        "azure-common~=1.1",
+        "azure-mgmt-core>=1.3.0,<2.0.0",
+        {%- endif %}
+        {%- if package_mode == "dataplane" %}
+        "six>=1.11.0",
+        "azure-core<2.0.0,>=1.20.1",
+        {%- endif %}
+    ],
+    python_requires=">=3.6",
+)

tasks.py

@@ -361,6 +361,7 @@ def regenerate_legacy(c, swagger_name=None, debug=False):
         regenerate_samples(c, debug)
         regenerate_with_python3_operation_files(c, debug)
         regenerate_python3_only(c, debug)
+        regenerate_package_mode(c, debug)
 
 @task
 def regenerate(
@@ -482,6 +483,20 @@ def regenerate_multiapi(c, debug=False, swagger_name="test"):
 
     _run_autorest(cmds, debug)
 
+@task
+def regenerate_package_mode(c, debug=False):
+    cwd = os.getcwd()
+    package_mode = {
+        'mgmtplane': 'test/azure/legacy/specification/packagemodemgmtplane/README.md',
+        'dataplane': 'test/azure/legacy/specification/packagemodedataplane/README.md',
+        'test/azure/legacy/specification/packagemodecustomize/template': 'test/azure/legacy/specification/packagemodecustomize/README.md',
+    }
+    cmds = [
+        f'autorest {v} --use=. --python-sdks-folder={cwd}/test/ --package-mode={k}' for k,v in package_mode.items()
+    ]
+
+    _run_autorest(cmds, debug=debug)
+
 @task
 def regenerate_custom_poller_pager_legacy(c, debug=False):
     cwd = os.getcwd()

test/azure/legacy/Expected/AcceptanceTests/PackageModeCustomize/azure/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore

test/azure/legacy/Expected/AcceptanceTests/PackageModeCustomize/azure/package/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore

test/azure/legacy/Expected/AcceptanceTests/PackageModeCustomize/azure/package/mode/__init__.py

@@ -0,0 +1,19 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+
+from ._auto_rest_paging_test_service import AutoRestPagingTestService
+from ._version import VERSION
+
+__version__ = VERSION
+__all__ = ["AutoRestPagingTestService"]
+
+# `._patch.py` is used for handwritten extensions to the generated code
+# Example: https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/customize_code/how-to-patch-sdk-code.md
+from ._patch import patch_sdk
+
+patch_sdk()

test/azure/legacy/Expected/AcceptanceTests/PackageModeCustomize/azure/package/mode/_auto_rest_paging_test_service.py

@@ -0,0 +1,85 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+
+from copy import deepcopy
+from typing import Any, TYPE_CHECKING
+
+from msrest import Deserializer, Serializer
+
+from azure.core.rest import HttpRequest, HttpResponse
+from azure.mgmt.core import ARMPipelineClient
+
+from ._configuration import AutoRestPagingTestServiceConfiguration
+from .operations import PagingOperations
+
+if TYPE_CHECKING:
+    # pylint: disable=unused-import,ungrouped-imports
+    from typing import Dict
+
+    from azure.core.credentials import TokenCredential
+
+
+class AutoRestPagingTestService:
+    """Long-running Operation for AutoRest.
+
+    :ivar paging: PagingOperations operations
+    :vartype paging: azure.package.mode.operations.PagingOperations
+    :param credential: Credential needed for the client to connect to Azure.
+    :type credential: ~azure.core.credentials.TokenCredential
+    :keyword endpoint: Service URL. Default value is 'http://localhost:3000'.
+    :paramtype endpoint: str
+    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no
+     Retry-After header is present.
+    """
+
+    def __init__(
+        self, credential: "TokenCredential", *, endpoint: str = "http://localhost:3000", **kwargs: Any
+    ) -> None:
+
+        self._config = AutoRestPagingTestServiceConfiguration(credential=credential, **kwargs)
+        self._client = ARMPipelineClient(base_url=endpoint, config=self._config, **kwargs)
+
+        self._serialize = Serializer()
+        self._deserialize = Deserializer()
+        self._serialize.client_side_validation = False
+        self.paging = PagingOperations(self._client, self._config, self._serialize, self._deserialize)
+
+    def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse:
+        """Runs the network request through the client's chained policies.
+
+        >>> from azure.core.rest import HttpRequest
+        >>> request = HttpRequest("GET", "https://www.example.org/")
+        <HttpRequest [GET], url: 'https://www.example.org/'>
+        >>> response = client.send_request(request)
+        <HttpResponse: 200 OK>
+
+        For more information on this code flow, see https://aka.ms/azsdk/python/protocol/quickstart
+
+        :param request: The network request you want to make. Required.
+        :type request: ~azure.core.rest.HttpRequest
+        :keyword bool stream: Whether the response payload will be streamed. Defaults to False.
+        :return: The response of your network call. Does not do error handling on your response.
+        :rtype: ~azure.core.rest.HttpResponse
+        """
+
+        request_copy = deepcopy(request)
+        request_copy.url = self._client.format_url(request_copy.url)
+        return self._client.send_request(request_copy, **kwargs)
+
+    def close(self):
+        # type: () -> None
+        self._client.close()
+
+    def __enter__(self):
+        # type: () -> AutoRestPagingTestService
+        self._client.__enter__()
+        return self
+
+    def __exit__(self, *exc_details):
+        # type: (Any) -> None
+        self._client.__exit__(*exc_details)