@autorest/python 5.14.0 → 5.15.0

package/autorest/codegen/templates/metadata.json.jinja2

@@ -92,9 +92,9 @@
     },
     "config": {
         "credential": {{ code_model.options['credential'] | tojson }},
-        "credential_scopes": {{ (code_model.credential_schema_policy.credential_scopes if code_model.options['credential'] and code_model.credential_schema_policy.credential_scopes is defined else None)| tojson}},
-        "credential_call_sync": {{ (code_model.credential_schema_policy.call(async_mode=False) if code_model.options['credential'] else None) | tojson }},
-        "credential_call_async": {{ (code_model.credential_schema_policy.call(async_mode=True) if code_model.options['credential'] else None) | tojson }},
+        "credential_scopes": {{ (code_model.credential_model.credential_schema_policy.credential_scopes if code_model.options['credential'] and code_model.credential_model.credential_schema_policy.credential_scopes is defined else None)| tojson}},
+        "credential_call_sync": {{ (code_model.credential_model.credential_schema_policy.call(async_mode=False) if code_model.options['credential'] else None) | tojson }},
+        "credential_call_async": {{ (code_model.credential_model.credential_schema_policy.call(async_mode=True) if code_model.options['credential'] else None) | tojson }},
         "sync_imports": {{ sync_config_imports | tojson }},
         "async_imports": {{ async_config_imports | tojson }}
     },

package/autorest/codegen/templates/model.py.jinja2

