add --package-mode for new service to package

autorest/codegen/__init__.py

@@ -76,6 +76,21 @@ def _validate_code_model_options(options: Dict[str, Any]) -> None:
             "If you want operation files, pass in flag --show-operations"
         )
 
+    if options["package_mode"] == 'dataplane' and \
+        not all([options["package_name"], options["client_name"], options["credential_scopes"],
+                options["package_pprint_name"], options["output_folder"], options["input_file"]]):
+        raise ValueError(
+            "--package-name, --title, --package-pprint-name, --credential-scopes, --output-folder"
+            " --input-file are necessary"
+        )
+
+    if options["package_mode"] == 'dataplane' and options["azure_arm"]:
+        raise ValueError(
+            "--package_mode=dataplane and --azure-arm can not be used at the same time"
+        )
+
+
+
 _LOGGER = logging.getLogger(__name__)
 class CodeGenerator(Plugin):
     @staticmethod
@@ -134,7 +149,7 @@ def _create_code_model(self, yaml_data: Dict[str, Any], options: Dict[str, Union
         code_model.setup_client_input_parameters(yaml_data)
 
         # Get my namespace
-        namespace = self._autorestapi.get_value("namespace")
+        namespace = code_model.options.get("namespace", self._autorestapi.get_value("namespace"))
         _LOGGER.debug("Namespace parameter was %s", namespace)
         if not namespace:
             namespace = yaml_data["info"]["python_title"]
@@ -289,6 +304,12 @@ 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"),
+            "client_name": self._autorestapi.get_value("title"),
+            "credential_scopes": self._autorestapi.get_value("credential-scopes"),
+            "package_pprint_name": self._autorestapi.get_value("package-pprint-name"),
+            "output_folder": self._autorestapi.get_value("output-folder"),
+            "input_file": self._autorestapi.get_value("input-file"),
         }
 
         if options["builders_visibility"] is None:
@@ -306,8 +327,16 @@ def _build_code_model_options(self) -> Dict[str, Any]:
         if azure_arm:
             options["credential"] = True
             options["head_as_boolean"] = True
+
+        if options["package_mode"] == 'dataplane':
+            options["namespace"] = options["package_name"].replace("-", '.')
+            options["credential"] = True
+            options["basic_setup_py"] = True
+            options["package_version"] = options["package_version"] if options["package_version"] else "1.0.0b1"
+
         return options
 
+
     def process(self) -> bool:
         # List the input file, should be only one
         inputs = self._autorestapi.list_inputs()

autorest/codegen/serializers/__init__.py

@@ -3,8 +3,9 @@
 # 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, Any
 from pathlib import Path
+import time
 from jinja2 import PackageLoader, Environment
 from autorest.codegen.models.operation_group import OperationGroup
 
@@ -29,6 +30,31 @@
     "JinjaSerializer",
 ]
 
+def _get_environment(template_path: str) -> Environment:
+    return Environment(loader=PackageLoader("autorest.codegen", template_path))
+
+
+def _build_package_render_parameters(code_model: CodeModel) -> Any:
+    parameters = {}
+    parameters["package_name"] = code_model.options["package_name"]
+    parameters["package_version"] = code_model.options["package_version"]
+    parameters["namespace"] = code_model.options["namespace"]
+    folder_list = parameters["package_name"].split('-')
+    parameters["folder_first"] = folder_list[0]
+    parameters["folder_second"] = folder_list[1]
+    parameters["test_prefix"] = folder_list[-1]
+    parameters["date_to_release"] = time.strftime('%Y-%m-%d', time.localtime())
+    parameters["client_name"] = code_model.options["client_name"]
+    parameters["package_pprint_name"] = code_model.options["package_pprint_name"]
+    parameters['output_folder'] = code_model.options["output_folder"]
+    parameters['folder_parent'] = Path(parameters["output_folder"]).parts[-2]
+    parameters['input_file'] = code_model.options["input_file"]
+    parameters['credential_scopes'] = code_model.options["credential_scopes"]
+    parameters['swagger_readme_output'] = '../' + parameters["package_name"].replace('-', '/')
+
+
+    return parameters
+
 class JinjaSerializer:
     def __init__(self, autorestapi: AutorestAPI) -> None:
         self._autorestapi = autorestapi
@@ -72,6 +98,26 @@ def serialize(self, code_model: CodeModel) -> None:
             self._serialize_and_write_models_folder(code_model=code_model, env=env, namespace_path=namespace_path)
 
 
+        if code_model.options["package_mode"] == 'dataplane':
+            parameters = _build_package_render_parameters(code_model)
+            self._serialize_and_write_package_folder(
+                namespace_path=Path("."),
+                template_path="templates/templates_package_dataplane",
+                parameters=parameters
+            )
+
+
+    def _serialize_and_write_package_folder(
+        self, namespace_path: Path, template_path: str, parameters: Any
+    ) -> None:
+        env = _get_environment(template_path)
+        for template_name in env.list_templates():
+            template = env.get_template(template_name)
+            result = template.render(**parameters)
+            output_name = template_name.replace(".jinja2", "")
+            self._autorestapi.write_file(namespace_path / output_name, result)
+
+
 
     def _keep_patch_file(self, path_file: Path, env: Environment):
         if self._autorestapi.read_file(path_file):

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

@@ -0,0 +1,6 @@
+# Release History
+
+## 1.0.0b1 ({{ date_to_release }})
+
+- Initial version
+

autorest/codegen/templates/templates_package_dataplane/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_dataplane/MANIFEST.in.jinja2

