@autorest/python 5.11.2 → 5.12.0

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

@@ -1,13 +1,6 @@
 {% import 'keywords.jinja2' as keywords with context %}
 {% import 'operation_tools.jinja2' as op_tools %}
 {% set version_import = ".._version" if async_mode else "._version" %}
-{% macro method_signature() %}
-def __init__(
-    self,
-    {% for param_signature in code_model.global_parameters.config_method_signature(async_mode) %}
-    {{ param_signature }}
-    {% endfor %}
-){{" -> None" if async_mode else "" }}:{% endmacro %}
 {# actual template starts here #}
 # coding=utf-8
 {{ code_model.options['license_header'] }}
@@ -32,10 +25,7 @@ class {{ code_model.class_name }}Configuration(Configuration):
 {% endfor %}
     """
 
-    {{ method_signature()|indent }}
-    {% if not async_mode %}
-        # type: (...) -> None
-    {% endif %}
+    {{ serializer.init_signature_and_response_type_annotation(async_mode) | indent }}
         super({{ code_model.class_name }}Configuration, self).__init__(**kwargs)
     {% if code_model.service_client.parameters.config_kwargs_to_pop(async_mode) %}
         {{ op_tools.serialize(serializer.pop_kwargs_from_signature(async_mode)) | indent(8) }}

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

@@ -9,8 +9,7 @@ __version__ = VERSION
 {% endif %}
 __all__ = ['{{ code_model.class_name }}']
 
-try:
-    from ._patch import patch_sdk  # type: ignore
-    patch_sdk()
-except ImportError:
-    pass
+# `._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()

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

@@ -20,7 +20,7 @@
         "sync": {
             {% for gp in sync_global_parameters.config_method %}
             {{ gp.serialized_name | tojson }}: {
-                "signature": {{ gp.method_signature(is_python_3_file=False) | tojson }},
+                "signature": {{ gp.method_signature(is_python3_file=False) | tojson }},
                 "description": {{ gp.description | tojson }},
                 "docstring_type": {{ gp.docstring_type | tojson }},
                 "required": {{ gp.required | tojson }}
@@ -30,7 +30,7 @@
         "async": {
             {% for gp in async_global_parameters.config_method %}
             {{ gp.serialized_name | tojson }}: {
-                "signature": {{ (gp.method_signature(is_python_3_file=True)) | tojson }},
+                "signature": {{ (gp.method_signature(is_python3_file=True)) | tojson }},
                 "description": {{ gp.description | tojson }},
                 "docstring_type": {{ gp.docstring_type | tojson }},
                 "required": {{ gp.required | tojson }}

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

@@ -7,7 +7,7 @@ from ._models_py3 import {{ schema }}
 {% endmacro %}
 
 {% if schemas %}
-    {% if code_model.options["python_3_only"] %}
+    {% if code_model.options["python3_only"] %}
 {{ iterate_models_py3() }}
     {% else %}
 try:

package/autorest/codegen/templates/{operations_class.py.jinja2 → operation_group.py.jinja2}

@@ -1,4 +1,5 @@
 class {{ operation_group.class_name }}{{ object_base_class }}:
+{% if not operation_group.is_empty_operation_group %}
     """{{ operation_group.class_name }} {{ operations_description }}.
 
     You should not instantiate this class directly. Instead, you should create a Client instance that
@@ -23,6 +24,7 @@ class {{ operation_group.class_name }}{{ object_base_class }}:
         self._serialize = serializer
         self._deserialize = deserializer
         self._config = config
+{% endif %}
 {% for operation in operation_group.operations %}
 
 {% set request_builder = operation.request_builder %}

package/autorest/codegen/templates/{operations_container.py.jinja2 → operation_groups_container.py.jinja2}

@@ -2,39 +2,25 @@
 {% 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 "" %}
-{% set operation_group = operation_groups[0] %}
 # coding=utf-8
 {{ code_model.options['license_header'] }}
 {{ imports }}
 
 {% if code_model.options["builders_visibility"] == "embedded" and not async_mode %}
 {{ op_tools.declare_serializer(code_model) }}
-{%- if not is_python_3_file %}
+{%- if not is_python3_file %}
 # fmt: off
 {% endif %}
-{% if not code_model.options['combine_operation_files'] %}
+{% for operation_group in operation_groups %}
     {% for request_builder in code_model.rest.request_builders | selectattr("operation_group_name", "equalto", operation_group.name) %}
 
         {% include "request_builder.py.jinja2" %}
     {% endfor %}
-{% else %}
-    {% for request_builder in code_model.rest.request_builders %}
-
-        {% include "request_builder.py.jinja2" %}
-    {% endfor %}
-{% endif %}
-{% if not is_python_3_file %}
+{% endfor %}
+{% if not is_python3_file %}
 # fmt: on
 {% endif %}
 {% endif %}
-{% if not code_model.options['combine_operation_files'] %}
-    {% include "operations_class.py.jinja2" %}
-{% else %}
-    {% for operation_group in operation_groups %}
-        {% if operation_group.is_empty_operation_group %}
-            {% include "operations_class_mixin.py.jinja2" %}
-        {% else %}
-            {% include "operations_class.py.jinja2" %}
-        {% endif %}
-    {% endfor %}
-{% endif %}
+{% for operation_group in operation_groups %}
+    {% include "operation_group.py.jinja2" %}
+{% endfor %}

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

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

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

@@ -0,0 +1,31 @@
+# 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.
+#
+# --------------------------------------------------------------------------
+
+# 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

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

@@ -4,7 +4,7 @@
 {% 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_python_3_file) %}
