Fixed pylint issues for azure-communication-identity (Azure#39458)

* fixed next-pylint issues

* fixed sdist failing tests

* fixed mypy failure

* applied the same changes to all shared folder

* fixed lint issue

* fixed PR comments

* fixed sphinx failure for chat

Author: AikoBB

sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_shared/auth_policy_utils.py

@@ -19,8 +19,7 @@ def get_authentication_policy(
     credential: Union[TokenCredential, AsyncTokenCredential, AzureKeyCredential, str],
     decode_url: bool = False,
     is_async: bool = False,
-):
-    # type: (...) -> Union[AsyncBearerTokenCredentialPolicy, BearerTokenCredentialPolicy, HMACCredentialsPolicy]
+) -> Union[AsyncBearerTokenCredentialPolicy, BearerTokenCredentialPolicy, HMACCredentialsPolicy]:
     """Returns the correct authentication policy based on which credential is being passed.
 
     :param endpoint: The endpoint to which we are authenticating to.

sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_shared/policy.py

@@ -26,11 +26,10 @@ class HMACCredentialsPolicy(SansIOHTTPPolicy):
 
     def __init__(
         self,
-        host,  # type: str
-        access_key,  # type: Union[str, AzureKeyCredential]
-        decode_url=False,  # type: bool
-    ):
-        # type: (...) -> None
+        host: str,
+        access_key: Union[str, AzureKeyCredential],
+        decode_url: bool = False,
+    ) -> None:
         super(HMACCredentialsPolicy, self).__init__()
 
         if host.startswith("https://"):

sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_shared/user_credential_async.py

@@ -3,7 +3,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-
+# pylint: disable=C4763
 from asyncio import Condition, Lock, Event
 from datetime import timedelta
 from typing import Any

sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_shared/utils.py

@@ -25,8 +25,7 @@ def _convert_datetime_to_utc_int(input_datetime) -> int:
     return int(calendar.timegm(input_datetime.utctimetuple()))
 
 
-def parse_connection_str(conn_str):
-    # type: (Optional[str]) -> Tuple[str, str]
+def parse_connection_str(conn_str: Optional[str]) -> Tuple[str, str]:
     if conn_str is None:
         raise ValueError("Connection string is undefined.")
     endpoint = None
@@ -51,19 +50,16 @@ def parse_connection_str(conn_str):
     return host, str(shared_access_key)
 
 
-def get_current_utc_time():
-    # type: () -> str
+def get_current_utc_time() -> str:
     return str(datetime.now(tz=TZ_UTC).strftime("%a, %d %b %Y %H:%M:%S ")) + "GMT"
 
 
-def get_current_utc_as_int():
-    # type: () -> int
+def get_current_utc_as_int() -> int:
     current_utc_datetime = datetime.utcnow()
     return _convert_datetime_to_utc_int(current_utc_datetime)
 
 
-def create_access_token(token):
-    # type: (str) -> AccessToken
+def create_access_token(token) -> AccessToken:
     """Creates an instance of azure.core.credentials.AccessToken from a
     string token. The input string is jwt token in the following form:
     <token_header>.<token_payload>.<token_signature>

sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_shared/utils_async.py

@@ -3,9 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
-
-import asyncio
-
+# pylint: disable=C4763
+from asyncio import sleep, ensure_future
 
 class AsyncTimer:
     """A non-blocking timer, that calls a function after a specified number of seconds:
@@ -19,10 +18,10 @@ def __init__(self, interval, callback):
         self._task = None
 
     def start(self):
-        self._task = asyncio.ensure_future(self._job())
+        self._task = ensure_future(self._job())
 
     async def _job(self):
-        await asyncio.sleep(self._interval)
+        await sleep(self._interval)
         await self._callback()
 
     def cancel(self):

sdk/communication/azure-communication-chat/azure/communication/chat/_shared/auth_policy_utils.py

@@ -19,8 +19,7 @@ def get_authentication_policy(
     credential: Union[TokenCredential, AsyncTokenCredential, AzureKeyCredential, str],
     decode_url: bool = False,
     is_async: bool = False,
-):
-    # type: (...) -> Union[AsyncBearerTokenCredentialPolicy, BearerTokenCredentialPolicy, HMACCredentialsPolicy]
+) -> Union[AsyncBearerTokenCredentialPolicy, BearerTokenCredentialPolicy, HMACCredentialsPolicy]:
     """Returns the correct authentication policy based on which credential is being passed.
 
     :param endpoint: The endpoint to which we are authenticating to.

sdk/communication/azure-communication-chat/azure/communication/chat/_shared/policy.py

@@ -26,11 +26,10 @@ class HMACCredentialsPolicy(SansIOHTTPPolicy):
 
     def __init__(
         self,
-        host,  # type: str
-        access_key,  # type: Union[str, AzureKeyCredential]
-        decode_url=False,  # type: bool
-    ):
-        # type: (...) -> None
+        host: str,
+        access_key: Union[str, AzureKeyCredential],
+        decode_url: bool = False,
+    ) -> None:
         super(HMACCredentialsPolicy, self).__init__()
 
         if host.startswith("https://"):

