only add polling interval in service client doc if package has lro operations

autorest/codegen/models/code_model.py

@@ -368,3 +368,11 @@ def generate_single_parameter_from_multiple_media_types(self) -> None:
                         raise ValueError("You are missing a parameter that has multiple media types")
                     chosen_parameter.multiple_media_types_type_annot = f"Union[{type_annot}]"
                     chosen_parameter.multiple_media_types_docstring_type = docstring_type
+
+    @property
+    def has_lro_operations(self) -> bool:
+        return any([
+            operation.is_lro
+            for operation_group in self.operation_groups
+            for operation in operation_group.operations
+        ])

autorest/codegen/models/lro_operation.py

@@ -109,3 +109,7 @@ def imports(self, code_model, async_mode: bool) -> FileImport:
             else:
                 file_import.add_from_import("azure.core.polling.base_polling", "LROBasePolling", ImportType.AZURECORE)
         return file_import
+
+    @property
+    def is_lro(self):
+        return True

autorest/codegen/models/lro_paging_operation.py

@@ -55,4 +55,11 @@ def imports(self, code_model, async_mode: bool) -> FileImport:
         file_import = lro_imports
         file_import.merge(paging_imports)
         return file_import
-
+
+    @property
+    def is_lro(self):
+        return True
+
+    @property
+    def is_paging(self):
+        return True

autorest/codegen/models/operation.py

@@ -306,6 +306,14 @@ def imports(self, code_model, async_mode: bool) -> FileImport:
 
         return file_import
 
+    @property
+    def is_lro(self):
+        return False
+
+    @property
+    def is_paging(self):
+        return False
+
     @classmethod
     def from_yaml(cls, yaml_data: Dict[str, Any]) -> "Operation":
         name = yaml_data["language"]["python"]["name"]

autorest/codegen/models/paging_operation.py

@@ -113,6 +113,10 @@ def success_status_code(self) -> List[Union[str, int]]:
             return [200]
         return super(PagingOperation, self).success_status_code
 
+    @property
+    def is_paging(self):
+        return True
+
     def imports(self, code_model, async_mode: bool) -> FileImport:
         file_import = super(PagingOperation, self).imports(code_model, async_mode)
 

autorest/codegen/serializers/metadata_serializer.py

@@ -11,8 +11,6 @@
     CodeModel,
     Operation,
     OperationGroup,
-    LROOperation,
-    PagingOperation,
     CredentialSchema,
     ParameterList,
     TypingSection,
@@ -83,12 +81,6 @@ def _make_async_copy_of_global_parameters(self) -> ParameterList:
         return global_parameters
 
     def serialize(self) -> str:
