[Key Vault] Enable pyright for Secrets library (#36095)

Author: mccoyp

sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/_client.py

@@ -3,7 +3,7 @@
 # Licensed under the MIT License.
 # ------------------------------------
 from functools import partial
-from typing import Any, Optional
+from typing import Any, cast, Optional
 
 from azure.core.paging import ItemPaged
 from azure.core.polling import LROPoller
@@ -258,7 +258,7 @@ def backup_secret(self, name: str, **kwargs: Any) -> bytes:
 
         """
         backup_result = self._client.backup_secret(self.vault_url, name, **kwargs)
-        return backup_result.value
+        return cast(bytes, backup_result.value)
 
     @distributed_trace
     def restore_secret_backup(self, backup: bytes, **kwargs: Any) -> SecretProperties:
@@ -319,12 +319,13 @@ def begin_delete_secret(self, name: str, **kwargs: Any) -> LROPoller[DeletedSecr
         polling_interval = kwargs.pop("_polling_interval", None)
         if polling_interval is None:
             polling_interval = 2
+        # Ignore pyright warning about return type not being iterable because we use `cls` to return a tuple
         pipeline_response, deleted_secret_bundle = self._client.delete_secret(
             vault_base_url=self.vault_url,
             secret_name=name,
             cls=lambda pipeline_response, deserialized, _: (pipeline_response, deserialized),
             **kwargs,
-        )
+        )  # pyright: ignore[reportGeneralTypeIssues]
         deleted_secret = DeletedSecret._from_deleted_secret_bundle(deleted_secret_bundle)
 
         command = partial(self.get_deleted_secret, name=name, **kwargs)
@@ -447,12 +448,13 @@ def begin_recover_deleted_secret(self, name: str, **kwargs: Any) -> LROPoller[Se
         polling_interval = kwargs.pop("_polling_interval", None)
         if polling_interval is None:
             polling_interval = 2
+        # Ignore pyright warning about return type not being iterable because we use `cls` to return a tuple
         pipeline_response, recovered_secret_bundle = self._client.recover_deleted_secret(
             vault_base_url=self.vault_url,
             secret_name=name,
             cls=lambda pipeline_response, deserialized, _: (pipeline_response, deserialized),
             **kwargs,
-        )
+        )  # pyright: ignore[reportGeneralTypeIssues]
         recovered_secret = SecretProperties._from_secret_bundle(recovered_secret_bundle)
 
         command = partial(self.get_secret, name=name, **kwargs)

sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/_shared/async_client_base.py

@@ -57,9 +57,11 @@ def __init__(self, vault_url: str, credential: AsyncTokenCredential, **kwargs: A
             )
             self._models = _models
         except ValueError as exc:
+            # Ignore pyright error that comes from not identifying ApiVersion as an iterable enum
             raise NotImplementedError(
                 f"This package doesn't support API version '{self.api_version}'. "
-                + f"Supported versions: {', '.join(v.value for v in ApiVersion)}"
+                + "Supported versions: "
+                + f"{', '.join(v.value for v in ApiVersion)}"  # pyright: ignore[reportGeneralTypeIssues]
             ) from exc
 
     @property

sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/_shared/client_base.py

@@ -109,9 +109,11 @@ def __init__(self, vault_url: str, credential: TokenCredential, **kwargs: Any) -
             )
             self._models = _models
         except ValueError as exc:
+            # Ignore pyright error that comes from not identifying ApiVersion as an iterable enum
             raise NotImplementedError(
                 f"This package doesn't support API version '{self.api_version}'. "
-                + f"Supported versions: {', '.join(v.value for v in ApiVersion)}"
+                + "Supported versions: "
+                + f"{', '.join(v.value for v in ApiVersion)}"  # pyright: ignore[reportGeneralTypeIssues]
             ) from exc
 
     @property

sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/aio/_client.py

@@ -2,7 +2,7 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
 # ------------------------------------
-from typing import Any, Optional
+from typing import Any, cast, Optional
 from functools import partial
 
 from azure.core.tracing.decorator import distributed_trace
@@ -246,7 +246,7 @@ async def backup_secret(self, name: str, **kwargs: Any) -> bytes:
                 :dedent: 8
         """
         backup_result = await self._client.backup_secret(self.vault_url, name, **kwargs)
-        return backup_result.value
+        return cast(bytes, backup_result.value)
 
     @distributed_trace_async
     async def restore_secret_backup(self, backup: bytes, **kwargs: Any) -> SecretProperties:
@@ -300,12 +300,13 @@ async def delete_secret(self, name: str, **kwargs: Any) -> DeletedSecret:
         polling_interval = kwargs.pop("_polling_interval", None)
         if polling_interval is None:
             polling_interval = 2
+        # Ignore pyright warning about return type not being iterable because we use `cls` to return a tuple
         pipeline_response, deleted_secret_bundle = await self._client.delete_secret(
             vault_base_url=self.vault_url,
             secret_name=name,
             cls=lambda pipeline_response, deserialized, _: (pipeline_response, deserialized),
             **kwargs,
-        )
+        )  # pyright: ignore[reportGeneralTypeIssues]
         deleted_secret = DeletedSecret._from_deleted_secret_bundle(deleted_secret_bundle)
 
         polling_method = AsyncDeleteRecoverPollingMethod(
@@ -420,12 +421,13 @@ async def recover_deleted_secret(self, name: str, **kwargs: Any) -> SecretProper
         polling_interval = kwargs.pop("_polling_interval", None)
         if polling_interval is None:
             polling_interval = 2
+        # Ignore pyright warning about return type not being iterable because we use `cls` to return a tuple
         pipeline_response, recovered_secret_bundle = await self._client.recover_deleted_secret(
             vault_base_url=self.vault_url,
             secret_name=name,
             cls=lambda pipeline_response, deserialized, _: (pipeline_response, deserialized),
             **kwargs,
-        )
+        )  # pyright: ignore[reportGeneralTypeIssues]
         recovered_secret = SecretProperties._from_secret_bundle(recovered_secret_bundle)
 
         command = partial(self.get_secret, name=name, **kwargs)

sdk/keyvault/azure-keyvault-secrets/pyproject.toml

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

sdk/keyvault/azure-keyvault-secrets/pyrightconfig.json

@@ -0,0 +1,7 @@
+{
+  "reportMissingImports": false,
+  "pythonVersion": "3.8",
+  "exclude": [
+    "**/_generated/**"
+  ]
+}