diff --git a/sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_shared/auth_policy_utils.py b/sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_shared/auth_policy_utils.py index e408cf57202a..c176b112f9b1 100644 --- a/sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_shared/auth_policy_utils.py +++ b/sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_shared/auth_policy_utils.py @@ -28,11 +28,10 @@ def get_authentication_policy( :type credential: Union[TokenCredential, AsyncTokenCredential, AzureKeyCredential, str] :param bool decode_url: `True` if there is a need to decode the url. Default value is `False` :param bool is_async: For async clients there is a need to decode the url - - :return: Either AsyncBearerTokenCredentialPolicy or BearerTokenCredentialPolicy or HMACCredentialsPolicy + :return: The authentication policy to be used. :rtype: ~azure.core.pipeline.policies.AsyncBearerTokenCredentialPolicy or - ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or - ~azure.communication.callautomation.shared.policy.HMACCredentialsPolicy + ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or + ~.HMACCredentialsPolicy """ if credential is None: diff --git a/sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_shared/models.py b/sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_shared/models.py index 0fd3ac27dd34..d71d8428504d 100644 --- a/sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_shared/models.py +++ b/sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_shared/models.py @@ -245,7 +245,7 @@ def __init__(self, user_id: str, **kwargs: Any) -> None: :param str user_id: Microsoft Teams user id. :keyword bool is_anonymous: `True` if the identifier is anonymous. Default value is `False`. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.callautomation.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -316,7 +316,7 @@ def __init__(self, app_id: str, **kwargs: Any) -> None: """ :param str app_id: Microsoft Teams application id. :keyword cloud: Cloud environment that the application belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.callautomation.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -360,7 +360,7 @@ def __init__(self, bot_id, **kwargs): :keyword bool is_resource_account_configured: `False` if the identifier is global. Default value is `True` for tennantzed bots. :keyword cloud: Cloud environment that the bot belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.callautomation.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` """ warnings.warn( "The MicrosoftBotIdentifier is deprecated and has been replaced by MicrosoftTeamsAppIdentifier.", @@ -398,7 +398,7 @@ def __init__(self, *, user_id: str, tenant_id: str, resource_id: str, **kwargs: :param str tenant_id: Tenant id associated with the user. :param str resource_id: The Communication Services resource id. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.callautomation.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -455,7 +455,7 @@ def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: d :param str raw_id: A raw ID to construct the CommunicationIdentifier from. :return: The CommunicationIdentifier parsed from the raw_id. - :rtype: CommunicationIdentifier + :rtype: :class:`~.CommunicationIdentifier` """ if raw_id.startswith(PHONE_NUMBER_PREFIX): return PhoneNumberIdentifier(value=raw_id[len(PHONE_NUMBER_PREFIX) :], raw_id=raw_id) diff --git a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/auth_policy_utils.py b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/auth_policy_utils.py index 750e6bf1e3ed..c176b112f9b1 100644 --- a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/auth_policy_utils.py +++ b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/auth_policy_utils.py @@ -4,7 +4,7 @@ # license information. # ------------------------------------------------------------------------- -from typing import Union +from typing import Union, cast from azure.core.credentials import TokenCredential, AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.policies import ( @@ -28,11 +28,10 @@ def get_authentication_policy( :type credential: Union[TokenCredential, AsyncTokenCredential, AzureKeyCredential, str] :param bool decode_url: `True` if there is a need to decode the url. Default value is `False` :param bool is_async: For async clients there is a need to decode the url - - :return: Either AsyncBearerTokenCredentialPolicy or BearerTokenCredentialPolicy or HMACCredentialsPolicy + :return: The authentication policy to be used. :rtype: ~azure.core.pipeline.policies.AsyncBearerTokenCredentialPolicy or - ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or - ~azure.communication.chat.shared.policy.HMACCredentialsPolicy + ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or + ~.HMACCredentialsPolicy """ if credential is None: @@ -40,9 +39,11 @@ def get_authentication_policy( if hasattr(credential, "get_token"): if is_async: return AsyncBearerTokenCredentialPolicy( - credential, "https://communication.azure.com//.default" # type: ignore + cast(AsyncTokenCredential, credential), "https://communication.azure.com//.default" ) - return BearerTokenCredentialPolicy(credential, "https://communication.azure.com//.default") # type: ignore + return BearerTokenCredentialPolicy( + cast(TokenCredential, credential), "https://communication.azure.com//.default" + ) if isinstance(credential, (AzureKeyCredential, str)): return HMACCredentialsPolicy(endpoint, credential, decode_url=decode_url) diff --git a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/models.py b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/models.py index 0f8d6f5503ce..d71d8428504d 100644 --- a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/models.py +++ b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/models.py @@ -157,14 +157,16 @@ def __init__(self, value: str, **kwargs: Any) -> None: is_anonymous: bool if raw_id is not None: - phone_number = raw_id[len(PHONE_NUMBER_PREFIX):] + phone_number = raw_id[len(PHONE_NUMBER_PREFIX) :] is_anonymous = phone_number == PHONE_NUMBER_ANONYMOUS_SUFFIX asserted_id_index = -1 if is_anonymous else phone_number.rfind("_") + 1 has_asserted_id = 0 < asserted_id_index < len(phone_number) - props = {"value": value, "is_anonymous": is_anonymous} if has_asserted_id: - props["asserted_id"] = phone_number[asserted_id_index:] - self.properties = PhoneNumberProperties(**props) # type: ignore + self.properties = PhoneNumberProperties( + value=value, is_anonymous=is_anonymous, asserted_id=phone_number[asserted_id_index:] + ) + else: + self.properties = PhoneNumberProperties(value=value, is_anonymous=is_anonymous) else: self.properties = PhoneNumberProperties(value=value) self.raw_id = raw_id if raw_id is not None else self._format_raw_id(self.properties) @@ -183,6 +185,7 @@ def _format_raw_id(self, properties: PhoneNumberProperties) -> str: value = properties["value"] return f"{PHONE_NUMBER_PREFIX}{value}" + class UnknownIdentifier: """Represents an identifier of an unknown type. @@ -242,7 +245,7 @@ def __init__(self, user_id: str, **kwargs: Any) -> None: :param str user_id: Microsoft Teams user id. :keyword bool is_anonymous: `True` if the identifier is anonymous. Default value is `False`. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.chat.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -313,7 +316,7 @@ def __init__(self, app_id: str, **kwargs: Any) -> None: """ :param str app_id: Microsoft Teams application id. :keyword cloud: Cloud environment that the application belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.chat.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -357,7 +360,7 @@ def __init__(self, bot_id, **kwargs): :keyword bool is_resource_account_configured: `False` if the identifier is global. Default value is `True` for tennantzed bots. :keyword cloud: Cloud environment that the bot belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.chat.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` """ warnings.warn( "The MicrosoftBotIdentifier is deprecated and has been replaced by MicrosoftTeamsAppIdentifier.", @@ -389,20 +392,13 @@ class TeamsExtensionUserIdentifier: raw_id: str """The raw ID of the identifier.""" - def __init__( - self, - *, - user_id: str, - tenant_id: str, - resource_id: str, - **kwargs: Any - ) -> None: + def __init__(self, *, user_id: str, tenant_id: str, resource_id: str, **kwargs: Any) -> None: """ :param str user_id: Teams extension user id. :param str tenant_id: Tenant id associated with the user. :param str resource_id: The Communication Services resource id. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.chat.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -434,6 +430,7 @@ def _format_raw_id(self, properties: TeamsExtensionUserProperties) -> str: prefix = ACS_USER_PREFIX return f"{prefix}{properties['resource_id']}_{properties['tenant_id']}_{properties['user_id']}" + def try_create_teams_extension_user(prefix: str, suffix: str) -> Optional[TeamsExtensionUserIdentifier]: segments = suffix.split("_") if len(segments) != 3: @@ -449,6 +446,7 @@ def try_create_teams_extension_user(prefix: str, suffix: str) -> Optional[TeamsE raise ValueError("Invalid MRI") return TeamsExtensionUserIdentifier(user_id=user_id, tenant_id=tenant_id, resource_id=resource_id, cloud=cloud) + def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: disable=too-many-return-statements """ Creates a CommunicationIdentifier from a given raw ID. @@ -457,7 +455,7 @@ def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: d :param str raw_id: A raw ID to construct the CommunicationIdentifier from. :return: The CommunicationIdentifier parsed from the raw_id. - :rtype: CommunicationIdentifier + :rtype: :class:`~.CommunicationIdentifier` """ if raw_id.startswith(PHONE_NUMBER_PREFIX): return PhoneNumberIdentifier(value=raw_id[len(PHONE_NUMBER_PREFIX) :], raw_id=raw_id) diff --git a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/policy.py b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/policy.py index 1843d22e83a2..6eae18574193 100644 --- a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/policy.py +++ b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/policy.py @@ -5,13 +5,15 @@ # ------------------------------------------------------------------------- import hashlib -import urllib import base64 import hmac -from urllib.parse import ParseResult, urlparse +from urllib.parse import urlparse, unquote from typing import Union + from azure.core.credentials import AzureKeyCredential from azure.core.pipeline.policies import SansIOHTTPPolicy +from azure.core.pipeline import PipelineRequest + from .utils import get_current_utc_time @@ -41,9 +43,7 @@ def __init__( self._access_key = access_key self._decode_url = decode_url - def _compute_hmac( - self, value # type: str - ): + def _compute_hmac(self, value: str) -> str: if isinstance(self._access_key, AzureKeyCredential): decoded_secret = base64.b64decode(self._access_key.key) else: @@ -53,11 +53,11 @@ def _compute_hmac( return base64.b64encode(digest).decode("utf-8") - def _sign_request(self, request): + def _sign_request(self, request: PipelineRequest) -> None: verb = request.http_request.method.upper() # Get the path and query from url, which looks like https://host/path/query - parsed_url: ParseResult = urlparse(request.http_request.url) + parsed_url = urlparse(request.http_request.url) query_url = parsed_url.path if parsed_url.query: @@ -91,7 +91,7 @@ def _sign_request(self, request): pass if self._decode_url: - query_url = urllib.parse.unquote(query_url) + query_url = unquote(query_url) signed_headers = "x-ms-date;host;x-ms-content-sha256" @@ -114,7 +114,5 @@ def _sign_request(self, request): request.http_request.headers.update(signature_header) - return request - - def on_request(self, request): + def on_request(self, request: PipelineRequest) -> None: self._sign_request(request) diff --git a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/token_exchange.py b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/token_exchange.py index 32d6297d4b1b..1b0dde140479 100644 --- a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/token_exchange.py +++ b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/token_exchange.py @@ -6,6 +6,7 @@ import json from typing import Any, List, Optional + # pylint: disable=non-abstract-transport-import # pylint: disable=no-name-in-module @@ -21,7 +22,7 @@ class TokenExchangeClient: """Represents a client that exchanges an Entra token for an Azure Communication Services (ACS) token. - + :param resource_endpoint: The endpoint URL of the resource to authenticate against. :param credential: The credential to use for token exchange. :param scopes: The scopes to request during the token exchange. @@ -31,11 +32,8 @@ class TokenExchangeClient: # pylint: disable=C4748 # pylint: disable=client-method-missing-type-annotations def __init__( - self, - resource_endpoint: str, - credential: TokenCredential, - scopes: Optional[List[str]] = None, - **kwargs: Any): + self, resource_endpoint: str, credential: TokenCredential, scopes: Optional[List[str]] = None, **kwargs: Any + ): self._resource_endpoint = resource_endpoint self._scopes = scopes or ["https://communication.azure.com/clients/.default"] @@ -76,6 +74,5 @@ def _parse_access_token_from_response(self, response: PipelineResponse) -> Acces raise ValueError("Failed to parse access token from response") from ex else: raise HttpResponseError( - message="Failed to exchange Entra token for ACS token", - response=response.http_response + message="Failed to exchange Entra token for ACS token", response=response.http_response ) diff --git a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/token_exchange_async.py b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/token_exchange_async.py index 0181b5982673..22dd4582460b 100644 --- a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/token_exchange_async.py +++ b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/token_exchange_async.py @@ -6,6 +6,7 @@ import json from typing import Any, Optional, List + # pylint: disable=non-abstract-transport-import # pylint: disable=no-name-in-module @@ -35,7 +36,8 @@ def __init__( resource_endpoint: str, credential: AsyncTokenCredential, scopes: Optional[List[str]] = None, - **kwargs: Any): + **kwargs: Any + ): self._resource_endpoint = resource_endpoint self._scopes = scopes or ["https://communication.azure.com/clients/.default"] @@ -76,6 +78,5 @@ async def _parse_access_token_from_response(self, response: PipelineResponse) -> raise ValueError("Failed to parse access token from response") from ex else: raise HttpResponseError( - message="Failed to exchange Entra token for ACS token", - response=response.http_response + message="Failed to exchange Entra token for ACS token", response=response.http_response ) diff --git a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/token_utils.py b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/token_utils.py index f4115a001029..9628d3e76ec9 100644 --- a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/token_utils.py +++ b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/token_utils.py @@ -21,6 +21,7 @@ def create_request_message(resource_endpoint: str, scopes: Optional[List[str]]) -> Any: from azure.core.pipeline.transport import HttpRequest + request_uri = create_request_uri(resource_endpoint, scopes) request = HttpRequest("POST", request_uri) request.headers["Accept"] = "application/json" @@ -59,26 +60,26 @@ def parse_expires_on(expires_on, response): return expires_on_epoch except Exception as exc: raise HttpResponseError( - message="Unknown format for expires_on field in access token response", - response=response.http_response) from exc + message="Unknown format for expires_on field in access token response", response=response.http_response + ) from exc else: raise HttpResponseError( - message="Missing expires_on field in access token response", - response=response.http_response) + message="Missing expires_on field in access token response", response=response.http_response + ) def is_entra_token_cache_valid(entra_token_cache, request): current_entra_token = request.http_request.headers.get("Authorization", "") - cache_valid = ( - entra_token_cache is not None and - current_entra_token == entra_token_cache - ) + cache_valid = entra_token_cache is not None and current_entra_token == entra_token_cache return cache_valid, current_entra_token def is_acs_token_cache_valid(response_cache): - if (response_cache is None or response_cache.http_response is None or - response_cache.http_response.status_code != 200): + if ( + response_cache is None + or response_cache.http_response is None + or response_cache.http_response.status_code != 200 + ): return False try: content = response_cache.http_response.text() @@ -86,6 +87,5 @@ def is_acs_token_cache_valid(response_cache): expires_on = data["accessToken"]["expiresOn"] expires_on_dt = isodate.parse_datetime(expires_on) return datetime.now(timezone.utc) < expires_on_dt - except (KeyError, ValueError, json.JSONDecodeError): - raise ValueError( # pylint: disable=W0707 - "Invalid token response") + except (KeyError, ValueError, json.JSONDecodeError) as e: + raise ValueError("Invalid token response") from e diff --git a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/user_credential.py b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/user_credential.py index b8b90ee06bc9..17adbf77dcc9 100644 --- a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/user_credential.py +++ b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/user_credential.py @@ -46,7 +46,7 @@ def __init__( *, token_refresher: Optional[Callable[[], AccessToken]] = None, proactive_refresh: bool = False, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential. @@ -64,7 +64,7 @@ def __init__( resource_endpoint: str, token_credential: TokenCredential, scopes: Optional[list[str]] = None, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential using token exchange. @@ -91,15 +91,13 @@ def __init__(self, token: Optional[str] = None, **kwargs: Any): if token_credential is None: missing_fields.append("token_credential") raise ValueError( - "When using token exchange, resource_endpoint and token_credential must be provided. " - f"Missing: {', '.join(missing_fields)}") + "When using token exchange, resource_endpoint and token_credential must be provided. " + f"Missing: {', '.join(missing_fields)}" + ) self._token_exchange_client = None if resource_endpoint and token_credential: - self._token_exchange_client = TokenExchangeClient( - resource_endpoint, - token_credential, - scopes) + self._token_exchange_client = TokenExchangeClient(resource_endpoint, token_credential, scopes) self._token_refresher = self._token_exchange_client.exchange_entra_token self._proactive_refresh = False self._token = self._token_exchange_client.exchange_entra_token() diff --git a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/user_credential_async.py b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/user_credential_async.py index 5a5d85d1fb0d..81c4b79c4e6d 100644 --- a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/user_credential_async.py +++ b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/user_credential_async.py @@ -50,7 +50,7 @@ def __init__( *, token_refresher: Optional[Callable[[], Awaitable[Any]]] = None, proactive_refresh: bool = False, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential. @@ -60,6 +60,7 @@ def __init__( :param proactive_refresh: Whether to refresh the token proactively. :param kwargs: Additional keyword arguments. """ + @overload def __init__( self, @@ -67,7 +68,7 @@ def __init__( resource_endpoint: str, token_credential: AsyncTokenCredential, scopes: Optional[list[str]] = None, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential using token exchange. @@ -95,14 +96,12 @@ def __init__(self, token: Optional[str] = None, **kwargs: Any): missing_fields.append("token_credential") raise ValueError( "When using token exchange, resource_endpoint and token_credential must be provided. " - f"Missing: {', '.join(missing_fields)}") + f"Missing: {', '.join(missing_fields)}" + ) self._token_exchange_client = None if resource_endpoint and token_credential: - self._token_exchange_client = TokenExchangeClient( - resource_endpoint, - token_credential, - scopes) + self._token_exchange_client = TokenExchangeClient(resource_endpoint, token_credential, scopes) self._token_refresher = self._token_exchange_client.exchange_entra_token self._proactive_refresh = False diff --git a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/utils_async.py b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/utils_async.py index 7402d088a880..b779d5c814b3 100644 --- a/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/utils_async.py +++ b/sdk/communication/azure-communication-chat/azure/communication/chat/_shared/utils_async.py @@ -6,6 +6,7 @@ # 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: :param int interval: time interval in seconds diff --git a/sdk/communication/azure-communication-chat/mypy.ini b/sdk/communication/azure-communication-chat/mypy.ini new file mode 100644 index 000000000000..78e98f92ce62 --- /dev/null +++ b/sdk/communication/azure-communication-chat/mypy.ini @@ -0,0 +1,4 @@ +[mypy] +ignore_missing_imports = True +check_untyped_defs = False +disallow_untyped_defs = False \ No newline at end of file diff --git a/sdk/communication/azure-communication-email/azure/communication/email/_shared/auth_policy_utils.py b/sdk/communication/azure-communication-email/azure/communication/email/_shared/auth_policy_utils.py index b6b569cdadcb..c176b112f9b1 100644 --- a/sdk/communication/azure-communication-email/azure/communication/email/_shared/auth_policy_utils.py +++ b/sdk/communication/azure-communication-email/azure/communication/email/_shared/auth_policy_utils.py @@ -4,7 +4,7 @@ # license information. # ------------------------------------------------------------------------- -from typing import Union +from typing import Union, cast from azure.core.credentials import TokenCredential, AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.policies import ( @@ -28,11 +28,10 @@ def get_authentication_policy( :type credential: Union[TokenCredential, AsyncTokenCredential, AzureKeyCredential, str] :param bool decode_url: `True` if there is a need to decode the url. Default value is `False` :param bool is_async: For async clients there is a need to decode the url - - :return: Either AsyncBearerTokenCredentialPolicy or BearerTokenCredentialPolicy or HMACCredentialsPolicy + :return: The authentication policy to be used. :rtype: ~azure.core.pipeline.policies.AsyncBearerTokenCredentialPolicy or - ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or - ~azure.communication.email.shared.policy.HMACCredentialsPolicy + ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or + ~.HMACCredentialsPolicy """ if credential is None: @@ -40,9 +39,11 @@ def get_authentication_policy( if hasattr(credential, "get_token"): if is_async: return AsyncBearerTokenCredentialPolicy( - credential, "https://communication.azure.com//.default" # type: ignore + cast(AsyncTokenCredential, credential), "https://communication.azure.com//.default" ) - return BearerTokenCredentialPolicy(credential, "https://communication.azure.com//.default") # type: ignore + return BearerTokenCredentialPolicy( + cast(TokenCredential, credential), "https://communication.azure.com//.default" + ) if isinstance(credential, (AzureKeyCredential, str)): return HMACCredentialsPolicy(endpoint, credential, decode_url=decode_url) diff --git a/sdk/communication/azure-communication-email/azure/communication/email/_shared/models.py b/sdk/communication/azure-communication-email/azure/communication/email/_shared/models.py index a4f1d2088dc7..d71d8428504d 100644 --- a/sdk/communication/azure-communication-email/azure/communication/email/_shared/models.py +++ b/sdk/communication/azure-communication-email/azure/communication/email/_shared/models.py @@ -157,14 +157,16 @@ def __init__(self, value: str, **kwargs: Any) -> None: is_anonymous: bool if raw_id is not None: - phone_number = raw_id[len(PHONE_NUMBER_PREFIX):] + phone_number = raw_id[len(PHONE_NUMBER_PREFIX) :] is_anonymous = phone_number == PHONE_NUMBER_ANONYMOUS_SUFFIX asserted_id_index = -1 if is_anonymous else phone_number.rfind("_") + 1 has_asserted_id = 0 < asserted_id_index < len(phone_number) - props = {"value": value, "is_anonymous": is_anonymous} if has_asserted_id: - props["asserted_id"] = phone_number[asserted_id_index:] - self.properties = PhoneNumberProperties(**props) # type: ignore + self.properties = PhoneNumberProperties( + value=value, is_anonymous=is_anonymous, asserted_id=phone_number[asserted_id_index:] + ) + else: + self.properties = PhoneNumberProperties(value=value, is_anonymous=is_anonymous) else: self.properties = PhoneNumberProperties(value=value) self.raw_id = raw_id if raw_id is not None else self._format_raw_id(self.properties) @@ -183,6 +185,7 @@ def _format_raw_id(self, properties: PhoneNumberProperties) -> str: value = properties["value"] return f"{PHONE_NUMBER_PREFIX}{value}" + class UnknownIdentifier: """Represents an identifier of an unknown type. @@ -242,7 +245,7 @@ def __init__(self, user_id: str, **kwargs: Any) -> None: :param str user_id: Microsoft Teams user id. :keyword bool is_anonymous: `True` if the identifier is anonymous. Default value is `False`. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.email.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -313,7 +316,7 @@ def __init__(self, app_id: str, **kwargs: Any) -> None: """ :param str app_id: Microsoft Teams application id. :keyword cloud: Cloud environment that the application belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.email.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -357,7 +360,7 @@ def __init__(self, bot_id, **kwargs): :keyword bool is_resource_account_configured: `False` if the identifier is global. Default value is `True` for tennantzed bots. :keyword cloud: Cloud environment that the bot belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.email.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` """ warnings.warn( "The MicrosoftBotIdentifier is deprecated and has been replaced by MicrosoftTeamsAppIdentifier.", @@ -389,20 +392,13 @@ class TeamsExtensionUserIdentifier: raw_id: str """The raw ID of the identifier.""" - def __init__( - self, - *, - user_id: str, - tenant_id: str, - resource_id: str, - **kwargs: Any - ) -> None: + def __init__(self, *, user_id: str, tenant_id: str, resource_id: str, **kwargs: Any) -> None: """ :param str user_id: Teams extension user id. :param str tenant_id: Tenant id associated with the user. :param str resource_id: The Communication Services resource id. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.email.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -434,6 +430,7 @@ def _format_raw_id(self, properties: TeamsExtensionUserProperties) -> str: prefix = ACS_USER_PREFIX return f"{prefix}{properties['resource_id']}_{properties['tenant_id']}_{properties['user_id']}" + def try_create_teams_extension_user(prefix: str, suffix: str) -> Optional[TeamsExtensionUserIdentifier]: segments = suffix.split("_") if len(segments) != 3: @@ -449,6 +446,7 @@ def try_create_teams_extension_user(prefix: str, suffix: str) -> Optional[TeamsE raise ValueError("Invalid MRI") return TeamsExtensionUserIdentifier(user_id=user_id, tenant_id=tenant_id, resource_id=resource_id, cloud=cloud) + def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: disable=too-many-return-statements """ Creates a CommunicationIdentifier from a given raw ID. @@ -457,7 +455,7 @@ def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: d :param str raw_id: A raw ID to construct the CommunicationIdentifier from. :return: The CommunicationIdentifier parsed from the raw_id. - :rtype: CommunicationIdentifier + :rtype: :class:`~.CommunicationIdentifier` """ if raw_id.startswith(PHONE_NUMBER_PREFIX): return PhoneNumberIdentifier(value=raw_id[len(PHONE_NUMBER_PREFIX) :], raw_id=raw_id) diff --git a/sdk/communication/azure-communication-email/azure/communication/email/_shared/policy.py b/sdk/communication/azure-communication-email/azure/communication/email/_shared/policy.py index 1843d22e83a2..6eae18574193 100644 --- a/sdk/communication/azure-communication-email/azure/communication/email/_shared/policy.py +++ b/sdk/communication/azure-communication-email/azure/communication/email/_shared/policy.py @@ -5,13 +5,15 @@ # ------------------------------------------------------------------------- import hashlib -import urllib import base64 import hmac -from urllib.parse import ParseResult, urlparse +from urllib.parse import urlparse, unquote from typing import Union + from azure.core.credentials import AzureKeyCredential from azure.core.pipeline.policies import SansIOHTTPPolicy +from azure.core.pipeline import PipelineRequest + from .utils import get_current_utc_time @@ -41,9 +43,7 @@ def __init__( self._access_key = access_key self._decode_url = decode_url - def _compute_hmac( - self, value # type: str - ): + def _compute_hmac(self, value: str) -> str: if isinstance(self._access_key, AzureKeyCredential): decoded_secret = base64.b64decode(self._access_key.key) else: @@ -53,11 +53,11 @@ def _compute_hmac( return base64.b64encode(digest).decode("utf-8") - def _sign_request(self, request): + def _sign_request(self, request: PipelineRequest) -> None: verb = request.http_request.method.upper() # Get the path and query from url, which looks like https://host/path/query - parsed_url: ParseResult = urlparse(request.http_request.url) + parsed_url = urlparse(request.http_request.url) query_url = parsed_url.path if parsed_url.query: @@ -91,7 +91,7 @@ def _sign_request(self, request): pass if self._decode_url: - query_url = urllib.parse.unquote(query_url) + query_url = unquote(query_url) signed_headers = "x-ms-date;host;x-ms-content-sha256" @@ -114,7 +114,5 @@ def _sign_request(self, request): request.http_request.headers.update(signature_header) - return request - - def on_request(self, request): + def on_request(self, request: PipelineRequest) -> None: self._sign_request(request) diff --git a/sdk/communication/azure-communication-email/azure/communication/email/_shared/token_exchange.py b/sdk/communication/azure-communication-email/azure/communication/email/_shared/token_exchange.py index 32d6297d4b1b..1b0dde140479 100644 --- a/sdk/communication/azure-communication-email/azure/communication/email/_shared/token_exchange.py +++ b/sdk/communication/azure-communication-email/azure/communication/email/_shared/token_exchange.py @@ -6,6 +6,7 @@ import json from typing import Any, List, Optional + # pylint: disable=non-abstract-transport-import # pylint: disable=no-name-in-module @@ -21,7 +22,7 @@ class TokenExchangeClient: """Represents a client that exchanges an Entra token for an Azure Communication Services (ACS) token. - + :param resource_endpoint: The endpoint URL of the resource to authenticate against. :param credential: The credential to use for token exchange. :param scopes: The scopes to request during the token exchange. @@ -31,11 +32,8 @@ class TokenExchangeClient: # pylint: disable=C4748 # pylint: disable=client-method-missing-type-annotations def __init__( - self, - resource_endpoint: str, - credential: TokenCredential, - scopes: Optional[List[str]] = None, - **kwargs: Any): + self, resource_endpoint: str, credential: TokenCredential, scopes: Optional[List[str]] = None, **kwargs: Any + ): self._resource_endpoint = resource_endpoint self._scopes = scopes or ["https://communication.azure.com/clients/.default"] @@ -76,6 +74,5 @@ def _parse_access_token_from_response(self, response: PipelineResponse) -> Acces raise ValueError("Failed to parse access token from response") from ex else: raise HttpResponseError( - message="Failed to exchange Entra token for ACS token", - response=response.http_response + message="Failed to exchange Entra token for ACS token", response=response.http_response ) diff --git a/sdk/communication/azure-communication-email/azure/communication/email/_shared/token_exchange_async.py b/sdk/communication/azure-communication-email/azure/communication/email/_shared/token_exchange_async.py index 0181b5982673..22dd4582460b 100644 --- a/sdk/communication/azure-communication-email/azure/communication/email/_shared/token_exchange_async.py +++ b/sdk/communication/azure-communication-email/azure/communication/email/_shared/token_exchange_async.py @@ -6,6 +6,7 @@ import json from typing import Any, Optional, List + # pylint: disable=non-abstract-transport-import # pylint: disable=no-name-in-module @@ -35,7 +36,8 @@ def __init__( resource_endpoint: str, credential: AsyncTokenCredential, scopes: Optional[List[str]] = None, - **kwargs: Any): + **kwargs: Any + ): self._resource_endpoint = resource_endpoint self._scopes = scopes or ["https://communication.azure.com/clients/.default"] @@ -76,6 +78,5 @@ async def _parse_access_token_from_response(self, response: PipelineResponse) -> raise ValueError("Failed to parse access token from response") from ex else: raise HttpResponseError( - message="Failed to exchange Entra token for ACS token", - response=response.http_response + message="Failed to exchange Entra token for ACS token", response=response.http_response ) diff --git a/sdk/communication/azure-communication-email/azure/communication/email/_shared/token_utils.py b/sdk/communication/azure-communication-email/azure/communication/email/_shared/token_utils.py index f4115a001029..9628d3e76ec9 100644 --- a/sdk/communication/azure-communication-email/azure/communication/email/_shared/token_utils.py +++ b/sdk/communication/azure-communication-email/azure/communication/email/_shared/token_utils.py @@ -21,6 +21,7 @@ def create_request_message(resource_endpoint: str, scopes: Optional[List[str]]) -> Any: from azure.core.pipeline.transport import HttpRequest + request_uri = create_request_uri(resource_endpoint, scopes) request = HttpRequest("POST", request_uri) request.headers["Accept"] = "application/json" @@ -59,26 +60,26 @@ def parse_expires_on(expires_on, response): return expires_on_epoch except Exception as exc: raise HttpResponseError( - message="Unknown format for expires_on field in access token response", - response=response.http_response) from exc + message="Unknown format for expires_on field in access token response", response=response.http_response + ) from exc else: raise HttpResponseError( - message="Missing expires_on field in access token response", - response=response.http_response) + message="Missing expires_on field in access token response", response=response.http_response + ) def is_entra_token_cache_valid(entra_token_cache, request): current_entra_token = request.http_request.headers.get("Authorization", "") - cache_valid = ( - entra_token_cache is not None and - current_entra_token == entra_token_cache - ) + cache_valid = entra_token_cache is not None and current_entra_token == entra_token_cache return cache_valid, current_entra_token def is_acs_token_cache_valid(response_cache): - if (response_cache is None or response_cache.http_response is None or - response_cache.http_response.status_code != 200): + if ( + response_cache is None + or response_cache.http_response is None + or response_cache.http_response.status_code != 200 + ): return False try: content = response_cache.http_response.text() @@ -86,6 +87,5 @@ def is_acs_token_cache_valid(response_cache): expires_on = data["accessToken"]["expiresOn"] expires_on_dt = isodate.parse_datetime(expires_on) return datetime.now(timezone.utc) < expires_on_dt - except (KeyError, ValueError, json.JSONDecodeError): - raise ValueError( # pylint: disable=W0707 - "Invalid token response") + except (KeyError, ValueError, json.JSONDecodeError) as e: + raise ValueError("Invalid token response") from e diff --git a/sdk/communication/azure-communication-email/azure/communication/email/_shared/user_credential.py b/sdk/communication/azure-communication-email/azure/communication/email/_shared/user_credential.py index b8b90ee06bc9..17adbf77dcc9 100644 --- a/sdk/communication/azure-communication-email/azure/communication/email/_shared/user_credential.py +++ b/sdk/communication/azure-communication-email/azure/communication/email/_shared/user_credential.py @@ -46,7 +46,7 @@ def __init__( *, token_refresher: Optional[Callable[[], AccessToken]] = None, proactive_refresh: bool = False, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential. @@ -64,7 +64,7 @@ def __init__( resource_endpoint: str, token_credential: TokenCredential, scopes: Optional[list[str]] = None, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential using token exchange. @@ -91,15 +91,13 @@ def __init__(self, token: Optional[str] = None, **kwargs: Any): if token_credential is None: missing_fields.append("token_credential") raise ValueError( - "When using token exchange, resource_endpoint and token_credential must be provided. " - f"Missing: {', '.join(missing_fields)}") + "When using token exchange, resource_endpoint and token_credential must be provided. " + f"Missing: {', '.join(missing_fields)}" + ) self._token_exchange_client = None if resource_endpoint and token_credential: - self._token_exchange_client = TokenExchangeClient( - resource_endpoint, - token_credential, - scopes) + self._token_exchange_client = TokenExchangeClient(resource_endpoint, token_credential, scopes) self._token_refresher = self._token_exchange_client.exchange_entra_token self._proactive_refresh = False self._token = self._token_exchange_client.exchange_entra_token() diff --git a/sdk/communication/azure-communication-email/azure/communication/email/_shared/user_credential_async.py b/sdk/communication/azure-communication-email/azure/communication/email/_shared/user_credential_async.py index 5a5d85d1fb0d..81c4b79c4e6d 100644 --- a/sdk/communication/azure-communication-email/azure/communication/email/_shared/user_credential_async.py +++ b/sdk/communication/azure-communication-email/azure/communication/email/_shared/user_credential_async.py @@ -50,7 +50,7 @@ def __init__( *, token_refresher: Optional[Callable[[], Awaitable[Any]]] = None, proactive_refresh: bool = False, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential. @@ -60,6 +60,7 @@ def __init__( :param proactive_refresh: Whether to refresh the token proactively. :param kwargs: Additional keyword arguments. """ + @overload def __init__( self, @@ -67,7 +68,7 @@ def __init__( resource_endpoint: str, token_credential: AsyncTokenCredential, scopes: Optional[list[str]] = None, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential using token exchange. @@ -95,14 +96,12 @@ def __init__(self, token: Optional[str] = None, **kwargs: Any): missing_fields.append("token_credential") raise ValueError( "When using token exchange, resource_endpoint and token_credential must be provided. " - f"Missing: {', '.join(missing_fields)}") + f"Missing: {', '.join(missing_fields)}" + ) self._token_exchange_client = None if resource_endpoint and token_credential: - self._token_exchange_client = TokenExchangeClient( - resource_endpoint, - token_credential, - scopes) + self._token_exchange_client = TokenExchangeClient(resource_endpoint, token_credential, scopes) self._token_refresher = self._token_exchange_client.exchange_entra_token self._proactive_refresh = False diff --git a/sdk/communication/azure-communication-email/azure/communication/email/_shared/utils_async.py b/sdk/communication/azure-communication-email/azure/communication/email/_shared/utils_async.py index 7402d088a880..b779d5c814b3 100644 --- a/sdk/communication/azure-communication-email/azure/communication/email/_shared/utils_async.py +++ b/sdk/communication/azure-communication-email/azure/communication/email/_shared/utils_async.py @@ -6,6 +6,7 @@ # 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: :param int interval: time interval in seconds diff --git a/sdk/communication/azure-communication-email/mypy.ini b/sdk/communication/azure-communication-email/mypy.ini new file mode 100644 index 000000000000..78e98f92ce62 --- /dev/null +++ b/sdk/communication/azure-communication-email/mypy.ini @@ -0,0 +1,4 @@ +[mypy] +ignore_missing_imports = True +check_untyped_defs = False +disallow_untyped_defs = False \ No newline at end of file diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/auth_policy_utils.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/auth_policy_utils.py index 4fafc133dfd5..c176b112f9b1 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/auth_policy_utils.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/auth_policy_utils.py @@ -4,7 +4,7 @@ # license information. # ------------------------------------------------------------------------- -from typing import Union +from typing import Union, cast from azure.core.credentials import TokenCredential, AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.policies import ( @@ -28,11 +28,10 @@ def get_authentication_policy( :type credential: Union[TokenCredential, AsyncTokenCredential, AzureKeyCredential, str] :param bool decode_url: `True` if there is a need to decode the url. Default value is `False` :param bool is_async: For async clients there is a need to decode the url - - :return: Either AsyncBearerTokenCredentialPolicy or BearerTokenCredentialPolicy or HMACCredentialsPolicy + :return: The authentication policy to be used. :rtype: ~azure.core.pipeline.policies.AsyncBearerTokenCredentialPolicy or - ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or - ~azure.communication.identity.shared.policy.HMACCredentialsPolicy + ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or + ~.HMACCredentialsPolicy """ if credential is None: @@ -40,9 +39,11 @@ def get_authentication_policy( if hasattr(credential, "get_token"): if is_async: return AsyncBearerTokenCredentialPolicy( - credential, "https://communication.azure.com//.default" # type: ignore + cast(AsyncTokenCredential, credential), "https://communication.azure.com//.default" ) - return BearerTokenCredentialPolicy(credential, "https://communication.azure.com//.default") # type: ignore + return BearerTokenCredentialPolicy( + cast(TokenCredential, credential), "https://communication.azure.com//.default" + ) if isinstance(credential, (AzureKeyCredential, str)): return HMACCredentialsPolicy(endpoint, credential, decode_url=decode_url) diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/models.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/models.py index e5d4a1d242c9..d71d8428504d 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/models.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/models.py @@ -157,14 +157,16 @@ def __init__(self, value: str, **kwargs: Any) -> None: is_anonymous: bool if raw_id is not None: - phone_number = raw_id[len(PHONE_NUMBER_PREFIX):] + phone_number = raw_id[len(PHONE_NUMBER_PREFIX) :] is_anonymous = phone_number == PHONE_NUMBER_ANONYMOUS_SUFFIX asserted_id_index = -1 if is_anonymous else phone_number.rfind("_") + 1 has_asserted_id = 0 < asserted_id_index < len(phone_number) - props = {"value": value, "is_anonymous": is_anonymous} if has_asserted_id: - props["asserted_id"] = phone_number[asserted_id_index:] - self.properties = PhoneNumberProperties(**props) # type: ignore + self.properties = PhoneNumberProperties( + value=value, is_anonymous=is_anonymous, asserted_id=phone_number[asserted_id_index:] + ) + else: + self.properties = PhoneNumberProperties(value=value, is_anonymous=is_anonymous) else: self.properties = PhoneNumberProperties(value=value) self.raw_id = raw_id if raw_id is not None else self._format_raw_id(self.properties) @@ -183,6 +185,7 @@ def _format_raw_id(self, properties: PhoneNumberProperties) -> str: value = properties["value"] return f"{PHONE_NUMBER_PREFIX}{value}" + class UnknownIdentifier: """Represents an identifier of an unknown type. @@ -242,7 +245,7 @@ def __init__(self, user_id: str, **kwargs: Any) -> None: :param str user_id: Microsoft Teams user id. :keyword bool is_anonymous: `True` if the identifier is anonymous. Default value is `False`. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.identity.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -313,7 +316,7 @@ def __init__(self, app_id: str, **kwargs: Any) -> None: """ :param str app_id: Microsoft Teams application id. :keyword cloud: Cloud environment that the application belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.identity.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -357,7 +360,7 @@ def __init__(self, bot_id, **kwargs): :keyword bool is_resource_account_configured: `False` if the identifier is global. Default value is `True` for tennantzed bots. :keyword cloud: Cloud environment that the bot belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.identity.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` """ warnings.warn( "The MicrosoftBotIdentifier is deprecated and has been replaced by MicrosoftTeamsAppIdentifier.", @@ -389,20 +392,13 @@ class TeamsExtensionUserIdentifier: raw_id: str """The raw ID of the identifier.""" - def __init__( - self, - *, - user_id: str, - tenant_id: str, - resource_id: str, - **kwargs: Any - ) -> None: + def __init__(self, *, user_id: str, tenant_id: str, resource_id: str, **kwargs: Any) -> None: """ :param str user_id: Teams extension user id. :param str tenant_id: Tenant id associated with the user. :param str resource_id: The Communication Services resource id. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.identity.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -434,6 +430,7 @@ def _format_raw_id(self, properties: TeamsExtensionUserProperties) -> str: prefix = ACS_USER_PREFIX return f"{prefix}{properties['resource_id']}_{properties['tenant_id']}_{properties['user_id']}" + def try_create_teams_extension_user(prefix: str, suffix: str) -> Optional[TeamsExtensionUserIdentifier]: segments = suffix.split("_") if len(segments) != 3: @@ -449,6 +446,7 @@ def try_create_teams_extension_user(prefix: str, suffix: str) -> Optional[TeamsE raise ValueError("Invalid MRI") return TeamsExtensionUserIdentifier(user_id=user_id, tenant_id=tenant_id, resource_id=resource_id, cloud=cloud) + def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: disable=too-many-return-statements """ Creates a CommunicationIdentifier from a given raw ID. @@ -457,7 +455,7 @@ def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: d :param str raw_id: A raw ID to construct the CommunicationIdentifier from. :return: The CommunicationIdentifier parsed from the raw_id. - :rtype: CommunicationIdentifier + :rtype: :class:`~.CommunicationIdentifier` """ if raw_id.startswith(PHONE_NUMBER_PREFIX): return PhoneNumberIdentifier(value=raw_id[len(PHONE_NUMBER_PREFIX) :], raw_id=raw_id) diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/policy.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/policy.py index 1843d22e83a2..6eae18574193 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/policy.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/policy.py @@ -5,13 +5,15 @@ # ------------------------------------------------------------------------- import hashlib -import urllib import base64 import hmac -from urllib.parse import ParseResult, urlparse +from urllib.parse import urlparse, unquote from typing import Union + from azure.core.credentials import AzureKeyCredential from azure.core.pipeline.policies import SansIOHTTPPolicy +from azure.core.pipeline import PipelineRequest + from .utils import get_current_utc_time @@ -41,9 +43,7 @@ def __init__( self._access_key = access_key self._decode_url = decode_url - def _compute_hmac( - self, value # type: str - ): + def _compute_hmac(self, value: str) -> str: if isinstance(self._access_key, AzureKeyCredential): decoded_secret = base64.b64decode(self._access_key.key) else: @@ -53,11 +53,11 @@ def _compute_hmac( return base64.b64encode(digest).decode("utf-8") - def _sign_request(self, request): + def _sign_request(self, request: PipelineRequest) -> None: verb = request.http_request.method.upper() # Get the path and query from url, which looks like https://host/path/query - parsed_url: ParseResult = urlparse(request.http_request.url) + parsed_url = urlparse(request.http_request.url) query_url = parsed_url.path if parsed_url.query: @@ -91,7 +91,7 @@ def _sign_request(self, request): pass if self._decode_url: - query_url = urllib.parse.unquote(query_url) + query_url = unquote(query_url) signed_headers = "x-ms-date;host;x-ms-content-sha256" @@ -114,7 +114,5 @@ def _sign_request(self, request): request.http_request.headers.update(signature_header) - return request - - def on_request(self, request): + def on_request(self, request: PipelineRequest) -> None: self._sign_request(request) diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/token_exchange.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/token_exchange.py index 32d6297d4b1b..1b0dde140479 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/token_exchange.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/token_exchange.py @@ -6,6 +6,7 @@ import json from typing import Any, List, Optional + # pylint: disable=non-abstract-transport-import # pylint: disable=no-name-in-module @@ -21,7 +22,7 @@ class TokenExchangeClient: """Represents a client that exchanges an Entra token for an Azure Communication Services (ACS) token. - + :param resource_endpoint: The endpoint URL of the resource to authenticate against. :param credential: The credential to use for token exchange. :param scopes: The scopes to request during the token exchange. @@ -31,11 +32,8 @@ class TokenExchangeClient: # pylint: disable=C4748 # pylint: disable=client-method-missing-type-annotations def __init__( - self, - resource_endpoint: str, - credential: TokenCredential, - scopes: Optional[List[str]] = None, - **kwargs: Any): + self, resource_endpoint: str, credential: TokenCredential, scopes: Optional[List[str]] = None, **kwargs: Any + ): self._resource_endpoint = resource_endpoint self._scopes = scopes or ["https://communication.azure.com/clients/.default"] @@ -76,6 +74,5 @@ def _parse_access_token_from_response(self, response: PipelineResponse) -> Acces raise ValueError("Failed to parse access token from response") from ex else: raise HttpResponseError( - message="Failed to exchange Entra token for ACS token", - response=response.http_response + message="Failed to exchange Entra token for ACS token", response=response.http_response ) diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/token_exchange_async.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/token_exchange_async.py index 0181b5982673..22dd4582460b 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/token_exchange_async.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/token_exchange_async.py @@ -6,6 +6,7 @@ import json from typing import Any, Optional, List + # pylint: disable=non-abstract-transport-import # pylint: disable=no-name-in-module @@ -35,7 +36,8 @@ def __init__( resource_endpoint: str, credential: AsyncTokenCredential, scopes: Optional[List[str]] = None, - **kwargs: Any): + **kwargs: Any + ): self._resource_endpoint = resource_endpoint self._scopes = scopes or ["https://communication.azure.com/clients/.default"] @@ -76,6 +78,5 @@ async def _parse_access_token_from_response(self, response: PipelineResponse) -> raise ValueError("Failed to parse access token from response") from ex else: raise HttpResponseError( - message="Failed to exchange Entra token for ACS token", - response=response.http_response + message="Failed to exchange Entra token for ACS token", response=response.http_response ) diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/token_utils.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/token_utils.py index dd40b08b2398..9628d3e76ec9 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/token_utils.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/token_utils.py @@ -8,7 +8,7 @@ import json from datetime import datetime, timezone from typing import Tuple, Any, List, Optional -import isodate # type: ignore +import isodate from azure.core.exceptions import HttpResponseError TEAMS_EXTENSION_SCOPE_PREFIX = "https://auth.msft.communication.azure.com/" @@ -21,6 +21,7 @@ def create_request_message(resource_endpoint: str, scopes: Optional[List[str]]) -> Any: from azure.core.pipeline.transport import HttpRequest + request_uri = create_request_uri(resource_endpoint, scopes) request = HttpRequest("POST", request_uri) request.headers["Accept"] = "application/json" @@ -59,26 +60,26 @@ def parse_expires_on(expires_on, response): return expires_on_epoch except Exception as exc: raise HttpResponseError( - message="Unknown format for expires_on field in access token response", - response=response.http_response) from exc + message="Unknown format for expires_on field in access token response", response=response.http_response + ) from exc else: raise HttpResponseError( - message="Missing expires_on field in access token response", - response=response.http_response) + message="Missing expires_on field in access token response", response=response.http_response + ) def is_entra_token_cache_valid(entra_token_cache, request): current_entra_token = request.http_request.headers.get("Authorization", "") - cache_valid = ( - entra_token_cache is not None and - current_entra_token == entra_token_cache - ) + cache_valid = entra_token_cache is not None and current_entra_token == entra_token_cache return cache_valid, current_entra_token def is_acs_token_cache_valid(response_cache): - if (response_cache is None or response_cache.http_response is None or - response_cache.http_response.status_code != 200): + if ( + response_cache is None + or response_cache.http_response is None + or response_cache.http_response.status_code != 200 + ): return False try: content = response_cache.http_response.text() @@ -86,6 +87,5 @@ def is_acs_token_cache_valid(response_cache): expires_on = data["accessToken"]["expiresOn"] expires_on_dt = isodate.parse_datetime(expires_on) return datetime.now(timezone.utc) < expires_on_dt - except (KeyError, ValueError, json.JSONDecodeError): - raise ValueError( # pylint: disable=W0707 - "Invalid token response") + except (KeyError, ValueError, json.JSONDecodeError) as e: + raise ValueError("Invalid token response") from e diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/user_credential.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/user_credential.py index b8b90ee06bc9..17adbf77dcc9 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/user_credential.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/user_credential.py @@ -46,7 +46,7 @@ def __init__( *, token_refresher: Optional[Callable[[], AccessToken]] = None, proactive_refresh: bool = False, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential. @@ -64,7 +64,7 @@ def __init__( resource_endpoint: str, token_credential: TokenCredential, scopes: Optional[list[str]] = None, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential using token exchange. @@ -91,15 +91,13 @@ def __init__(self, token: Optional[str] = None, **kwargs: Any): if token_credential is None: missing_fields.append("token_credential") raise ValueError( - "When using token exchange, resource_endpoint and token_credential must be provided. " - f"Missing: {', '.join(missing_fields)}") + "When using token exchange, resource_endpoint and token_credential must be provided. " + f"Missing: {', '.join(missing_fields)}" + ) self._token_exchange_client = None if resource_endpoint and token_credential: - self._token_exchange_client = TokenExchangeClient( - resource_endpoint, - token_credential, - scopes) + self._token_exchange_client = TokenExchangeClient(resource_endpoint, token_credential, scopes) self._token_refresher = self._token_exchange_client.exchange_entra_token self._proactive_refresh = False self._token = self._token_exchange_client.exchange_entra_token() diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/user_credential_async.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/user_credential_async.py index 5a5d85d1fb0d..81c4b79c4e6d 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/user_credential_async.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/user_credential_async.py @@ -50,7 +50,7 @@ def __init__( *, token_refresher: Optional[Callable[[], Awaitable[Any]]] = None, proactive_refresh: bool = False, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential. @@ -60,6 +60,7 @@ def __init__( :param proactive_refresh: Whether to refresh the token proactively. :param kwargs: Additional keyword arguments. """ + @overload def __init__( self, @@ -67,7 +68,7 @@ def __init__( resource_endpoint: str, token_credential: AsyncTokenCredential, scopes: Optional[list[str]] = None, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential using token exchange. @@ -95,14 +96,12 @@ def __init__(self, token: Optional[str] = None, **kwargs: Any): missing_fields.append("token_credential") raise ValueError( "When using token exchange, resource_endpoint and token_credential must be provided. " - f"Missing: {', '.join(missing_fields)}") + f"Missing: {', '.join(missing_fields)}" + ) self._token_exchange_client = None if resource_endpoint and token_credential: - self._token_exchange_client = TokenExchangeClient( - resource_endpoint, - token_credential, - scopes) + self._token_exchange_client = TokenExchangeClient(resource_endpoint, token_credential, scopes) self._token_refresher = self._token_exchange_client.exchange_entra_token self._proactive_refresh = False diff --git a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/utils_async.py b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/utils_async.py index 7402d088a880..b779d5c814b3 100644 --- a/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/utils_async.py +++ b/sdk/communication/azure-communication-identity/azure/communication/identity/_shared/utils_async.py @@ -6,6 +6,7 @@ # 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: :param int interval: time interval in seconds diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/auth_policy_utils.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/auth_policy_utils.py index d0c4713176c2..c176b112f9b1 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/auth_policy_utils.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/auth_policy_utils.py @@ -4,7 +4,7 @@ # license information. # ------------------------------------------------------------------------- -from typing import Union +from typing import Union, cast from azure.core.credentials import TokenCredential, AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.policies import ( @@ -28,11 +28,10 @@ def get_authentication_policy( :type credential: Union[TokenCredential, AsyncTokenCredential, AzureKeyCredential, str] :param bool decode_url: `True` if there is a need to decode the url. Default value is `False` :param bool is_async: For async clients there is a need to decode the url - - :return: Either AsyncBearerTokenCredentialPolicy or BearerTokenCredentialPolicy or HMACCredentialsPolicy + :return: The authentication policy to be used. :rtype: ~azure.core.pipeline.policies.AsyncBearerTokenCredentialPolicy or - ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or - ~azure.communication.jobrouter.shared.policy.HMACCredentialsPolicy + ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or + ~.HMACCredentialsPolicy """ if credential is None: @@ -40,9 +39,11 @@ def get_authentication_policy( if hasattr(credential, "get_token"): if is_async: return AsyncBearerTokenCredentialPolicy( - credential, "https://communication.azure.com//.default" # type: ignore + cast(AsyncTokenCredential, credential), "https://communication.azure.com//.default" ) - return BearerTokenCredentialPolicy(credential, "https://communication.azure.com//.default") # type: ignore + return BearerTokenCredentialPolicy( + cast(TokenCredential, credential), "https://communication.azure.com//.default" + ) if isinstance(credential, (AzureKeyCredential, str)): return HMACCredentialsPolicy(endpoint, credential, decode_url=decode_url) diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/models.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/models.py index 73d54070da7b..d71d8428504d 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/models.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/models.py @@ -157,14 +157,16 @@ def __init__(self, value: str, **kwargs: Any) -> None: is_anonymous: bool if raw_id is not None: - phone_number = raw_id[len(PHONE_NUMBER_PREFIX):] + phone_number = raw_id[len(PHONE_NUMBER_PREFIX) :] is_anonymous = phone_number == PHONE_NUMBER_ANONYMOUS_SUFFIX asserted_id_index = -1 if is_anonymous else phone_number.rfind("_") + 1 has_asserted_id = 0 < asserted_id_index < len(phone_number) - props = {"value": value, "is_anonymous": is_anonymous} if has_asserted_id: - props["asserted_id"] = phone_number[asserted_id_index:] - self.properties = PhoneNumberProperties(**props) # type: ignore + self.properties = PhoneNumberProperties( + value=value, is_anonymous=is_anonymous, asserted_id=phone_number[asserted_id_index:] + ) + else: + self.properties = PhoneNumberProperties(value=value, is_anonymous=is_anonymous) else: self.properties = PhoneNumberProperties(value=value) self.raw_id = raw_id if raw_id is not None else self._format_raw_id(self.properties) @@ -183,6 +185,7 @@ def _format_raw_id(self, properties: PhoneNumberProperties) -> str: value = properties["value"] return f"{PHONE_NUMBER_PREFIX}{value}" + class UnknownIdentifier: """Represents an identifier of an unknown type. @@ -242,7 +245,7 @@ def __init__(self, user_id: str, **kwargs: Any) -> None: :param str user_id: Microsoft Teams user id. :keyword bool is_anonymous: `True` if the identifier is anonymous. Default value is `False`. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.jobrouter.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -313,7 +316,7 @@ def __init__(self, app_id: str, **kwargs: Any) -> None: """ :param str app_id: Microsoft Teams application id. :keyword cloud: Cloud environment that the application belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.jobrouter.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -357,7 +360,7 @@ def __init__(self, bot_id, **kwargs): :keyword bool is_resource_account_configured: `False` if the identifier is global. Default value is `True` for tennantzed bots. :keyword cloud: Cloud environment that the bot belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.jobrouter.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` """ warnings.warn( "The MicrosoftBotIdentifier is deprecated and has been replaced by MicrosoftTeamsAppIdentifier.", @@ -389,20 +392,13 @@ class TeamsExtensionUserIdentifier: raw_id: str """The raw ID of the identifier.""" - def __init__( - self, - *, - user_id: str, - tenant_id: str, - resource_id: str, - **kwargs: Any - ) -> None: + def __init__(self, *, user_id: str, tenant_id: str, resource_id: str, **kwargs: Any) -> None: """ :param str user_id: Teams extension user id. :param str tenant_id: Tenant id associated with the user. :param str resource_id: The Communication Services resource id. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.jobrouter.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -434,6 +430,7 @@ def _format_raw_id(self, properties: TeamsExtensionUserProperties) -> str: prefix = ACS_USER_PREFIX return f"{prefix}{properties['resource_id']}_{properties['tenant_id']}_{properties['user_id']}" + def try_create_teams_extension_user(prefix: str, suffix: str) -> Optional[TeamsExtensionUserIdentifier]: segments = suffix.split("_") if len(segments) != 3: @@ -449,6 +446,7 @@ def try_create_teams_extension_user(prefix: str, suffix: str) -> Optional[TeamsE raise ValueError("Invalid MRI") return TeamsExtensionUserIdentifier(user_id=user_id, tenant_id=tenant_id, resource_id=resource_id, cloud=cloud) + def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: disable=too-many-return-statements """ Creates a CommunicationIdentifier from a given raw ID. @@ -457,7 +455,7 @@ def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: d :param str raw_id: A raw ID to construct the CommunicationIdentifier from. :return: The CommunicationIdentifier parsed from the raw_id. - :rtype: CommunicationIdentifier + :rtype: :class:`~.CommunicationIdentifier` """ if raw_id.startswith(PHONE_NUMBER_PREFIX): return PhoneNumberIdentifier(value=raw_id[len(PHONE_NUMBER_PREFIX) :], raw_id=raw_id) diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/policy.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/policy.py index 1843d22e83a2..6eae18574193 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/policy.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/policy.py @@ -5,13 +5,15 @@ # ------------------------------------------------------------------------- import hashlib -import urllib import base64 import hmac -from urllib.parse import ParseResult, urlparse +from urllib.parse import urlparse, unquote from typing import Union + from azure.core.credentials import AzureKeyCredential from azure.core.pipeline.policies import SansIOHTTPPolicy +from azure.core.pipeline import PipelineRequest + from .utils import get_current_utc_time @@ -41,9 +43,7 @@ def __init__( self._access_key = access_key self._decode_url = decode_url - def _compute_hmac( - self, value # type: str - ): + def _compute_hmac(self, value: str) -> str: if isinstance(self._access_key, AzureKeyCredential): decoded_secret = base64.b64decode(self._access_key.key) else: @@ -53,11 +53,11 @@ def _compute_hmac( return base64.b64encode(digest).decode("utf-8") - def _sign_request(self, request): + def _sign_request(self, request: PipelineRequest) -> None: verb = request.http_request.method.upper() # Get the path and query from url, which looks like https://host/path/query - parsed_url: ParseResult = urlparse(request.http_request.url) + parsed_url = urlparse(request.http_request.url) query_url = parsed_url.path if parsed_url.query: @@ -91,7 +91,7 @@ def _sign_request(self, request): pass if self._decode_url: - query_url = urllib.parse.unquote(query_url) + query_url = unquote(query_url) signed_headers = "x-ms-date;host;x-ms-content-sha256" @@ -114,7 +114,5 @@ def _sign_request(self, request): request.http_request.headers.update(signature_header) - return request - - def on_request(self, request): + def on_request(self, request: PipelineRequest) -> None: self._sign_request(request) diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/token_exchange.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/token_exchange.py index 32d6297d4b1b..1b0dde140479 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/token_exchange.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/token_exchange.py @@ -6,6 +6,7 @@ import json from typing import Any, List, Optional + # pylint: disable=non-abstract-transport-import # pylint: disable=no-name-in-module @@ -21,7 +22,7 @@ class TokenExchangeClient: """Represents a client that exchanges an Entra token for an Azure Communication Services (ACS) token. - + :param resource_endpoint: The endpoint URL of the resource to authenticate against. :param credential: The credential to use for token exchange. :param scopes: The scopes to request during the token exchange. @@ -31,11 +32,8 @@ class TokenExchangeClient: # pylint: disable=C4748 # pylint: disable=client-method-missing-type-annotations def __init__( - self, - resource_endpoint: str, - credential: TokenCredential, - scopes: Optional[List[str]] = None, - **kwargs: Any): + self, resource_endpoint: str, credential: TokenCredential, scopes: Optional[List[str]] = None, **kwargs: Any + ): self._resource_endpoint = resource_endpoint self._scopes = scopes or ["https://communication.azure.com/clients/.default"] @@ -76,6 +74,5 @@ def _parse_access_token_from_response(self, response: PipelineResponse) -> Acces raise ValueError("Failed to parse access token from response") from ex else: raise HttpResponseError( - message="Failed to exchange Entra token for ACS token", - response=response.http_response + message="Failed to exchange Entra token for ACS token", response=response.http_response ) diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/token_exchange_async.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/token_exchange_async.py index 0181b5982673..22dd4582460b 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/token_exchange_async.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/token_exchange_async.py @@ -6,6 +6,7 @@ import json from typing import Any, Optional, List + # pylint: disable=non-abstract-transport-import # pylint: disable=no-name-in-module @@ -35,7 +36,8 @@ def __init__( resource_endpoint: str, credential: AsyncTokenCredential, scopes: Optional[List[str]] = None, - **kwargs: Any): + **kwargs: Any + ): self._resource_endpoint = resource_endpoint self._scopes = scopes or ["https://communication.azure.com/clients/.default"] @@ -76,6 +78,5 @@ async def _parse_access_token_from_response(self, response: PipelineResponse) -> raise ValueError("Failed to parse access token from response") from ex else: raise HttpResponseError( - message="Failed to exchange Entra token for ACS token", - response=response.http_response + message="Failed to exchange Entra token for ACS token", response=response.http_response ) diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/token_utils.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/token_utils.py index f4115a001029..9628d3e76ec9 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/token_utils.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/token_utils.py @@ -21,6 +21,7 @@ def create_request_message(resource_endpoint: str, scopes: Optional[List[str]]) -> Any: from azure.core.pipeline.transport import HttpRequest + request_uri = create_request_uri(resource_endpoint, scopes) request = HttpRequest("POST", request_uri) request.headers["Accept"] = "application/json" @@ -59,26 +60,26 @@ def parse_expires_on(expires_on, response): return expires_on_epoch except Exception as exc: raise HttpResponseError( - message="Unknown format for expires_on field in access token response", - response=response.http_response) from exc + message="Unknown format for expires_on field in access token response", response=response.http_response + ) from exc else: raise HttpResponseError( - message="Missing expires_on field in access token response", - response=response.http_response) + message="Missing expires_on field in access token response", response=response.http_response + ) def is_entra_token_cache_valid(entra_token_cache, request): current_entra_token = request.http_request.headers.get("Authorization", "") - cache_valid = ( - entra_token_cache is not None and - current_entra_token == entra_token_cache - ) + cache_valid = entra_token_cache is not None and current_entra_token == entra_token_cache return cache_valid, current_entra_token def is_acs_token_cache_valid(response_cache): - if (response_cache is None or response_cache.http_response is None or - response_cache.http_response.status_code != 200): + if ( + response_cache is None + or response_cache.http_response is None + or response_cache.http_response.status_code != 200 + ): return False try: content = response_cache.http_response.text() @@ -86,6 +87,5 @@ def is_acs_token_cache_valid(response_cache): expires_on = data["accessToken"]["expiresOn"] expires_on_dt = isodate.parse_datetime(expires_on) return datetime.now(timezone.utc) < expires_on_dt - except (KeyError, ValueError, json.JSONDecodeError): - raise ValueError( # pylint: disable=W0707 - "Invalid token response") + except (KeyError, ValueError, json.JSONDecodeError) as e: + raise ValueError("Invalid token response") from e diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/user_credential.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/user_credential.py index b8b90ee06bc9..17adbf77dcc9 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/user_credential.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/user_credential.py @@ -46,7 +46,7 @@ def __init__( *, token_refresher: Optional[Callable[[], AccessToken]] = None, proactive_refresh: bool = False, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential. @@ -64,7 +64,7 @@ def __init__( resource_endpoint: str, token_credential: TokenCredential, scopes: Optional[list[str]] = None, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential using token exchange. @@ -91,15 +91,13 @@ def __init__(self, token: Optional[str] = None, **kwargs: Any): if token_credential is None: missing_fields.append("token_credential") raise ValueError( - "When using token exchange, resource_endpoint and token_credential must be provided. " - f"Missing: {', '.join(missing_fields)}") + "When using token exchange, resource_endpoint and token_credential must be provided. " + f"Missing: {', '.join(missing_fields)}" + ) self._token_exchange_client = None if resource_endpoint and token_credential: - self._token_exchange_client = TokenExchangeClient( - resource_endpoint, - token_credential, - scopes) + self._token_exchange_client = TokenExchangeClient(resource_endpoint, token_credential, scopes) self._token_refresher = self._token_exchange_client.exchange_entra_token self._proactive_refresh = False self._token = self._token_exchange_client.exchange_entra_token() diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/user_credential_async.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/user_credential_async.py index 5a5d85d1fb0d..81c4b79c4e6d 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/user_credential_async.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/user_credential_async.py @@ -50,7 +50,7 @@ def __init__( *, token_refresher: Optional[Callable[[], Awaitable[Any]]] = None, proactive_refresh: bool = False, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential. @@ -60,6 +60,7 @@ def __init__( :param proactive_refresh: Whether to refresh the token proactively. :param kwargs: Additional keyword arguments. """ + @overload def __init__( self, @@ -67,7 +68,7 @@ def __init__( resource_endpoint: str, token_credential: AsyncTokenCredential, scopes: Optional[list[str]] = None, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential using token exchange. @@ -95,14 +96,12 @@ def __init__(self, token: Optional[str] = None, **kwargs: Any): missing_fields.append("token_credential") raise ValueError( "When using token exchange, resource_endpoint and token_credential must be provided. " - f"Missing: {', '.join(missing_fields)}") + f"Missing: {', '.join(missing_fields)}" + ) self._token_exchange_client = None if resource_endpoint and token_credential: - self._token_exchange_client = TokenExchangeClient( - resource_endpoint, - token_credential, - scopes) + self._token_exchange_client = TokenExchangeClient(resource_endpoint, token_credential, scopes) self._token_refresher = self._token_exchange_client.exchange_entra_token self._proactive_refresh = False diff --git a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/utils_async.py b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/utils_async.py index 7402d088a880..b779d5c814b3 100644 --- a/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/utils_async.py +++ b/sdk/communication/azure-communication-jobrouter/azure/communication/jobrouter/_shared/utils_async.py @@ -6,6 +6,7 @@ # 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: :param int interval: time interval in seconds diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/auth_policy_utils.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/auth_policy_utils.py index e0bdebfcc294..c176b112f9b1 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/auth_policy_utils.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/auth_policy_utils.py @@ -4,7 +4,7 @@ # license information. # ------------------------------------------------------------------------- -from typing import Union +from typing import Union, cast from azure.core.credentials import TokenCredential, AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.policies import ( @@ -28,11 +28,10 @@ def get_authentication_policy( :type credential: Union[TokenCredential, AsyncTokenCredential, AzureKeyCredential, str] :param bool decode_url: `True` if there is a need to decode the url. Default value is `False` :param bool is_async: For async clients there is a need to decode the url - - :return: Either AsyncBearerTokenCredentialPolicy or BearerTokenCredentialPolicy or HMACCredentialsPolicy + :return: The authentication policy to be used. :rtype: ~azure.core.pipeline.policies.AsyncBearerTokenCredentialPolicy or - ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or - ~azure.communication.messages.shared.policy.HMACCredentialsPolicy + ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or + ~.HMACCredentialsPolicy """ if credential is None: @@ -40,9 +39,11 @@ def get_authentication_policy( if hasattr(credential, "get_token"): if is_async: return AsyncBearerTokenCredentialPolicy( - credential, "https://communication.azure.com//.default" # type: ignore + cast(AsyncTokenCredential, credential), "https://communication.azure.com//.default" ) - return BearerTokenCredentialPolicy(credential, "https://communication.azure.com//.default") # type: ignore + return BearerTokenCredentialPolicy( + cast(TokenCredential, credential), "https://communication.azure.com//.default" + ) if isinstance(credential, (AzureKeyCredential, str)): return HMACCredentialsPolicy(endpoint, credential, decode_url=decode_url) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/models.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/models.py index 45c0c4ee9029..d71d8428504d 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/models.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/models.py @@ -157,14 +157,16 @@ def __init__(self, value: str, **kwargs: Any) -> None: is_anonymous: bool if raw_id is not None: - phone_number = raw_id[len(PHONE_NUMBER_PREFIX):] + phone_number = raw_id[len(PHONE_NUMBER_PREFIX) :] is_anonymous = phone_number == PHONE_NUMBER_ANONYMOUS_SUFFIX asserted_id_index = -1 if is_anonymous else phone_number.rfind("_") + 1 has_asserted_id = 0 < asserted_id_index < len(phone_number) - props = {"value": value, "is_anonymous": is_anonymous} if has_asserted_id: - props["asserted_id"] = phone_number[asserted_id_index:] - self.properties = PhoneNumberProperties(**props) # type: ignore + self.properties = PhoneNumberProperties( + value=value, is_anonymous=is_anonymous, asserted_id=phone_number[asserted_id_index:] + ) + else: + self.properties = PhoneNumberProperties(value=value, is_anonymous=is_anonymous) else: self.properties = PhoneNumberProperties(value=value) self.raw_id = raw_id if raw_id is not None else self._format_raw_id(self.properties) @@ -183,6 +185,7 @@ def _format_raw_id(self, properties: PhoneNumberProperties) -> str: value = properties["value"] return f"{PHONE_NUMBER_PREFIX}{value}" + class UnknownIdentifier: """Represents an identifier of an unknown type. @@ -242,7 +245,7 @@ def __init__(self, user_id: str, **kwargs: Any) -> None: :param str user_id: Microsoft Teams user id. :keyword bool is_anonymous: `True` if the identifier is anonymous. Default value is `False`. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.messages.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -313,7 +316,7 @@ def __init__(self, app_id: str, **kwargs: Any) -> None: """ :param str app_id: Microsoft Teams application id. :keyword cloud: Cloud environment that the application belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.messages.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -357,7 +360,7 @@ def __init__(self, bot_id, **kwargs): :keyword bool is_resource_account_configured: `False` if the identifier is global. Default value is `True` for tennantzed bots. :keyword cloud: Cloud environment that the bot belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.messages.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` """ warnings.warn( "The MicrosoftBotIdentifier is deprecated and has been replaced by MicrosoftTeamsAppIdentifier.", @@ -389,20 +392,13 @@ class TeamsExtensionUserIdentifier: raw_id: str """The raw ID of the identifier.""" - def __init__( - self, - *, - user_id: str, - tenant_id: str, - resource_id: str, - **kwargs: Any - ) -> None: + def __init__(self, *, user_id: str, tenant_id: str, resource_id: str, **kwargs: Any) -> None: """ :param str user_id: Teams extension user id. :param str tenant_id: Tenant id associated with the user. :param str resource_id: The Communication Services resource id. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.messages.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -434,6 +430,7 @@ def _format_raw_id(self, properties: TeamsExtensionUserProperties) -> str: prefix = ACS_USER_PREFIX return f"{prefix}{properties['resource_id']}_{properties['tenant_id']}_{properties['user_id']}" + def try_create_teams_extension_user(prefix: str, suffix: str) -> Optional[TeamsExtensionUserIdentifier]: segments = suffix.split("_") if len(segments) != 3: @@ -449,6 +446,7 @@ def try_create_teams_extension_user(prefix: str, suffix: str) -> Optional[TeamsE raise ValueError("Invalid MRI") return TeamsExtensionUserIdentifier(user_id=user_id, tenant_id=tenant_id, resource_id=resource_id, cloud=cloud) + def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: disable=too-many-return-statements """ Creates a CommunicationIdentifier from a given raw ID. @@ -457,7 +455,7 @@ def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: d :param str raw_id: A raw ID to construct the CommunicationIdentifier from. :return: The CommunicationIdentifier parsed from the raw_id. - :rtype: CommunicationIdentifier + :rtype: :class:`~.CommunicationIdentifier` """ if raw_id.startswith(PHONE_NUMBER_PREFIX): return PhoneNumberIdentifier(value=raw_id[len(PHONE_NUMBER_PREFIX) :], raw_id=raw_id) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/policy.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/policy.py index 1843d22e83a2..6eae18574193 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/policy.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/policy.py @@ -5,13 +5,15 @@ # ------------------------------------------------------------------------- import hashlib -import urllib import base64 import hmac -from urllib.parse import ParseResult, urlparse +from urllib.parse import urlparse, unquote from typing import Union + from azure.core.credentials import AzureKeyCredential from azure.core.pipeline.policies import SansIOHTTPPolicy +from azure.core.pipeline import PipelineRequest + from .utils import get_current_utc_time @@ -41,9 +43,7 @@ def __init__( self._access_key = access_key self._decode_url = decode_url - def _compute_hmac( - self, value # type: str - ): + def _compute_hmac(self, value: str) -> str: if isinstance(self._access_key, AzureKeyCredential): decoded_secret = base64.b64decode(self._access_key.key) else: @@ -53,11 +53,11 @@ def _compute_hmac( return base64.b64encode(digest).decode("utf-8") - def _sign_request(self, request): + def _sign_request(self, request: PipelineRequest) -> None: verb = request.http_request.method.upper() # Get the path and query from url, which looks like https://host/path/query - parsed_url: ParseResult = urlparse(request.http_request.url) + parsed_url = urlparse(request.http_request.url) query_url = parsed_url.path if parsed_url.query: @@ -91,7 +91,7 @@ def _sign_request(self, request): pass if self._decode_url: - query_url = urllib.parse.unquote(query_url) + query_url = unquote(query_url) signed_headers = "x-ms-date;host;x-ms-content-sha256" @@ -114,7 +114,5 @@ def _sign_request(self, request): request.http_request.headers.update(signature_header) - return request - - def on_request(self, request): + def on_request(self, request: PipelineRequest) -> None: self._sign_request(request) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/token_exchange.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/token_exchange.py index 32d6297d4b1b..1b0dde140479 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/token_exchange.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/token_exchange.py @@ -6,6 +6,7 @@ import json from typing import Any, List, Optional + # pylint: disable=non-abstract-transport-import # pylint: disable=no-name-in-module @@ -21,7 +22,7 @@ class TokenExchangeClient: """Represents a client that exchanges an Entra token for an Azure Communication Services (ACS) token. - + :param resource_endpoint: The endpoint URL of the resource to authenticate against. :param credential: The credential to use for token exchange. :param scopes: The scopes to request during the token exchange. @@ -31,11 +32,8 @@ class TokenExchangeClient: # pylint: disable=C4748 # pylint: disable=client-method-missing-type-annotations def __init__( - self, - resource_endpoint: str, - credential: TokenCredential, - scopes: Optional[List[str]] = None, - **kwargs: Any): + self, resource_endpoint: str, credential: TokenCredential, scopes: Optional[List[str]] = None, **kwargs: Any + ): self._resource_endpoint = resource_endpoint self._scopes = scopes or ["https://communication.azure.com/clients/.default"] @@ -76,6 +74,5 @@ def _parse_access_token_from_response(self, response: PipelineResponse) -> Acces raise ValueError("Failed to parse access token from response") from ex else: raise HttpResponseError( - message="Failed to exchange Entra token for ACS token", - response=response.http_response + message="Failed to exchange Entra token for ACS token", response=response.http_response ) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/token_exchange_async.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/token_exchange_async.py index 0181b5982673..22dd4582460b 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/token_exchange_async.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/token_exchange_async.py @@ -6,6 +6,7 @@ import json from typing import Any, Optional, List + # pylint: disable=non-abstract-transport-import # pylint: disable=no-name-in-module @@ -35,7 +36,8 @@ def __init__( resource_endpoint: str, credential: AsyncTokenCredential, scopes: Optional[List[str]] = None, - **kwargs: Any): + **kwargs: Any + ): self._resource_endpoint = resource_endpoint self._scopes = scopes or ["https://communication.azure.com/clients/.default"] @@ -76,6 +78,5 @@ async def _parse_access_token_from_response(self, response: PipelineResponse) -> raise ValueError("Failed to parse access token from response") from ex else: raise HttpResponseError( - message="Failed to exchange Entra token for ACS token", - response=response.http_response + message="Failed to exchange Entra token for ACS token", response=response.http_response ) diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/token_utils.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/token_utils.py index f4115a001029..9628d3e76ec9 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/token_utils.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/token_utils.py @@ -21,6 +21,7 @@ def create_request_message(resource_endpoint: str, scopes: Optional[List[str]]) -> Any: from azure.core.pipeline.transport import HttpRequest + request_uri = create_request_uri(resource_endpoint, scopes) request = HttpRequest("POST", request_uri) request.headers["Accept"] = "application/json" @@ -59,26 +60,26 @@ def parse_expires_on(expires_on, response): return expires_on_epoch except Exception as exc: raise HttpResponseError( - message="Unknown format for expires_on field in access token response", - response=response.http_response) from exc + message="Unknown format for expires_on field in access token response", response=response.http_response + ) from exc else: raise HttpResponseError( - message="Missing expires_on field in access token response", - response=response.http_response) + message="Missing expires_on field in access token response", response=response.http_response + ) def is_entra_token_cache_valid(entra_token_cache, request): current_entra_token = request.http_request.headers.get("Authorization", "") - cache_valid = ( - entra_token_cache is not None and - current_entra_token == entra_token_cache - ) + cache_valid = entra_token_cache is not None and current_entra_token == entra_token_cache return cache_valid, current_entra_token def is_acs_token_cache_valid(response_cache): - if (response_cache is None or response_cache.http_response is None or - response_cache.http_response.status_code != 200): + if ( + response_cache is None + or response_cache.http_response is None + or response_cache.http_response.status_code != 200 + ): return False try: content = response_cache.http_response.text() @@ -86,6 +87,5 @@ def is_acs_token_cache_valid(response_cache): expires_on = data["accessToken"]["expiresOn"] expires_on_dt = isodate.parse_datetime(expires_on) return datetime.now(timezone.utc) < expires_on_dt - except (KeyError, ValueError, json.JSONDecodeError): - raise ValueError( # pylint: disable=W0707 - "Invalid token response") + except (KeyError, ValueError, json.JSONDecodeError) as e: + raise ValueError("Invalid token response") from e diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential.py index b8b90ee06bc9..17adbf77dcc9 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential.py @@ -46,7 +46,7 @@ def __init__( *, token_refresher: Optional[Callable[[], AccessToken]] = None, proactive_refresh: bool = False, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential. @@ -64,7 +64,7 @@ def __init__( resource_endpoint: str, token_credential: TokenCredential, scopes: Optional[list[str]] = None, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential using token exchange. @@ -91,15 +91,13 @@ def __init__(self, token: Optional[str] = None, **kwargs: Any): if token_credential is None: missing_fields.append("token_credential") raise ValueError( - "When using token exchange, resource_endpoint and token_credential must be provided. " - f"Missing: {', '.join(missing_fields)}") + "When using token exchange, resource_endpoint and token_credential must be provided. " + f"Missing: {', '.join(missing_fields)}" + ) self._token_exchange_client = None if resource_endpoint and token_credential: - self._token_exchange_client = TokenExchangeClient( - resource_endpoint, - token_credential, - scopes) + self._token_exchange_client = TokenExchangeClient(resource_endpoint, token_credential, scopes) self._token_refresher = self._token_exchange_client.exchange_entra_token self._proactive_refresh = False self._token = self._token_exchange_client.exchange_entra_token() diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential_async.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential_async.py index 5a5d85d1fb0d..81c4b79c4e6d 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential_async.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/user_credential_async.py @@ -50,7 +50,7 @@ def __init__( *, token_refresher: Optional[Callable[[], Awaitable[Any]]] = None, proactive_refresh: bool = False, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential. @@ -60,6 +60,7 @@ def __init__( :param proactive_refresh: Whether to refresh the token proactively. :param kwargs: Additional keyword arguments. """ + @overload def __init__( self, @@ -67,7 +68,7 @@ def __init__( resource_endpoint: str, token_credential: AsyncTokenCredential, scopes: Optional[list[str]] = None, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential using token exchange. @@ -95,14 +96,12 @@ def __init__(self, token: Optional[str] = None, **kwargs: Any): missing_fields.append("token_credential") raise ValueError( "When using token exchange, resource_endpoint and token_credential must be provided. " - f"Missing: {', '.join(missing_fields)}") + f"Missing: {', '.join(missing_fields)}" + ) self._token_exchange_client = None if resource_endpoint and token_credential: - self._token_exchange_client = TokenExchangeClient( - resource_endpoint, - token_credential, - scopes) + self._token_exchange_client = TokenExchangeClient(resource_endpoint, token_credential, scopes) self._token_refresher = self._token_exchange_client.exchange_entra_token self._proactive_refresh = False diff --git a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/utils_async.py b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/utils_async.py index 7402d088a880..b779d5c814b3 100644 --- a/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/utils_async.py +++ b/sdk/communication/azure-communication-messages/azure/communication/messages/_shared/utils_async.py @@ -6,6 +6,7 @@ # 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: :param int interval: time interval in seconds diff --git a/sdk/communication/azure-communication-messages/mypy.ini b/sdk/communication/azure-communication-messages/mypy.ini new file mode 100644 index 000000000000..78e98f92ce62 --- /dev/null +++ b/sdk/communication/azure-communication-messages/mypy.ini @@ -0,0 +1,4 @@ +[mypy] +ignore_missing_imports = True +check_untyped_defs = False +disallow_untyped_defs = False \ No newline at end of file diff --git a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/auth_policy_utils.py b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/auth_policy_utils.py index da996f728695..c176b112f9b1 100644 --- a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/auth_policy_utils.py +++ b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/auth_policy_utils.py @@ -4,7 +4,7 @@ # license information. # ------------------------------------------------------------------------- -from typing import Union +from typing import Union, cast from azure.core.credentials import TokenCredential, AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.policies import ( @@ -28,11 +28,10 @@ def get_authentication_policy( :type credential: Union[TokenCredential, AsyncTokenCredential, AzureKeyCredential, str] :param bool decode_url: `True` if there is a need to decode the url. Default value is `False` :param bool is_async: For async clients there is a need to decode the url - - :return: Either AsyncBearerTokenCredentialPolicy or BearerTokenCredentialPolicy or HMACCredentialsPolicy + :return: The authentication policy to be used. :rtype: ~azure.core.pipeline.policies.AsyncBearerTokenCredentialPolicy or - ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or - ~azure.communication.phonenumbers.shared.policy.HMACCredentialsPolicy + ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or + ~.HMACCredentialsPolicy """ if credential is None: @@ -40,9 +39,11 @@ def get_authentication_policy( if hasattr(credential, "get_token"): if is_async: return AsyncBearerTokenCredentialPolicy( - credential, "https://communication.azure.com//.default" # type: ignore + cast(AsyncTokenCredential, credential), "https://communication.azure.com//.default" ) - return BearerTokenCredentialPolicy(credential, "https://communication.azure.com//.default") # type: ignore + return BearerTokenCredentialPolicy( + cast(TokenCredential, credential), "https://communication.azure.com//.default" + ) if isinstance(credential, (AzureKeyCredential, str)): return HMACCredentialsPolicy(endpoint, credential, decode_url=decode_url) diff --git a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/models.py b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/models.py index 37da0f80dd61..d71d8428504d 100644 --- a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/models.py +++ b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/models.py @@ -157,14 +157,16 @@ def __init__(self, value: str, **kwargs: Any) -> None: is_anonymous: bool if raw_id is not None: - phone_number = raw_id[len(PHONE_NUMBER_PREFIX):] + phone_number = raw_id[len(PHONE_NUMBER_PREFIX) :] is_anonymous = phone_number == PHONE_NUMBER_ANONYMOUS_SUFFIX asserted_id_index = -1 if is_anonymous else phone_number.rfind("_") + 1 has_asserted_id = 0 < asserted_id_index < len(phone_number) - props = {"value": value, "is_anonymous": is_anonymous} if has_asserted_id: - props["asserted_id"] = phone_number[asserted_id_index:] - self.properties = PhoneNumberProperties(**props) # type: ignore + self.properties = PhoneNumberProperties( + value=value, is_anonymous=is_anonymous, asserted_id=phone_number[asserted_id_index:] + ) + else: + self.properties = PhoneNumberProperties(value=value, is_anonymous=is_anonymous) else: self.properties = PhoneNumberProperties(value=value) self.raw_id = raw_id if raw_id is not None else self._format_raw_id(self.properties) @@ -183,6 +185,7 @@ def _format_raw_id(self, properties: PhoneNumberProperties) -> str: value = properties["value"] return f"{PHONE_NUMBER_PREFIX}{value}" + class UnknownIdentifier: """Represents an identifier of an unknown type. @@ -242,7 +245,7 @@ def __init__(self, user_id: str, **kwargs: Any) -> None: :param str user_id: Microsoft Teams user id. :keyword bool is_anonymous: `True` if the identifier is anonymous. Default value is `False`. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.phonenumbers.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -313,7 +316,7 @@ def __init__(self, app_id: str, **kwargs: Any) -> None: """ :param str app_id: Microsoft Teams application id. :keyword cloud: Cloud environment that the application belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.phonenumbers.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -357,7 +360,7 @@ def __init__(self, bot_id, **kwargs): :keyword bool is_resource_account_configured: `False` if the identifier is global. Default value is `True` for tennantzed bots. :keyword cloud: Cloud environment that the bot belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.phonenumbers.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` """ warnings.warn( "The MicrosoftBotIdentifier is deprecated and has been replaced by MicrosoftTeamsAppIdentifier.", @@ -389,20 +392,13 @@ class TeamsExtensionUserIdentifier: raw_id: str """The raw ID of the identifier.""" - def __init__( - self, - *, - user_id: str, - tenant_id: str, - resource_id: str, - **kwargs: Any - ) -> None: + def __init__(self, *, user_id: str, tenant_id: str, resource_id: str, **kwargs: Any) -> None: """ :param str user_id: Teams extension user id. :param str tenant_id: Tenant id associated with the user. :param str resource_id: The Communication Services resource id. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.phonenumbers.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -434,6 +430,7 @@ def _format_raw_id(self, properties: TeamsExtensionUserProperties) -> str: prefix = ACS_USER_PREFIX return f"{prefix}{properties['resource_id']}_{properties['tenant_id']}_{properties['user_id']}" + def try_create_teams_extension_user(prefix: str, suffix: str) -> Optional[TeamsExtensionUserIdentifier]: segments = suffix.split("_") if len(segments) != 3: @@ -449,6 +446,7 @@ def try_create_teams_extension_user(prefix: str, suffix: str) -> Optional[TeamsE raise ValueError("Invalid MRI") return TeamsExtensionUserIdentifier(user_id=user_id, tenant_id=tenant_id, resource_id=resource_id, cloud=cloud) + def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: disable=too-many-return-statements """ Creates a CommunicationIdentifier from a given raw ID. @@ -457,7 +455,7 @@ def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: d :param str raw_id: A raw ID to construct the CommunicationIdentifier from. :return: The CommunicationIdentifier parsed from the raw_id. - :rtype: CommunicationIdentifier + :rtype: :class:`~.CommunicationIdentifier` """ if raw_id.startswith(PHONE_NUMBER_PREFIX): return PhoneNumberIdentifier(value=raw_id[len(PHONE_NUMBER_PREFIX) :], raw_id=raw_id) diff --git a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/policy.py b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/policy.py index 1843d22e83a2..6eae18574193 100644 --- a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/policy.py +++ b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/policy.py @@ -5,13 +5,15 @@ # ------------------------------------------------------------------------- import hashlib -import urllib import base64 import hmac -from urllib.parse import ParseResult, urlparse +from urllib.parse import urlparse, unquote from typing import Union + from azure.core.credentials import AzureKeyCredential from azure.core.pipeline.policies import SansIOHTTPPolicy +from azure.core.pipeline import PipelineRequest + from .utils import get_current_utc_time @@ -41,9 +43,7 @@ def __init__( self._access_key = access_key self._decode_url = decode_url - def _compute_hmac( - self, value # type: str - ): + def _compute_hmac(self, value: str) -> str: if isinstance(self._access_key, AzureKeyCredential): decoded_secret = base64.b64decode(self._access_key.key) else: @@ -53,11 +53,11 @@ def _compute_hmac( return base64.b64encode(digest).decode("utf-8") - def _sign_request(self, request): + def _sign_request(self, request: PipelineRequest) -> None: verb = request.http_request.method.upper() # Get the path and query from url, which looks like https://host/path/query - parsed_url: ParseResult = urlparse(request.http_request.url) + parsed_url = urlparse(request.http_request.url) query_url = parsed_url.path if parsed_url.query: @@ -91,7 +91,7 @@ def _sign_request(self, request): pass if self._decode_url: - query_url = urllib.parse.unquote(query_url) + query_url = unquote(query_url) signed_headers = "x-ms-date;host;x-ms-content-sha256" @@ -114,7 +114,5 @@ def _sign_request(self, request): request.http_request.headers.update(signature_header) - return request - - def on_request(self, request): + def on_request(self, request: PipelineRequest) -> None: self._sign_request(request) diff --git a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/token_exchange.py b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/token_exchange.py index 32d6297d4b1b..1b0dde140479 100644 --- a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/token_exchange.py +++ b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/token_exchange.py @@ -6,6 +6,7 @@ import json from typing import Any, List, Optional + # pylint: disable=non-abstract-transport-import # pylint: disable=no-name-in-module @@ -21,7 +22,7 @@ class TokenExchangeClient: """Represents a client that exchanges an Entra token for an Azure Communication Services (ACS) token. - + :param resource_endpoint: The endpoint URL of the resource to authenticate against. :param credential: The credential to use for token exchange. :param scopes: The scopes to request during the token exchange. @@ -31,11 +32,8 @@ class TokenExchangeClient: # pylint: disable=C4748 # pylint: disable=client-method-missing-type-annotations def __init__( - self, - resource_endpoint: str, - credential: TokenCredential, - scopes: Optional[List[str]] = None, - **kwargs: Any): + self, resource_endpoint: str, credential: TokenCredential, scopes: Optional[List[str]] = None, **kwargs: Any + ): self._resource_endpoint = resource_endpoint self._scopes = scopes or ["https://communication.azure.com/clients/.default"] @@ -76,6 +74,5 @@ def _parse_access_token_from_response(self, response: PipelineResponse) -> Acces raise ValueError("Failed to parse access token from response") from ex else: raise HttpResponseError( - message="Failed to exchange Entra token for ACS token", - response=response.http_response + message="Failed to exchange Entra token for ACS token", response=response.http_response ) diff --git a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/token_exchange_async.py b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/token_exchange_async.py index 0181b5982673..22dd4582460b 100644 --- a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/token_exchange_async.py +++ b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/token_exchange_async.py @@ -6,6 +6,7 @@ import json from typing import Any, Optional, List + # pylint: disable=non-abstract-transport-import # pylint: disable=no-name-in-module @@ -35,7 +36,8 @@ def __init__( resource_endpoint: str, credential: AsyncTokenCredential, scopes: Optional[List[str]] = None, - **kwargs: Any): + **kwargs: Any + ): self._resource_endpoint = resource_endpoint self._scopes = scopes or ["https://communication.azure.com/clients/.default"] @@ -76,6 +78,5 @@ async def _parse_access_token_from_response(self, response: PipelineResponse) -> raise ValueError("Failed to parse access token from response") from ex else: raise HttpResponseError( - message="Failed to exchange Entra token for ACS token", - response=response.http_response + message="Failed to exchange Entra token for ACS token", response=response.http_response ) diff --git a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/token_utils.py b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/token_utils.py index f4115a001029..9628d3e76ec9 100644 --- a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/token_utils.py +++ b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/token_utils.py @@ -21,6 +21,7 @@ def create_request_message(resource_endpoint: str, scopes: Optional[List[str]]) -> Any: from azure.core.pipeline.transport import HttpRequest + request_uri = create_request_uri(resource_endpoint, scopes) request = HttpRequest("POST", request_uri) request.headers["Accept"] = "application/json" @@ -59,26 +60,26 @@ def parse_expires_on(expires_on, response): return expires_on_epoch except Exception as exc: raise HttpResponseError( - message="Unknown format for expires_on field in access token response", - response=response.http_response) from exc + message="Unknown format for expires_on field in access token response", response=response.http_response + ) from exc else: raise HttpResponseError( - message="Missing expires_on field in access token response", - response=response.http_response) + message="Missing expires_on field in access token response", response=response.http_response + ) def is_entra_token_cache_valid(entra_token_cache, request): current_entra_token = request.http_request.headers.get("Authorization", "") - cache_valid = ( - entra_token_cache is not None and - current_entra_token == entra_token_cache - ) + cache_valid = entra_token_cache is not None and current_entra_token == entra_token_cache return cache_valid, current_entra_token def is_acs_token_cache_valid(response_cache): - if (response_cache is None or response_cache.http_response is None or - response_cache.http_response.status_code != 200): + if ( + response_cache is None + or response_cache.http_response is None + or response_cache.http_response.status_code != 200 + ): return False try: content = response_cache.http_response.text() @@ -86,6 +87,5 @@ def is_acs_token_cache_valid(response_cache): expires_on = data["accessToken"]["expiresOn"] expires_on_dt = isodate.parse_datetime(expires_on) return datetime.now(timezone.utc) < expires_on_dt - except (KeyError, ValueError, json.JSONDecodeError): - raise ValueError( # pylint: disable=W0707 - "Invalid token response") + except (KeyError, ValueError, json.JSONDecodeError) as e: + raise ValueError("Invalid token response") from e diff --git a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/user_credential.py b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/user_credential.py index b8b90ee06bc9..17adbf77dcc9 100644 --- a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/user_credential.py +++ b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/user_credential.py @@ -46,7 +46,7 @@ def __init__( *, token_refresher: Optional[Callable[[], AccessToken]] = None, proactive_refresh: bool = False, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential. @@ -64,7 +64,7 @@ def __init__( resource_endpoint: str, token_credential: TokenCredential, scopes: Optional[list[str]] = None, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential using token exchange. @@ -91,15 +91,13 @@ def __init__(self, token: Optional[str] = None, **kwargs: Any): if token_credential is None: missing_fields.append("token_credential") raise ValueError( - "When using token exchange, resource_endpoint and token_credential must be provided. " - f"Missing: {', '.join(missing_fields)}") + "When using token exchange, resource_endpoint and token_credential must be provided. " + f"Missing: {', '.join(missing_fields)}" + ) self._token_exchange_client = None if resource_endpoint and token_credential: - self._token_exchange_client = TokenExchangeClient( - resource_endpoint, - token_credential, - scopes) + self._token_exchange_client = TokenExchangeClient(resource_endpoint, token_credential, scopes) self._token_refresher = self._token_exchange_client.exchange_entra_token self._proactive_refresh = False self._token = self._token_exchange_client.exchange_entra_token() diff --git a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/user_credential_async.py b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/user_credential_async.py index 5a5d85d1fb0d..81c4b79c4e6d 100644 --- a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/user_credential_async.py +++ b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/user_credential_async.py @@ -50,7 +50,7 @@ def __init__( *, token_refresher: Optional[Callable[[], Awaitable[Any]]] = None, proactive_refresh: bool = False, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential. @@ -60,6 +60,7 @@ def __init__( :param proactive_refresh: Whether to refresh the token proactively. :param kwargs: Additional keyword arguments. """ + @overload def __init__( self, @@ -67,7 +68,7 @@ def __init__( resource_endpoint: str, token_credential: AsyncTokenCredential, scopes: Optional[list[str]] = None, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential using token exchange. @@ -95,14 +96,12 @@ def __init__(self, token: Optional[str] = None, **kwargs: Any): missing_fields.append("token_credential") raise ValueError( "When using token exchange, resource_endpoint and token_credential must be provided. " - f"Missing: {', '.join(missing_fields)}") + f"Missing: {', '.join(missing_fields)}" + ) self._token_exchange_client = None if resource_endpoint and token_credential: - self._token_exchange_client = TokenExchangeClient( - resource_endpoint, - token_credential, - scopes) + self._token_exchange_client = TokenExchangeClient(resource_endpoint, token_credential, scopes) self._token_refresher = self._token_exchange_client.exchange_entra_token self._proactive_refresh = False diff --git a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/utils_async.py b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/utils_async.py index 7402d088a880..b779d5c814b3 100644 --- a/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/utils_async.py +++ b/sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/_shared/utils_async.py @@ -6,6 +6,7 @@ # 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: :param int interval: time interval in seconds diff --git a/sdk/communication/azure-communication-phonenumbers/mypy.ini b/sdk/communication/azure-communication-phonenumbers/mypy.ini new file mode 100644 index 000000000000..78e98f92ce62 --- /dev/null +++ b/sdk/communication/azure-communication-phonenumbers/mypy.ini @@ -0,0 +1,4 @@ +[mypy] +ignore_missing_imports = True +check_untyped_defs = False +disallow_untyped_defs = False \ No newline at end of file diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/auth_policy_utils.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/auth_policy_utils.py index 72fc7424e6f8..c176b112f9b1 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/auth_policy_utils.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/auth_policy_utils.py @@ -4,7 +4,7 @@ # license information. # ------------------------------------------------------------------------- -from typing import Union +from typing import Union, cast from azure.core.credentials import TokenCredential, AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.policies import ( @@ -28,11 +28,10 @@ def get_authentication_policy( :type credential: Union[TokenCredential, AsyncTokenCredential, AzureKeyCredential, str] :param bool decode_url: `True` if there is a need to decode the url. Default value is `False` :param bool is_async: For async clients there is a need to decode the url - - :return: Either AsyncBearerTokenCredentialPolicy or BearerTokenCredentialPolicy or HMACCredentialsPolicy + :return: The authentication policy to be used. :rtype: ~azure.core.pipeline.policies.AsyncBearerTokenCredentialPolicy or - ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or - ~azure.communication.rooms.shared.policy.HMACCredentialsPolicy + ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or + ~.HMACCredentialsPolicy """ if credential is None: @@ -40,9 +39,11 @@ def get_authentication_policy( if hasattr(credential, "get_token"): if is_async: return AsyncBearerTokenCredentialPolicy( - credential, "https://communication.azure.com//.default" # type: ignore + cast(AsyncTokenCredential, credential), "https://communication.azure.com//.default" ) - return BearerTokenCredentialPolicy(credential, "https://communication.azure.com//.default") # type: ignore + return BearerTokenCredentialPolicy( + cast(TokenCredential, credential), "https://communication.azure.com//.default" + ) if isinstance(credential, (AzureKeyCredential, str)): return HMACCredentialsPolicy(endpoint, credential, decode_url=decode_url) diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/models.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/models.py index 6ec0b3344cbc..d71d8428504d 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/models.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/models.py @@ -157,14 +157,16 @@ def __init__(self, value: str, **kwargs: Any) -> None: is_anonymous: bool if raw_id is not None: - phone_number = raw_id[len(PHONE_NUMBER_PREFIX):] + phone_number = raw_id[len(PHONE_NUMBER_PREFIX) :] is_anonymous = phone_number == PHONE_NUMBER_ANONYMOUS_SUFFIX asserted_id_index = -1 if is_anonymous else phone_number.rfind("_") + 1 has_asserted_id = 0 < asserted_id_index < len(phone_number) - props = {"value": value, "is_anonymous": is_anonymous} if has_asserted_id: - props["asserted_id"] = phone_number[asserted_id_index:] - self.properties = PhoneNumberProperties(**props) # type: ignore + self.properties = PhoneNumberProperties( + value=value, is_anonymous=is_anonymous, asserted_id=phone_number[asserted_id_index:] + ) + else: + self.properties = PhoneNumberProperties(value=value, is_anonymous=is_anonymous) else: self.properties = PhoneNumberProperties(value=value) self.raw_id = raw_id if raw_id is not None else self._format_raw_id(self.properties) @@ -183,6 +185,7 @@ def _format_raw_id(self, properties: PhoneNumberProperties) -> str: value = properties["value"] return f"{PHONE_NUMBER_PREFIX}{value}" + class UnknownIdentifier: """Represents an identifier of an unknown type. @@ -242,7 +245,7 @@ def __init__(self, user_id: str, **kwargs: Any) -> None: :param str user_id: Microsoft Teams user id. :keyword bool is_anonymous: `True` if the identifier is anonymous. Default value is `False`. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.rooms.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -313,7 +316,7 @@ def __init__(self, app_id: str, **kwargs: Any) -> None: """ :param str app_id: Microsoft Teams application id. :keyword cloud: Cloud environment that the application belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.rooms.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -357,7 +360,7 @@ def __init__(self, bot_id, **kwargs): :keyword bool is_resource_account_configured: `False` if the identifier is global. Default value is `True` for tennantzed bots. :keyword cloud: Cloud environment that the bot belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.rooms.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` """ warnings.warn( "The MicrosoftBotIdentifier is deprecated and has been replaced by MicrosoftTeamsAppIdentifier.", @@ -389,20 +392,13 @@ class TeamsExtensionUserIdentifier: raw_id: str """The raw ID of the identifier.""" - def __init__( - self, - *, - user_id: str, - tenant_id: str, - resource_id: str, - **kwargs: Any - ) -> None: + def __init__(self, *, user_id: str, tenant_id: str, resource_id: str, **kwargs: Any) -> None: """ :param str user_id: Teams extension user id. :param str tenant_id: Tenant id associated with the user. :param str resource_id: The Communication Services resource id. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.rooms.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -434,6 +430,7 @@ def _format_raw_id(self, properties: TeamsExtensionUserProperties) -> str: prefix = ACS_USER_PREFIX return f"{prefix}{properties['resource_id']}_{properties['tenant_id']}_{properties['user_id']}" + def try_create_teams_extension_user(prefix: str, suffix: str) -> Optional[TeamsExtensionUserIdentifier]: segments = suffix.split("_") if len(segments) != 3: @@ -449,6 +446,7 @@ def try_create_teams_extension_user(prefix: str, suffix: str) -> Optional[TeamsE raise ValueError("Invalid MRI") return TeamsExtensionUserIdentifier(user_id=user_id, tenant_id=tenant_id, resource_id=resource_id, cloud=cloud) + def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: disable=too-many-return-statements """ Creates a CommunicationIdentifier from a given raw ID. @@ -457,7 +455,7 @@ def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: d :param str raw_id: A raw ID to construct the CommunicationIdentifier from. :return: The CommunicationIdentifier parsed from the raw_id. - :rtype: CommunicationIdentifier + :rtype: :class:`~.CommunicationIdentifier` """ if raw_id.startswith(PHONE_NUMBER_PREFIX): return PhoneNumberIdentifier(value=raw_id[len(PHONE_NUMBER_PREFIX) :], raw_id=raw_id) diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/policy.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/policy.py index 1843d22e83a2..6eae18574193 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/policy.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/policy.py @@ -5,13 +5,15 @@ # ------------------------------------------------------------------------- import hashlib -import urllib import base64 import hmac -from urllib.parse import ParseResult, urlparse +from urllib.parse import urlparse, unquote from typing import Union + from azure.core.credentials import AzureKeyCredential from azure.core.pipeline.policies import SansIOHTTPPolicy +from azure.core.pipeline import PipelineRequest + from .utils import get_current_utc_time @@ -41,9 +43,7 @@ def __init__( self._access_key = access_key self._decode_url = decode_url - def _compute_hmac( - self, value # type: str - ): + def _compute_hmac(self, value: str) -> str: if isinstance(self._access_key, AzureKeyCredential): decoded_secret = base64.b64decode(self._access_key.key) else: @@ -53,11 +53,11 @@ def _compute_hmac( return base64.b64encode(digest).decode("utf-8") - def _sign_request(self, request): + def _sign_request(self, request: PipelineRequest) -> None: verb = request.http_request.method.upper() # Get the path and query from url, which looks like https://host/path/query - parsed_url: ParseResult = urlparse(request.http_request.url) + parsed_url = urlparse(request.http_request.url) query_url = parsed_url.path if parsed_url.query: @@ -91,7 +91,7 @@ def _sign_request(self, request): pass if self._decode_url: - query_url = urllib.parse.unquote(query_url) + query_url = unquote(query_url) signed_headers = "x-ms-date;host;x-ms-content-sha256" @@ -114,7 +114,5 @@ def _sign_request(self, request): request.http_request.headers.update(signature_header) - return request - - def on_request(self, request): + def on_request(self, request: PipelineRequest) -> None: self._sign_request(request) diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/token_exchange.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/token_exchange.py index 32d6297d4b1b..1b0dde140479 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/token_exchange.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/token_exchange.py @@ -6,6 +6,7 @@ import json from typing import Any, List, Optional + # pylint: disable=non-abstract-transport-import # pylint: disable=no-name-in-module @@ -21,7 +22,7 @@ class TokenExchangeClient: """Represents a client that exchanges an Entra token for an Azure Communication Services (ACS) token. - + :param resource_endpoint: The endpoint URL of the resource to authenticate against. :param credential: The credential to use for token exchange. :param scopes: The scopes to request during the token exchange. @@ -31,11 +32,8 @@ class TokenExchangeClient: # pylint: disable=C4748 # pylint: disable=client-method-missing-type-annotations def __init__( - self, - resource_endpoint: str, - credential: TokenCredential, - scopes: Optional[List[str]] = None, - **kwargs: Any): + self, resource_endpoint: str, credential: TokenCredential, scopes: Optional[List[str]] = None, **kwargs: Any + ): self._resource_endpoint = resource_endpoint self._scopes = scopes or ["https://communication.azure.com/clients/.default"] @@ -76,6 +74,5 @@ def _parse_access_token_from_response(self, response: PipelineResponse) -> Acces raise ValueError("Failed to parse access token from response") from ex else: raise HttpResponseError( - message="Failed to exchange Entra token for ACS token", - response=response.http_response + message="Failed to exchange Entra token for ACS token", response=response.http_response ) diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/token_exchange_async.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/token_exchange_async.py index 0181b5982673..22dd4582460b 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/token_exchange_async.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/token_exchange_async.py @@ -6,6 +6,7 @@ import json from typing import Any, Optional, List + # pylint: disable=non-abstract-transport-import # pylint: disable=no-name-in-module @@ -35,7 +36,8 @@ def __init__( resource_endpoint: str, credential: AsyncTokenCredential, scopes: Optional[List[str]] = None, - **kwargs: Any): + **kwargs: Any + ): self._resource_endpoint = resource_endpoint self._scopes = scopes or ["https://communication.azure.com/clients/.default"] @@ -76,6 +78,5 @@ async def _parse_access_token_from_response(self, response: PipelineResponse) -> raise ValueError("Failed to parse access token from response") from ex else: raise HttpResponseError( - message="Failed to exchange Entra token for ACS token", - response=response.http_response + message="Failed to exchange Entra token for ACS token", response=response.http_response ) diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/token_utils.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/token_utils.py index f4115a001029..9628d3e76ec9 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/token_utils.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/token_utils.py @@ -21,6 +21,7 @@ def create_request_message(resource_endpoint: str, scopes: Optional[List[str]]) -> Any: from azure.core.pipeline.transport import HttpRequest + request_uri = create_request_uri(resource_endpoint, scopes) request = HttpRequest("POST", request_uri) request.headers["Accept"] = "application/json" @@ -59,26 +60,26 @@ def parse_expires_on(expires_on, response): return expires_on_epoch except Exception as exc: raise HttpResponseError( - message="Unknown format for expires_on field in access token response", - response=response.http_response) from exc + message="Unknown format for expires_on field in access token response", response=response.http_response + ) from exc else: raise HttpResponseError( - message="Missing expires_on field in access token response", - response=response.http_response) + message="Missing expires_on field in access token response", response=response.http_response + ) def is_entra_token_cache_valid(entra_token_cache, request): current_entra_token = request.http_request.headers.get("Authorization", "") - cache_valid = ( - entra_token_cache is not None and - current_entra_token == entra_token_cache - ) + cache_valid = entra_token_cache is not None and current_entra_token == entra_token_cache return cache_valid, current_entra_token def is_acs_token_cache_valid(response_cache): - if (response_cache is None or response_cache.http_response is None or - response_cache.http_response.status_code != 200): + if ( + response_cache is None + or response_cache.http_response is None + or response_cache.http_response.status_code != 200 + ): return False try: content = response_cache.http_response.text() @@ -86,6 +87,5 @@ def is_acs_token_cache_valid(response_cache): expires_on = data["accessToken"]["expiresOn"] expires_on_dt = isodate.parse_datetime(expires_on) return datetime.now(timezone.utc) < expires_on_dt - except (KeyError, ValueError, json.JSONDecodeError): - raise ValueError( # pylint: disable=W0707 - "Invalid token response") + except (KeyError, ValueError, json.JSONDecodeError) as e: + raise ValueError("Invalid token response") from e diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/user_credential.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/user_credential.py index b8b90ee06bc9..17adbf77dcc9 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/user_credential.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/user_credential.py @@ -46,7 +46,7 @@ def __init__( *, token_refresher: Optional[Callable[[], AccessToken]] = None, proactive_refresh: bool = False, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential. @@ -64,7 +64,7 @@ def __init__( resource_endpoint: str, token_credential: TokenCredential, scopes: Optional[list[str]] = None, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential using token exchange. @@ -91,15 +91,13 @@ def __init__(self, token: Optional[str] = None, **kwargs: Any): if token_credential is None: missing_fields.append("token_credential") raise ValueError( - "When using token exchange, resource_endpoint and token_credential must be provided. " - f"Missing: {', '.join(missing_fields)}") + "When using token exchange, resource_endpoint and token_credential must be provided. " + f"Missing: {', '.join(missing_fields)}" + ) self._token_exchange_client = None if resource_endpoint and token_credential: - self._token_exchange_client = TokenExchangeClient( - resource_endpoint, - token_credential, - scopes) + self._token_exchange_client = TokenExchangeClient(resource_endpoint, token_credential, scopes) self._token_refresher = self._token_exchange_client.exchange_entra_token self._proactive_refresh = False self._token = self._token_exchange_client.exchange_entra_token() diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/user_credential_async.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/user_credential_async.py index 5a5d85d1fb0d..81c4b79c4e6d 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/user_credential_async.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/user_credential_async.py @@ -50,7 +50,7 @@ def __init__( *, token_refresher: Optional[Callable[[], Awaitable[Any]]] = None, proactive_refresh: bool = False, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential. @@ -60,6 +60,7 @@ def __init__( :param proactive_refresh: Whether to refresh the token proactively. :param kwargs: Additional keyword arguments. """ + @overload def __init__( self, @@ -67,7 +68,7 @@ def __init__( resource_endpoint: str, token_credential: AsyncTokenCredential, scopes: Optional[list[str]] = None, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential using token exchange. @@ -95,14 +96,12 @@ def __init__(self, token: Optional[str] = None, **kwargs: Any): missing_fields.append("token_credential") raise ValueError( "When using token exchange, resource_endpoint and token_credential must be provided. " - f"Missing: {', '.join(missing_fields)}") + f"Missing: {', '.join(missing_fields)}" + ) self._token_exchange_client = None if resource_endpoint and token_credential: - self._token_exchange_client = TokenExchangeClient( - resource_endpoint, - token_credential, - scopes) + self._token_exchange_client = TokenExchangeClient(resource_endpoint, token_credential, scopes) self._token_refresher = self._token_exchange_client.exchange_entra_token self._proactive_refresh = False diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/utils_async.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/utils_async.py index 7402d088a880..b779d5c814b3 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/utils_async.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_shared/utils_async.py @@ -6,6 +6,7 @@ # 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: :param int interval: time interval in seconds diff --git a/sdk/communication/azure-communication-rooms/mypy.ini b/sdk/communication/azure-communication-rooms/mypy.ini new file mode 100644 index 000000000000..78e98f92ce62 --- /dev/null +++ b/sdk/communication/azure-communication-rooms/mypy.ini @@ -0,0 +1,4 @@ +[mypy] +ignore_missing_imports = True +check_untyped_defs = False +disallow_untyped_defs = False \ No newline at end of file diff --git a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/auth_policy_utils.py b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/auth_policy_utils.py index a0fdb82b860e..c176b112f9b1 100644 --- a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/auth_policy_utils.py +++ b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/auth_policy_utils.py @@ -4,7 +4,7 @@ # license information. # ------------------------------------------------------------------------- -from typing import Union +from typing import Union, cast from azure.core.credentials import TokenCredential, AzureKeyCredential from azure.core.credentials_async import AsyncTokenCredential from azure.core.pipeline.policies import ( @@ -28,11 +28,10 @@ def get_authentication_policy( :type credential: Union[TokenCredential, AsyncTokenCredential, AzureKeyCredential, str] :param bool decode_url: `True` if there is a need to decode the url. Default value is `False` :param bool is_async: For async clients there is a need to decode the url - - :return: Either AsyncBearerTokenCredentialPolicy or BearerTokenCredentialPolicy or HMACCredentialsPolicy + :return: The authentication policy to be used. :rtype: ~azure.core.pipeline.policies.AsyncBearerTokenCredentialPolicy or - ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or - ~azure.communication.sms.shared.policy.HMACCredentialsPolicy + ~azure.core.pipeline.policies.BearerTokenCredentialPolicy or + ~.HMACCredentialsPolicy """ if credential is None: @@ -40,9 +39,11 @@ def get_authentication_policy( if hasattr(credential, "get_token"): if is_async: return AsyncBearerTokenCredentialPolicy( - credential, "https://communication.azure.com//.default" # type: ignore + cast(AsyncTokenCredential, credential), "https://communication.azure.com//.default" ) - return BearerTokenCredentialPolicy(credential, "https://communication.azure.com//.default") # type: ignore + return BearerTokenCredentialPolicy( + cast(TokenCredential, credential), "https://communication.azure.com//.default" + ) if isinstance(credential, (AzureKeyCredential, str)): return HMACCredentialsPolicy(endpoint, credential, decode_url=decode_url) diff --git a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/models.py b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/models.py index 390b20fb9948..d71d8428504d 100644 --- a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/models.py +++ b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/models.py @@ -157,14 +157,16 @@ def __init__(self, value: str, **kwargs: Any) -> None: is_anonymous: bool if raw_id is not None: - phone_number = raw_id[len(PHONE_NUMBER_PREFIX):] + phone_number = raw_id[len(PHONE_NUMBER_PREFIX) :] is_anonymous = phone_number == PHONE_NUMBER_ANONYMOUS_SUFFIX asserted_id_index = -1 if is_anonymous else phone_number.rfind("_") + 1 has_asserted_id = 0 < asserted_id_index < len(phone_number) - props = {"value": value, "is_anonymous": is_anonymous} if has_asserted_id: - props["asserted_id"] = phone_number[asserted_id_index:] - self.properties = PhoneNumberProperties(**props) # type: ignore + self.properties = PhoneNumberProperties( + value=value, is_anonymous=is_anonymous, asserted_id=phone_number[asserted_id_index:] + ) + else: + self.properties = PhoneNumberProperties(value=value, is_anonymous=is_anonymous) else: self.properties = PhoneNumberProperties(value=value) self.raw_id = raw_id if raw_id is not None else self._format_raw_id(self.properties) @@ -183,6 +185,7 @@ def _format_raw_id(self, properties: PhoneNumberProperties) -> str: value = properties["value"] return f"{PHONE_NUMBER_PREFIX}{value}" + class UnknownIdentifier: """Represents an identifier of an unknown type. @@ -242,7 +245,7 @@ def __init__(self, user_id: str, **kwargs: Any) -> None: :param str user_id: Microsoft Teams user id. :keyword bool is_anonymous: `True` if the identifier is anonymous. Default value is `False`. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.sms.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -313,7 +316,7 @@ def __init__(self, app_id: str, **kwargs: Any) -> None: """ :param str app_id: Microsoft Teams application id. :keyword cloud: Cloud environment that the application belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.sms.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -357,7 +360,7 @@ def __init__(self, bot_id, **kwargs): :keyword bool is_resource_account_configured: `False` if the identifier is global. Default value is `True` for tennantzed bots. :keyword cloud: Cloud environment that the bot belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.sms.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` """ warnings.warn( "The MicrosoftBotIdentifier is deprecated and has been replaced by MicrosoftTeamsAppIdentifier.", @@ -389,20 +392,13 @@ class TeamsExtensionUserIdentifier: raw_id: str """The raw ID of the identifier.""" - def __init__( - self, - *, - user_id: str, - tenant_id: str, - resource_id: str, - **kwargs: Any - ) -> None: + def __init__(self, *, user_id: str, tenant_id: str, resource_id: str, **kwargs: Any) -> None: """ :param str user_id: Teams extension user id. :param str tenant_id: Tenant id associated with the user. :param str resource_id: The Communication Services resource id. :keyword cloud: Cloud environment that the user belongs to. Default value is `PUBLIC`. - :paramtype cloud: str or ~azure.communication.sms.CommunicationCloudEnvironment + :paramtype cloud: str or :class:`~.CommunicationCloudEnvironment` :keyword str raw_id: The raw ID of the identifier. If not specified, this value will be constructed from the other properties. """ @@ -434,6 +430,7 @@ def _format_raw_id(self, properties: TeamsExtensionUserProperties) -> str: prefix = ACS_USER_PREFIX return f"{prefix}{properties['resource_id']}_{properties['tenant_id']}_{properties['user_id']}" + def try_create_teams_extension_user(prefix: str, suffix: str) -> Optional[TeamsExtensionUserIdentifier]: segments = suffix.split("_") if len(segments) != 3: @@ -449,6 +446,7 @@ def try_create_teams_extension_user(prefix: str, suffix: str) -> Optional[TeamsE raise ValueError("Invalid MRI") return TeamsExtensionUserIdentifier(user_id=user_id, tenant_id=tenant_id, resource_id=resource_id, cloud=cloud) + def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: disable=too-many-return-statements """ Creates a CommunicationIdentifier from a given raw ID. @@ -457,7 +455,7 @@ def identifier_from_raw_id(raw_id: str) -> CommunicationIdentifier: # pylint: d :param str raw_id: A raw ID to construct the CommunicationIdentifier from. :return: The CommunicationIdentifier parsed from the raw_id. - :rtype: CommunicationIdentifier + :rtype: :class:`~.CommunicationIdentifier` """ if raw_id.startswith(PHONE_NUMBER_PREFIX): return PhoneNumberIdentifier(value=raw_id[len(PHONE_NUMBER_PREFIX) :], raw_id=raw_id) diff --git a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/policy.py b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/policy.py index 1843d22e83a2..6eae18574193 100644 --- a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/policy.py +++ b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/policy.py @@ -5,13 +5,15 @@ # ------------------------------------------------------------------------- import hashlib -import urllib import base64 import hmac -from urllib.parse import ParseResult, urlparse +from urllib.parse import urlparse, unquote from typing import Union + from azure.core.credentials import AzureKeyCredential from azure.core.pipeline.policies import SansIOHTTPPolicy +from azure.core.pipeline import PipelineRequest + from .utils import get_current_utc_time @@ -41,9 +43,7 @@ def __init__( self._access_key = access_key self._decode_url = decode_url - def _compute_hmac( - self, value # type: str - ): + def _compute_hmac(self, value: str) -> str: if isinstance(self._access_key, AzureKeyCredential): decoded_secret = base64.b64decode(self._access_key.key) else: @@ -53,11 +53,11 @@ def _compute_hmac( return base64.b64encode(digest).decode("utf-8") - def _sign_request(self, request): + def _sign_request(self, request: PipelineRequest) -> None: verb = request.http_request.method.upper() # Get the path and query from url, which looks like https://host/path/query - parsed_url: ParseResult = urlparse(request.http_request.url) + parsed_url = urlparse(request.http_request.url) query_url = parsed_url.path if parsed_url.query: @@ -91,7 +91,7 @@ def _sign_request(self, request): pass if self._decode_url: - query_url = urllib.parse.unquote(query_url) + query_url = unquote(query_url) signed_headers = "x-ms-date;host;x-ms-content-sha256" @@ -114,7 +114,5 @@ def _sign_request(self, request): request.http_request.headers.update(signature_header) - return request - - def on_request(self, request): + def on_request(self, request: PipelineRequest) -> None: self._sign_request(request) diff --git a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/token_exchange.py b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/token_exchange.py index 32d6297d4b1b..1b0dde140479 100644 --- a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/token_exchange.py +++ b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/token_exchange.py @@ -6,6 +6,7 @@ import json from typing import Any, List, Optional + # pylint: disable=non-abstract-transport-import # pylint: disable=no-name-in-module @@ -21,7 +22,7 @@ class TokenExchangeClient: """Represents a client that exchanges an Entra token for an Azure Communication Services (ACS) token. - + :param resource_endpoint: The endpoint URL of the resource to authenticate against. :param credential: The credential to use for token exchange. :param scopes: The scopes to request during the token exchange. @@ -31,11 +32,8 @@ class TokenExchangeClient: # pylint: disable=C4748 # pylint: disable=client-method-missing-type-annotations def __init__( - self, - resource_endpoint: str, - credential: TokenCredential, - scopes: Optional[List[str]] = None, - **kwargs: Any): + self, resource_endpoint: str, credential: TokenCredential, scopes: Optional[List[str]] = None, **kwargs: Any + ): self._resource_endpoint = resource_endpoint self._scopes = scopes or ["https://communication.azure.com/clients/.default"] @@ -76,6 +74,5 @@ def _parse_access_token_from_response(self, response: PipelineResponse) -> Acces raise ValueError("Failed to parse access token from response") from ex else: raise HttpResponseError( - message="Failed to exchange Entra token for ACS token", - response=response.http_response + message="Failed to exchange Entra token for ACS token", response=response.http_response ) diff --git a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/token_exchange_async.py b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/token_exchange_async.py index 0181b5982673..22dd4582460b 100644 --- a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/token_exchange_async.py +++ b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/token_exchange_async.py @@ -6,6 +6,7 @@ import json from typing import Any, Optional, List + # pylint: disable=non-abstract-transport-import # pylint: disable=no-name-in-module @@ -35,7 +36,8 @@ def __init__( resource_endpoint: str, credential: AsyncTokenCredential, scopes: Optional[List[str]] = None, - **kwargs: Any): + **kwargs: Any + ): self._resource_endpoint = resource_endpoint self._scopes = scopes or ["https://communication.azure.com/clients/.default"] @@ -76,6 +78,5 @@ async def _parse_access_token_from_response(self, response: PipelineResponse) -> raise ValueError("Failed to parse access token from response") from ex else: raise HttpResponseError( - message="Failed to exchange Entra token for ACS token", - response=response.http_response + message="Failed to exchange Entra token for ACS token", response=response.http_response ) diff --git a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/token_utils.py b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/token_utils.py index f4115a001029..9628d3e76ec9 100644 --- a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/token_utils.py +++ b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/token_utils.py @@ -21,6 +21,7 @@ def create_request_message(resource_endpoint: str, scopes: Optional[List[str]]) -> Any: from azure.core.pipeline.transport import HttpRequest + request_uri = create_request_uri(resource_endpoint, scopes) request = HttpRequest("POST", request_uri) request.headers["Accept"] = "application/json" @@ -59,26 +60,26 @@ def parse_expires_on(expires_on, response): return expires_on_epoch except Exception as exc: raise HttpResponseError( - message="Unknown format for expires_on field in access token response", - response=response.http_response) from exc + message="Unknown format for expires_on field in access token response", response=response.http_response + ) from exc else: raise HttpResponseError( - message="Missing expires_on field in access token response", - response=response.http_response) + message="Missing expires_on field in access token response", response=response.http_response + ) def is_entra_token_cache_valid(entra_token_cache, request): current_entra_token = request.http_request.headers.get("Authorization", "") - cache_valid = ( - entra_token_cache is not None and - current_entra_token == entra_token_cache - ) + cache_valid = entra_token_cache is not None and current_entra_token == entra_token_cache return cache_valid, current_entra_token def is_acs_token_cache_valid(response_cache): - if (response_cache is None or response_cache.http_response is None or - response_cache.http_response.status_code != 200): + if ( + response_cache is None + or response_cache.http_response is None + or response_cache.http_response.status_code != 200 + ): return False try: content = response_cache.http_response.text() @@ -86,6 +87,5 @@ def is_acs_token_cache_valid(response_cache): expires_on = data["accessToken"]["expiresOn"] expires_on_dt = isodate.parse_datetime(expires_on) return datetime.now(timezone.utc) < expires_on_dt - except (KeyError, ValueError, json.JSONDecodeError): - raise ValueError( # pylint: disable=W0707 - "Invalid token response") + except (KeyError, ValueError, json.JSONDecodeError) as e: + raise ValueError("Invalid token response") from e diff --git a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/user_credential.py b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/user_credential.py index b8b90ee06bc9..17adbf77dcc9 100644 --- a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/user_credential.py +++ b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/user_credential.py @@ -46,7 +46,7 @@ def __init__( *, token_refresher: Optional[Callable[[], AccessToken]] = None, proactive_refresh: bool = False, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential. @@ -64,7 +64,7 @@ def __init__( resource_endpoint: str, token_credential: TokenCredential, scopes: Optional[list[str]] = None, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential using token exchange. @@ -91,15 +91,13 @@ def __init__(self, token: Optional[str] = None, **kwargs: Any): if token_credential is None: missing_fields.append("token_credential") raise ValueError( - "When using token exchange, resource_endpoint and token_credential must be provided. " - f"Missing: {', '.join(missing_fields)}") + "When using token exchange, resource_endpoint and token_credential must be provided. " + f"Missing: {', '.join(missing_fields)}" + ) self._token_exchange_client = None if resource_endpoint and token_credential: - self._token_exchange_client = TokenExchangeClient( - resource_endpoint, - token_credential, - scopes) + self._token_exchange_client = TokenExchangeClient(resource_endpoint, token_credential, scopes) self._token_refresher = self._token_exchange_client.exchange_entra_token self._proactive_refresh = False self._token = self._token_exchange_client.exchange_entra_token() diff --git a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/user_credential_async.py b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/user_credential_async.py index 5a5d85d1fb0d..81c4b79c4e6d 100644 --- a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/user_credential_async.py +++ b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/user_credential_async.py @@ -50,7 +50,7 @@ def __init__( *, token_refresher: Optional[Callable[[], Awaitable[Any]]] = None, proactive_refresh: bool = False, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential. @@ -60,6 +60,7 @@ def __init__( :param proactive_refresh: Whether to refresh the token proactively. :param kwargs: Additional keyword arguments. """ + @overload def __init__( self, @@ -67,7 +68,7 @@ def __init__( resource_endpoint: str, token_credential: AsyncTokenCredential, scopes: Optional[list[str]] = None, - **kwargs: Any + **kwargs: Any, ): """ Initializes the CommunicationTokenCredential using token exchange. @@ -95,14 +96,12 @@ def __init__(self, token: Optional[str] = None, **kwargs: Any): missing_fields.append("token_credential") raise ValueError( "When using token exchange, resource_endpoint and token_credential must be provided. " - f"Missing: {', '.join(missing_fields)}") + f"Missing: {', '.join(missing_fields)}" + ) self._token_exchange_client = None if resource_endpoint and token_credential: - self._token_exchange_client = TokenExchangeClient( - resource_endpoint, - token_credential, - scopes) + self._token_exchange_client = TokenExchangeClient(resource_endpoint, token_credential, scopes) self._token_refresher = self._token_exchange_client.exchange_entra_token self._proactive_refresh = False diff --git a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/utils_async.py b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/utils_async.py index 7402d088a880..b779d5c814b3 100644 --- a/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/utils_async.py +++ b/sdk/communication/azure-communication-sms/azure/communication/sms/_shared/utils_async.py @@ -6,6 +6,7 @@ # 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: :param int interval: time interval in seconds diff --git a/sdk/communication/azure-communication-sms/mypy.ini b/sdk/communication/azure-communication-sms/mypy.ini new file mode 100644 index 000000000000..78e98f92ce62 --- /dev/null +++ b/sdk/communication/azure-communication-sms/mypy.ini @@ -0,0 +1,4 @@ +[mypy] +ignore_missing_imports = True +check_untyped_defs = False +disallow_untyped_defs = False \ No newline at end of file diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/CHANGELOG.md b/sdk/confidentialledger/azure-confidentialledger-certificate/CHANGELOG.md new file mode 100644 index 000000000000..236d7dd0ea4d --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/CHANGELOG.md @@ -0,0 +1,5 @@ +# Release History + +## 1.0.0b1 (2025-10-10) + +- Initial version diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/LICENSE b/sdk/confidentialledger/azure-confidentialledger-certificate/LICENSE new file mode 100644 index 000000000000..63447fd8bbbf --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/LICENSE @@ -0,0 +1,21 @@ +Copyright (c) Microsoft Corporation. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/MANIFEST.in b/sdk/confidentialledger/azure-confidentialledger-certificate/MANIFEST.in new file mode 100644 index 000000000000..d0dd1317a665 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/MANIFEST.in @@ -0,0 +1,7 @@ +include *.md +include LICENSE +include azure/confidentialledger/certificate/py.typed +recursive-include tests *.py +recursive-include samples *.py *.md +include azure/__init__.py +include azure/confidentialledger/__init__.py diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/README.md b/sdk/confidentialledger/azure-confidentialledger-certificate/README.md new file mode 100644 index 000000000000..993964892c4b --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/README.md @@ -0,0 +1,93 @@ +# Azure Confidential Ledger Certificate client library for Python + +The Confidential Ledger Certificate client library is used to retrieve the TLS certificate required for connecting to a Confidential Ledger. + +## Getting started + +### Install the package + +```bash +python -m pip install azure-confidentialledger-certificate +``` + +#### Prerequisites + +- Python 3.9 or later is required to use this package. +- You need an [Azure subscription][azure_sub] to use this package. +- An existing Confidential Ledger instance. + +## Key concepts + +Clients may authenticate with a client certificate in mutual TLS instead of via an Azure Active Directory token. Use the `get_ledger_identity()` method on the `ConfidentialLedgerCertificateClient` to retrieve the certificate. + +## Examples + +Get a ledger certificate for authentication using the `ConfidentialLedgerCertificateClient` from the `azure-confidentialledger-certificate` package, save the certificate, pass the certificate path to the `ConfidentialLedgerCertificateCredential` from the `azure-confidentialledger` package, and pass the credential to the `ConfidentialLedgerClient` for authentication: + +```python +from azure.confidentialledger.certificate import ConfidentialLedgerCertificateClient +from azure.confidentialledger import ( + ConfidentialLedgerCertificateCredential, + ConfidentialLedgerClient, +) + +identity_client = ConfidentialLedgerCertificateClient() +network_identity = identity_client.get_ledger_identity( + ledger_id="my-ledger-id" +) + +ledger_tls_cert_file_name = "ledger_certificate.pem" +with open(ledger_tls_cert_file_name, "w") as cert_file: + cert_file.write(network_identity["ledgerTlsCertificate"]) + +credential = ConfidentialLedgerCertificateCredential( + certificate_path="Path to user certificate PEM file" +) +ledger_client = ConfidentialLedgerClient( + endpoint="https://my-ledger-id.confidential-ledger.azure.com", + credential=credential, + ledger_certificate_path=ledger_tls_cert_file_name +) +``` + +## Troubleshooting + +Confidential Ledger clients raise exceptions defined in [azure-core][azure_core_exceptions]. + +## Next steps + +Use the certificate retrieved using this library with the `azure-confidentialledger` package. The Azure Confidential Ledger client library has several code samples that show common scenario operations. + +### Additional Documentation + +For more extensive documentation on Azure Confidential Ledger, see the +[API reference documentation][reference_docs]. You may also read more about Microsoft Research's open-source [Confidential Consortium Framework][ccf]. + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require +you to agree to a Contributor License Agreement (CLA) declaring that you have +the right to, and actually do, grant us the rights to use your contribution. +For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether +you need to provide a CLA and decorate the PR appropriately (e.g., label, +comment). Simply follow the instructions provided by the bot. You will only +need to do this once across all repos using our CLA. + +This project has adopted the +[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, +see the Code of Conduct FAQ or contact opencode@microsoft.com with any +additional questions or comments. + + + +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[azure_core_exceptions]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core#azure-core-library-exceptions +[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token +[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials +[azure_identity_pip]: https://pypi.org/project/azure-identity/ +[pip]: https://pypi.org/project/pip/ +[azure_sub]: https://azure.microsoft.com/free/ +[reference_docs]: https://aka.ms/azsdk/python/confidentialledger/ref-docs +[ccf]: https://github.com/Microsoft/CCF diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/_metadata.json b/sdk/confidentialledger/azure-confidentialledger-certificate/_metadata.json new file mode 100644 index 000000000000..9b574d2c1b24 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/_metadata.json @@ -0,0 +1,3 @@ +{ + "apiVersion": "2024-12-09-preview" +} \ No newline at end of file diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/apiview-properties.json b/sdk/confidentialledger/azure-confidentialledger-certificate/apiview-properties.json new file mode 100644 index 000000000000..f9d7e76f078d --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/apiview-properties.json @@ -0,0 +1,10 @@ +{ + "CrossLanguagePackageId": "ConfidentialLedgerCertificate", + "CrossLanguageDefinitionId": { + "azure.confidentialledger.certificate.models.ConfidentialLedgerError": "ConfidentialLedgerCommon.ConfidentialLedgerError", + "azure.confidentialledger.certificate.models.ConfidentialLedgerErrorBody": "ConfidentialLedgerCommon.ConfidentialLedgerErrorBody", + "azure.confidentialledger.certificate.models.LedgerIdentityInformation": "ConfidentialLedgerCertificate.LedgerIdentityInformation", + "azure.confidentialledger.certificate.ConfidentialLedgerCertificateClient.get_ledger_identity": "ConfidentialLedgerCertificate.getLedgerIdentity", + "azure.confidentialledger.certificate.aio.ConfidentialLedgerCertificateClient.get_ledger_identity": "ConfidentialLedgerCertificate.getLedgerIdentity" + } +} \ No newline at end of file diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/assets.json b/sdk/confidentialledger/azure-confidentialledger-certificate/assets.json new file mode 100644 index 000000000000..6681b7d9f036 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/assets.json @@ -0,0 +1,6 @@ +{ + "AssetsRepo": "Azure/azure-sdk-assets", + "AssetsRepoPrefixPath": "python", + "TagPrefix": "python/confidentialledger/azure-confidentialledger-certificate", + "Tag": "python/confidentialledger/azure-confidentialledger-certificate_e868943cfa" +} diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/__init__.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/__init__.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/__init__.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/__init__.py new file mode 100644 index 000000000000..45d9af59d5ad --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/__init__.py @@ -0,0 +1,32 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import ConfidentialLedgerCertificateClient # type: ignore +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "ConfidentialLedgerCertificateClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore + +_patch_sdk() diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_client.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_client.py new file mode 100644 index 000000000000..fc06251dac77 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_client.py @@ -0,0 +1,104 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any +from typing_extensions import Self + +from azure.core import PipelineClient +from azure.core.pipeline import policies +from azure.core.rest import HttpRequest, HttpResponse + +from ._configuration import ConfidentialLedgerCertificateClientConfiguration +from ._operations import _ConfidentialLedgerCertificateClientOperationsMixin +from ._utils.serialization import Deserializer, Serializer + + +class ConfidentialLedgerCertificateClient(_ConfidentialLedgerCertificateClientOperationsMixin): + """The Confidential Ledger Certificate endpoint is used to retrieve the TLS certificate + required for connecting to a Confidential Ledger. + + :keyword certificate_endpoint: The certificate endpoint (or "Identity Service Endpoint" in the + Azure portal), for example `https://identity.confidential-ledger.core.azure.com + `_. Default value is + "https://identity.confidential-ledger.core.azure.com". + :paramtype certificate_endpoint: str + :keyword api_version: The API version to use for this operation. Default value is + "2024-12-09-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__( # pylint: disable=missing-client-constructor-parameter-credential + self, *, certificate_endpoint: str = "https://identity.confidential-ledger.core.azure.com", **kwargs: Any + ) -> None: + _endpoint = "{certificateEndpoint}" + self._config = ConfidentialLedgerCertificateClientConfiguration( + certificate_endpoint=certificate_endpoint, **kwargs + ) + + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "certificateEndpoint": self._serialize.url( + "self._config.certificate_endpoint", self._config.certificate_endpoint, "str", skip_quote=True + ), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() + + def __enter__(self) -> Self: + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_configuration.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_configuration.py new file mode 100644 index 000000000000..9df1cc055aa7 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_configuration.py @@ -0,0 +1,53 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any + +from azure.core.pipeline import policies + +from ._version import VERSION + + +class ConfidentialLedgerCertificateClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for ConfidentialLedgerCertificateClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param certificate_endpoint: The certificate endpoint (or "Identity Service Endpoint" in the + Azure portal), for example `https://identity.confidential-ledger.core.azure.com + `_. Default value is + "https://identity.confidential-ledger.core.azure.com". + :type certificate_endpoint: str + :keyword api_version: The API version to use for this operation. Default value is + "2024-12-09-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__( + self, certificate_endpoint: str = "https://identity.confidential-ledger.core.azure.com", **kwargs: Any + ) -> None: + api_version: str = kwargs.pop("api_version", "2024-12-09-preview") + + self.certificate_endpoint = certificate_endpoint + self.api_version = api_version + kwargs.setdefault("sdk_moniker", "confidentialledger-certificate/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_operations/__init__.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_operations/__init__.py new file mode 100644 index 000000000000..f537d5b7aba9 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_operations/__init__.py @@ -0,0 +1,24 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._operations import _ConfidentialLedgerCertificateClientOperationsMixin # type: ignore # pylint: disable=unused-import + +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_operations/_operations.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_operations/_operations.py new file mode 100644 index 000000000000..bd82f3eb1483 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_operations/_operations.py @@ -0,0 +1,134 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from collections.abc import MutableMapping +from typing import Any, Callable, Optional, TypeVar + +from azure.core import PipelineClient +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import models as _models +from .._configuration import ConfidentialLedgerCertificateClientConfiguration +from .._utils.model_base import _deserialize, _failsafe_deserialize +from .._utils.serialization import Serializer +from .._utils.utils import ClientMixinABC + +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_confidential_ledger_certificate_get_ledger_identity_request( # pylint: disable=name-too-long + ledger_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-12-09-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/ledgerIdentity/{ledgerId}" + path_format_arguments = { + "ledgerId": _SERIALIZER.url("ledger_id", ledger_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +class _ConfidentialLedgerCertificateClientOperationsMixin( + ClientMixinABC[PipelineClient[HttpRequest, HttpResponse], ConfidentialLedgerCertificateClientConfiguration] +): + + @distributed_trace + def get_ledger_identity(self, ledger_id: str, **kwargs: Any) -> _models.LedgerIdentityInformation: + """Gets identity information for a Confidential Ledger instance. + + Gets identity information for a Confidential Ledger instance. + + :param ledger_id: Id of the Confidential Ledger instance to get information for. Required. + :type ledger_id: str + :return: LedgerIdentityInformation. The LedgerIdentityInformation is compatible with + MutableMapping + :rtype: ~azure.confidentialledger.certificate.models.LedgerIdentityInformation + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.LedgerIdentityInformation] = kwargs.pop("cls", None) + + _request = build_confidential_ledger_certificate_get_ledger_identity_request( + ledger_id=ledger_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "certificateEndpoint": self._serialize.url( + "self._config.certificate_endpoint", self._config.certificate_endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize(_models.ConfidentialLedgerError, response) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.LedgerIdentityInformation, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_operations/_patch.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_operations/_patch.py new file mode 100644 index 000000000000..8bcb627aa475 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_operations/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_patch.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_patch.py new file mode 100644 index 000000000000..8bcb627aa475 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_utils/__init__.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_utils/__init__.py new file mode 100644 index 000000000000..8026245c2abc --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_utils/__init__.py @@ -0,0 +1,6 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_utils/model_base.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_utils/model_base.py new file mode 100644 index 000000000000..12926fa98dcf --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_utils/model_base.py @@ -0,0 +1,1237 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, broad-except + +import copy +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +import xml.etree.ElementTree as ET +from collections.abc import MutableMapping +from typing_extensions import Self +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null +from azure.core.rest import HttpResponse + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +def _deserialize_int_as_str(attr): + if isinstance(attr, int): + return attr + return int(attr) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if annotation is int and rf and rf._format == "str": + return _deserialize_int_as_str + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) # pyright: ignore + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): + def __init__(self, data: dict[str, typing.Any]) -> None: + self._data = data + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + """ + :returns: a set-like object providing a view on D's keys + :rtype: ~typing.KeysView + """ + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + """ + :returns: an object providing a view on D's values + :rtype: ~typing.ValuesView + """ + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + """ + :returns: set-like object providing a view on D's items + :rtype: ~typing.ItemsView + """ + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + """ + Get the value for key if key is in the dictionary, else default. + :param str key: The key to look up. + :param any default: The value to return if key is not in the dictionary. Defaults to None + :returns: D[k] if k in D, else d. + :rtype: any + """ + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: ... # pylint: disable=arguments-differ + + @typing.overload + def pop(self, key: str, default: _T) -> _T: ... # pylint: disable=signature-differs + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Removes specified key and return the corresponding value. + :param str key: The key to pop. + :param any default: The value to return if key is not in the dictionary + :returns: The value corresponding to the key. + :rtype: any + :raises KeyError: If key is not found and default is not given. + """ + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> tuple[str, typing.Any]: + """ + Removes and returns some (key, value) pair + :returns: The (key, value) pair. + :rtype: tuple + :raises KeyError: if D is empty. + """ + return self._data.popitem() + + def clear(self) -> None: + """ + Remove all items from D. + """ + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: # pylint: disable=arguments-differ + """ + Updates D from mapping/iterable E and F. + :param any args: Either a mapping object or an iterable of key-value pairs. + """ + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Same as calling D.get(k, d), and setting D[k]=d if k not found + :param str key: The key to look up. + :param any default: The value to set if key is not in the dictionary + :returns: D[k] if k in D, else d. + :rtype: any + """ + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + if isinstance(o, int): + if format == "str": + return str(o) + return o + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field(attr_to_rest_field: dict[str, "_RestField"], rest_name: str) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + if isinstance(value, ET.Element): + value = _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +class Model(_MyMutableMapping): + _is_model = True + # label whether current class's _attr_to_rest_field has been calculated + # could not see _attr_to_rest_field directly because subclass inherits it from parent class + _calculated: set[str] = set() + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: # pylint: disable=too-many-nested-blocks + if isinstance(args[0], ET.Element): + existed_attr_keys = [] + model_meta = getattr(self, "_xml", {}) + + for rf in self._attr_to_rest_field.values(): + prop_meta = getattr(rf, "_xml", {}) + xml_name = prop_meta.get("name", rf._rest_name) + xml_ns = prop_meta.get("ns", model_meta.get("ns", None)) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + # attribute + if prop_meta.get("attribute", False) and args[0].get(xml_name) is not None: + existed_attr_keys.append(xml_name) + dict_to_pass[rf._rest_name] = _deserialize(rf._type, args[0].get(xml_name)) + continue + + # unwrapped element is array + if prop_meta.get("unwrapped", False): + # unwrapped array could either use prop items meta/prop meta + if prop_meta.get("itemsName"): + xml_name = prop_meta.get("itemsName") + xml_ns = prop_meta.get("itemNs") + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + items = args[0].findall(xml_name) # pyright: ignore + if len(items) > 0: + existed_attr_keys.append(xml_name) + dict_to_pass[rf._rest_name] = _deserialize(rf._type, items) + continue + + # text element is primitive type + if prop_meta.get("text", False): + if args[0].text is not None: + dict_to_pass[rf._rest_name] = _deserialize(rf._type, args[0].text) + continue + + # wrapped element could be normal property or array, it should only have one element + item = args[0].find(xml_name) + if item is not None: + existed_attr_keys.append(xml_name) + dict_to_pass[rf._rest_name] = _deserialize(rf._type, item) + + # rest thing is additional properties + for e in args[0]: + if e.tag not in existed_attr_keys: + dict_to_pass[e.tag] = _convert_element(e) + else: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: + if f"{cls.__module__}.{cls.__qualname__}" not in cls._calculated: + # we know the last nine classes in mro are going to be 'Model', '_MyMutableMapping', 'MutableMapping', + # 'Mapping', 'Collection', 'Sized', 'Iterable', 'Container' and 'object' + mros = cls.__mro__[:-9][::-1] # ignore parents, and reverse the mro order + attr_to_rest_field: dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") + for k, v in mro_class.__annotations__.items() + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: dict[str, _RestField] = dict(attr_to_rest_field.items()) + cls._calculated.add(f"{cls.__module__}.{cls.__qualname__}") + + return super().__new__(cls) + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional["_RestField"]: + for v in cls.__dict__.values(): + if isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators: + return v + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + if discriminator is None: + return cls(data) + exist_discriminators.append(discriminator._rest_name) + if isinstance(data, ET.Element): + model_meta = getattr(cls, "_xml", {}) + prop_meta = getattr(discriminator, "_xml", {}) + xml_name = prop_meta.get("name", discriminator._rest_name) + xml_ns = prop_meta.get("ns", model_meta.get("ns", None)) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + if data.get(xml_name) is not None: + discriminator_value = data.get(xml_name) + else: + discriminator_value = data.find(xml_name).text # pyright: ignore + else: + discriminator_value = data.get(discriminator._rest_name) + mapped_cls = cls.__mapping__.get(discriminator_value, cls) # pyright: ignore # pylint: disable=no-member + return mapped_cls._deserialize(data, exist_discriminators) + + def as_dict(self, *, exclude_readonly: bool = False) -> dict[str, typing.Any]: + """Return a dict that can be turned into json using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + +def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + +def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + +def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj: dict[typing.Any, typing.Any], +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = {child.tag: child for child in obj} + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + +def _deserialize_multiple_sequence( + entry_deserializers: list[typing.Optional[typing.Callable]], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry, deserializer in zip(obj, entry_deserializers)) + + +def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = list(obj) + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + +def _sorted_annotations(types: list[typing.Any]) -> list[typing.Any]: + return sorted( + types, + key=lambda x: hasattr(x, "__name__") and x.__name__.lower() in ("str", "float", "int", "bool"), + ) + + +def _get_deserialize_callable_from_annotation( # pylint: disable=too-many-return-statements, too-many-statements, too-many-branches + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) # type: ignore + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore + if len(annotation.__args__) <= 2: # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + # the type is Optional[Union[...]], we need to remove the None type from the Union + annotation_copy = copy.copy(annotation) + annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a != type(None)] # pyright: ignore + return _get_deserialize_callable_from_annotation(annotation_copy, module, rf) + except AttributeError: + pass + + # is it union? + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in _sorted_annotations(annotation.__args__) # pyright: ignore + ] + + return functools.partial(_deserialize_with_union, deserializers) + + try: + annotation_name = ( + annotation.__name__ if hasattr(annotation, "__name__") else annotation._name # pyright: ignore + ) + if annotation_name.lower() == "dict": + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + return functools.partial( + _deserialize_dict, + value_deserializer, + module, + ) + except (AttributeError, IndexError): + pass + try: + annotation_name = ( + annotation.__name__ if hasattr(annotation, "__name__") else annotation._name # pyright: ignore + ) + if annotation_name.lower() in ["list", "set", "tuple", "sequence"]: + if len(annotation.__args__) > 1: # pyright: ignore + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers, module) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_sequence, deserializer, module) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): # pylint: disable=too-many-return-statements + try: + if value is None or isinstance(value, _Null): + return None + if isinstance(value, ET.Element): + if deserializer is str: + return value.text or "" + if deserializer is int: + return int(value.text) if value.text else None + if deserializer is float: + return float(value.text) if value.text else None + if deserializer is bool: + return value.text == "true" if value.text else None + if deserializer is None: + return value + if deserializer in [int, float, bool]: + return deserializer(value) + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value) + except ValueError: + # for unknown value, return raw value + return value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +def _failsafe_deserialize( + deserializer: typing.Any, + response: HttpResponse, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + try: + return _deserialize(deserializer, response.json(), module, rf, format) + except DeserializationError: + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +def _failsafe_deserialize_xml( + deserializer: typing.Any, + response: HttpResponse, +) -> typing.Any: + try: + return _deserialize_xml(deserializer, response.text()) + except DeserializationError: + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[list[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[dict[str, typing.Any]] = None, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + self._xml = xml if xml is not None else {} + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + item = obj.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) + + def __set__(self, obj: Model, value) -> None: + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[list[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[dict[str, typing.Any]] = None, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + xml=xml, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[list[str]] = None, + xml: typing.Optional[dict[str, typing.Any]] = None, +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True, visibility=visibility, xml=xml) + + +def serialize_xml(model: Model, exclude_readonly: bool = False) -> str: + """Serialize a model to XML. + + :param Model model: The model to serialize. + :param bool exclude_readonly: Whether to exclude readonly properties. + :returns: The XML representation of the model. + :rtype: str + """ + return ET.tostring(_get_element(model, exclude_readonly), encoding="unicode") # type: ignore + + +def _get_element( + o: typing.Any, + exclude_readonly: bool = False, + parent_meta: typing.Optional[dict[str, typing.Any]] = None, + wrapped_element: typing.Optional[ET.Element] = None, +) -> typing.Union[ET.Element, list[ET.Element]]: + if _is_model(o): + model_meta = getattr(o, "_xml", {}) + + # if prop is a model, then use the prop element directly, else generate a wrapper of model + if wrapped_element is None: + wrapped_element = _create_xml_element( + model_meta.get("name", o.__class__.__name__), + model_meta.get("prefix"), + model_meta.get("ns"), + ) + + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + + for k, v in o.items(): + # do not serialize readonly properties + if exclude_readonly and k in readonly_props: + continue + + prop_rest_field = _get_rest_field(o._attr_to_rest_field, k) + if prop_rest_field: + prop_meta = getattr(prop_rest_field, "_xml").copy() + # use the wire name as xml name if no specific name is set + if prop_meta.get("name") is None: + prop_meta["name"] = k + else: + # additional properties will not have rest field, use the wire name as xml name + prop_meta = {"name": k} + + # if no ns for prop, use model's + if prop_meta.get("ns") is None and model_meta.get("ns"): + prop_meta["ns"] = model_meta.get("ns") + prop_meta["prefix"] = model_meta.get("prefix") + + if prop_meta.get("unwrapped", False): + # unwrapped could only set on array + wrapped_element.extend(_get_element(v, exclude_readonly, prop_meta)) + elif prop_meta.get("text", False): + # text could only set on primitive type + wrapped_element.text = _get_primitive_type_value(v) + elif prop_meta.get("attribute", False): + xml_name = prop_meta.get("name", k) + if prop_meta.get("ns"): + ET.register_namespace(prop_meta.get("prefix"), prop_meta.get("ns")) # pyright: ignore + xml_name = "{" + prop_meta.get("ns") + "}" + xml_name # pyright: ignore + # attribute should be primitive type + wrapped_element.set(xml_name, _get_primitive_type_value(v)) + else: + # other wrapped prop element + wrapped_element.append(_get_wrapped_element(v, exclude_readonly, prop_meta)) + return wrapped_element + if isinstance(o, list): + return [_get_element(x, exclude_readonly, parent_meta) for x in o] # type: ignore + if isinstance(o, dict): + result = [] + for k, v in o.items(): + result.append( + _get_wrapped_element( + v, + exclude_readonly, + { + "name": k, + "ns": parent_meta.get("ns") if parent_meta else None, + "prefix": parent_meta.get("prefix") if parent_meta else None, + }, + ) + ) + return result + + # primitive case need to create element based on parent_meta + if parent_meta: + return _get_wrapped_element( + o, + exclude_readonly, + { + "name": parent_meta.get("itemsName", parent_meta.get("name")), + "prefix": parent_meta.get("itemsPrefix", parent_meta.get("prefix")), + "ns": parent_meta.get("itemsNs", parent_meta.get("ns")), + }, + ) + + raise ValueError("Could not serialize value into xml: " + o) + + +def _get_wrapped_element( + v: typing.Any, + exclude_readonly: bool, + meta: typing.Optional[dict[str, typing.Any]], +) -> ET.Element: + wrapped_element = _create_xml_element( + meta.get("name") if meta else None, meta.get("prefix") if meta else None, meta.get("ns") if meta else None + ) + if isinstance(v, (dict, list)): + wrapped_element.extend(_get_element(v, exclude_readonly, meta)) + elif _is_model(v): + _get_element(v, exclude_readonly, meta, wrapped_element) + else: + wrapped_element.text = _get_primitive_type_value(v) + return wrapped_element + + +def _get_primitive_type_value(v) -> str: + if v is True: + return "true" + if v is False: + return "false" + if isinstance(v, _Null): + return "" + return str(v) + + +def _create_xml_element(tag, prefix=None, ns=None): + if prefix and ns: + ET.register_namespace(prefix, ns) + if ns: + return ET.Element("{" + ns + "}" + tag) + return ET.Element(tag) + + +def _deserialize_xml( + deserializer: typing.Any, + value: str, +) -> typing.Any: + element = ET.fromstring(value) # nosec + return _deserialize(deserializer, element) + + +def _convert_element(e: ET.Element): + # dict case + if len(e.attrib) > 0 or len({child.tag for child in e}) > 1: + dict_result: dict[str, typing.Any] = {} + for child in e: + if dict_result.get(child.tag) is not None: + if isinstance(dict_result[child.tag], list): + dict_result[child.tag].append(_convert_element(child)) + else: + dict_result[child.tag] = [dict_result[child.tag], _convert_element(child)] + else: + dict_result[child.tag] = _convert_element(child) + dict_result.update(e.attrib) + return dict_result + # array case + if len(e) > 0: + array_result: list[typing.Any] = [] + for child in e: + array_result.append(_convert_element(child)) + return array_result + # primitive case + return e.text diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_utils/serialization.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_utils/serialization.py new file mode 100644 index 000000000000..45a3e44e45cb --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_utils/serialization.py @@ -0,0 +1,2030 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + MutableMapping, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore +from typing_extensions import Self + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + :return: The deserialized data. + :rtype: object + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) from err + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + elif content_type.startswith("text/"): + return data_as_str + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + + :param bytes body_bytes: The body of the response. + :param dict headers: The headers of the response. + :returns: The deserialized data. + :rtype: object + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + +TZ_UTC = datetime.timezone.utc + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[dict[str, Any]] = {} + for k in kwargs: # pylint: disable=consider-using-dict-items + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are equal + :rtype: bool + """ + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are not equal + :rtype: bool + """ + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node. + + :returns: The XML node + :rtype: xml.etree.ElementTree.Element + """ + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, keep_readonly=keep_readonly, **kwargs + ) + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[[str, dict[str, Any], Any], Any] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs + ) + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: # pylint: disable=broad-exception-caught + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls, data: Any, content_type: Optional[str] = None) -> Self: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises DeserializationError: if something went wrong + :rtype: Self + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls, + data: Any, + key_extractors: Optional[Callable[[str, dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> Self: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param function key_extractors: A key extractor function. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises DeserializationError: if something went wrong + :rtype: Self + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result |= objects[valuetype]._flatten_subtype(key, objects) # pylint: disable=protected-access + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + + :param dict response: The initial data + :param dict objects: The class objects + :returns: The class to be used + :rtype: class + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.get(rest_api_response_key, None) or response.get(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + :returns: The decoded key + :rtype: str + """ + return key.replace("\\.", ".") + + +class Serializer: # pylint: disable=too-many-public-methods + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: dict[str, type] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize( # pylint: disable=too-many-nested-blocks, too-many-branches, too-many-statements, too-many-locals + self, target_obj, data_type=None, **kwargs + ): + """Serialize data into a string according to type. + + :param object target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises SerializationError: if serialization fails. + :returns: The serialized data. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() # pylint: disable=protected-access + try: + attributes = target_obj._attribute_map # pylint: disable=protected-access + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get( # pylint: disable=protected-access + attr_name, {} + ).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized |= target_obj.additional_properties + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, + # we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises SerializationError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized request body + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) # pylint: disable=protected-access + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param str name: The name of the URL path parameter. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :returns: The serialized URL path + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param str name: The name of the query parameter. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, list + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized query parameter + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param str name: The name of the header. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized header + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :raises AttributeError: if required data is None. + :raises ValueError: if data is None + :raises SerializationError: if serialization fails. + :returns: The serialized data. + :rtype: str, int, float, bool, dict, list + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + if data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, cast(type, data.__class__)) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): # pylint: disable=inconsistent-return-statements + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param obj data: Object to be serialized. + :param str data_type: Type of object in the iterable. + :rtype: str, int, float, bool + :return: serialized object + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + return eval(data_type)(data) # nosec # pylint: disable=eval-used + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param str data: Object to be serialized. + :rtype: str + :return: serialized object + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list data: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + Defaults to False. + :rtype: list, str + :return: serialized iterable + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :rtype: dict + :return: serialized dictionary + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + :return: serialized object + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + if obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError as exc: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) from exc + + @staticmethod + def serialize_bytearray(attr, **kwargs): # pylint: disable=unused-argument + """Serialize bytearray into base-64 string. + + :param str attr: Object to be serialized. + :rtype: str + :return: serialized base64 + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): # pylint: disable=unused-argument + """Serialize str into base-64 string. + + :param str attr: Object to be serialized. + :rtype: str + :return: serialized base64 + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Decimal object to float. + + :param decimal attr: Object to be serialized. + :rtype: float + :return: serialized decimal + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): # pylint: disable=unused-argument + """Serialize long (Py2) or int (Py3). + + :param int attr: Object to be serialized. + :rtype: int/long + :return: serialized long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + :return: serialized date + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + :return: serialized time + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + :return: serialized duration + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises TypeError: if format invalid. + :return: serialized rfc + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError as exc: + raise TypeError("RFC1123 object must be valid Datetime object.") from exc + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises SerializationError: if format invalid. + :return: serialized iso + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises SerializationError: if format invalid + :return: serialied unix + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError as exc: + raise TypeError("Unix time object must be valid Datetime object.") from exc + + +def rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(list[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor( # pylint: disable=unused-argument, inconsistent-return-statements + attr, attr_desc, data +): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument,too-many-return-statements + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer: + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: dict[str, type] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): # pylint: disable=inconsistent-return-statements + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): # pylint: disable=protected-access + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, str): + return self.deserialize_data(data, response) + if isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None or data is CoreNull: + return data + try: + attributes = response._attribute_map # type: ignore # pylint: disable=protected-access + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :return: The classified target object and its class name. + :rtype: tuple + """ + if target is None: + return None, None + + if isinstance(target, str): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) # type: ignore # pylint: disable=protected-access + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + :return: Deserialized object. + :rtype: object + """ + try: + return self(target_obj, data, content_type=content_type) + except: # pylint: disable=bare-except + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param obj raw_data: Data to be processed. + :param str content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + :rtype: object + :return: Unpacked content. + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param Response response: The response model class. + :param dict attrs: The deserialized response attributes. + :param dict additional_properties: Additional properties to be set. + :rtype: Response + :return: The instantiated response model. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("readonly") + ] + const = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("constant") + ] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties # type: ignore + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) from err + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) from exp + + def deserialize_data(self, data, data_type): # pylint: disable=too-many-return-statements + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in [ # pylint: disable=unnecessary-lambda-assignment + "object", + "[]", + r"{}", + ] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :return: Deserialized iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :return: Deserialized dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :return: Deserialized object. + :rtype: dict + :raises TypeError: if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, str): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): # pylint: disable=too-many-return-statements + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :return: Deserialized basic type. + :rtype: str, int, float or bool + :raises TypeError: if string format is not valid. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + if isinstance(attr, str): + if attr.lower() in ["true", "1"]: + return True + if attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + return eval(data_type)(attr) # nosec # pylint: disable=eval-used + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :return: Deserialized string. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :return: Deserialized enum object. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError as exc: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) from exc + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :return: Deserialized bytearray + :rtype: bytearray + :raises TypeError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :return: Deserialized base64 string + :rtype: bytearray + :raises TypeError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :return: Deserialized decimal + :raises DeserializationError: if string format invalid. + :rtype: decimal + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :return: Deserialized int + :rtype: long or int + :raises ValueError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :return: Deserialized duration + :rtype: TimeDelta + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :return: Deserialized date + :rtype: Date + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :return: Deserialized time + :rtype: datetime.time + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :return: Deserialized RFC datetime + :rtype: Datetime + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=datetime.timezone(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :return: Deserialized ISO datetime + :rtype: Datetime + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :return: Deserialized datetime + :rtype: Datetime + :raises DeserializationError: if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + return date_obj diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_utils/utils.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_utils/utils.py new file mode 100644 index 000000000000..35c9c836f85f --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_utils/utils.py @@ -0,0 +1,25 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import Generic, TYPE_CHECKING, TypeVar + +if TYPE_CHECKING: + from .serialization import Deserializer, Serializer + + +TClient = TypeVar("TClient") +TConfig = TypeVar("TConfig") + + +class ClientMixinABC(ABC, Generic[TClient, TConfig]): + """DO NOT use this class. It is for internal typing use only.""" + + _client: TClient + _config: TConfig + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_version.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_version.py new file mode 100644 index 000000000000..be71c81bd282 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/_version.py @@ -0,0 +1,9 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/__init__.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/__init__.py new file mode 100644 index 000000000000..32e51aef5bae --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/__init__.py @@ -0,0 +1,29 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import ConfidentialLedgerCertificateClient # type: ignore + +try: + from ._patch import __all__ as _patch_all + from ._patch import * +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "ConfidentialLedgerCertificateClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore + +_patch_sdk() diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_client.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_client.py new file mode 100644 index 000000000000..1de15713ece8 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_client.py @@ -0,0 +1,106 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, Awaitable +from typing_extensions import Self + +from azure.core import AsyncPipelineClient +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._utils.serialization import Deserializer, Serializer +from ._configuration import ConfidentialLedgerCertificateClientConfiguration +from ._operations import _ConfidentialLedgerCertificateClientOperationsMixin + + +class ConfidentialLedgerCertificateClient(_ConfidentialLedgerCertificateClientOperationsMixin): + """The Confidential Ledger Certificate endpoint is used to retrieve the TLS certificate + required for connecting to a Confidential Ledger. + + :keyword certificate_endpoint: The certificate endpoint (or "Identity Service Endpoint" in the + Azure portal), for example `https://identity.confidential-ledger.core.azure.com + `_. Default value is + "https://identity.confidential-ledger.core.azure.com". + :paramtype certificate_endpoint: str + :keyword api_version: The API version to use for this operation. Default value is + "2024-12-09-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__( # pylint: disable=missing-client-constructor-parameter-credential + self, *, certificate_endpoint: str = "https://identity.confidential-ledger.core.azure.com", **kwargs: Any + ) -> None: + _endpoint = "{certificateEndpoint}" + self._config = ConfidentialLedgerCertificateClientConfiguration( + certificate_endpoint=certificate_endpoint, **kwargs + ) + + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "certificateEndpoint": self._serialize.url( + "self._config.certificate_endpoint", self._config.certificate_endpoint, "str", skip_quote=True + ), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> Self: + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_configuration.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_configuration.py new file mode 100644 index 000000000000..3dc90218ed1b --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_configuration.py @@ -0,0 +1,53 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any + +from azure.core.pipeline import policies + +from .._version import VERSION + + +class ConfidentialLedgerCertificateClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for ConfidentialLedgerCertificateClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param certificate_endpoint: The certificate endpoint (or "Identity Service Endpoint" in the + Azure portal), for example `https://identity.confidential-ledger.core.azure.com + `_. Default value is + "https://identity.confidential-ledger.core.azure.com". + :type certificate_endpoint: str + :keyword api_version: The API version to use for this operation. Default value is + "2024-12-09-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__( + self, certificate_endpoint: str = "https://identity.confidential-ledger.core.azure.com", **kwargs: Any + ) -> None: + api_version: str = kwargs.pop("api_version", "2024-12-09-preview") + + self.certificate_endpoint = certificate_endpoint + self.api_version = api_version + kwargs.setdefault("sdk_moniker", "confidentialledger-certificate/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_operations/__init__.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_operations/__init__.py new file mode 100644 index 000000000000..f537d5b7aba9 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_operations/__init__.py @@ -0,0 +1,24 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._operations import _ConfidentialLedgerCertificateClientOperationsMixin # type: ignore # pylint: disable=unused-import + +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_operations/_operations.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_operations/_operations.py new file mode 100644 index 000000000000..59ba4f992dc2 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_operations/_operations.py @@ -0,0 +1,107 @@ +# pylint: disable=line-too-long,useless-suppression +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from collections.abc import MutableMapping +from typing import Any, Callable, Optional, TypeVar + +from azure.core import AsyncPipelineClient +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator_async import distributed_trace_async + +from ... import models as _models +from ..._operations._operations import build_confidential_ledger_certificate_get_ledger_identity_request +from ..._utils.model_base import _deserialize, _failsafe_deserialize +from ..._utils.utils import ClientMixinABC +from .._configuration import ConfidentialLedgerCertificateClientConfiguration + +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, dict[str, Any]], Any]] + + +class _ConfidentialLedgerCertificateClientOperationsMixin( + ClientMixinABC[ + AsyncPipelineClient[HttpRequest, AsyncHttpResponse], ConfidentialLedgerCertificateClientConfiguration + ] +): + + @distributed_trace_async + async def get_ledger_identity(self, ledger_id: str, **kwargs: Any) -> _models.LedgerIdentityInformation: + """Gets identity information for a Confidential Ledger instance. + + Gets identity information for a Confidential Ledger instance. + + :param ledger_id: Id of the Confidential Ledger instance to get information for. Required. + :type ledger_id: str + :return: LedgerIdentityInformation. The LedgerIdentityInformation is compatible with + MutableMapping + :rtype: ~azure.confidentialledger.certificate.models.LedgerIdentityInformation + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.LedgerIdentityInformation] = kwargs.pop("cls", None) + + _request = build_confidential_ledger_certificate_get_ledger_identity_request( + ledger_id=ledger_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "certificateEndpoint": self._serialize.url( + "self._config.certificate_endpoint", self._config.certificate_endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize(_models.ConfidentialLedgerError, response) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.LedgerIdentityInformation, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_operations/_patch.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_operations/_patch.py new file mode 100644 index 000000000000..8bcb627aa475 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_operations/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_patch.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_patch.py new file mode 100644 index 000000000000..8bcb627aa475 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/aio/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/models/__init__.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/models/__init__.py new file mode 100644 index 000000000000..5c0bbc50f4e6 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/models/__init__.py @@ -0,0 +1,31 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + + +from ._models import ( # type: ignore + ConfidentialLedgerError, + ConfidentialLedgerErrorBody, + LedgerIdentityInformation, +) +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "ConfidentialLedgerError", + "ConfidentialLedgerErrorBody", + "LedgerIdentityInformation", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/models/_models.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/models/_models.py new file mode 100644 index 000000000000..0267c036233e --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/models/_models.py @@ -0,0 +1,76 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=useless-super-delegation + +from typing import Any, Mapping, Optional, TYPE_CHECKING, overload + +from .._utils.model_base import Model as _Model, rest_field + +if TYPE_CHECKING: + from .. import models as _models + + +class ConfidentialLedgerError(_Model): + """An error response from Confidential Ledger. + + :ivar error: An error response from Confidential Ledger. + :vartype error: ~azure.confidentialledger.certificate.models.ConfidentialLedgerErrorBody + """ + + error: Optional["_models.ConfidentialLedgerErrorBody"] = rest_field(visibility=["read"]) + """An error response from Confidential Ledger.""" + + +class ConfidentialLedgerErrorBody(_Model): + """An error response from Confidential Ledger. + + :ivar code: The error code. + :vartype code: str + :ivar message: The error message. + :vartype message: str + """ + + code: Optional[str] = rest_field(visibility=["read"]) + """The error code.""" + message: Optional[str] = rest_field(visibility=["read"]) + """The error message.""" + + +class LedgerIdentityInformation(_Model): + """Contains the information about a Confidential Ledger. + + :ivar ledger_id: Id for the ledger. + :vartype ledger_id: str + :ivar ledger_tls_certificate: PEM-encoded certificate used for TLS by the Confidential Ledger. + Required. + :vartype ledger_tls_certificate: str + """ + + ledger_id: Optional[str] = rest_field(name="ledgerId", visibility=["read"]) + """Id for the ledger.""" + ledger_tls_certificate: str = rest_field( + name="ledgerTlsCertificate", visibility=["read", "create", "update", "delete", "query"] + ) + """PEM-encoded certificate used for TLS by the Confidential Ledger. Required.""" + + @overload + def __init__( + self, + *, + ledger_tls_certificate: str, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/models/_patch.py b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/models/_patch.py new file mode 100644 index 000000000000..8bcb627aa475 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/models/_patch.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/py.typed b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/azure/confidentialledger/certificate/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/dev_requirements.txt b/sdk/confidentialledger/azure-confidentialledger-certificate/dev_requirements.txt new file mode 100644 index 000000000000..0e53b6a72db5 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/dev_requirements.txt @@ -0,0 +1,3 @@ +-e ../../../eng/tools/azure-sdk-tools +../../core/azure-core +aiohttp \ No newline at end of file diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/pyproject.toml b/sdk/confidentialledger/azure-confidentialledger-certificate/pyproject.toml new file mode 100644 index 000000000000..43dd27cccf33 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/pyproject.toml @@ -0,0 +1,59 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +[build-system] +requires = ["setuptools>=77.0.3", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "azure-confidentialledger-certificate" +authors = [ + { name = "Microsoft Corporation", email = "azpysdkhelp@microsoft.com" }, +] +description = "Microsoft Corporation Azure Confidential Ledger Certificate Client Library for Python" +license = "MIT" +classifiers = [ + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", +] +requires-python = ">=3.9" +keywords = ["azure", "azure sdk"] + +dependencies = [ + "isodate>=0.6.1", + "azure-core>=1.35.0", + "typing-extensions>=4.6.0", +] +dynamic = [ +"version", "readme" +] + +[project.urls] +repository = "https://github.com/Azure/azure-sdk-for-python" + +[tool.setuptools.dynamic] +version = {attr = "azure.confidentialledger.certificate._version.VERSION"} +readme = {file = ["README.md", "CHANGELOG.md"], content-type = "text/markdown"} + +[tool.setuptools.packages.find] +exclude = [ + "tests*", + "samples*", + "doc*", + "azure", + "azure.confidentialledger", +] + +[tool.setuptools.package-data] +pytyped = ["py.typed"] diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/samples/README.md b/sdk/confidentialledger/azure-confidentialledger-certificate/samples/README.md new file mode 100644 index 000000000000..413a200c36e3 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/samples/README.md @@ -0,0 +1,46 @@ +--- +page_type: sample +languages: + - python +products: + - azure + - azure-confidentialledger +urlFragment: azure-confidentialledger-certificate-samples +--- + +# Azure Confidential Ledger Certificate client library for Python Samples + +These are code samples that show common scenario operations with the Azure Confidential Ledger Certificate client library. +The async versions of the samples (the python sample files appended with `_async`) show asynchronous operations. + +## Prerequisites + +- Python 3.6 or later is required to use this package +- You need an [Azure subscription][azure_sub], and a [Azure Confidential Ledger service instance][confidential_ledger_docs] to use this package. + +## Setup + +1. Install the Azure Confidential Ledger Certificate client library for Python with [pip](https://pypi.org/project/pip/): + +```bash +pip install azure-confidentialledger-certificate +``` + +2. Clone or download this sample repository +3. Open the sample folder in Visual Studio Code or your IDE of choice. + +## Running the samples + +1. Open a terminal window and `cd` to the directory that the samples are saved in. +2. Set the environment variables specified in the sample file you wish to run. +3. Follow the usage described in the file. + +## Next Steps + +Take a look at our [API Documentation][reference_docs] for more information about the APIs that are available in the clients. + + + +[azure_sub]: https://azure.microsoft.com/free/ +[confidential_ledger_docs]: https://aka.ms/confidentialledger-servicedocs +[reference_docs]: https://aka.ms/azsdk/python/confidentialledger/ref-docs diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/samples/get_certificate.py b/sdk/confidentialledger/azure-confidentialledger-certificate/samples/get_certificate.py new file mode 100644 index 000000000000..12104d160325 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/samples/get_certificate.py @@ -0,0 +1,71 @@ +# pylint: disable=line-too-long,useless-suppression +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +""" +FILE: get_certificate.py +DESCRIPTION: + This sample demonstrates how to get the certificate from the Confidential Ledger identity service. +USAGE: + python get_certificate.py + Set the environment variables with your own values before running the sample: + 1) CONFIDENTIALLEDGER_ENDPOINT - the endpoint of the Confidential Ledger. +""" + +import logging +import os +import sys +import tempfile + +from azure.confidentialledger.certificate import ( + ConfidentialLedgerCertificateClient, +) + + +logging.basicConfig(level=logging.ERROR) +LOG = logging.getLogger() + + +def main(): + # Set the values of the following environment variables before running the sample: + # CONFIDENTIALLEDGER_ENDPOINT + try: + ledger_endpoint = os.environ["CONFIDENTIALLEDGER_ENDPOINT"] + except KeyError: + LOG.error( + "Missing environment variable 'CONFIDENTIALLEDGER_ENDPOINT' - " "please set it before running the example" + ) + sys.exit(1) + + # Under the current URI format, the ledger id is the first part of the ledger endpoint. + # i.e. https://.confidential-ledger.azure.com + ledger_id = ledger_endpoint.replace("https://", "").split(".")[0] + + identity_service_client = ConfidentialLedgerCertificateClient() # type: ignore[call-arg] + ledger_certificate = identity_service_client.get_ledger_identity(ledger_id) + + # The Confidential Ledger's TLS certificate must be written to a file to be used by the + # ConfidentialLedgerClient from the azure-confidentialledger package. Here, we write it to + # a temporary file so that is is cleaned up automatically when the program exits. + with tempfile.TemporaryDirectory() as tempdir: + ledger_cert_file = os.path.join(tempdir, f"{ledger_id}.pem") + with open(ledger_cert_file, "w") as outfile: + outfile.write(ledger_certificate["ledgerTlsCertificate"]) + + print( + f"Ledger certificate has been written to {ledger_cert_file}. " + "It will be deleted when the script completes." + ) + + print( + "The certificate can be used to create a ConfidentialLedgerClient instance." + "See samples for the azure-confidentialledger package for details:" + "https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/confidentialledger/azure-confidentialledger/samples" + ) + + +if __name__ == "__main__": + main() diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/samples/get_certificate_async.py b/sdk/confidentialledger/azure-confidentialledger-certificate/samples/get_certificate_async.py new file mode 100644 index 000000000000..93de2501170d --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/samples/get_certificate_async.py @@ -0,0 +1,73 @@ +# pylint: disable=line-too-long,useless-suppression +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +""" +FILE: get_certificate_async.py +DESCRIPTION: + This sample demonstrates how to get the certificate from the Confidential Ledger identity service. +USAGE: + python get_certificate_async.py + Set the environment variables with your own values before running the sample: + 1) CONFIDENTIALLEDGER_ENDPOINT - the endpoint of the Confidential Ledger. +""" + +import asyncio +import logging +import os +import sys +import tempfile + +from azure.confidentialledger.certificate.aio import ( + ConfidentialLedgerCertificateClient, +) + + +logging.basicConfig(level=logging.ERROR) +LOG = logging.getLogger() + + +async def main(): + # Set the values of the following environment variables before running the sample: + # CONFIDENTIALLEDGER_ENDPOINT + try: + ledger_endpoint = os.environ["CONFIDENTIALLEDGER_ENDPOINT"] + except KeyError: + LOG.error( + "Missing environment variable 'CONFIDENTIALLEDGER_ENDPOINT' - " "please set it before running the example" + ) + sys.exit(1) + + # Under the current URI format, the ledger id is the first part of the ledger endpoint. + # i.e. https://.confidential-ledger.azure.com + ledger_id = ledger_endpoint.replace("https://", "").split(".")[0] + + identity_service_client = ConfidentialLedgerCertificateClient() # type: ignore[call-arg] + async with identity_service_client: + ledger_certificate = await identity_service_client.get_ledger_identity(ledger_id) + + # The Confidential Ledger's TLS certificate must be written to a file to be used by the + # ConfidentialLedgerClient. Here, we write it to a temporary file so that is is cleaned up + # automatically when the program exits. + with tempfile.TemporaryDirectory() as tempdir: + ledger_cert_file = os.path.join(tempdir, f"{ledger_id}.pem") + with open(ledger_cert_file, "w") as outfile: + outfile.write(ledger_certificate["ledgerTlsCertificate"]) + + print( + f"Ledger certificate has been written to {ledger_cert_file}. " + "It will be deleted when the script completes." + ) + + print( + "The certificate can be used to create a ConfidentialLedgerClient instance." + "See samples for the azure-confidentialledger package for details:" + "https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/confidentialledger/azure-confidentialledger/samples" + ) + + +if __name__ == "__main__": + asyncio.run(main()) diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/tests/_shared/__init__.py b/sdk/confidentialledger/azure-confidentialledger-certificate/tests/_shared/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/tests/_shared/constants.py b/sdk/confidentialledger/azure-confidentialledger-certificate/tests/_shared/constants.py new file mode 100644 index 000000000000..fac368a9bbbf --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/tests/_shared/constants.py @@ -0,0 +1,74 @@ +# pylint: disable=line-too-long,useless-suppression +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ + +import os + +TEST_PROXY_CERT = os.path.abspath( + os.path.join( + os.path.dirname(__file__), "..", "..", "..", "..", "..", "eng", "common", "testproxy", "dotnet-devcert.crt" + ) +) + +# Duplicate certificate from KeyVault. +# https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/keyvault/azure-keyvault-certificates/tests/ca.crt +USER_CERTIFICATE_PUBLIC_KEY = """-----BEGIN CERTIFICATE----- +MIIDazCCAlOgAwIBAgIUYju9zymmCCF7rCaROzfZs0pNgmkwDQYJKoZIhvcNAQEL +BQAwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoM +GEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDAeFw0xOTA4MjgyMjU0MTNaFw0xOTA5 +MjcyMjU0MTNaMEUxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEw +HwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwggEiMA0GCSqGSIb3DQEB +AQUAA4IBDwAwggEKAoIBAQD0YrMz5atoPmTTxLtCO69kM3E97bdjJgyAVZJS9mP3 +HQyHkFNb09eDeAAzcZLR5nYXX7yweowTWVcIe3k9+Z/tUeVrAlOVe2COaIHAUZIh +jELq/u8257/8MqqbKXhsyrWNAVDyKndDgvbbgxNsUTbMoAe9BCL/5fzowsnPLaCI +MCYRaQJUySbIoTmKi11hF09CFFSkL9nvfQODFyEde6JHPWrVRse2lioPLJeC9LoU +GNNZnbqry+UbHp4vORPp6OQTqBTm1ZVWPzCuYuWUmEe27K7zghEJr/Yx0OLq9kI5 +H960CSOkdhsOTcBkORfhivSQnmOn2RnCPIEsUTzjwXNZAgMBAAGjUzBRMB0GA1Ud +DgQWBBQIAunu6y1BmFSDfFNfTnqFggB0gzAfBgNVHSMEGDAWgBQIAunu6y1BmFSD +fFNfTnqFggB0gzAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQAr ++RM7gbqWRXnWJwE/hV/ZI2hXAhDN4RYQ4fWMJfg/E9wcLeqqRtJhXbqpJW08IZWp +QKcWfrFcfZ3ZxVAi5Ey+iuvD2VeBf9v5RZI4c9JqswS9xG2A1x/BeGcUk1y/q9E5 +4whf5fLSJQVxK+C53yemoHPrBg8zVhLJv5SG7Uw7jcqiQvu2aHGGWPLiO7mmMPtP +qO/I+6FjXuBpNomTqM897MY3Qzg43rpoCilpOpkRtMHknfhFxt05p+Fn73Fb60ru +ZsFRA52lsEBxGmI0QmXGjwkUZFwQTXEDUWwId3VJxoHRZwv1gmHfwhkYt+mNWJDa +mU7AMDzlQRwGC8hpWJRT +-----END CERTIFICATE-----""" + +# https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/keyvault/azure-keyvault-certificates/tests/ca.key +USER_CERTIFICATE_PRIVATE_KEY = ( + "-----BEGIN RSA PRIVATE KEY-----\n" # [SuppressMessage("Microsoft.Security", "CS001:SecretInline", Justification="Test secret that is found elsewhere in this repo")] + """MIIEpQIBAAKCAQEA9GKzM+WraD5k08S7QjuvZDNxPe23YyYMgFWSUvZj9x0Mh5BT +W9PXg3gAM3GS0eZ2F1+8sHqME1lXCHt5Pfmf7VHlawJTlXtgjmiBwFGSIYxC6v7v +Nue//DKqmyl4bMq1jQFQ8ip3Q4L224MTbFE2zKAHvQQi/+X86MLJzy2giDAmEWkC +VMkmyKE5iotdYRdPQhRUpC/Z730DgxchHXuiRz1q1UbHtpYqDyyXgvS6FBjTWZ26 +q8vlGx6eLzkT6ejkE6gU5tWVVj8wrmLllJhHtuyu84IRCa/2MdDi6vZCOR/etAkj +pHYbDk3AZDkX4Yr0kJ5jp9kZwjyBLFE848FzWQIDAQABAoIBAHrhegv5SrOy083r +mODX0/wFJcam1dRD2HtbC6UtgNxLPfaYKmH85duUJj23uMRUJkLgf6cZJ3+/J1T7 +iN4Ru0mAKWQiGlcKX2WbxMon+dtmhGtW3n90DgPIkiJMuuGxF5Kb+9CYa7mFi4ya +ntSTDYPcX6e6AcM8KGv9La4/2f0/hQKCN3jZbnQ/GqjnJdxrAV1KV0IMoNPpZmat +Sa0EZ9eiR57/xAe1OxceEt0nO7hAl+jX7tFEGvaNClKG2OMgZ+oHOxI+s9jW8DyD +wRJbd0hxUl/KXLxzyeFTBdLxB+SQtlcr4w5khyt3AvlKd4Iveqkq2FBCtfATYitt ++Ic61IUCgYEA/j4mMdo+qokzACmGJWEquC6yNoUI5aYsHTRVvX0sLpBX7MapIEwM +zHdvMEFBxw8rs7ll1xELW+dnbIZqj/ou43E3+PSgovdFGOA8kQlPpcIIutTEZQh7 +dlWzvAVZr0iO4xfXY2gFQot41fY4yRy8Q14ayo/VjQK4uKlnGqqlmwsCgYEA9hMc +FIAYpit7779tKD+O4vEkMoTkIxqSAZUuOZ5qB5UaF4Y/+MIGZUnrjJlGLnoFQmsP +CVPVMOQKV7yjg0LBadeDHEjESwHJNk0qxPSXWuXGlu01yVkqUehNumSBdnSLBmjR +jNIxPVEmW9d6+eAzIFiTkwqM9cAuLb75DL++iasCgYEAxhqzNEE0dzl0zfmNF29B +FEb+glDi/96dnRv8eywf0yCSAmNBwXLAvkmKD/WpRWxixyX9XrlfOntzMTMDsbBl +/L9pt8kVqiY2Zw3C49h3gVdR6hKD/Z3AZhKdfDJHEbfd7sHTCRgykQmQXFgBI2QK +pguboJ627atjODB3sGWrqMUCgYEA2QoJ3lsNYqM/8TpaQQGuOaSPVK+5uOyakyLN +XqzGwGFWXiFfEz2u/m+wfpZCPIQLV4WuAYAbrb+1D6WmYwPiLESVs8DKwY2Vt3tg +mc9SIC5CdqRKqIkoto264Qf82En6xXB2Q0qxe2+z8ZWhNfv1nDYEE9FeevNCx76F +VCVbHXkCgYEA4+FD1q6iwl9wsAOKFVo+W044/MhKHDsyIED3YOzeRTAWRl2w/KX0 +c5ty2KecGu0cVXoAv2YUttHsuMZfm/QdosZr9UB4CR2lmzRys3LSx6QzCkZeMb/s +QOMs6SYCPXggdXCAu9EVf5+TtYQg7aQNTTuYErlyq2g/tk3un8bHTwI= +-----END RSA PRIVATE KEY-----""" +) + +USER_CERTIFICATE = f"{USER_CERTIFICATE_PUBLIC_KEY}\n{USER_CERTIFICATE_PRIVATE_KEY}" + +USER_CERTIFICATE_THUMBPRINT = ( + "5F:23:3D:26:E2:28:88:9C:06:E0:88:21:FA:C7:B2:9A:F8:81:30:6B:F9:15:41:F2:34:05:05:44:4C:AD:5A:B5" +) diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/tests/_shared/testcase.py b/sdk/confidentialledger/azure-confidentialledger-certificate/tests/_shared/testcase.py new file mode 100644 index 000000000000..8291d327fa70 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/tests/_shared/testcase.py @@ -0,0 +1,104 @@ +import functools +import os +import tempfile + +from devtools_testutils import ( + AzureRecordedTestCase, + EnvironmentVariableLoader, +) + +from azure.confidentialledger.certificate import ( + ConfidentialLedgerCertificateClient, +) +from azure.confidentialledger.certificate.aio import ( + ConfidentialLedgerCertificateClient as ConfidentialLedgerCertificateClientAsync, +) + +from .constants import USER_CERTIFICATE + + +ConfidentialLedgerPreparer = functools.partial( + EnvironmentVariableLoader, + "confidentialledger", + confidentialledger_id="fake", + confidentialledger_endpoint="https://fake.confidential-ledger.azure.com", + confidentialledger_resource_group="fakegroup", +) + + +class ConfidentialLedgerTestCase(AzureRecordedTestCase): + @classmethod + def setup_class(cls): + """setup any state specific to the execution of the given class (which + usually contains tests). + """ + + with tempfile.NamedTemporaryFile("w", suffix=".pem", delete=False) as tls_cert_file: + cls.network_certificate_path = tls_cert_file.name + + with tempfile.NamedTemporaryFile("w", suffix=".pem", delete=False) as user_cert_file: + user_cert_file.write(USER_CERTIFICATE) + cls.user_certificate_path = user_cert_file.name + + @classmethod + def teardown_class(cls): + """teardown any state that was previously setup with a call to + setup_class. + """ + try: + os.remove(cls.user_certificate_path) + except FileNotFoundError: + pass + + if cls.network_certificate_path: + try: + os.remove(cls.network_certificate_path) + except FileNotFoundError: + pass + + def set_ledger_identity(self, confidentialledger_id: str) -> str: + """Retrieves the Confidential Ledger's TLS certificate, saving it to the object's network + certificate path as well as returning it directly. + + :param confidentialledger_id: Id of the Confidential Ledger. + :type confidentialledger_id: str + :return: The Confidential Ledger's TLS certificate. + :rtype: str + """ + client = self.create_client_from_credential( + ConfidentialLedgerCertificateClient, + credential=None, + ) + + network_identity = client.get_ledger_identity(ledger_id=confidentialledger_id) + + with open(self.network_certificate_path, "w", encoding="utf-8") as outfile: + outfile.write(network_identity["ledgerTlsCertificate"]) + + return network_identity["ledgerTlsCertificate"] + + async def set_ledger_identity_async(self, confidentialledger_id: str) -> str: + """Retrieves the Confidential Ledger's TLS certificate, saving it to the object's network + certificate path as well as returning it directly. + + An async version of this method is needed so that this request is recorded by async tests. + + :param confidentialledger_id: Id of the Confidential Ledger. + :type confidentialledger_id: str + :return: The Confidential Ledger's TLS certificate. + :rtype: str + """ + client = self.create_client_from_credential( + ConfidentialLedgerCertificateClientAsync, + credential=None, + ) + + try: + network_identity = await client.get_ledger_identity(ledger_id=confidentialledger_id) + + with open(self.network_certificate_path, "w", encoding="utf-8") as outfile: + outfile.write(network_identity["ledgerTlsCertificate"]) + + return network_identity["ledgerTlsCertificate"] + finally: + await client.close() diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/tests/conftest.py b/sdk/confidentialledger/azure-confidentialledger-certificate/tests/conftest.py new file mode 100644 index 000000000000..4ff615f3f93f --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/tests/conftest.py @@ -0,0 +1,11 @@ +from devtools_testutils import test_proxy, remove_batch_sanitizers + +import pytest + + +# autouse=True will trigger this fixture on each pytest run, even if it's not explicitly used by a test method +@pytest.fixture(scope="session", autouse=True) +def add_sanitizers(test_proxy): + # Remove the following sanitizers since certain fields are needed in tests and are non-sensitive: + # - AZSDK3433: $..userid + remove_batch_sanitizers(["AZSDK3433"]) diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/tests/test_identity_service_client.py b/sdk/confidentialledger/azure-confidentialledger-certificate/tests/test_identity_service_client.py new file mode 100644 index 000000000000..be1a478d136b --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/tests/test_identity_service_client.py @@ -0,0 +1,24 @@ +from devtools_testutils import AzureRecordedTestCase, recorded_by_proxy + +from azure.confidentialledger.certificate import ( + ConfidentialLedgerCertificateClient, +) + +from _shared.testcase import ConfidentialLedgerPreparer + + +class TestConfidentialLedgerCertificateClient(AzureRecordedTestCase): + @ConfidentialLedgerPreparer() + @recorded_by_proxy + def test_get_ledger_identity(self, **kwargs): + confidentialledger_id = kwargs.pop("confidentialledger_id") + + client = self.create_client_from_credential( + ConfidentialLedgerCertificateClient, + credential=None, + ) + + network_identity = client.get_ledger_identity(ledger_id=confidentialledger_id) + + assert network_identity["ledgerId"] == confidentialledger_id + assert network_identity["ledgerTlsCertificate"] diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/tests/test_identity_service_client_async.py b/sdk/confidentialledger/azure-confidentialledger-certificate/tests/test_identity_service_client_async.py new file mode 100644 index 000000000000..2706a24c89a6 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/tests/test_identity_service_client_async.py @@ -0,0 +1,28 @@ +from devtools_testutils import AzureRecordedTestCase +from devtools_testutils.aio import recorded_by_proxy_async + +from azure.confidentialledger.certificate.aio import ( + ConfidentialLedgerCertificateClient, +) + +from _shared.testcase import ConfidentialLedgerPreparer + + +class TestConfidentialLedgerCertificateClient(AzureRecordedTestCase): + @ConfidentialLedgerPreparer() + @recorded_by_proxy_async + async def test_get_ledger_identity(self, **kwargs): + confidentialledger_id = kwargs.pop("confidentialledger_id") + + client = self.create_client_from_credential( + ConfidentialLedgerCertificateClient, + credential=None, + ) + + try: + network_identity = await client.get_ledger_identity(ledger_id=confidentialledger_id) + + assert network_identity["ledgerId"] == confidentialledger_id + assert network_identity["ledgerTlsCertificate"] + finally: + await client.close() diff --git a/sdk/confidentialledger/azure-confidentialledger-certificate/tsp-location.yaml b/sdk/confidentialledger/azure-confidentialledger-certificate/tsp-location.yaml new file mode 100644 index 000000000000..a4c9b37a2176 --- /dev/null +++ b/sdk/confidentialledger/azure-confidentialledger-certificate/tsp-location.yaml @@ -0,0 +1,4 @@ +directory: specification/confidentialledger/data-plane/ConfidentialLedgerIdentity +commit: e82ffadf9c017299199a75b01ea9c91ffbe292a8 +repo: Azure/azure-rest-api-specs +additionalDirectories: diff --git a/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluate/_batch_run/_run_submitter_client.py b/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluate/_batch_run/_run_submitter_client.py index bcb7d567cdee..5d270a437a09 100644 --- a/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluate/_batch_run/_run_submitter_client.py +++ b/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluate/_batch_run/_run_submitter_client.py @@ -159,6 +159,8 @@ def get_run_summary(self, client_run: BatchClientRun) -> Dict[str, Any]: "completed_lines": total_lines - failed_lines, "failed_lines": failed_lines, "log_path": None, + "error_message": f"({run.result.error.blame.value}) {run.result.error.message}" if run.result and run.result.error and run.result.error.blame else None, + "error_code": f"{run.result.error.category.value}" if run.result and run.result.error and run.result.error.category else None } @staticmethod diff --git a/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluate/_evaluate.py b/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluate/_evaluate.py index bfc96f3e86e3..3d427aff2723 100644 --- a/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluate/_evaluate.py +++ b/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluate/_evaluate.py @@ -56,7 +56,7 @@ _write_output, DataLoaderFactory, _log_metrics_and_instance_results_onedp, - _add_aoai_structured_results_to_results + _convert_results_to_aoai_evaluation_results ) from ._batch_run.batch_clients import BatchClient, BatchClientRun @@ -910,6 +910,7 @@ def _evaluate( # pylint: disable=too-many-locals,too-many-statements results_df = pd.DataFrame() metrics: Dict[str, float] = {} eval_run_info_list: List[OAIEvalRunCreationInfo] = [] + eval_run_summary_dict = {} # Start OAI eval runs if any graders are present. need_oai_run = len(graders) > 0 @@ -944,6 +945,8 @@ def _evaluate( # pylint: disable=too-many-locals,too-many-statements got_local_results = True # TODO figure out how to update this printing to include OAI results? _print_summary(per_evaluator_results) + eval_run_summary_dict = {name: result["run_summary"] for name, result in per_evaluator_results.items()} + LOGGER.info(f"run_summary: \r\n{json.dumps(eval_run_summary_dict, indent=4)}") except EvaluationException as e: if need_get_oai_results: # If there are OAI graders, we only print a warning on local failures. @@ -991,13 +994,15 @@ def _evaluate( # pylint: disable=too-many-locals,too-many-statements result_df_dict = results_df.to_dict("records") result: EvaluationResult = {"rows": result_df_dict, "metrics": metrics, "studio_url": studio_url} # type: ignore - _add_aoai_structured_results_to_results(result, LOGGER, kwargs.get("eval_meta_data")) + # _add_aoai_structured_results_to_results(result, LOGGER, kwargs.get("eval_meta_data")) + + eval_meta_data: Optional[Dict[str, Any]] = kwargs.get("eval_meta_data") + _convert_results_to_aoai_evaluation_results(result, LOGGER, eval_meta_data, eval_run_summary_dict) if app_insights_configuration := kwargs.get("app_insights_configuration"): emit_eval_result_events_to_app_insights(app_insights_configuration, result["evaluation_results_list"]) if output_path: _write_output(output_path, result) - return result diff --git a/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluate/_utils.py b/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluate/_utils.py index c198dd490881..4939cb591c91 100644 --- a/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluate/_utils.py +++ b/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluate/_utils.py @@ -487,7 +487,12 @@ def get_loader(filename: Union[os.PathLike, str]) -> Union[JSONLDataFileLoader, return JSONLDataFileLoader(filename) -def _add_aoai_structured_results_to_results(results: EvaluationResult, logger: logging.Logger, eval_meta_data: Optional[Dict[str, Any]] = None) -> None: +def _convert_results_to_aoai_evaluation_results( + results: EvaluationResult, + logger: logging.Logger, + eval_meta_data: Optional[Dict[str, Any]] = None, + eval_run_summary: Optional[Dict[str, Any]] = None +) -> None: """ Convert evaluation results to AOAI evaluation results format. @@ -525,12 +530,12 @@ def _add_aoai_structured_results_to_results(results: EvaluationResult, logger: l criteria_type = criteria.get("type") if criteria_name is not None and criteria_type is not None: testing_criteria_name_types[criteria_name] = criteria_type - + for row_idx, row in enumerate(results.get("rows", [])): # Group outputs by test criteria name - criteria_groups = {} + criteria_groups = {criteria: {} for criteria in testing_criteria_name_types.keys()} input_groups = {} - top_sample = {} + top_sample = [] for key, value in row.items(): if key.startswith("outputs."): # Parse key: outputs.. @@ -538,10 +543,10 @@ def _add_aoai_structured_results_to_results(results: EvaluationResult, logger: l if len(parts) >= 3: criteria_name = parts[1] metric_name = parts[2] - + if criteria_name not in criteria_groups: criteria_groups[criteria_name] = {} - + criteria_groups[criteria_name][metric_name] = value elif key.startswith("inputs."): input_key = key.replace('inputs.', '') @@ -550,7 +555,6 @@ def _add_aoai_structured_results_to_results(results: EvaluationResult, logger: l # Convert each criteria group to RunOutputItem result run_output_results = [] - for criteria_name, metrics in criteria_groups.items(): # Extract metrics for this criteria score = None @@ -559,14 +563,13 @@ def _add_aoai_structured_results_to_results(results: EvaluationResult, logger: l threshold = None passed = None sample = None - # Find score - look for various score patterns for metric_key, metric_value in metrics.items(): if metric_key.endswith("_score") or metric_key == "score": score = metric_value elif metric_key.endswith("_result") or metric_key == "result" or metric_key == "passed": label = metric_value - passed = True if (str(metric_value).lower() == 'pass' or str(metric_value).lower() == 'true') else False + passed = True if (str(metric_value).lower() == 'pass' or str(metric_value).lower() == 'true') else False elif metric_key.endswith("_reason") or metric_key == "reason": reason = metric_value elif metric_key.endswith("_threshold") or metric_key == "threshold": @@ -577,17 +580,16 @@ def _add_aoai_structured_results_to_results(results: EvaluationResult, logger: l # If no score found yet and this doesn't match other patterns, use as score if score is None: score = metric_value - + # Determine passed status passed = True if (str(label).lower() == 'pass' or str(label).lower() == 'true') else False - + # Create result object for this criteria result_obj = { "type": testing_criteria_name_types[criteria_name] if testing_criteria_name_types and criteria_name in testing_criteria_name_types else "azure_ai_evaluator", # Use criteria name as type "name": criteria_name, # Use criteria name as name "metric": criteria_name # Use criteria name as metric } - # Add optional fields if they exist if score is not None: result_obj["score"] = score @@ -599,12 +601,23 @@ def _add_aoai_structured_results_to_results(results: EvaluationResult, logger: l result_obj["threshold"] = threshold if passed is not None: result_obj["passed"] = passed + if sample is not None: result_obj["sample"] = sample - top_sample = sample # Save top sample for the row + top_sample.append(sample) # Save top sample for the row + elif criteria_name in eval_run_summary and "error_code" in eval_run_summary[criteria_name]: + error_info = { + "code": eval_run_summary[criteria_name].get("error_code", None), + "message": eval_run_summary[criteria_name].get("error_message", None), + } + sample = { + "error": error_info + } + result_obj["sample"] = sample + top_sample.append(sample) run_output_results.append(result_obj) - + # Create RunOutputItem structure run_output_item = { "object": "eval.run.output_item", @@ -613,22 +626,18 @@ def _add_aoai_structured_results_to_results(results: EvaluationResult, logger: l "eval_id": eval_id, "created_at": created_time, "datasource_item_id": row_idx, - "datasource_item": {}, + "datasource_item": input_groups, "results": run_output_results, "status": "completed" if len(run_output_results) > 0 else "error" } - if top_sample is None or "inputs" not in top_sample: - top_sample["inputs"] = input_groups - run_output_item["sample"] = top_sample - + converted_rows.append(run_output_item) # Create converted results maintaining the same structure results["evaluation_results_list"] = converted_rows logger.info(f"Converted {len(converted_rows)} rows to AOAI evaluation format, eval_id: {eval_id}, eval_run_id: {eval_run_id}") - # Calculate summary statistics evaluation_summary = _calculate_aoai_evaluation_summary(converted_rows, logger) results["evaluation_summary"] = evaluation_summary @@ -651,11 +660,11 @@ def _calculate_aoai_evaluation_summary(aoai_results: list, logger: logging.Logge "failed": 0, "passed": 0 } - + # Count results by status and calculate per model usage model_usage_stats = {} # Dictionary to aggregate usage by model result_counts_stats = {} # Dictionary to aggregate usage by model - + for aoai_result in aoai_results: logger.info(f"\r\nProcessing aoai_result with id: {getattr(aoai_result, 'id', 'unknown')}, row keys: {aoai_result.keys() if hasattr(aoai_result, 'keys') else 'N/A'}") if isinstance(aoai_result, dict) and 'results' in aoai_result: @@ -692,7 +701,6 @@ def _calculate_aoai_evaluation_summary(aoai_results: list, logger: logging.Logge if isinstance(aoai_result, dict) and 'sample' in aoai_result: logger.info(f"\r\n 2 Processing aoai_result with id: {getattr(aoai_result, 'id', 'unknown')}, summary count: {len(aoai_result['sample'])}") sample_data = aoai_result['sample'] - if sample_data and hasattr(sample_data, 'usage') and sample_data.usage: usage_data = sample_data.usage model_name = sample_data.model if hasattr(sample_data, 'model') and sample_data.model else 'unknown' @@ -730,7 +738,6 @@ def _calculate_aoai_evaluation_summary(aoai_results: list, logger: logging.Logge model_stats['prompt_tokens'] += usage_data.get('prompt_tokens', 0) model_stats['completion_tokens'] += usage_data.get('completion_tokens', 0) model_stats['cached_tokens'] += usage_data.get('cached_tokens', 0) - # Convert model usage stats to list format matching EvaluationRunPerModelUsage per_model_usage = [] for model_name, stats in model_usage_stats.items(): @@ -742,7 +749,6 @@ def _calculate_aoai_evaluation_summary(aoai_results: list, logger: logging.Logge 'completion_tokens': stats['completion_tokens'], 'cached_tokens': stats['cached_tokens'] }) - result_counts_stats_val = [] logger.info(f"\r\n Result counts stats: {result_counts_stats}") for criteria_name, stats_val in result_counts_stats.items(): @@ -753,7 +759,6 @@ def _calculate_aoai_evaluation_summary(aoai_results: list, logger: logging.Logge 'passed': stats_val.get('passed', 0), 'failed': stats_val.get('failed', 0) }) - return { "result_counts": result_counts, "per_model_usage": per_model_usage, diff --git a/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluators/_common/_base_eval.py b/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluators/_common/_base_eval.py index e6f5f3e1be51..df4a19f6094c 100644 --- a/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluators/_common/_base_eval.py +++ b/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluators/_common/_base_eval.py @@ -5,6 +5,7 @@ import inspect from abc import ABC, abstractmethod import json +import copy from typing import ( Any, Callable, @@ -500,7 +501,7 @@ def _parse_tools_from_response(self, response): if message.get("role") == "assistant" and isinstance(message.get("content"), list): for content_item in message.get("content"): if isinstance(content_item, dict) and content_item.get("type") == "tool_call": - tool_calls.append(content_item) + tool_calls.append(copy.deepcopy(content_item)) # Extract tool results from tool messages elif message.get("role") == "tool" and message.get("tool_call_id"): diff --git a/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_legacy/_batch_engine/_run_submitter.py b/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_legacy/_batch_engine/_run_submitter.py index 131b36df3610..f514bcbf0a79 100644 --- a/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_legacy/_batch_engine/_run_submitter.py +++ b/sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_legacy/_batch_engine/_run_submitter.py @@ -17,7 +17,7 @@ from .._common._logging import incremental_print, print_red_error from ._config import BatchEngineConfig from ._exceptions import BatchEngineValidationError -from ._engine import DEFAULTS_KEY, BatchEngine, BatchEngineError, BatchResult +from ._engine import DEFAULTS_KEY, BatchEngine, BatchEngineError, BatchResult, BatchStatus class RunSubmitter: @@ -141,6 +141,19 @@ async def _submit_bulk_run(self, run: Run, local_storage: AbstractRunStorage, ** run._status = RunStatus.FAILED # when run failed in executor, store the exception in result and dump to file logger.warning(f"Run {run.name} failed when executing in executor with exception {e}.") + if not batch_result: + batch_result = BatchResult( + status=BatchStatus.Failed, + total_lines=0, + failed_lines=0, + start_time=datetime.now(timezone.utc), + end_time=datetime.now(timezone.utc), + tokens=None, + details=[] + ) + batch_result.error = e + elif not batch_result.error: + batch_result.error = e # for user error, swallow stack trace and return failed run since user don't need the stack trace if not isinstance(e, BatchEngineValidationError): # for other errors, raise it to user to help debug root cause. diff --git a/sdk/evaluation/azure-ai-evaluation/tests/unittests/data/evaluate_test_data_for_groundedness.jsonl b/sdk/evaluation/azure-ai-evaluation/tests/unittests/data/evaluate_test_data_for_groundedness.jsonl new file mode 100644 index 000000000000..1d95f7fcedd7 --- /dev/null +++ b/sdk/evaluation/azure-ai-evaluation/tests/unittests/data/evaluate_test_data_for_groundedness.jsonl @@ -0,0 +1 @@ +{"query": [{"role": "system", "content": "# Cost Management Agent\n\n## Context\nYou are an Azure Cost Management Agent; your purpose is to provide numerical cost data.\n\nYour tools are:\n- cost_management_query_plugin (this provides actual cost data)\n- cost_management_forecast_plugin (this provides forecast cost data)\n\nDecide which tool to use with the following logic:\nIf the requested time period for cost information ends in the future: use cost_management_forecast_plugin \nelse: use cost_management_query_plugin \n\nWhen the time period starts in the past and ends in the future, cost_management_forecast_plugin will return both actuals and forecast data.\nBe VERY careful when selecting the tool. If the time period is in the past and cost_management_forecast_plugin is used, it will throw a BAD REQUEST error.\nFirst consider what is Today's date, what is the beginning and the end of the time period, then select the tool appropriately.\n\n## Required Information (When to Clarify)\nThe tools require a subscription ID parameter which should be in the format of UUID v4 (eg: a2bddb13-8540-4229-ac11-01d0224d54ad). \n\n## Today's Date\nToday's date is {TODAYS_DATE} in YYYY-MM-DD format."}, {"createdAt": "2025-10-03T06:31:06.491912Z", "role": "user", "content": [{"type": "text", "text": "What are my forecasted costs for next month?"}]}], "response": [{"createdAt": "2025-10-03T06:31:07.491912Z", "run_id": "run_0_1", "role": "assistant", "content": [{"type": "tool_call", "tool_call_id": "call_6cbdc3788e394206", "name": "CostManagementAgent", "arguments": {"message": "Please retrieve the forecasted costs for next month for the user's currently selected subscription(s) and scope. Return:\n- Total forecasted cost for next month (with currency)\n- Forecast per subscription (if multiple subscriptions are selected)\n- Breakdown by resource group and the top 5 resources driving cost\n- Forecasting method/timeframe used and confidence if available\nIf additional information or subscription selection is needed from the user, ask a concise follow-up question. Also confirm the time zone and currency used in the forecast."}}]}, {"createdAt": "2025-10-03T06:31:09.491912Z", "run_id": "run_0_1", "tool_call_id": "call_6cbdc3788e394206", "role": "tool", "content": [{"type": "tool_result", "tool_result": "What subscription Id do you want cost information for, and Id must be provided not a name?"}]}, {"createdAt": "2025-10-03T06:31:10.491912Z", "run_id": "run_0_1", "role": "assistant", "content": [{"type": "text", "text": "To provide you with the forecasted costs for next month, I need the subscription ID you want the cost information for. Please provide the subscription ID, as names are not sufficient for this query."}]}], "tool_definitions": [{"name": "CostManagementAgent", "description": "# Cost Management Agent\n\n## Context\nYou are an Azure Cost Management Agent; your purpose is to provide numerical cost data.\n\nYour tools are:\n- cost_management_query_plugin (this provides actual cost data)\n- cost_management_forecast_plugin (this provides forecast cost data)\n\nDecide which tool to use with the following logic:\nIf the requested time period for cost information ends in the future: use cost_management_forecast_plugin \nelse: use cost_management_query_plugin \n\nWhen the time period starts in the past and ends in the future, cost_management_forecast_plugin will return both actuals and forecast data.\nBe VERY careful when selecting the tool. If the time period is in the past and cost_management_forecast_plugin is used, it will throw a BAD REQUEST error.\nFirst consider what is Today's date, what is the beginning and the end of the time period, then select the tool appropriately.\n\n## Required Information (When to Clarify)\nThe tools require a subscription ID parameter which should be in the format of UUID v4 (eg: a2bddb13-8540-4229-ac11-01d0224d54ad). If the user does not provide a subscription ID, ask them to provide it by responding in the Clarify state and include a clarifyResponse requesting the subscription ID. The clarifyResponse should be very clear it should just ask the user 'What subscription Id do you want cost information for, and Id must be provided not a name?'. If a user provides a subscription name, respond with state Clarify and ask in clarifyResponse to provide the subscription ID.\nDo not use any context related to globally selected subscriptions , if there is no user input containing a subscription ID ask to clarify. If multiple subscription Ids are specified ask to clarify in the clarifyMessage say 'Provide only 1 subscription ID'.\n\n## Tool: cost_management_query_plugin\n\n### Parameters\n cost_management_query_plugin accepts a subset of SQL-like parameters so you can request custom views of cost management data. Key concepts:\n- grouping: equivalent to GROUP BY, this requires table dimensions to be selected or a Tag Key. Tag Key and Tag Value may be specified in the format key:value in the user prompt.\n- aggregate: Aggregation clause, only sum is supported\n- granularity: groups results into Daily or Monthly datasets useful for trends over time. Otherwise use None \n- timeperiod: the time period for the query, must be specified. The maximum range is 1 year (when creating a time period for a year be ensure it is less than a year by making it 2 days less than a full year). If no time period is specified by the user default to the last full month. \n\nParameters for filtering are not generated, if a user request information for a specific datavalue, use grouping on that dimension and then when responding only return the relavent datarows.\n\n### Supported Table Dimensions for Grouping\n- MeterCategory: Equivalent to the resource or service type.\n- ResourceLocation: Geographic region where the resource is deployed.\n- ResourceGuid: Unique id for each resource.\n- ResourceGroupName: Resource group containing the resource.\n- PricingModel: These are Savings Plans where per usage prices are lower if a user commits up front to usage. Pricing Models include pay-as-you-go, reserved and more.\n- BenefitName: Discounts or incentives (e.g., free credits, dev/test discounts), this is not a Savings Plan.\n\n## Tool: cost_management_forecast_plugin\n\n### Parameters\n cost_management_forecast_plugin accepts SQL-like parameters so you can request custom views of cost management forecast. Key concepts:\n- filter: like WHERE , used to filter by specific datavalues in specific table dimensions or using Tag keys and Tag values. Tag Key and Tag Value may be specified in the format key:value in the user prompt.\n- granularity: groups results into Daily or Monthly datasets useful for trends over time. Otherwise use None \n- timeperiod: the time period for the forecast, the to date cannot be in past. If no time period is specified by the user default to the next full month.\n\n### Supported Table Dimensions for Filtering\n- MeterCategory: Equivalent to the resource/service type.\n- ResourceLocation: Geographic region where the resource is deployed.\n- ResourceGuid: Unique id for each resource.\n- ResourceGroupName: Resource group containing the resource.\n- PricingModel: These are Savings Plans where per usage prices are lower if a user commits up front to usage. Pricing Models include pay-as-you-go, reserved and more.\n- BenefitName: Discounts or incentives (e.g., free credits, dev/test discounts), this is not a Savings Plan.\n\n### Datavalues for filtering\nIf filtering on a table dimension, datavalues for filters must be first fetched by calling cost_management_query_plugin and using grouping with the same table dimension.\nThe returned data will have the distinct datavalues for that dimension. Create a filter using the time dimension and relevant datavalues.\n\n## Today's Date\nToday's date is {TODAYS_DATE} in YYYY-MM-DD format.", "parameters": {"type": "object", "properties": {"message": {"type": "string", "description": "The message or request to send to the agent"}}, "required": ["message"]}}, {"name": "cost_management_query_plugin", "description": "Get cost information for Azure, all returned costs are Actual costs. All cost information is grouped by a subscription; if there is no subscription Id (guuid) in the users request clarify the subscription Id before continuing. Do not use a placeholder for subscription Id. If a subscription Id cannot be inferred request clarification from the user", "parameters": {"type": "object", "properties": {"dataset": {"type": "object", "properties": {"granularity": {"type": "string", "enum": ["None", "Daily", "Monthly"], "description": "Granularity groups cost data by time intervals of a day, month or not at all. Select 'None' if the user wants to see the total costs over the time period, or if the user wants to see a specific day or month. Select 'Daily' or 'Monthly' if a user wants to see trends over a time period. Select 'Daily' when keywords like 'daily', 'per day' are present or multiple days are specified. Select 'Monthly' when keywords like 'monthly', 'per month' are present or multiple months specified. Granularity is distinct from the time period."}, "aggregationCostType": {"type": "string", "description": "The type of cost to use. This can either be Pre Tax Cost or Total Cost, and it can be either in USD or local currency.", "enum": ["PreTaxCost", "Cost", "PreTaxCostUSD", "CostUSD"], "default": "Cost"}, "grouping": {"type": "array", "default": null, "description": "Like a SQL Group By clause. This groups the cost data by specific dimensions or tags. This should be used when the user wants a cost breakdown on the specified dimension (eg/ 'cost per service type') or the user wants to see the cost for multiple values in a dimension (eg/ 'cost for services Virtual Machines, Storage and Databases')", "maxItems": 2, "items": {"anyOf": [{"type": "object", "description": "Group by a specific dimension", "properties": {"name": {"type": "string", "enum": ["MeterCategory", "ResourceLocation", "ResourceGroupName", "PricingModel ", "ResourceGuid", "BenefitName"], "description": "The name of the column to group by. Use 'MeterCategory' if the user wants cost breakdown for Azure Service Types (eg 'Virtual Machines', 'Storage'). Use 'ResourceLocation' to group by deployed resource region (eg 'East US', 'West Europe'). Use 'ResourceGroupName' to group by Resource Group Name. Use 'PricingModel' to group by Pricing Model (eg 'Pay-As-You-Go', 'Reserved'). Use 'ResourceId' to group costs per resource. Use 'BenefitName' if the user specifies a Benefit Name."}, "type": {"type": "string", "enum": ["Dimension"]}}, "required": ["name", "type"], "additionalProperties": false}, {"type": "object", "description": "Group by a specific tag", "properties": {"name": {"type": "string", "description": "The name of the tag key to group by. This should be excatly as the user specifies it, including case sensitivity. For example, if the user specifies 'Environment', use 'Environment'. If the user specifies 'environment', use 'environment'."}, "type": {"type": "string", "enum": ["TagKey"]}}, "required": ["name", "type"], "additionalProperties": false}]}}}, "required": ["granularity", "aggregationCostType"], "additionalProperties": false}, "costType": {"type": "string", "enum": ["ActualCost", "AmortizedCost"], "description": "The cost type parameter for the query API. Determines whether to use 'ActualCost' (default) or 'AmortizedCost' based on user intent. ActualCost for general cost queries, AmortizedCost for reservation/savings plan utilization, coverage, and amortization scenarios. Use ActualCost by default. Only use AmortizedCost when specifically asked for the amount of used, unused, unutilized, or wasted reservation and savings plan benefits, breaking down a one-time cost into periodic payments, and identifying resources, subscriptions, and other entities that received benefits or coverage from reservations and savings plans benefits.", "default": "ActualCost"}, "timeperiod": {"type": "object", "properties": {"from": {"type": "string", "description": "Start date of the time period. Use YYYY-MM-DDTHH:MM:SS format", "pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2})$"}, "to": {"type": "string", "description": "End date of the time period. Use YYYY-MM-DDTHH:MM:SS format", "pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2})$"}}, "required": ["to", "from"], "additionalProperties": false, "description": "The time period for the cost query with 'from' and 'to' dates. Determine the specific date range based on user intent. If no time period is specified in the user prompt, set 'from' as 1 month from today, and 'to' as todays date. 'to' should be set to today's date when used to determine all relative dates eg/ last week, last month, last year. When user refers to a month, default to first of the month unless specifically stated otherwise. Dates should be in YYYY-MM-DDTHH:MM:SS format. The time period should be a maximum of 1 year, therefore if there is a request for cost management data greater than 1 year just use 1 year. Consider adjusting time periods to start and end on the first and last day of the month/year/financial year respectively, when appropriate."}, "subscriptionId": {"description": "The subscriptionId to get the cost data for", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}, "required": ["subscriptionId", "costType", "timeperiod", "dataset"]}}, {"name": "cost_management_forecast_plugin", "description": "Get cost information for Azure, returned costs in the future are forecast costs. A mix of actual and forecast costs can be returned, but not strictly actual costs. All cost information is grouped by a subscription; if there is no subscription Id (guuid) in the users request clarify the subscription Id before continuing. Do not use a placeholder for subscription Id. If a subscription Id cannot be inferred request clarification from the user", "parameters": {"type": "object", "properties": {"dataset": {"type": "object", "properties": {"granularity": {"type": "string", "enum": ["None", "Daily", "Monthly"], "description": "Granularity groups cost data by time intervals of a day, month or not at all. Select 'None' if the user wants to see the total costs over the time period, or if the user wants to see a specific day or month. Select 'Daily' or 'Monthly' if a user wants to see trends over a time period. Select 'Daily' when keywords like 'daily', 'per day' are present or multiple days are specified. Select 'Monthly' when keywords like 'monthly', 'per month' are present or multiple months specified. Granularity is distinct from the time period."}, "filter": {"type": "object", "description": "Like a SQL Where clause. It filters only relevant cost management data. Supports logical AND/OR, dimension, and tag-based filtering. To use this the user must specify both the Dimension or Tag and the values to filter by. For example, if the user specifies 'Show costs for resources in the US', use 'ResourceLocation' as the dimension and ['Central US', 'East US', 'East US 2', 'North Central US', 'South Central US', 'West Central US', 'West US', 'West US 2', 'West US 3'] as the value. It is okay to be conservative with the filter and include more data than necessary. Only include a filter if the user specifies wanting costs for specific resources, services, tags, or regions. If the user does not specify any filter criteria, do not include this property.", "anyOf": [{"type": "object", "properties": {"and": {"type": "array", "items": {"$ref": "#"}, "minItems": 2, "description": "The logical 'AND' expression. Must have at least 2 items."}}, "required": ["and"], "additionalProperties": false}, {"type": "object", "properties": {"or": {"type": "array", "items": {"$ref": "#"}, "minItems": 2, "description": "The logical 'OR' expression. Must have at least 2 items."}}, "required": ["or"], "additionalProperties": false}, {"type": "object", "properties": {"dimensions": {"type": "object", "properties": {"name": {"type": "string", "enum": ["MeterCategory", "ResourceLocation", "ResourceGroupName", "PricingModel ", "ResourceGuid", "BenefitName"]}, "operator": {"type": "string", "enum": ["In"]}, "values": {"type": "array", "items": {"type": "string"}, "description": "Datavalues to include. The datavalues are enums, the exact datavalues to include must be known in advance."}}, "required": ["name", "operator", "values"], "additionalProperties": false}}, "required": ["dimensions"], "additionalProperties": false}, {"type": "object", "properties": {"tags": {"type": "object", "description": "Filter by tag key and values. This is used when the user specifies a tag key and values to filter by. For example, if the user wants to show costs for resources Tagged with 'Environment' equals 'Production', use 'Environment' as the tag key and 'Production' as the value.", "properties": {"name": {"type": "string", "description": "Tag name to filter by. This should be exactly as the user specifies it, including case sensitivity. For example, if the user specifies 'Environment', use 'Environment'"}, "operator": {"type": "string", "enum": ["In"]}, "values": {"type": "array", "items": {"type": "string"}, "description": "Array of values to use for comparison. This should be exactly as the user specifies it, including case sensitivity. For example, if the user specifies 'Production', use 'Production'."}}, "required": ["name", "operator", "values"], "additionalProperties": false}}, "required": ["tags"], "additionalProperties": false}]}, "aggregationCostType": {"type": "string", "description": "The type of cost to use. This can either be Pre Tax Cost or Total Cost, and it can be either in USD or local currency.", "enum": ["PreTaxCost", "Cost", "PreTaxCostUSD", "CostUSD"], "default": "Cost"}}, "required": ["granularity", "aggregationCostType"], "additionalProperties": false}, "costType": {"type": "string", "enum": ["ActualCost", "AmortizedCost"], "description": "The cost type parameter for the query API. Determines whether to use 'ActualCost' (default) or 'AmortizedCost' based on user intent. ActualCost for general cost queries, AmortizedCost for reservation/savings plan utilization, coverage, and amortization scenarios. Use ActualCost by default. Only use AmortizedCost when specifically asked for the amount of used, unused, unutilized, or wasted reservation and savings plan benefits, breaking down a one-time cost into periodic payments, and identifying resources, subscriptions, and other entities that received benefits or coverage from reservations and savings plans benefits.", "default": "ActualCost"}, "timeperiod": {"type": "object", "properties": {"from": {"type": "string", "description": "Start date of the time period. Use YYYY-MM-DDTHH:MM:SS format", "pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2})$"}, "to": {"type": "string", "description": "End date of the time period. Use YYYY-MM-DDTHH:MM:SS format", "pattern": "^(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2})$"}}, "required": ["to", "from"], "additionalProperties": false, "description": "Explicit custom date range for forecast. Supports past, present, and future. 'from' may be today or an earlier date if user wants history; 'to' may extend into the future (forecast horizon: up to ~90 days ahead for Daily granularity, up to 12 months ahead for Monthly; trim any excess). Use forward defaults when user only says 'forecast' (e.g. today through end of current month or next 30 days). For 'next month' set from = first day of next month, to = last day of next month. Allow overlap (e.g. 'last 30 days and next 30 days'). Dates UTC, format YYYY-MM-DDTHH:MM:SS, inclusive."}, "subscriptionId": {"description": "The subscriptionId to get the cost data for", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}, "required": ["subscriptionId", "costType", "timeperiod", "dataset"]}}], "conversation_id": "AoCwVfcPVOZGXx6WxIR6js-us", "turn_number": 1, "tools_used": ["CostManagementAgent"], "total_turns": 6, "turn_processing_time_ms": 30110} \ No newline at end of file diff --git a/sdk/evaluation/azure-ai-evaluation/tests/unittests/test_evaluate.py b/sdk/evaluation/azure-ai-evaluation/tests/unittests/test_evaluate.py index b2348e0aceb8..a7bc4d3f7acc 100644 --- a/sdk/evaluation/azure-ai-evaluation/tests/unittests/test_evaluate.py +++ b/sdk/evaluation/azure-ai-evaluation/tests/unittests/test_evaluate.py @@ -81,6 +81,11 @@ def evaluate_test_data_alphanumeric(): return _get_file("evaluate_test_data_alphanumeric.jsonl") +@pytest.fixture +def evaluate_test_data_for_groundedness(): + return _get_file("evaluate_test_data_for_groundedness.jsonl") + + @pytest.fixture def questions_file(): return _get_file("questions.jsonl") @@ -461,6 +466,31 @@ def test_evaluate_valid_column_mapping_with_numeric_chars(self, mock_model_confi assert "inputs.query456" in row_result_df.columns assert "inputs.context789" in row_result_df.columns + def test_evaluate_groundedness_tool_result(self, mock_model_config, evaluate_test_data_for_groundedness): + # Validates if groundedness evaluator does not add tool_call results to tool call messages + + result = evaluate( + data=evaluate_test_data_for_groundedness, + evaluators={"g": GroundednessEvaluator(model_config=mock_model_config)}, + fail_on_evaluator_errors=False, + ) + + # Verify that the test completed without errors related to column mapping format + # The test data has the fields with numeric characters, so it should work correctly + assert result is not None + # Verify we're getting data from the numerically-named fields + row_result_df = pd.DataFrame(result["rows"]) + assert "inputs.response" in row_result_df.columns + assert "inputs.query" in row_result_df.columns + + # Break down the assertion for better error handling + response_data = row_result_df["inputs.response"][0] + first_message = response_data[0] + content_data = first_message["content"][0] + + # Now check if "tool_result" is in the keys + assert "tool_result" not in content_data.keys() + def test_renaming_column(self): """Test that the columns are renamed correctly.""" df = pd.DataFrame( diff --git a/sdk/identity/test-resources.bicep b/sdk/identity/test-resources.bicep index 98590d600209..ac104fecf847 100644 --- a/sdk/identity/test-resources.bicep +++ b/sdk/identity/test-resources.bicep @@ -95,7 +95,6 @@ resource webRole 'Microsoft.Authorization/roleAssignments@2022-04-01' = if (prov properties: { principalId: testApplicationOid roleDefinitionId: websiteContributor - principalType: 'ServicePrincipal' } } @@ -105,7 +104,6 @@ resource webRole2 'Microsoft.Authorization/roleAssignments@2022-04-01' = if (pro properties: { principalId: testApplicationOid roleDefinitionId: websiteContributor - principalType: 'ServicePrincipal' } } @@ -304,7 +302,7 @@ resource kubernetesCluster 'Microsoft.ContainerService/managedClusters@2023-06-0 { name: 'agentpool' count: 1 - vmSize: 'Standard_D2s_v3' + vmSize: 'Standard_D2s_v6' osDiskSizeGB: 128 osDiskType: 'Managed' kubeletDiskType: 'OS'