-        def _is_lro(operation):
-            return isinstance(operation, LROOperation)
-
-        def _is_paging(operation):
-            return isinstance(operation, PagingOperation)
-
         mixin_operation_group: Optional[OperationGroup] = next(
             (operation_group
             for operation_group in self.code_model.operation_groups if operation_group.is_empty_operation_group),
@@ -122,8 +114,6 @@ def _is_paging(operation):
             async_global_parameters=async_global_parameters,
             mixin_operations=mixin_operations,
             any=any,
-            is_lro=_is_lro,
-            is_paging=_is_paging,
             str=str,
             sync_mixin_imports=(
                 _json_serialize_imports(sync_mixin_imports.imports)

autorest/codegen/serializers/operation_group_serializer.py

@@ -6,7 +6,7 @@
 from jinja2 import Environment
 
 from .import_serializer import FileImportSerializer
-from ..models import LROOperation, PagingOperation, CodeModel, OperationGroup
+from ..models import CodeModel, OperationGroup
 
 
 class OperationGroupSerializer:
@@ -19,12 +19,6 @@ def __init__(
         self.async_mode = async_mode
 
     def serialize(self) -> str:
-        def _is_lro(operation):
-            return isinstance(operation, LROOperation)
-
-        def _is_paging(operation):
-            return isinstance(operation, PagingOperation)
-
         operation_group_template = self.env.get_template("operations_container.py.jinja2")
         if self.operation_group.is_empty_operation_group:
             operation_group_template = self.env.get_template("operations_container_mixin.py.jinja2")
@@ -40,6 +34,4 @@ def _is_paging(operation):
                 is_python_3_file=self.async_mode
             ),
             async_mode=self.async_mode,
-            is_lro=_is_lro,
-            is_paging=_is_paging,
         )

autorest/codegen/templates/metadata.json.jinja2

@@ -10,7 +10,8 @@
         {% set base_url =  code_model.base_url if code_model.base_url else ('https://management.azure.com' if code_model.options["azure_arm"] else None )%}
         "base_url": {{ (keywords.escape_str(base_url) if base_url else None) | tojson }},
         "custom_base_url": {{ (keywords.escape_str(code_model.custom_base_url) if code_model.custom_base_url else None) | tojson }},
-        "azure_arm": {{ code_model.options["azure_arm"]  | tojson }}
+        "azure_arm": {{ code_model.options["azure_arm"]  | tojson }},
+        "has_lro_operations": {{ code_model.has_lro_operations | tojson }}
     },
     "global_parameters": {
         "sync_method": {
@@ -57,16 +58,16 @@
     },
     "operation_mixins": {
         {% for operation in mixin_operations %}
-        {% set operation_name = "begin_" + operation.name if is_lro(operation) else operation.name %}
+        {% set operation_name = "begin_" + operation.name if operation.is_lro else operation.name %}
         {{ operation_name | tojson }} : {
             "sync": {
-                {% if is_lro(operation) and is_paging(operation) %}
+                {% if operation.is_lro and operation.is_paging %}
                     {% from "lro_paging_operation.py.jinja2" import operation_docstring with context %}
                     {% set sync_return_type_wrapper = ["LROPoller", "ItemPaged"] %}
-                {% elif is_lro(operation) %}
+                {% elif operation.is_lro %}
                     {% from "lro_operation.py.jinja2" import operation_docstring with context %}
                     {% set sync_return_type_wrapper = ["LROPoller"] %}
-                {% elif is_paging(operation) %}
+                {% elif operation.is_paging %}
                     {% from "paging_operation.py.jinja2" import operation_docstring with context %}
                     {% set sync_return_type_wrapper = ["ItemPaged"] %}
                 {% else %}
@@ -77,15 +78,15 @@
                 "doc": {{ operation_docstring(async_mode=False) | tojson }}
             },
             "async": {
-                {% set coroutine = False if is_paging(operation) else True %}
+                {% set coroutine = False if operation.is_paging else True %}
                 "coroutine": {{ coroutine | tojson }},
-                {% if is_lro(operation) and is_paging(operation) %}
+                {% if operation.is_lro and operation.is_paging %}
                     {% from "lro_paging_operation.py.jinja2" import operation_docstring with context %}
                     {% set async_return_type_wrapper = ["AsyncLROPoller", "AsyncItemPaged"] %}
-                {% elif is_lro(operation) %}
+                {% elif operation.is_lro %}
                     {% from "lro_operation.py.jinja2" import operation_docstring with context %}
                     {% set async_return_type_wrapper = ["AsyncLROPoller"] %}
-                {% elif is_paging(operation) %}
+                {% elif operation.is_paging %}
                     {% from "paging_operation.py.jinja2" import operation_docstring with context %}
                     {% set async_return_type_wrapper = ["AsyncItemPaged"] %}
                 {% else %}

autorest/codegen/templates/operations_container.py.jinja2

@@ -35,11 +35,11 @@ class {{ operation_group.class_name }}{{ object_base_class }}:
         self._config = config
 {% for operation in operation_group.operations %}
 
-    {% if is_lro(operation) and is_paging(operation) %}
+    {% if operation.is_lro and operation.is_paging %}
     {% macro someop() %}{% include "lro_paging_operation.py.jinja2" %}{% endmacro %}
-    {% elif is_lro(operation) %}
+    {% elif operation.is_lro %}
     {% macro someop() %}{% include "lro_operation.py.jinja2" %}{% endmacro %}
-    {% elif is_paging(operation) %}
+    {% elif operation.is_paging %}
     {% macro someop() %}{% include "paging_operation.py.jinja2" %}{% endmacro %}
     {% else %}
     {% macro someop() %}{% include "operation.py.jinja2" %}{% endmacro %}

autorest/codegen/templates/operations_container_mixin.py.jinja2

@@ -9,11 +9,11 @@
 class {{ operation_group.class_name }}{{ object_base_class }}:
 {% for operation in operation_group.operations %}
 
-    {% if is_lro(operation) and is_paging(operation) %}
+    {% if operation.is_lro and operation.is_paging %}
     {%- macro someop() %}{% include "lro_paging_operation.py.jinja2" %}{% endmacro %}
-    {% elif is_lro(operation) %}
+    {% elif operation.is_lro %}
     {%- macro someop() %}{% include "lro_operation.py.jinja2" %}{% endmacro %}
-    {% elif is_paging(operation) %}
+    {% elif operation.is_paging %}
     {% macro someop() %}{% include "paging_operation.py.jinja2" %}{% endmacro %}
     {% else %}
     {% macro someop() %}{% include "operation.py.jinja2" %}{% endmacro %}

autorest/codegen/templates/service_client.py.jinja2

@@ -60,7 +60,9 @@ class {{ code_model.class_name }}({{ base_class }}):
     {% if not code_model.custom_base_url %}
     :param str base_url: Service URL
     {% endif %}
+    {% if code_model.has_lro_operations %}
     :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
+    {% endif %}
     """
 
     {{ method_signature()|indent }}

autorest/multiapi/__init__.py

@@ -312,6 +312,17 @@ def _merge_mixin_imports_across_versions(
 
         return imports
 
+    def _has_lro_operations(
+        self, paths_to_versions: List[Path]
+    ) -> bool:
+        has_lro_operations = False
+        for version_path in paths_to_versions:
+            metadata_json = json.loads(self._autorestapi.read_file(version_path / "_metadata.json"))
+            current_client_has_lro_operations = metadata_json["client"]["has_lro_operations"]
+            if current_client_has_lro_operations:
+                has_lro_operations = True
+        return has_lro_operations
+
     def process(self) -> bool:
         _LOGGER.info("Generating multiapi client")
         # If True, means the auto-profile will consider preview versions.
@@ -417,7 +428,8 @@ def process(self) -> bool:
             "async_imports": str(FileImportSerializer(async_imports, is_python_3_file=True)),
             "base_url": metadata_json["client"]["base_url"],
             "custom_base_url_to_api_version": self._build_custom_base_url_to_api_version(paths_to_versions),
-            "azure_arm": metadata_json["client"]["azure_arm"]
+            "azure_arm": metadata_json["client"]["azure_arm"],
+            "has_lro_operations": self._has_lro_operations(paths_to_versions)
         }
 
         multiapi_serializer = MultiAPISerializer(

autorest/multiapi/templates/multiapi_service_client.py.jinja2

@@ -78,7 +78,9 @@ class {{ client_name }}({% if mixin_operations %}{{ client_name }}OperationsMixi
     {% endif %}
     :param profile: A profile definition, from KnownProfiles to dict.
     :type profile: azure.profiles.KnownProfiles
+    {% if has_lro_operations %}
     :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
+    {% endif %}
     """
 
     DEFAULT_API_VERSION = '{{ last_api_version }}'

test/azure/Expected/AcceptanceTests/AzureBodyDuration/bodyduration/_auto_rest_duration_test_service.py

@@ -26,7 +26,6 @@ class AutoRestDurationTestService(object):
     :ivar duration: DurationOperations operations
     :vartype duration: bodyduration.operations.DurationOperations
     :param str base_url: Service URL
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/AzureBodyDuration/bodyduration/aio/_auto_rest_duration_test_service_async.py

@@ -22,7 +22,6 @@ class AutoRestDurationTestService(object):
     :ivar duration: DurationOperations operations
     :vartype duration: bodyduration.aio.operations_async.DurationOperations
     :param str base_url: Service URL
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/AzureParameterGrouping/azureparametergrouping/_auto_rest_parameter_grouping_test_service.py

@@ -26,7 +26,6 @@ class AutoRestParameterGroupingTestService(object):
     :ivar parameter_grouping: ParameterGroupingOperations operations
     :vartype parameter_grouping: azureparametergrouping.operations.ParameterGroupingOperations
     :param str base_url: Service URL
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/AzureParameterGrouping/azureparametergrouping/aio/_auto_rest_parameter_grouping_test_service_async.py

@@ -22,7 +22,6 @@ class AutoRestParameterGroupingTestService(object):
     :ivar parameter_grouping: ParameterGroupingOperations operations
     :vartype parameter_grouping: azureparametergrouping.aio.operations_async.ParameterGroupingOperations
     :param str base_url: Service URL
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/AzureReport/azurereport/_auto_rest_report_service_for_azure.py

@@ -24,7 +24,6 @@ class AutoRestReportServiceForAzure(AutoRestReportServiceForAzureOperationsMixin
     """Test Infrastructure for AutoRest.
 
     :param str base_url: Service URL
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/AzureReport/azurereport/aio/_auto_rest_report_service_for_azure_async.py

@@ -20,7 +20,6 @@ class AutoRestReportServiceForAzure(AutoRestReportServiceForAzureOperationsMixin
     """Test Infrastructure for AutoRest.
 
     :param str base_url: Service URL
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/AzureSpecials/azurespecialproperties/_auto_rest_azure_special_parameters_test_client.py

@@ -53,7 +53,6 @@ class AutoRestAzureSpecialParametersTestClient(object):
     :param subscription_id: The subscription id, which appears in the path, always modeled in credentials. The value is always '1234-5678-9012-3456'.
     :type subscription_id: str
     :param str base_url: Service URL
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/AzureSpecials/azurespecialproperties/aio/_auto_rest_azure_special_parameters_test_client_async.py

@@ -51,7 +51,6 @@ class AutoRestAzureSpecialParametersTestClient(object):
     :param subscription_id: The subscription id, which appears in the path, always modeled in credentials. The value is always '1234-5678-9012-3456'.
     :type subscription_id: str
     :param str base_url: Service URL
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/CustomBaseUri/custombaseurl/_auto_rest_parameterized_host_test_client.py

@@ -27,7 +27,6 @@ class AutoRestParameterizedHostTestClient(object):
     :vartype paths: custombaseurl.operations.PathsOperations
     :param host: A string value that is used as a global part of the parameterized host.
     :type host: str
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/CustomBaseUri/custombaseurl/aio/_auto_rest_parameterized_host_test_client_async.py

@@ -23,7 +23,6 @@ class AutoRestParameterizedHostTestClient(object):
     :vartype paths: custombaseurl.aio.operations_async.PathsOperations
     :param host: A string value that is used as a global part of the parameterized host.
     :type host: str
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/CustomUrlPaging/custombaseurlpaging/_auto_rest_parameterized_host_test_paging_client.py

@@ -31,7 +31,6 @@ class AutoRestParameterizedHostTestPagingClient(object):
     :type credential: ~azure.core.credentials.TokenCredential
     :param host: A string value that is used as a global part of the parameterized host.
     :type host: str
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/CustomUrlPaging/custombaseurlpaging/aio/_auto_rest_parameterized_host_test_paging_client_async.py

@@ -29,7 +29,6 @@ class AutoRestParameterizedHostTestPagingClient(object):
     :type credential: ~azure.core.credentials_async.AsyncTokenCredential
     :param host: A string value that is used as a global part of the parameterized host.
     :type host: str
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/Head/head/_auto_rest_head_test_service.py

@@ -29,7 +29,6 @@ class AutoRestHeadTestService(object):
     :param credential: Credential needed for the client to connect to Azure.
     :type credential: ~azure.core.credentials.TokenCredential
     :param str base_url: Service URL
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/Head/head/aio/_auto_rest_head_test_service_async.py

@@ -29,7 +29,6 @@ class AutoRestHeadTestService(object):
     :param credential: Credential needed for the client to connect to Azure.
     :type credential: ~azure.core.credentials_async.AsyncTokenCredential
     :param str base_url: Service URL
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/HeadExceptions/headexceptions/_auto_rest_head_exception_test_service.py

@@ -29,7 +29,6 @@ class AutoRestHeadExceptionTestService(object):
     :param credential: Credential needed for the client to connect to Azure.
     :type credential: ~azure.core.credentials.TokenCredential
     :param str base_url: Service URL
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/HeadExceptions/headexceptions/aio/_auto_rest_head_exception_test_service_async.py

@@ -29,7 +29,6 @@ class AutoRestHeadExceptionTestService(object):
     :param credential: Credential needed for the client to connect to Azure.
     :type credential: ~azure.core.credentials_async.AsyncTokenCredential
     :param str base_url: Service URL
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/HeadWithAzureKeyCredentialPolicy/headwithazurekeycredentialpolicy/_auto_rest_head_test_service.py

@@ -29,7 +29,6 @@ class AutoRestHeadTestService(object):
     :param credential: Credential needed for the client to connect to Azure.
     :type credential: ~azure.core.credentials.TokenCredential
     :param str base_url: Service URL
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(

test/azure/Expected/AcceptanceTests/HeadWithAzureKeyCredentialPolicy/headwithazurekeycredentialpolicy/aio/_auto_rest_head_test_service_async.py

@@ -29,7 +29,6 @@ class AutoRestHeadTestService(object):
     :param credential: Credential needed for the client to connect to Azure.
     :type credential: ~azure.core.credentials_async.AsyncTokenCredential
     :param str base_url: Service URL
-    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(