@@ -1,12 +1,7 @@
-{% set basename = model.base_models | join(', ', attribute='name') if model.base_models else "" %}
 {# actual template starts here #}
 
 
-{% if basename %}
-class {{ model.name }}({{ basename }}):
-{% else %}
-class {{ model.name }}(msrest.serialization.Model):
-{% endif %}
+{{ declare_model(model) }}
     """{{ model.description }}
     {% if model.discriminator_name %}
 

package/autorest/codegen/templates/model_init.py.jinja2

@@ -1,8 +1,9 @@
+{% import 'keywords.jinja2' as keywords %}
 # coding=utf-8
 {{ code_model.options['license_header'] }}
 {% macro iterate_models_py3() %}
     {% for schema in schemas %}
-from ._models_py3 import {{ schema }}
+from .{{ code_model.get_models_filename(is_python3_file=True) }} import {{ schema }}
     {% endfor %}
 {% endmacro %}
 
@@ -14,19 +15,19 @@ try:
     {{ iterate_models_py3() | indent-}}
 except (SyntaxError, ImportError):
         {% for schema in schemas %}
-    from ._models import {{ schema }}  # type: ignore
+    from .{{ code_model.get_models_filename(is_python3_file=False) }} import {{ schema }}  # type: ignore
         {% endfor %}
     {% endif %}
 {% endif %}
 {% if enums %}
 
-from ._{{ code_model.module_name }}_enums import (
+from .{{ code_model.enums_filename }} import (
     {% for enum in enums %}
     {{ enum }},
     {% endfor %}
 )
 {% endif %}
-
+{{ keywords.patch_imports() }}
 __all__ = [
     {% for schema in schemas %}
     '{{ schema }}',
@@ -37,3 +38,5 @@ __all__ = [
     {% endfor %}
 {% endif %}
 ]
+{{ keywords.extend_all }}
+_patch_sdk()

package/autorest/codegen/templates/operation.py.jinja2

@@ -9,16 +9,15 @@
 {{ operation_serializer.method_signature_and_response_type_annotation(operation) }}
 {% if operation.want_description_docstring %}
     {{ op_tools.description(operation, operation_serializer) | indent }}{% endif %}
-    cls = kwargs.pop('cls', None)  {{ operation_serializer.cls_type_annotation(operation) }}
 {% if operation.deprecated %}
     warnings.warn('Method {{operation.name}} is deprecated', DeprecationWarning)
 {% endif %}
     {{ op_tools.serialize(operation_serializer.error_map(operation)) | indent }}
-    {% if operation.parameters.kwargs_to_pop(async_mode) %}
+    {% if operation_serializer.pop_kwargs_from_signature(operation) %}
     {{ op_tools.serialize(operation_serializer.pop_kwargs_from_signature(operation)) | indent }}
     {% endif %}
     {{ op_tools.serialize(operation_serializer.call_request_builder(operation)) | indent }}
-    pipeline_response = {{ keywords.await }}self._client._pipeline.run(  # pylint: disable=protected-access
+    pipeline_response = {{ keywords.await }}self._client._pipeline.run(  # type: ignore # pylint: disable=protected-access
         request,
         {{ stream_request_parameter }},
         **kwargs

package/autorest/codegen/templates/operation_group.py.jinja2

@@ -1,4 +1,11 @@
 {% set disable = "  # pylint: disable=too-many-public-methods" if operation_group.operations | length > 20 else "" %}
+{% if operation_group.is_empty_operation_group and code_model.need_mixin_abc %}
+    {% set object_base_class = "(MixinABC)" %}
+{% elif not (async_mode or code_model.options["python3_only"]) %}
+    {% set object_base_class = "(object)" %}
+{% else %}
+    {% set object_base_class = "" %}
+{% endif %}
 class {{ operation_group.class_name }}{{ object_base_class }}:{{ disable }}
 {% if not operation_group.is_empty_operation_group %}
     """
@@ -15,11 +22,11 @@ class {{ operation_group.class_name }}{{ object_base_class }}:{{ disable }}
 
 {% endif %}
     def __init__(self, *args, **kwargs){{ return_none_type_annotation }}:
-        args = list(args)
-        self._client = args.pop(0) if args else kwargs.pop("client")
-        self._config = args.pop(0) if args else kwargs.pop("config")
-        self._serialize = args.pop(0) if args else kwargs.pop("serializer")
-        self._deserialize = args.pop(0) if args else kwargs.pop("deserializer")
+        input_args = list(args)
+        self._client = input_args.pop(0) if input_args else kwargs.pop("client")
+        self._config = input_args.pop(0) if input_args else kwargs.pop("config")
+        self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
+        self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
 
 {% endif %}
 {% for operation in operation_group.operations %}

package/autorest/codegen/templates/operation_groups_container.py.jinja2

@@ -1,5 +1,4 @@
 {% import 'operation_tools.jinja2' as op_tools %}
-{% set object_base_class = "" if async_mode else "(object)" %}
 {% set operations_description = "async operations" if async_mode else "operations" %}
 {% set return_none_type_annotation = " -> None" if async_mode else "" %}
 # pylint: disable=too-many-lines

package/autorest/codegen/templates/operations_folder_init.py.jinja2

@@ -1,9 +1,11 @@
 {% import 'operation_tools.jinja2' as op_tools %}
+{% import 'keywords.jinja2' as keywords %}
 {# actual template starts here #}
 # coding=utf-8
 {{ code_model.options['license_header'] }}
 
 {{ op_tools.serialize(operation_group_imports()) }}
+{{ keywords.patch_imports() }}
 {% if operation_groups %}
 __all__ = [
     {% for operation_group in operation_groups %}
@@ -11,3 +13,5 @@ __all__ = [
     {% endfor %}
 ]
 {% endif %}
+{{ keywords.extend_all }}
+_patch_sdk()

package/autorest/codegen/templates/paging_operation.py.jinja2

@@ -9,7 +9,7 @@
 {% if operation.deprecated %}
     warnings.warn('Method {{operation.name}} is deprecated', DeprecationWarning)
 {% endif %}
-    {% if operation.parameters.kwargs_to_pop(async_mode) %}
+    {% if operation_serializer.pop_kwargs_from_signature(operation) %}
     {{ op_tools.serialize(operation_serializer.pop_kwargs_from_signature(operation)) | indent }}
     {% endif %}
     {{ op_tools.serialize(operation_serializer.set_up_params_for_pager(operation)) | indent }}

package/autorest/codegen/templates/patch.py.jinja2

@@ -1,31 +1,20 @@
-# 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.
-#
-# --------------------------------------------------------------------------
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+"""Customize generated code here.
+
+Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize
+"""
+{{ imports }}
+
+{% set type_annotation = ": List[str]" %}
+__all__{{ type_annotation if is_python3_file else "" }} = []{{ "" if is_python3_file else ("  # type" + type_annotation) }}  # Add all objects you want publicly available to users at this package level
 
-# This file 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
 def patch_sdk():
-    pass
+    """Do not remove from this file.
+
+    `patch_sdk` is a last resort escape hatch that allows you to do customizations
+    you can't accomplish using the techniques described in
+    https://aka.ms/azsdk/python/dpcodegen/python/customize
+    """

package/autorest/codegen/templates/request_builder.py.jinja2

@@ -4,13 +4,11 @@
 {% if code_model.options["builders_visibility"] == "public" %}
     {{ op_tools.description(request_builder, request_builder_serializer) | indent }}
 {% endif %}
-{% if request_builder.parameters.kwargs_to_pop(is_python3_file) %}
+{% if request_builder_serializer.pop_kwargs_from_signature(request_builder) %}
     {{ op_tools.serialize(request_builder_serializer.pop_kwargs_from_signature(request_builder)) | indent }}
-{% endif %}
-{% if request_builder.parameters.constant|selectattr("original_parameter", "equalto", None)|selectattr("in_method_code")|selectattr("in_method_signature", "equalto", False) %}
-    {% for constant_parameter in request_builder.parameters.constant|selectattr("original_parameter", "equalto", None)|selectattr("in_method_code")|selectattr("in_method_signature", "equalto", False) %}
-    {{ constant_parameter.serialized_name }} = {{ constant_parameter.constant_declaration }}
-    {% endfor %}
+{%- endif -%}
+{% if request_builder_serializer.declare_non_inputtable_constants(request_builder) %}
+    {{ op_tools.serialize(request_builder_serializer.declare_non_inputtable_constants(request_builder)) | indent }}
 {% endif %}
     # Construct URL
     {{ request_builder_serializer.construct_url(request_builder) }}

package/autorest/codegen/templates/vendor.py.jinja2

@@ -1,8 +1,9 @@
+{% import 'keywords.jinja2' as keywords with context %}
 {{ code_model.options['license_header'] }}
 
 {{ imports }}
 
-{% if code_model.need_request_converter %}
+{% if code_model.need_request_converter and not async_mode %}
 def _convert_request(request, files=None):
     data = request.content if not files else None
     request = HttpRequest(method=request.method, url=request.url, headers=request.headers, data=data)
@@ -10,7 +11,7 @@ def _convert_request(request, files=None):
         request.set_formdata_body(files)
     return request
 {% endif %}
-{% if code_model.need_format_url %}
+{% if code_model.need_format_url and not async_mode %}
 
 def _format_url_section(template, **kwargs):
     components = template.split("/")
@@ -24,3 +25,12 @@ def _format_url_section(template, **kwargs):
             ]
             template = "/".join(components)
 {% endif %}
+{% if code_model.need_mixin_abc %}
+
+class MixinABC(ABC):
+    """DO NOT use this class. It is for internal typing use only."""
+    _client: "{{ keywords.async_class }}PipelineClient"
+    _config: {{ code_model.class_name }}Configuration
+    _serialize: "Serializer"
+    _deserialize: "Deserializer"
+{% endif %}

package/autorest/multiapi/models/imports.py

@@ -4,7 +4,7 @@
 # license information.
 # --------------------------------------------------------------------------
 from enum import Enum
-from typing import Dict, Optional, Set
+from typing import Dict, Optional, Set, Union, Tuple
 
 
 class ImportType(str, Enum):
@@ -21,29 +21,39 @@ class TypingSection(str, Enum):
 
 class FileImport:
     def __init__(
-        self, imports: Dict[TypingSection, Dict[ImportType, Dict[str, Set[Optional[str]]]]] = None
+        self,
+        imports: Dict[
+            TypingSection, Dict[ImportType, Dict[str, Set[Optional[Union[str, Tuple[str, str]]]]]]
+        ] = None
     ) -> None:
         # Basic implementation
         # First level dict: TypingSection
         # Second level dict: ImportType
         # Third level dict: the package name.
         # Fourth level set: None if this import is a "import", the name to import if it's a "from"
-        self._imports: Dict[TypingSection, Dict[ImportType, Dict[str, Set[Optional[str]]]]] = imports or dict()
+        self._imports: Dict[
+            TypingSection, Dict[ImportType, Dict[str, Set[Optional[Union[str, Tuple[str, str]]]]]]
+        ] = imports or dict()
 
     def _add_import(
         self,
         from_section: str,
         import_type: ImportType,
-        name_import: Optional[str] = None,
+        name_import: Optional[Union[str, Tuple[str, str]]] = None,
         typing_section: TypingSection = TypingSection.REGULAR
     ) -> None:
+        name_input: Optional[Union[str, Tuple[str, str]]] = None
+        if isinstance(name_import, list):
+            name_input = tuple(name_import)
+        else:
+            name_input = name_import
         self._imports.setdefault(
-                typing_section, dict()
-            ).setdefault(
-                import_type, dict()
-            ).setdefault(
-                from_section, set()
-            ).add(name_import)
+            typing_section, dict()
+        ).setdefault(
+            import_type, dict()
+        ).setdefault(
+            from_section, set()
+        ).add(name_input)
 
     def add_submodule_import(
         self,
@@ -66,7 +76,7 @@ class FileImport:
         self._add_import(name_import, import_type, None, typing_section)
 
     @property
-    def imports(self) -> Dict[TypingSection, Dict[ImportType, Dict[str, Set[Optional[str]]]]]:
+    def imports(self) -> Dict[TypingSection, Dict[ImportType, Dict[str, Set[Optional[Union[str, Tuple[str, str]]]]]]]:
         return self._imports
 
     def merge(self, file_import: "FileImport") -> None:

package/autorest/multiapi/serializers/import_serializer.py

@@ -14,7 +14,9 @@ def _serialize_package(package_name: str, module_list: Set[Optional[str]], delim
     if module_list != {None}:
         buffer.append(
             "from {} import {}".format(
-                package_name, ", ".join(sorted([mod for mod in module_list if mod is not None]))
+                package_name, ", ".join(sorted([
+                    mod if isinstance(mod, str) else f"{mod[0]} as {mod[1]}" for mod in module_list if mod is not None
+                ]))
             )
         )
     return delimiter.join(buffer)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@autorest/python",
-    "version": "5.14.0",
+    "version": "5.15.0",
     "description": "The Python extension for generators in AutoRest.",
     "scripts": {
         "prepare": "node run-python3.js prepare.py",
@@ -27,7 +27,7 @@
         "@azure-tools/extension": "~3.2.1"
     },
     "devDependencies": {
-        "@microsoft.azure/autorest.testserver": "^3.3.20"
+        "@microsoft.azure/autorest.testserver": "3.3.23"
     },
     "files": [
         "autorest/**/*.py",