From 1bb635880332bb34a15113bd906c800ed73dff04 Mon Sep 17 00:00:00 2001 From: msyyc <70930885+msyyc@users.noreply.github.com> Date: Wed, 11 Sep 2024 18:01:58 +0800 Subject: [PATCH 1/6] fix for line-too-long --- .../pygen/codegen/serializers/builder_serializer.py | 5 +++-- .../pygen/codegen/templates/operation_tools.jinja2 | 11 +++++++++-- .../models/resources/aio/operations/_operations.py | 1 + 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/packages/typespec-python/generator/pygen/codegen/serializers/builder_serializer.py b/packages/typespec-python/generator/pygen/codegen/serializers/builder_serializer.py index c02de62d2d2..bee409ec2e3 100644 --- a/packages/typespec-python/generator/pygen/codegen/serializers/builder_serializer.py +++ b/packages/typespec-python/generator/pygen/codegen/serializers/builder_serializer.py @@ -7,6 +7,7 @@ from abc import abstractmethod from collections import defaultdict from typing import Generic, List, Type, TypeVar, Dict, Union, Optional, cast +import logging from ..models import ( Operation, @@ -284,8 +285,8 @@ def description_and_summary(self, builder: BuilderType) -> List[str]: return description_list @staticmethod - def line_too_long(docs: List[str]) -> bool: - return any(len(line) > 120 for line in docs) + def line_too_long(docs: List[str], indentation: int = 0) -> bool: + return any(len(line) > (120 - indentation) for line in docs) def example_template(self, builder: BuilderType) -> List[str]: template = [] diff --git a/packages/typespec-python/generator/pygen/codegen/templates/operation_tools.jinja2 b/packages/typespec-python/generator/pygen/codegen/templates/operation_tools.jinja2 index 598da57e4d0..99e05d14abb 100644 --- a/packages/typespec-python/generator/pygen/codegen/templates/operation_tools.jinja2 +++ b/packages/typespec-python/generator/pygen/codegen/templates/operation_tools.jinja2 @@ -2,10 +2,17 @@ {% macro description(builder, serializer) %} {% set example_template = serializer.example_template(builder) %} +{% set param_description_and_response_docstring = serializer.param_description_and_response_docstring(builder) %} +{% set ns = namespace(line_too_long=false) %} +{% for item in param_description_and_response_docstring %} + {% if item and serializer.line_too_long(wrap_string(item, wrapstring='\n ').split('\n'), 8) %} + {% set ns.line_too_long = true %} + {% endif %} +{% endfor %} {% for description in serializer.description_and_summary(builder) %} {% if description %} {% set description = wrap_string(description, wrapstring='\n') %} - {% if serializer.line_too_long(example_template) and loop.first %} + {% if (serializer.line_too_long(example_template) or ns.line_too_long) and loop.first %} # pylint: disable=line-too-long {% endif %} {{ '"""' + description if loop.first else description }} @@ -13,7 +20,7 @@ {% endif %} {% endfor %} - {% for description in serializer.param_description_and_response_docstring(builder) %} + {% for description in param_description_and_response_docstring %} {% if description %} {{ wrap_string(description, wrapstring='\n ') }} {% else %} diff --git a/packages/typespec-python/test/azure/generated/azure-resource-manager-models-resources/azure/resourcemanager/models/resources/aio/operations/_operations.py b/packages/typespec-python/test/azure/generated/azure-resource-manager-models-resources/azure/resourcemanager/models/resources/aio/operations/_operations.py index 199ef94c08f..271f1370d67 100644 --- a/packages/typespec-python/test/azure/generated/azure-resource-manager-models-resources/azure/resourcemanager/models/resources/aio/operations/_operations.py +++ b/packages/typespec-python/test/azure/generated/azure-resource-manager-models-resources/azure/resourcemanager/models/resources/aio/operations/_operations.py @@ -2343,6 +2343,7 @@ async def update( def list_by_resource_group( self, resource_group_name: str, **kwargs: Any ) -> AsyncIterable["_models.SingletonTrackedResource"]: + # pylint: disable=line-too-long """List SingletonTrackedResource resources by resource group. :param resource_group_name: The name of the resource group. The name is case insensitive. From e723c84e46ee197e95eee664d16b55b4a6b6cab7 Mon Sep 17 00:00:00 2001 From: msyyc <70930885+msyyc@users.noreply.github.com> Date: Wed, 11 Sep 2024 18:02:53 +0800 Subject: [PATCH 2/6] changelog --- .chronus/changes/fix-ci-2024-09-11-2024-8-11-18-2-40.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 .chronus/changes/fix-ci-2024-09-11-2024-8-11-18-2-40.md diff --git a/.chronus/changes/fix-ci-2024-09-11-2024-8-11-18-2-40.md b/.chronus/changes/fix-ci-2024-09-11-2024-8-11-18-2-40.md new file mode 100644 index 00000000000..59efc31b10c --- /dev/null +++ b/.chronus/changes/fix-ci-2024-09-11-2024-8-11-18-2-40.md @@ -0,0 +1,7 @@ +--- +changeKind: fix +packages: + - "@azure-tools/typespec-python" +--- + +Fix "line-too-long" for docstring in operation \ No newline at end of file From 9191b43f34982d8302521c87635b4e08577cb055 Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Wed, 11 Sep 2024 18:05:56 +0800 Subject: [PATCH 3/6] Update builder_serializer.py --- .../generator/pygen/codegen/serializers/builder_serializer.py | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/typespec-python/generator/pygen/codegen/serializers/builder_serializer.py b/packages/typespec-python/generator/pygen/codegen/serializers/builder_serializer.py index bee409ec2e3..5de21830fad 100644 --- a/packages/typespec-python/generator/pygen/codegen/serializers/builder_serializer.py +++ b/packages/typespec-python/generator/pygen/codegen/serializers/builder_serializer.py @@ -7,7 +7,6 @@ from abc import abstractmethod from collections import defaultdict from typing import Generic, List, Type, TypeVar, Dict, Union, Optional, cast -import logging from ..models import ( Operation, From 356b0c7bdd034729af23df264d7ad67b9b402a63 Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Wed, 11 Sep 2024 18:25:56 +0800 Subject: [PATCH 4/6] regenerate --- .../generated/azure/multiapi/sample/aio/_operations_mixin.py | 1 + .../multiapi/generated/azure/multiapi/sample/v1/_metadata.json | 2 +- .../v1/aio/operations/_multiapi_service_client_operations.py | 1 + .../custompollerpager/aio/operations/_paging_operations.py | 1 + .../batch/paging/aio/operations/_paging_operations.py | 1 + .../multiapicredentialdefaultpolicy/aio/_operations_mixin.py | 1 + .../multiapicredentialdefaultpolicy/v1/_metadata.json | 2 +- .../v1/aio/operations/_multiapi_service_client_operations.py | 1 + .../multiapidataplane/aio/_operations_mixin.py | 1 + .../MultiapiDataPlane/multiapidataplane/v1/_metadata.json | 2 +- .../v1/aio/operations/_multiapi_service_client_operations.py | 1 + .../multiapikeywordonly/aio/_operations_mixin.py | 1 + .../MultiapiKeywordOnly/multiapikeywordonly/v1/_metadata.json | 2 +- .../v1/aio/operations/_multiapi_service_client_operations.py | 1 + .../MultiapiSecurity/multiapisecurity/aio/_operations_mixin.py | 1 + .../MultiapiSecurity/multiapisecurity/v1/_metadata.json | 2 +- .../v1/aio/operations/_multiapi_service_client_operations.py | 1 + .../multiapiwithsubmodule/submodule/aio/_operations_mixin.py | 1 + .../multiapiwithsubmodule/submodule/v1/_metadata.json | 2 +- .../v1/aio/operations/_multiapi_service_client_operations.py | 1 + .../multiapicombiner/aio/operations/_operations.py | 1 + .../multiapicombiner/multiapicombiner/v1/_metadata.json | 2 +- .../multiapicombiner/v1/aio/operations/_operations.py | 1 + 23 files changed, 23 insertions(+), 7 deletions(-) diff --git a/packages/autorest.python/samples/specification/multiapi/generated/azure/multiapi/sample/aio/_operations_mixin.py b/packages/autorest.python/samples/specification/multiapi/generated/azure/multiapi/sample/aio/_operations_mixin.py index 4ebccbbc730..ca605b77604 100644 --- a/packages/autorest.python/samples/specification/multiapi/generated/azure/multiapi/sample/aio/_operations_mixin.py +++ b/packages/autorest.python/samples/specification/multiapi/generated/azure/multiapi/sample/aio/_operations_mixin.py @@ -53,6 +53,7 @@ async def begin_test_lro_and_paging( test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None, **kwargs: Any ) -> AsyncLROPoller[AsyncIterable["_models.Product"]]: + # pylint: disable=line-too-long """A long-running paging operation that includes a nextLink that has 10 pages. :param client_request_id: Default value is None. diff --git a/packages/autorest.python/samples/specification/multiapi/generated/azure/multiapi/sample/v1/_metadata.json b/packages/autorest.python/samples/specification/multiapi/generated/azure/multiapi/sample/v1/_metadata.json index 7712c165380..d87bae7f235 100644 --- a/packages/autorest.python/samples/specification/multiapi/generated/azure/multiapi/sample/v1/_metadata.json +++ b/packages/autorest.python/samples/specification/multiapi/generated/azure/multiapi/sample/v1/_metadata.json @@ -161,7 +161,7 @@ "async": { "coroutine": true, "signature": "async def begin_test_lro_and_paging(\n self,\n client_request_id: Optional[str] = None,\n test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None,\n **kwargs: Any\n) -\u003e AsyncLROPoller[AsyncIterable[\"_models.Product\"]]:\n", - "doc": "\"\"\"A long-running paging operation that includes a nextLink that has 10 pages.\n\n:param client_request_id: Default value is None.\n:type client_request_id: str\n:param test_lro_and_paging_options: Parameter group. Default value is None.\n:type test_lro_and_paging_options: ~azure.multiapi.sample.v1.models.TestLroAndPagingOptions\n:return: An instance of LROPoller that returns an iterator like instance of either PagingResult\n or the result of cls(response)\n:rtype:\n ~azure.core.polling.AsyncLROPoller[~azure.core.async_paging.AsyncItemPaged[~azure.multiapi.sample.v1.models.Product]]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"", + "doc": "# pylint: disable=line-too-long\n\"\"\"A long-running paging operation that includes a nextLink that has 10 pages.\n\n:param client_request_id: Default value is None.\n:type client_request_id: str\n:param test_lro_and_paging_options: Parameter group. Default value is None.\n:type test_lro_and_paging_options: ~azure.multiapi.sample.v1.models.TestLroAndPagingOptions\n:return: An instance of LROPoller that returns an iterator like instance of either PagingResult\n or the result of cls(response)\n:rtype:\n ~azure.core.polling.AsyncLROPoller[~azure.core.async_paging.AsyncItemPaged[~azure.multiapi.sample.v1.models.Product]]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"", "call": "client_request_id, test_lro_and_paging_options, **kwargs" } }, diff --git a/packages/autorest.python/samples/specification/multiapi/generated/azure/multiapi/sample/v1/aio/operations/_multiapi_service_client_operations.py b/packages/autorest.python/samples/specification/multiapi/generated/azure/multiapi/sample/v1/aio/operations/_multiapi_service_client_operations.py index f362ca63279..93646eb8443 100644 --- a/packages/autorest.python/samples/specification/multiapi/generated/azure/multiapi/sample/v1/aio/operations/_multiapi_service_client_operations.py +++ b/packages/autorest.python/samples/specification/multiapi/generated/azure/multiapi/sample/v1/aio/operations/_multiapi_service_client_operations.py @@ -325,6 +325,7 @@ async def begin_test_lro_and_paging( test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None, **kwargs: Any ) -> AsyncLROPoller[AsyncIterable["_models.Product"]]: + # pylint: disable=line-too-long """A long-running paging operation that includes a nextLink that has 10 pages. :param client_request_id: Default value is None. diff --git a/packages/autorest.python/test/azure/legacy/Expected/AcceptanceTests/CustomPollerPager/custompollerpager/aio/operations/_paging_operations.py b/packages/autorest.python/test/azure/legacy/Expected/AcceptanceTests/CustomPollerPager/custompollerpager/aio/operations/_paging_operations.py index 41738c26572..6c894f74784 100644 --- a/packages/autorest.python/test/azure/legacy/Expected/AcceptanceTests/CustomPollerPager/custompollerpager/aio/operations/_paging_operations.py +++ b/packages/autorest.python/test/azure/legacy/Expected/AcceptanceTests/CustomPollerPager/custompollerpager/aio/operations/_paging_operations.py @@ -1599,6 +1599,7 @@ async def begin_get_multiple_pages_lro( paging_get_multiple_pages_lro_options: Optional[_models.PagingGetMultiplePagesLroOptions] = None, **kwargs: Any ) -> AsyncCustomPoller[AsyncIterable["_models.Product"]]: + # pylint: disable=line-too-long """A long-running paging operation that includes a nextLink that has 10 pages. :param client_request_id: Default value is None. diff --git a/packages/autorest.python/test/azure/legacy/Expected/AcceptanceTests/PackageModeBatch/azure/packagemode/batch/paging/aio/operations/_paging_operations.py b/packages/autorest.python/test/azure/legacy/Expected/AcceptanceTests/PackageModeBatch/azure/packagemode/batch/paging/aio/operations/_paging_operations.py index a45b2a3fc0b..292f1a263b3 100644 --- a/packages/autorest.python/test/azure/legacy/Expected/AcceptanceTests/PackageModeBatch/azure/packagemode/batch/paging/aio/operations/_paging_operations.py +++ b/packages/autorest.python/test/azure/legacy/Expected/AcceptanceTests/PackageModeBatch/azure/packagemode/batch/paging/aio/operations/_paging_operations.py @@ -1597,6 +1597,7 @@ async def begin_get_multiple_pages_lro( paging_get_multiple_pages_lro_options: Optional[_models.PagingGetMultiplePagesLroOptions] = None, **kwargs: Any ) -> AsyncLROPoller[AsyncIterable["_models.Product"]]: + # pylint: disable=line-too-long """A long-running paging operation that includes a nextLink that has 10 pages. :param client_request_id: Default value is None. diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/aio/_operations_mixin.py b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/aio/_operations_mixin.py index 15ab06cb27c..dcde65d560d 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/aio/_operations_mixin.py +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/aio/_operations_mixin.py @@ -55,6 +55,7 @@ async def begin_test_lro_and_paging( test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None, **kwargs: Any ) -> AsyncLROPoller[AsyncIterable["_models.Product"]]: + # pylint: disable=line-too-long """A long-running paging operation that includes a nextLink that has 10 pages. :param client_request_id: Default value is None. diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v1/_metadata.json b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v1/_metadata.json index f7dc80f1d3b..0c0141a728a 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v1/_metadata.json +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v1/_metadata.json @@ -161,7 +161,7 @@ "async": { "coroutine": true, "signature": "async def begin_test_lro_and_paging(\n self,\n client_request_id: Optional[str] = None,\n test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None,\n **kwargs: Any\n) -\u003e AsyncLROPoller[AsyncIterable[\"_models.Product\"]]:\n", - "doc": "\"\"\"A long-running paging operation that includes a nextLink that has 10 pages.\n\n:param client_request_id: Default value is None.\n:type client_request_id: str\n:param test_lro_and_paging_options: Parameter group. Default value is None.\n:type test_lro_and_paging_options:\n ~multiapicredentialdefaultpolicy.v1.models.TestLroAndPagingOptions\n:return: An instance of LROPoller that returns an iterator like instance of either PagingResult\n or the result of cls(response)\n:rtype:\n ~azure.core.polling.AsyncLROPoller[~azure.core.async_paging.AsyncItemPaged[~multiapicredentialdefaultpolicy.v1.models.Product]]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"", + "doc": "# pylint: disable=line-too-long\n\"\"\"A long-running paging operation that includes a nextLink that has 10 pages.\n\n:param client_request_id: Default value is None.\n:type client_request_id: str\n:param test_lro_and_paging_options: Parameter group. Default value is None.\n:type test_lro_and_paging_options:\n ~multiapicredentialdefaultpolicy.v1.models.TestLroAndPagingOptions\n:return: An instance of LROPoller that returns an iterator like instance of either PagingResult\n or the result of cls(response)\n:rtype:\n ~azure.core.polling.AsyncLROPoller[~azure.core.async_paging.AsyncItemPaged[~multiapicredentialdefaultpolicy.v1.models.Product]]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"", "call": "client_request_id, test_lro_and_paging_options, **kwargs" } }, diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v1/aio/operations/_multiapi_service_client_operations.py b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v1/aio/operations/_multiapi_service_client_operations.py index b255684ab37..59d36532c23 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v1/aio/operations/_multiapi_service_client_operations.py +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v1/aio/operations/_multiapi_service_client_operations.py @@ -325,6 +325,7 @@ async def begin_test_lro_and_paging( test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None, **kwargs: Any ) -> AsyncLROPoller[AsyncIterable["_models.Product"]]: + # pylint: disable=line-too-long """A long-running paging operation that includes a nextLink that has 10 pages. :param client_request_id: Default value is None. diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiDataPlane/multiapidataplane/aio/_operations_mixin.py b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiDataPlane/multiapidataplane/aio/_operations_mixin.py index 117e9bbc43e..fb44f34cdfe 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiDataPlane/multiapidataplane/aio/_operations_mixin.py +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiDataPlane/multiapidataplane/aio/_operations_mixin.py @@ -55,6 +55,7 @@ async def begin_test_lro_and_paging( test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None, **kwargs: Any ) -> AsyncLROPoller[AsyncIterable["_models.Product"]]: + # pylint: disable=line-too-long """A long-running paging operation that includes a nextLink that has 10 pages. :param client_request_id: Default value is None. diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiDataPlane/multiapidataplane/v1/_metadata.json b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiDataPlane/multiapidataplane/v1/_metadata.json index 4855bc4adcd..65fd8f6ce57 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiDataPlane/multiapidataplane/v1/_metadata.json +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiDataPlane/multiapidataplane/v1/_metadata.json @@ -161,7 +161,7 @@ "async": { "coroutine": true, "signature": "async def begin_test_lro_and_paging(\n self,\n client_request_id: Optional[str] = None,\n test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None,\n **kwargs: Any\n) -\u003e AsyncLROPoller[AsyncIterable[\"_models.Product\"]]:\n", - "doc": "\"\"\"A long-running paging operation that includes a nextLink that has 10 pages.\n\n:param client_request_id: Default value is None.\n:type client_request_id: str\n:param test_lro_and_paging_options: Parameter group. Default value is None.\n:type test_lro_and_paging_options: ~multiapidataplane.v1.models.TestLroAndPagingOptions\n:return: An instance of LROPoller that returns an iterator like instance of either PagingResult\n or the result of cls(response)\n:rtype:\n ~azure.core.polling.AsyncLROPoller[~azure.core.async_paging.AsyncItemPaged[~multiapidataplane.v1.models.Product]]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"", + "doc": "# pylint: disable=line-too-long\n\"\"\"A long-running paging operation that includes a nextLink that has 10 pages.\n\n:param client_request_id: Default value is None.\n:type client_request_id: str\n:param test_lro_and_paging_options: Parameter group. Default value is None.\n:type test_lro_and_paging_options: ~multiapidataplane.v1.models.TestLroAndPagingOptions\n:return: An instance of LROPoller that returns an iterator like instance of either PagingResult\n or the result of cls(response)\n:rtype:\n ~azure.core.polling.AsyncLROPoller[~azure.core.async_paging.AsyncItemPaged[~multiapidataplane.v1.models.Product]]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"", "call": "client_request_id, test_lro_and_paging_options, **kwargs" } }, diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiDataPlane/multiapidataplane/v1/aio/operations/_multiapi_service_client_operations.py b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiDataPlane/multiapidataplane/v1/aio/operations/_multiapi_service_client_operations.py index 2ab6b537349..a110c6f3556 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiDataPlane/multiapidataplane/v1/aio/operations/_multiapi_service_client_operations.py +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiDataPlane/multiapidataplane/v1/aio/operations/_multiapi_service_client_operations.py @@ -324,6 +324,7 @@ async def begin_test_lro_and_paging( test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None, **kwargs: Any ) -> AsyncLROPoller[AsyncIterable["_models.Product"]]: + # pylint: disable=line-too-long """A long-running paging operation that includes a nextLink that has 10 pages. :param client_request_id: Default value is None. diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiKeywordOnly/multiapikeywordonly/aio/_operations_mixin.py b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiKeywordOnly/multiapikeywordonly/aio/_operations_mixin.py index 925ea05b816..30b5f07f26a 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiKeywordOnly/multiapikeywordonly/aio/_operations_mixin.py +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiKeywordOnly/multiapikeywordonly/aio/_operations_mixin.py @@ -56,6 +56,7 @@ async def begin_test_lro_and_paging( client_request_id: Optional[str] = None, **kwargs: Any ) -> AsyncLROPoller[AsyncIterable["_models.Product"]]: + # pylint: disable=line-too-long """A long-running paging operation that includes a nextLink that has 10 pages. :param test_lro_and_paging_options: Parameter group. Default value is None. diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiKeywordOnly/multiapikeywordonly/v1/_metadata.json b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiKeywordOnly/multiapikeywordonly/v1/_metadata.json index d0dba6b2c22..b3234d98f9d 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiKeywordOnly/multiapikeywordonly/v1/_metadata.json +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiKeywordOnly/multiapikeywordonly/v1/_metadata.json @@ -161,7 +161,7 @@ "async": { "coroutine": true, "signature": "async def begin_test_lro_and_paging(\n self,\n test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None,\n *,\n client_request_id: Optional[str] = None,\n **kwargs: Any\n) -\u003e AsyncLROPoller[AsyncIterable[\"_models.Product\"]]:\n", - "doc": "\"\"\"A long-running paging operation that includes a nextLink that has 10 pages.\n\n:param test_lro_and_paging_options: Parameter group. Default value is None.\n:type test_lro_and_paging_options: ~multiapikeywordonly.v1.models.TestLroAndPagingOptions\n:keyword client_request_id: Default value is None.\n:paramtype client_request_id: str\n:return: An instance of LROPoller that returns an iterator like instance of either PagingResult\n or the result of cls(response)\n:rtype:\n ~azure.core.polling.AsyncLROPoller[~azure.core.async_paging.AsyncItemPaged[~multiapikeywordonly.v1.models.Product]]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"", + "doc": "# pylint: disable=line-too-long\n\"\"\"A long-running paging operation that includes a nextLink that has 10 pages.\n\n:param test_lro_and_paging_options: Parameter group. Default value is None.\n:type test_lro_and_paging_options: ~multiapikeywordonly.v1.models.TestLroAndPagingOptions\n:keyword client_request_id: Default value is None.\n:paramtype client_request_id: str\n:return: An instance of LROPoller that returns an iterator like instance of either PagingResult\n or the result of cls(response)\n:rtype:\n ~azure.core.polling.AsyncLROPoller[~azure.core.async_paging.AsyncItemPaged[~multiapikeywordonly.v1.models.Product]]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"", "call": "test_lro_and_paging_options, client_request_id=client_request_id, **kwargs" } }, diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiKeywordOnly/multiapikeywordonly/v1/aio/operations/_multiapi_service_client_operations.py b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiKeywordOnly/multiapikeywordonly/v1/aio/operations/_multiapi_service_client_operations.py index cc8e85f9bfd..71e0774d446 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiKeywordOnly/multiapikeywordonly/v1/aio/operations/_multiapi_service_client_operations.py +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiKeywordOnly/multiapikeywordonly/v1/aio/operations/_multiapi_service_client_operations.py @@ -326,6 +326,7 @@ async def begin_test_lro_and_paging( client_request_id: Optional[str] = None, **kwargs: Any ) -> AsyncLROPoller[AsyncIterable["_models.Product"]]: + # pylint: disable=line-too-long """A long-running paging operation that includes a nextLink that has 10 pages. :param test_lro_and_paging_options: Parameter group. Default value is None. diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiSecurity/multiapisecurity/aio/_operations_mixin.py b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiSecurity/multiapisecurity/aio/_operations_mixin.py index 6e7a1f9d9b5..397c7311271 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiSecurity/multiapisecurity/aio/_operations_mixin.py +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiSecurity/multiapisecurity/aio/_operations_mixin.py @@ -55,6 +55,7 @@ async def begin_test_lro_and_paging( test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None, **kwargs: Any ) -> AsyncLROPoller[AsyncIterable["_models.Product"]]: + # pylint: disable=line-too-long """A long-running paging operation that includes a nextLink that has 10 pages. :param client_request_id: Default value is None. diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiSecurity/multiapisecurity/v1/_metadata.json b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiSecurity/multiapisecurity/v1/_metadata.json index f242d36ac28..8c47757af1a 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiSecurity/multiapisecurity/v1/_metadata.json +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiSecurity/multiapisecurity/v1/_metadata.json @@ -161,7 +161,7 @@ "async": { "coroutine": true, "signature": "async def begin_test_lro_and_paging(\n self,\n client_request_id: Optional[str] = None,\n test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None,\n **kwargs: Any\n) -\u003e AsyncLROPoller[AsyncIterable[\"_models.Product\"]]:\n", - "doc": "\"\"\"A long-running paging operation that includes a nextLink that has 10 pages.\n\n:param client_request_id: Default value is None.\n:type client_request_id: str\n:param test_lro_and_paging_options: Parameter group. Default value is None.\n:type test_lro_and_paging_options: ~multiapisecurity.v1.models.TestLroAndPagingOptions\n:return: An instance of LROPoller that returns an iterator like instance of either PagingResult\n or the result of cls(response)\n:rtype:\n ~azure.core.polling.AsyncLROPoller[~azure.core.async_paging.AsyncItemPaged[~multiapisecurity.v1.models.Product]]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"", + "doc": "# pylint: disable=line-too-long\n\"\"\"A long-running paging operation that includes a nextLink that has 10 pages.\n\n:param client_request_id: Default value is None.\n:type client_request_id: str\n:param test_lro_and_paging_options: Parameter group. Default value is None.\n:type test_lro_and_paging_options: ~multiapisecurity.v1.models.TestLroAndPagingOptions\n:return: An instance of LROPoller that returns an iterator like instance of either PagingResult\n or the result of cls(response)\n:rtype:\n ~azure.core.polling.AsyncLROPoller[~azure.core.async_paging.AsyncItemPaged[~multiapisecurity.v1.models.Product]]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"", "call": "client_request_id, test_lro_and_paging_options, **kwargs" } }, diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiSecurity/multiapisecurity/v1/aio/operations/_multiapi_service_client_operations.py b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiSecurity/multiapisecurity/v1/aio/operations/_multiapi_service_client_operations.py index 51361e1a9d4..d448a38e7ef 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiSecurity/multiapisecurity/v1/aio/operations/_multiapi_service_client_operations.py +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiSecurity/multiapisecurity/v1/aio/operations/_multiapi_service_client_operations.py @@ -324,6 +324,7 @@ async def begin_test_lro_and_paging( test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None, **kwargs: Any ) -> AsyncLROPoller[AsyncIterable["_models.Product"]]: + # pylint: disable=line-too-long """A long-running paging operation that includes a nextLink that has 10 pages. :param client_request_id: Default value is None. diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiWithSubmodule/multiapiwithsubmodule/submodule/aio/_operations_mixin.py b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiWithSubmodule/multiapiwithsubmodule/submodule/aio/_operations_mixin.py index 2aae597fe42..26a86232e0c 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiWithSubmodule/multiapiwithsubmodule/submodule/aio/_operations_mixin.py +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiWithSubmodule/multiapiwithsubmodule/submodule/aio/_operations_mixin.py @@ -55,6 +55,7 @@ async def begin_test_lro_and_paging( test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None, **kwargs: Any ) -> AsyncLROPoller[AsyncIterable["_models.Product"]]: + # pylint: disable=line-too-long """A long-running paging operation that includes a nextLink that has 10 pages. :param client_request_id: Default value is None. diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiWithSubmodule/multiapiwithsubmodule/submodule/v1/_metadata.json b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiWithSubmodule/multiapiwithsubmodule/submodule/v1/_metadata.json index 59d3cc7735e..9d81015449c 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiWithSubmodule/multiapiwithsubmodule/submodule/v1/_metadata.json +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiWithSubmodule/multiapiwithsubmodule/submodule/v1/_metadata.json @@ -161,7 +161,7 @@ "async": { "coroutine": true, "signature": "async def begin_test_lro_and_paging(\n self,\n client_request_id: Optional[str] = None,\n test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None,\n **kwargs: Any\n) -\u003e AsyncLROPoller[AsyncIterable[\"_models.Product\"]]:\n", - "doc": "\"\"\"A long-running paging operation that includes a nextLink that has 10 pages.\n\n:param client_request_id: Default value is None.\n:type client_request_id: str\n:param test_lro_and_paging_options: Parameter group. Default value is None.\n:type test_lro_and_paging_options:\n ~multiapiwithsubmodule.submodule.v1.models.TestLroAndPagingOptions\n:return: An instance of LROPoller that returns an iterator like instance of either PagingResult\n or the result of cls(response)\n:rtype:\n ~azure.core.polling.AsyncLROPoller[~azure.core.async_paging.AsyncItemPaged[~multiapiwithsubmodule.submodule.v1.models.Product]]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"", + "doc": "# pylint: disable=line-too-long\n\"\"\"A long-running paging operation that includes a nextLink that has 10 pages.\n\n:param client_request_id: Default value is None.\n:type client_request_id: str\n:param test_lro_and_paging_options: Parameter group. Default value is None.\n:type test_lro_and_paging_options:\n ~multiapiwithsubmodule.submodule.v1.models.TestLroAndPagingOptions\n:return: An instance of LROPoller that returns an iterator like instance of either PagingResult\n or the result of cls(response)\n:rtype:\n ~azure.core.polling.AsyncLROPoller[~azure.core.async_paging.AsyncItemPaged[~multiapiwithsubmodule.submodule.v1.models.Product]]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"", "call": "client_request_id, test_lro_and_paging_options, **kwargs" } }, diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiWithSubmodule/multiapiwithsubmodule/submodule/v1/aio/operations/_multiapi_service_client_operations.py b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiWithSubmodule/multiapiwithsubmodule/submodule/v1/aio/operations/_multiapi_service_client_operations.py index 200b48555b0..0fea23052ae 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiWithSubmodule/multiapiwithsubmodule/submodule/v1/aio/operations/_multiapi_service_client_operations.py +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/MultiapiWithSubmodule/multiapiwithsubmodule/submodule/v1/aio/operations/_multiapi_service_client_operations.py @@ -325,6 +325,7 @@ async def begin_test_lro_and_paging( test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None, **kwargs: Any ) -> AsyncLROPoller[AsyncIterable["_models.Product"]]: + # pylint: disable=line-too-long """A long-running paging operation that includes a nextLink that has 10 pages. :param client_request_id: Default value is None. diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/multiapicombiner/multiapicombiner/aio/operations/_operations.py b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/multiapicombiner/multiapicombiner/aio/operations/_operations.py index f44e61a9660..fe980f0b56f 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/multiapicombiner/multiapicombiner/aio/operations/_operations.py +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/multiapicombiner/multiapicombiner/aio/operations/_operations.py @@ -612,6 +612,7 @@ async def begin_test_lro_and_paging( client_request_id: Optional[str] = None, **kwargs: Any ) -> AsyncLROPoller[AsyncIterable["_models.Product"]]: + # pylint: disable=line-too-long """A long-running paging operation that includes a nextLink that has 10 pages. :param test_lro_and_paging_options: Parameter group. Default value is None. diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/multiapicombiner/multiapicombiner/v1/_metadata.json b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/multiapicombiner/multiapicombiner/v1/_metadata.json index 7ba2535f50f..517dda7a1f1 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/multiapicombiner/multiapicombiner/v1/_metadata.json +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/multiapicombiner/multiapicombiner/v1/_metadata.json @@ -161,7 +161,7 @@ "async": { "coroutine": true, "signature": "async def begin_test_lro_and_paging(\n self,\n test_lro_and_paging_options: Optional[_models.TestLroAndPagingOptions] = None,\n *,\n client_request_id: Optional[str] = None,\n **kwargs: Any\n) -\u003e AsyncLROPoller[AsyncIterable[\"_models.Product\"]]:\n", - "doc": "\"\"\"A long-running paging operation that includes a nextLink that has 10 pages.\n\n:param test_lro_and_paging_options: Parameter group. Default value is None.\n:type test_lro_and_paging_options: ~multiapicombiner.v1.models.TestLroAndPagingOptions\n:keyword client_request_id: Default value is None.\n:paramtype client_request_id: str\n:return: An instance of LROPoller that returns an iterator like instance of either PagingResult\n or the result of cls(response)\n:rtype:\n ~azure.core.polling.AsyncLROPoller[~azure.core.async_paging.AsyncItemPaged[~multiapicombiner.v1.models.Product]]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"", + "doc": "# pylint: disable=line-too-long\n\"\"\"A long-running paging operation that includes a nextLink that has 10 pages.\n\n:param test_lro_and_paging_options: Parameter group. Default value is None.\n:type test_lro_and_paging_options: ~multiapicombiner.v1.models.TestLroAndPagingOptions\n:keyword client_request_id: Default value is None.\n:paramtype client_request_id: str\n:return: An instance of LROPoller that returns an iterator like instance of either PagingResult\n or the result of cls(response)\n:rtype:\n ~azure.core.polling.AsyncLROPoller[~azure.core.async_paging.AsyncItemPaged[~multiapicombiner.v1.models.Product]]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"", "call": "test_lro_and_paging_options, client_request_id=client_request_id, **kwargs" } }, diff --git a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/multiapicombiner/multiapicombiner/v1/aio/operations/_operations.py b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/multiapicombiner/multiapicombiner/v1/aio/operations/_operations.py index 9751f1ab11c..c11420224d8 100644 --- a/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/multiapicombiner/multiapicombiner/v1/aio/operations/_operations.py +++ b/packages/autorest.python/test/multiapi/Expected/AcceptanceTests/multiapicombiner/multiapicombiner/v1/aio/operations/_operations.py @@ -328,6 +328,7 @@ async def begin_test_lro_and_paging( client_request_id: Optional[str] = None, **kwargs: Any ) -> AsyncLROPoller[AsyncIterable["_models.Product"]]: + # pylint: disable=line-too-long """A long-running paging operation that includes a nextLink that has 10 pages. :param test_lro_and_paging_options: Parameter group. Default value is None. From 144cc519ad3660e1f0976296af7bb43b10aab3c8 Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Wed, 11 Sep 2024 18:27:54 +0800 Subject: [PATCH 5/6] Delete .chronus/changes/fix-ci-2024-09-11-2024-8-11-18-2-40.md --- .chronus/changes/fix-ci-2024-09-11-2024-8-11-18-2-40.md | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 .chronus/changes/fix-ci-2024-09-11-2024-8-11-18-2-40.md diff --git a/.chronus/changes/fix-ci-2024-09-11-2024-8-11-18-2-40.md b/.chronus/changes/fix-ci-2024-09-11-2024-8-11-18-2-40.md deleted file mode 100644 index 59efc31b10c..00000000000 --- a/.chronus/changes/fix-ci-2024-09-11-2024-8-11-18-2-40.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -changeKind: fix -packages: - - "@azure-tools/typespec-python" ---- - -Fix "line-too-long" for docstring in operation \ No newline at end of file From c93be3f1fb519e17245cdd5d09ee71300c8f96c2 Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Wed, 11 Sep 2024 18:28:43 +0800 Subject: [PATCH 6/6] changelog --- .chronus/changes/fix-ci-2024-09-11-2024-8-11-18-28-34.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .chronus/changes/fix-ci-2024-09-11-2024-8-11-18-28-34.md diff --git a/.chronus/changes/fix-ci-2024-09-11-2024-8-11-18-28-34.md b/.chronus/changes/fix-ci-2024-09-11-2024-8-11-18-28-34.md new file mode 100644 index 00000000000..5f33f62062f --- /dev/null +++ b/.chronus/changes/fix-ci-2024-09-11-2024-8-11-18-28-34.md @@ -0,0 +1,8 @@ +--- +changeKind: fix +packages: + - "@autorest/python" + - "@azure-tools/typespec-python" +--- + +Fix lint issue "line-too-long" for docstring in operation \ No newline at end of file