@@ -0,0 +1,6 @@
+include *.md
+include {{ folder_first }}/__init__.py
+include {{ folder_first }}/{{ folder_second }}/__init__.py
+include LICENSE
+recursive-include tests *.py
+recursive-include samples *.py *.md

autorest/codegen/templates/templates_package_dataplane/README.md.jinja2

@@ -0,0 +1,87 @@
+# {{ package_pprint_name }} client library for Python
+<!-- write necessary description of service -->
+
+## _Disclaimer_
+
+_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, 
+please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_
+
+## Getting started
+
+### Installating the package
+
+```bash
+python -m pip install {{ package_name }}
+```
+
+#### Prequisites
+
+- Python 3.7+ is required to use this package.
+- You need an [Azure subscription][azure_sub] to use this package.
+- An existing {{ package_pprint_name }} instance.
+
+#### Create with an Azure Active Directory Credential
+To use an [Azure Active Directory (AAD) token credential][authenticate_with_token],
+provide an instance of the desired credential type obtained from the
+[azure-identity][azure_identity_credentials] library.
+
+To authenticate with AAD, you must first [pip][pip] install [`azure-identity`][azure_identity_pip]
+
+After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use.
+As an example, [DefaultAzureCredential][default_azure_credential] can be used to authenticate the client:
+
+Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
+`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`
+
+Use the returned token credential to authenticate the client:
+
+```python
+>>> from {{ namespace }} import {{ client_name }}
+>>> from azure.identity import DefaultAzureCredential
+>>> client = {{ client_name }}(endpoint='<endpoint>', credential=DefaultAzureCredential())
+```
+
+## Examples
+
+```python
+>>> from {{ namespace }} import {{ client_name }}
+>>> from azure.identity import DefaultAzureCredential
+>>> from azure.core.exceptions import HttpResponseError
+
+>>> client = {{ client_name }}(endpoint='<endpoint>', credential=DefaultAzureCredential())
+>>> try:
+        <!-- wirte test code here -->
+    except HttpResponseError as e:
+        print('service responds error: {}'.format(e.response.json()))
+
+```
+
+## Next steps
+
+More examples are coming soon...
+
+## Contributing
+
+This project welcomes contributions and suggestions. Most contributions require
+you to agree to a Contributor License Agreement (CLA) declaring that you have
+the right to, and actually do, grant us the rights to use your contribution.
+For details, visit https://cla.microsoft.com.
+
+When you submit a pull request, a CLA-bot will automatically determine whether
+you need to provide a CLA and decorate the PR appropriately (e.g., label,
+comment). Simply follow the instructions provided by the bot. You will only
+need to do this once across all repos using our CLA.
+
+This project has adopted the
+[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information,
+see the Code of Conduct FAQ or contact opencode@microsoft.com with any
+additional questions or comments.
+
+<!-- LINKS -->
+[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
+[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
+[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials
+[azure_identity_pip]: https://pypi.org/project/azure-identity/
+[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential
+[pip]: https://pypi.org/project/pip/
+[azure_sub]: https://azure.microsoft.com/free/

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

@@ -0,0 +1,7 @@
+-e ../../../tools/azure-devtools
+-e ../../../tools/azure-sdk-tools
+../../core/azure-core
+../../identity/azure-identity
+aiohttp>=3.0
+typing_extensions>=3.7.2
+asyncio

autorest/codegen/templates/templates_package_dataplane/samples/sample.py.jinja2

@@ -0,0 +1,53 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+#
+# Copyright (c) Microsoft Corporation. All rights reserved.
+#
+# The MIT License (MIT)
+#
+# 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.
+#
+# --------------------------------------------------------------------------
+import logging
+import os
+
+from {{ namespace }} import {{ client_name }}
+from azure.identity import DefaultAzureCredential
+from azure.core.exceptions import HttpResponseError
+
+logging.basicConfig(level=logging.DEBUG)
+LOG = logging.getLogger()
+
+# Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
+# AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET, {{ test_prefix.upper() }}_ENDPOINT
+try:
+    endpoint = os.environ["{{ test_prefix.upper() }}_ENDPOINT"]
+except KeyError:
+    LOG.error("Missing environment variable '{{ test_prefix.upper() }}_ENDPOINT' - please set if before running the example")
+    exit()
+
+# Build a client through AAD
+client = {{ client_name }}(credential=DefaultAzureCredential(), endpoint=endpoint)
+
+# write your sample here. For example:
+# try:
+#     result = client.xxx.xx(...)
+#     print(result)
+# except HttpResponseError as e:
+#     print('Failed to send JSON message: {}'.format(e.response.json()))

autorest/codegen/templates/templates_package_dataplane/sdk_packaging.toml.jinja2

@@ -0,0 +1,7 @@
+[packaging]
+package_name = "{{ package_name }}"
+package_nspkg = "{{ folder_first }}-{{ folder_second }}-nspkg"
+package_pprint_name = "{{ package_pprint_name }}"
+package_doc_id = ""
+is_stable = false
+is_arm = false

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

@@ -0,0 +1,68 @@
+#!/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 {} Client Library for Python".format(PACKAGE_PPRINT_NAME),
+    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/{{ folder_parent }}/{{ package_name }}",
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3 :: Only",
+        "Programming Language :: Python :: 3",
+        "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=[
+            # Exclude packages that will be covered by PEP420 or nspkg
+            "azure",
+            "azure.{{ folder_second }}",
+        ]
+    ),
+    install_requires=[
+        "azure-core<2.0.0,>=1.20.1",
+        "msrest>=0.6.21",
+        'six>=1.11.0',
+    ],
+    python_requires=">=3.7",
+)