sdk/communication/azure-communication-chat/azure/communication/chat/_shared/user_credential.py

@@ -17,14 +17,15 @@ class CommunicationTokenCredential(object):
 
     :param str token: The token used to authenticate to an Azure Communication service.
     :keyword token_refresher: The sync token refresher to provide capacity to fetch a fresh token.
-        The returned token must be valid (expiration date must be in the future).
+     The returned token must be valid (expiration date must be in the future).
     :paramtype token_refresher: Callable[[], AccessToken]
     :keyword bool proactive_refresh: Whether to refresh the token proactively or not.
-        If the proactive refreshing is enabled ('proactive_refresh' is true), the credential will use
-        a background thread to attempt to refresh the token within 10 minutes before the cached token expires,
-        the proactive refresh will request a new token by calling the 'token_refresher' callback.
-        When 'proactive_refresh' is enabled, the Credential object must be either run within a context manager
-        or the 'close' method must be called once the object usage has been finished.
+     If the proactive refreshing is enabled ('proactive_refresh' is true), the credential will use
+     a background thread to attempt to refresh the token within 10 minutes before the cached token expires,
+     the proactive refresh will request a new token by calling the 'token_refresher' callback.
+     When 'proactive_refresh' is enabled, the Credential object must be either run within a context manager
+     or the 'close' method must be called once the object usage has been finished.
+
     :raises: TypeError if paramater 'token' is not a string
     :raises: ValueError if the 'proactive_refresh' is enabled without providing the 'token_refresher' callable.
     """

sdk/communication/azure-communication-chat/azure/communication/chat/_shared/user_credential_async.py

@@ -3,7 +3,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-
+# pylint: disable=C4763
 from asyncio import Condition, Lock, Event
 from datetime import timedelta
 from typing import Any
@@ -19,14 +19,15 @@ class CommunicationTokenCredential(object):
 
     :param str token: The token used to authenticate to an Azure Communication service.
     :keyword token_refresher: The async token refresher to provide capacity to fetch a fresh token.
-        The returned token must be valid (expiration date must be in the future).
+     The returned token must be valid (expiration date must be in the future).
     :paramtype token_refresher: Callable[[], Awaitable[AccessToken]]
     :keyword bool proactive_refresh: Whether to refresh the token proactively or not.
-        If the proactive refreshing is enabled ('proactive_refresh' is true), the credential will use
-        a background thread to attempt to refresh the token within 10 minutes before the cached token expires,
-        the proactive refresh will request a new token by calling the 'token_refresher' callback.
-        When 'proactive_refresh is enabled', the Credential object must be either run within a context manager
-        or the 'close' method must be called once the object usage has been finished.
+     If the proactive refreshing is enabled ('proactive_refresh' is true), the credential will use
+     a background thread to attempt to refresh the token within 10 minutes before the cached token expires,
+     the proactive refresh will request a new token by calling the 'token_refresher' callback.
+     When 'proactive_refresh is enabled', the Credential object must be either run within a context manager
+     or the 'close' method must be called once the object usage has been finished.
+
     :raises: TypeError if paramater 'token' is not a string
     :raises: ValueError if the 'proactive_refresh' is enabled without providing the 'token_refresher' function.
     """
@@ -54,7 +55,6 @@ def __init__(self, token: str, **kwargs: Any):
     async def get_token(self, *scopes, **kwargs):  # pylint: disable=unused-argument
         # type (*str, **Any) -> AccessToken
         """The value of the configured token.
-
         :param any scopes: Scopes to be added to the token.
         :return: AccessToken
         :rtype: ~azure.core.credentials.AccessToken

sdk/communication/azure-communication-chat/azure/communication/chat/_shared/utils.py

@@ -25,8 +25,7 @@ def _convert_datetime_to_utc_int(input_datetime) -> int:
     return int(calendar.timegm(input_datetime.utctimetuple()))
 
 
-def parse_connection_str(conn_str):
-    # type: (Optional[str]) -> Tuple[str, str]
+def parse_connection_str(conn_str: Optional[str]) -> Tuple[str, str]:
     if conn_str is None:
         raise ValueError("Connection string is undefined.")
     endpoint = None
@@ -51,19 +50,16 @@ def parse_connection_str(conn_str):
     return host, str(shared_access_key)
 
 
-def get_current_utc_time():
-    # type: () -> str
+def get_current_utc_time() -> str:
     return str(datetime.now(tz=TZ_UTC).strftime("%a, %d %b %Y %H:%M:%S ")) + "GMT"
 
 
-def get_current_utc_as_int():
-    # type: () -> int
+def get_current_utc_as_int() -> int:
     current_utc_datetime = datetime.utcnow()
     return _convert_datetime_to_utc_int(current_utc_datetime)
 
 
-def create_access_token(token):
-    # type: (str) -> AccessToken
+def create_access_token(token) -> AccessToken:
     """Creates an instance of azure.core.credentials.AccessToken from a
     string token. The input string is jwt token in the following form:
     <token_header>.<token_payload>.<token_signature>