[ACR] Fix pylint and sphinx errors (#35080)

Author: Yalin Li

sdk/containerregistry/azure-containerregistry/azure/containerregistry/_container_registry_client.py

@@ -8,7 +8,7 @@
 import hashlib
 import json
 from io import BytesIO
-from typing import Any, Dict, IO, Optional, overload, Union, cast, Tuple, MutableMapping
+from typing import Any, Dict, IO, Optional, overload, Union, cast, Tuple, MutableMapping, TYPE_CHECKING
 
 from azure.core.credentials import TokenCredential
 from azure.core.exceptions import (
@@ -47,6 +47,8 @@
     DigestValidationError,
 )
 
+if TYPE_CHECKING:
+    from ._generated.models import ArtifactManifestOrder, ArtifactTagOrder
 JSON = MutableMapping[str, Any]
 
 
@@ -136,7 +138,7 @@ def delete_repository(self, repository: str, **kwargs) -> None:
         self._client.container_registry.delete_repository(repository, **kwargs)
 
     @distributed_trace
-    def list_repository_names(self, **kwargs) -> ItemPaged[str]:
+    def list_repository_names(self, *, results_per_page: Optional[int] = None, **kwargs) -> ItemPaged[str]:
         """List all repositories
 
         :keyword results_per_page: Number of repositories to return per page
@@ -154,7 +156,6 @@ def list_repository_names(self, **kwargs) -> ItemPaged[str]:
                 :dedent: 8
                 :caption: List repositories in a container registry account
         """
-        n = kwargs.pop("results_per_page", None)
         last = kwargs.pop("last", None)
         cls = kwargs.pop("cls", None)
         error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
@@ -186,9 +187,9 @@ def prepare_request(next_link=None):
                     query_parameters["last"] = self._client._serialize.query(  # pylint: disable=protected-access
                         "last", last, "str"
                     )
-                if n is not None:
+                if results_per_page is not None:
                     query_parameters["n"] = self._client._serialize.query(  # pylint: disable=protected-access
-                        "n", n, "int"
+                        "n", results_per_page, "int"
                     )
 
                 request = self._client._client.get(  # pylint: disable=protected-access
@@ -256,7 +257,14 @@ def get_repository_properties(self, repository: str, **kwargs) -> RepositoryProp
         )
 
     @distributed_trace
-    def list_manifest_properties(self, repository: str, **kwargs) -> ItemPaged[ArtifactManifestProperties]:
+    def list_manifest_properties(
+        self,
+        repository: str,
+        *,
+        order_by: Optional[Union["ArtifactManifestOrder", str]] = None,
+        results_per_page: Optional[int] = None,
+        **kwargs,
+    ) -> ItemPaged[ArtifactManifestProperties]:
         """List the artifacts for a repository
 
         :param str repository: Name of the repository
@@ -270,8 +278,6 @@ def list_manifest_properties(self, repository: str, **kwargs) -> ItemPaged[Artif
         """
         name = repository
         last = kwargs.pop("last", None)
-        n = kwargs.pop("results_per_page", None)
-        orderby = kwargs.pop("order_by", None)
         cls = kwargs.pop(
             "cls",
             lambda objs: [
@@ -312,13 +318,13 @@ def prepare_request(next_link=None):
                     query_parameters["last"] = self._client._serialize.query(  # pylint: disable=protected-access
                         "last", last, "str"
                     )
-                if n is not None:
+                if results_per_page is not None:
                     query_parameters["n"] = self._client._serialize.query(  # pylint: disable=protected-access
-                        "n", n, "int"
+                        "n", results_per_page, "int"
                     )
-                if orderby is not None:
+                if order_by is not None:
                     query_parameters["orderby"] = self._client._serialize.query(  # pylint: disable=protected-access
-                        "orderby", orderby, "str"
+                        "orderby", order_by, "str"
                     )
 
                 request = self._client._client.get(  # pylint: disable=protected-access
@@ -458,7 +464,14 @@ def get_tag_properties(self, repository: str, tag: str, **kwargs) -> ArtifactTag
         )
 
     @distributed_trace
-    def list_tag_properties(self, repository: str, **kwargs) -> ItemPaged[ArtifactTagProperties]:
+    def list_tag_properties(
+        self,
+        repository: str,
+        *,
+        order_by: Optional[Union["ArtifactTagOrder", str]] = None,
+        results_per_page: Optional[int] = None,
+        **kwargs,
+    ) -> ItemPaged[ArtifactTagProperties]:
         """List the tags for a repository
 
         :param str repository: Name of the repository
@@ -483,8 +496,6 @@ def list_tag_properties(self, repository: str, **kwargs) -> ItemPaged[ArtifactTa
         """
         name = repository
         last = kwargs.pop("last", None)
-        n = kwargs.pop("results_per_page", None)
-        orderby = kwargs.pop("order_by", None)
         digest = kwargs.pop("digest", None)
         cls = kwargs.pop(
             "cls",
@@ -524,13 +535,13 @@ def prepare_request(next_link=None):
                     query_parameters["last"] = self._client._serialize.query(  # pylint: disable=protected-access
                         "last", last, "str"
                     )
-                if n is not None:
+                if results_per_page is not None:
                     query_parameters["n"] = self._client._serialize.query(  # pylint: disable=protected-access
-                        "n", n, "int"
+                        "n", results_per_page, "int"
                     )
-                if orderby is not None:
+                if order_by is not None:
                     query_parameters["orderby"] = self._client._serialize.query(  # pylint: disable=protected-access
-                        "orderby", orderby, "str"
+                        "orderby", order_by, "str"
                     )
                 if digest is not None:
                     query_parameters["digest"] = self._client._serialize.query(  # pylint: disable=protected-access

sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_container_registry_client.py

@@ -8,7 +8,7 @@
 import hashlib
 import json
 from io import BytesIO
-from typing import Any, Dict, IO, Optional, overload, Union, cast, Tuple, MutableMapping
+from typing import Any, Dict, IO, Optional, overload, Union, cast, Tuple, MutableMapping, TYPE_CHECKING
 
 from azure.core.async_paging import AsyncItemPaged, AsyncList
 from azure.core.credentials_async import AsyncTokenCredential
@@ -53,6 +53,8 @@
     DigestValidationError,
 )
 
+if TYPE_CHECKING:
+    from .._generated.models import ArtifactManifestOrder, ArtifactTagOrder
 JSON = MutableMapping[str, Any]
 
 
@@ -91,7 +93,7 @@ def __init__(
 
         .. admonition:: Example:
 
-            .. literalinclude:: ../samples/async_samples/sample_hello_world_async.py
+            .. literalinclude:: ../samples/sample_hello_world_async.py
                 :start-after: [START create_registry_client]
                 :end-before: [END create_registry_client]
                 :language: python
@@ -128,7 +130,7 @@ async def delete_repository(self, repository: str, **kwargs) -> None:
 
         .. admonition:: Example:
 
-            .. literalinclude:: ../samples/async_samples/sample_hello_world_async.py
+            .. literalinclude:: ../samples/sample_hello_world_async.py
                 :start-after: [START delete_repository]
                 :end-before: [END delete_repository]
                 :language: python
@@ -138,7 +140,7 @@ async def delete_repository(self, repository: str, **kwargs) -> None:
         await self._client.container_registry.delete_repository(repository, **kwargs)
 
     @distributed_trace
-    def list_repository_names(self, **kwargs) -> AsyncItemPaged[str]:
+    def list_repository_names(self, *, results_per_page: Optional[int] = None, **kwargs) -> AsyncItemPaged[str]:
         """List all repositories
 
         :keyword results_per_page: Number of repositories to return per page
@@ -149,14 +151,13 @@ def list_repository_names(self, **kwargs) -> AsyncItemPaged[str]:
 
         .. admonition:: Example:
 
-            .. literalinclude:: ../samples/async_samples/sample_delete_tags_async.py
+            .. literalinclude:: ../samples/sample_delete_tags_async.py
                 :start-after: [START list_repository_names]
                 :end-before: [END list_repository_names]
                 :language: python
                 :dedent: 8
                 :caption: List repositories in a container registry account
         """
-        n = kwargs.pop("results_per_page", None)
         last = kwargs.pop("last", None)
         cls = kwargs.pop("cls", None)
         error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
@@ -188,9 +189,9 @@ def prepare_request(next_link=None):
                     query_parameters["last"] = self._client._serialize.query(  # pylint: disable=protected-access
                         "last", last, "str"
                     )
-                if n is not None:
+                if results_per_page is not None:
                     query_parameters["n"] = self._client._serialize.query(  # pylint: disable=protected-access
-                        "n", n, "int"
+                        "n", results_per_page, "int"
                     )
 
                 request = self._client._client.get(  # pylint: disable=protected-access
@@ -258,7 +259,14 @@ async def get_repository_properties(self, repository: str, **kwargs) -> Reposito
         )
 
     @distributed_trace
-    def list_manifest_properties(self, repository: str, **kwargs) -> AsyncItemPaged[ArtifactManifestProperties]:
+    def list_manifest_properties(
+        self,
+        repository: str,
+        *,
+        order_by: Optional[Union["ArtifactManifestOrder", str]] = None,
+        results_per_page: Optional[int] = None,
+        **kwargs,
+    ) -> AsyncItemPaged[ArtifactManifestProperties]:
         """List the manifests of a repository
 
         :param str repository: Name of the repository
@@ -272,8 +280,6 @@ def list_manifest_properties(self, repository: str, **kwargs) -> AsyncItemPaged[
         """
         name = repository
         last = kwargs.pop("last", None)
-        n = kwargs.pop("results_per_page", None)
-        orderby = kwargs.pop("order_by", None)
         cls = kwargs.pop(
             "cls",
             lambda objs: [
@@ -314,13 +320,13 @@ def prepare_request(next_link=None):
                     query_parameters["last"] = self._client._serialize.query(  # pylint: disable=protected-access
                         "last", last, "str"
                     )
-                if n is not None:
+                if results_per_page is not None:
                     query_parameters["n"] = self._client._serialize.query(  # pylint: disable=protected-access
-                        "n", n, "int"
+                        "n", results_per_page, "int"
                     )
-                if orderby is not None:
+                if order_by is not None:
                     query_parameters["orderby"] = self._client._serialize.query(  # pylint: disable=protected-access
-                        "orderby", orderby, "str"
+                        "orderby", order_by, "str"
                     )
 
                 request = self._client._client.get(  # pylint: disable=protected-access
@@ -463,7 +469,14 @@ async def get_tag_properties(self, repository: str, tag: str, **kwargs) -> Artif
         )
 
     @distributed_trace
-    def list_tag_properties(self, repository: str, **kwargs) -> AsyncItemPaged[ArtifactTagProperties]:
+    def list_tag_properties(
+        self,
+        repository: str,
+        *,
+        order_by: Optional[Union["ArtifactTagOrder", str]] = None,
+        results_per_page: Optional[int] = None,
+        **kwargs,
+    ) -> AsyncItemPaged[ArtifactTagProperties]:
         """List the tags for a repository
 
         :param str repository: Name of the repository
@@ -488,8 +501,6 @@ def list_tag_properties(self, repository: str, **kwargs) -> AsyncItemPaged[Artif
         """
         name = repository
         last = kwargs.pop("last", None)
-        n = kwargs.pop("results_per_page", None)
-        orderby = kwargs.pop("order_by", None)
         digest = kwargs.pop("digest", None)
         cls = kwargs.pop(
             "cls",
@@ -529,13 +540,13 @@ def prepare_request(next_link=None):
                     query_parameters["last"] = self._client._serialize.query(  # pylint: disable=protected-access
                         "last", last, "str"
                     )
-                if n is not None:
+                if results_per_page is not None:
                     query_parameters["n"] = self._client._serialize.query(  # pylint: disable=protected-access
-                        "n", n, "int"
+                        "n", results_per_page, "int"
                     )
-                if orderby is not None:
+                if order_by is not None:
                     query_parameters["orderby"] = self._client._serialize.query(  # pylint: disable=protected-access
-                        "orderby", orderby, "str"
+                        "orderby", order_by, "str"
                     )
                 if digest is not None:
                     query_parameters["digest"] = self._client._serialize.query(  # pylint: disable=protected-access

sdk/containerregistry/azure-containerregistry/pyproject.toml

@@ -1,2 +1,3 @@
 [tool.azure-sdk-build]
 pyright = false
+strict_sphinx = true