+{% if request_builder.parameters.kwargs_to_pop(is_python3_file) %}
     {{ 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) %}
@@ -13,7 +13,12 @@
     {% endfor %}
 {% endif %}
     # Construct URL
-    url = kwargs.pop("template_url", {{ keywords.escape_str(request_builder.url) }})
+{% if code_model.options["version_tolerant"] or code_model.options["low_level_client"] %}
+    {% set url_value = keywords.escape_str(request_builder.url) %}
+{% else %}
+    {% set url_value = 'kwargs.pop("template_url", ' + keywords.escape_str(request_builder.url) + ')' %}
+{% endif %}
+    url = {{ url_value }}
 {% if request_builder.parameters.path %}
     {{ op_tools.serialize(request_builder_serializer.serialize_path(request_builder)) | indent }}
     url = _format_url_section(url, **path_format_arguments)

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

@@ -4,7 +4,7 @@
 {{ imports }}
 
 {{ op_tools.declare_serializer(code_model) }}
-{% if not is_python_3_file %}
+{% if not is_python3_file %}
 # fmt: off
 {% endif %}
 {% for request_builder in request_builders %}

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

@@ -16,7 +16,7 @@ VERSION = "{{ code_model.options.get('package_version', '0.0.0') }}"
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 
-REQUIRES = ["msrest>=0.6.21", "azure-core<2.0.0,>=1.20.0"{{ azure_mgmt_core_import }}]
+REQUIRES = ["msrest>=0.6.21", "azure-core<2.0.0,>=1.20.1"{{ azure_mgmt_core_import }}]
 
 setup(
     name=NAME,

package/autorest/multiapi/serializers/__init__.py

@@ -55,7 +55,7 @@ class MultiAPISerializer(object):
         # serialize service client file
         imports = FileImportSerializer(
             code_model.service_client.imports(async_mode),
-            is_python_3_file=async_mode
+            is_python3_file=async_mode
         )
         self._autorestapi.write_file(
             _get_file_path(code_model.service_client.filename, async_mode),
@@ -65,7 +65,7 @@ class MultiAPISerializer(object):
         # serialize config file
         imports = FileImportSerializer(
             code_model.config.imports(async_mode),
-            is_python_3_file=async_mode
+            is_python3_file=async_mode
         )
         self._autorestapi.write_file(
             _get_file_path("_configuration", async_mode),
@@ -76,7 +76,7 @@ class MultiAPISerializer(object):
         if code_model.operation_mixin_group.mixin_operations:
             imports = FileImportSerializer(
                 code_model.operation_mixin_group.imports(async_mode),
-                is_python_3_file=async_mode
+                is_python3_file=async_mode
             )
             self._autorestapi.write_file(
                 _get_file_path("_operations_mixin", async_mode),

package/autorest/multiapi/serializers/import_serializer.py

@@ -36,9 +36,9 @@ def _get_import_clauses(imports: Dict[ImportType, Dict[str, Set[Optional[str]]]]
 
 
 class FileImportSerializer:
-    def __init__(self, file_import: FileImport, is_python_3_file: bool) -> None:
+    def __init__(self, file_import: FileImport, is_python3_file: bool) -> None:
         self._file_import = file_import
-        self.is_python_3_file = is_python_3_file
+        self.is_python3_file = is_python3_file
 
     def _switch_typing_section_key(self, new_key: TypingSection):
         switched_dictionary = {}
@@ -60,7 +60,7 @@ class FileImportSerializer:
     def _add_type_checking_import(self):
         if (
             self._file_import.imports.get(TypingSection.TYPING) or
-            (not self.is_python_3_file and self._file_import.imports.get(TypingSection.CONDITIONAL))
+            (not self.is_python3_file and self._file_import.imports.get(TypingSection.CONDITIONAL))
         ):
             self._file_import.add_from_import("typing", "TYPE_CHECKING", ImportType.STDLIB)
 
@@ -68,7 +68,7 @@ class FileImportSerializer:
         self._add_type_checking_import()
         regular_imports = ""
         regular_imports_dict = self._get_imports_dict(
-            baseline_typing_section=TypingSection.REGULAR, add_conditional_typing=self.is_python_3_file
+            baseline_typing_section=TypingSection.REGULAR, add_conditional_typing=self.is_python3_file
         )
 
         if regular_imports_dict:
@@ -78,7 +78,7 @@ class FileImportSerializer:
 
         typing_imports = ""
         typing_imports_dict = self._get_imports_dict(
-            baseline_typing_section=TypingSection.TYPING, add_conditional_typing=not self.is_python_3_file
+            baseline_typing_section=TypingSection.TYPING, add_conditional_typing=not self.is_python3_file
         )
         if typing_imports_dict:
             typing_imports += "\n\nif TYPE_CHECKING:\n    # pylint: disable=unused-import,ungrouped-imports\n    "

package/autorest/namer/name_converter.py

@@ -71,6 +71,7 @@ class NameConverter:
             operation_group_name = operation_group['language']['default']['name']
             if not operation_group_name:
                 operation_group['language']['python']['className'] = code_model_title + "OperationsMixin"
+                operation_group['language']['python']['name'] = ""
             elif operation_group_name == 'Operations':
                 operation_group['language']['python']['className'] = operation_group_name
             else:

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@autorest/python",
-    "version": "5.11.2",
+    "version": "5.12.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.1.6"
+        "@microsoft.azure/autorest.testserver": "^3.1.8"
     },
     "files": [
         "autorest/**/*.py",

package/setup.py

@@ -48,6 +48,7 @@ setup(
         "json-rpc",
         "Jinja2 >= 2.11", # I need "include" and auto-context + blank line are not indented by default
         "pyyaml",
+        "mistune < 2.0.0",
         "m2r",
         "black",
     ],

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

@@ -1,16 +0,0 @@
-class {{ operation_group.class_name }}{{ object_base_class }}:
-{% for operation in operation_group.operations %}
-
-{% set request_builder = operation.request_builder %}
-{% set operation_serializer = get_operation_serializer(operation) %}
-    {% if is_lro(operation) and is_paging(operation) %}
-    {%- macro someop() %}{% include "lro_paging_operation.py.jinja2" %}{% endmacro %}
-    {% elif is_lro(operation) %}
-    {%- macro someop() %}{% include "lro_operation.py.jinja2" %}{% endmacro %}
-    {% elif is_paging(operation) %}
-    {% macro someop() %}{% include "paging_operation.py.jinja2" %}{% endmacro %}
-    {% else %}
-    {% macro someop() %}{% include "operation.py.jinja2" %}{% endmacro %}
-    {% endif %}
-    {{ someop()|indent }}
-{% endfor %}

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

@@ -1,24 +0,0 @@
-{% macro operation_group_imports(filename_suffix="") %}
-    {% for operation_group in operation_groups %}
-from .{{ ("_operations" if code_model.options['combine_operation_files'] else operation_group.filename) + filename_suffix }} import {{ operation_group.class_name }}
-    {% endfor %}
-{% endmacro %}
-{# actual template starts here #}
-# coding=utf-8
-{{ code_model.options['license_header'] }}
-
-{% if not code_model.options["add_python_3_operation_files"] %}
-{{ operation_group_imports() }}
-{% elif code_model.options["add_python_3_operation_files"] and code_model.options["python_3_only"] %}
-{{ operation_group_imports("_py3") }}
-{% else %}
-try:
-    {{ operation_group_imports("_py3") | indent }}
-except (SyntaxError, ImportError):
-    {{ operation_group_imports() | indent }}
-{% endif %}
-__all__ = [
-{% for operation_group in operation_groups %}
-    '{{ operation_group.class_name }}',
-{% endfor %}
-]

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

@@ -1,21 +0,0 @@
-{% import 'operation_tools.jinja2' as op_tools %}
-{% set object_base_class = "" if async_mode else "(object)" %}
-{% set operation_group = operation_groups[0] %}
-# coding=utf-8
-{{ code_model.options['license_header'] }}
-{{ imports }}
-
-{% if code_model.options["builders_visibility"] == "embedded" and not async_mode %}
-{{ op_tools.declare_serializer(code_model) }}
-{%- if not is_python_3_file %}
-# fmt: off
-{% endif %}
-    {% for request_builder in code_model.rest.request_builders | selectattr("builder_group_name", "equalto", "") %}
-
-    {% include "request_builder.py.jinja2" %}
-    {% endfor %}
-{% if not is_python_3_file %}
-# fmt: on
-{% endif %}
-{% endif %}
-{% include "operations_class_mixin.py.jinja2" %}

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

@@ -1,26 +0,0 @@
-{% macro operation_group_imports(filename_suffix="") %}
-    {% for operation_group in operation_groups %}
-from .{{ operation_group.filename + filename_suffix }} import {{ operation_group.class_name }}
-    {% endfor %}
-{% endmacro %}
-{# actual template starts here #}
-# coding=utf-8
-{{ code_model.options['license_header'] }}
-
-{% if not code_model.options["add_python_3_operation_files"] %}
-{{ operation_group_imports() }}
-{% elif code_model.options["add_python_3_operation_files"] and code_model.options["python_3_only"] %}
-{{ operation_group_imports("_py3") }}
-{% else %}
-try:
-    {{ operation_group_imports("_py3") | indent }}
-except (SyntaxError, ImportError):
-    {{ operation_group_imports() | indent }}
-{% endif %}
-{% if operation_groups %}
-__all__ = [
-{% for operation_group in operation_groups %}
-    '{{ operation_group.class_name }}',
-{% endfor %}
-]
-{% endif %}