From 22d0ec06bcd1524cc772eaef28184a6d5660ee52 Mon Sep 17 00:00:00 2001 From: Paola Vicencio Date: Tue, 18 Feb 2025 21:00:04 -0600 Subject: [PATCH 1/7] Updating Rooms collaborator Role --- .../rooms/_generated/__init__.py | 14 +- .../communication/rooms/_generated/_client.py | 9 +- .../rooms/_generated/_configuration.py | 6 +- .../communication/rooms/_generated/_patch.py | 1 + .../rooms/_generated/_serialization.py | 542 ++++++++++-------- .../rooms/_generated/aio/__init__.py | 14 +- .../rooms/_generated/aio/_client.py | 9 +- .../rooms/_generated/aio/_configuration.py | 6 +- .../rooms/_generated/aio/_patch.py | 1 + .../_generated/aio/operations/__init__.py | 16 +- .../_generated/aio/operations/_operations.py | 296 +++------- .../rooms/_generated/aio/operations/_patch.py | 1 + .../rooms/_generated/operations/__init__.py | 16 +- .../_generated/operations/_operations.py | 310 +++------- .../rooms/_generated/operations/_patch.py | 1 + .../swagger/README.md | 2 +- 16 files changed, 533 insertions(+), 711 deletions(-) diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/__init__.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/__init__.py index 3b2f1e1ffe83..54cb0e7f0b09 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/__init__.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/__init__.py @@ -1,14 +1,20 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.13.7) +# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.28.4) # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._client import AzureCommunicationRoomsService +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import AzureCommunicationRoomsService # type: ignore try: from ._patch import __all__ as _patch_all - from ._patch import * # pylint: disable=unused-wildcard-import + from ._patch import * except ImportError: _patch_all = [] from ._patch import patch_sdk as _patch_sdk @@ -16,6 +22,6 @@ __all__ = [ "AzureCommunicationRoomsService", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/_client.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/_client.py index f8170363e8d6..acdaa298df29 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/_client.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/_client.py @@ -1,11 +1,12 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.13.7) +# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.28.4) # 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 @@ -16,7 +17,7 @@ from .operations import ParticipantsOperations, RoomsOperations -class AzureCommunicationRoomsService: # pylint: disable=client-accepts-api-version-keyword +class AzureCommunicationRoomsService: """Azure Communication Room Service. :ivar rooms: RoomsOperations operations @@ -25,7 +26,7 @@ class AzureCommunicationRoomsService: # pylint: disable=client-accepts-api-vers :vartype participants: azure.communication.rooms.operations.ParticipantsOperations :param endpoint: The endpoint of the Azure Communication resource. Required. :type endpoint: str - :keyword api_version: Api Version. Default value is "2024-04-15". Note that overriding this + :keyword api_version: Api Version. Default value is "2025-03-07". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ @@ -89,7 +90,7 @@ def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: def close(self) -> None: self._client.close() - def __enter__(self) -> "AzureCommunicationRoomsService": + def __enter__(self) -> Self: self._client.__enter__() return self diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/_configuration.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/_configuration.py index bd75c423f194..8fd7a743ec08 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/_configuration.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/_configuration.py @@ -1,6 +1,6 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.13.7) +# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.28.4) # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- @@ -19,13 +19,13 @@ class AzureCommunicationRoomsServiceConfiguration: # pylint: disable=too-many-i :param endpoint: The endpoint of the Azure Communication resource. Required. :type endpoint: str - :keyword api_version: Api Version. Default value is "2024-04-15". Note that overriding this + :keyword api_version: Api Version. Default value is "2025-03-07". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, **kwargs: Any) -> None: - api_version: str = kwargs.pop("api_version", "2024-04-15") + api_version: str = kwargs.pop("api_version", "2025-03-07") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/_patch.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/_patch.py index f7dd32510333..49900f6ab120 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/_patch.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/_patch.py @@ -2,6 +2,7 @@ # Copyright (c) Microsoft Corporation. # Licensed under the MIT License. # ------------------------------------ + """Customize generated code here. Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/_serialization.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/_serialization.py index 2f781d740827..e2a20b1d534c 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/_serialization.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/_serialization.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines # -------------------------------------------------------------------------- # # Copyright (c) Microsoft Corporation. All rights reserved. @@ -24,7 +25,6 @@ # # -------------------------------------------------------------------------- -# pylint: skip-file # pyright: reportUnnecessaryTypeIgnoreComment=false from base64 import b64decode, b64encode @@ -48,11 +48,8 @@ IO, Mapping, Callable, - TypeVar, MutableMapping, - Type, List, - Mapping, ) try: @@ -62,13 +59,13 @@ 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") -ModelType = TypeVar("ModelType", bound="Model") JSON = MutableMapping[str, Any] @@ -91,6 +88,8 @@ def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: :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 @@ -112,7 +111,7 @@ def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: try: return json.loads(data_as_str) except ValueError as err: - raise DeserializationError("JSON is invalid: {}".format(err), err) + raise DeserializationError("JSON is invalid: {}".format(err), err) from err elif "xml" in (content_type or []): try: @@ -144,6 +143,8 @@ def _json_attemp(data): # 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 @@ -153,6 +154,11 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], 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 @@ -177,80 +183,31 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], except NameError: _long_type = int - -class UTC(datetime.tzinfo): - """Time Zone info for handling UTC""" - - def utcoffset(self, dt): - """UTF offset for UTC is 0.""" - return datetime.timedelta(0) - - def tzname(self, dt): - """Timestamp representation.""" - return "Z" - - def dst(self, dt): - """No daylight saving for UTC.""" - return datetime.timedelta(hours=1) - - -try: - from datetime import timezone as _FixedOffset # type: ignore -except ImportError: # Python 2.7 - - class _FixedOffset(datetime.tzinfo): # type: ignore - """Fixed offset in minutes east from UTC. - Copy/pasted from Python doc - :param datetime.timedelta offset: offset in timedelta format - """ - - def __init__(self, offset): - self.__offset = offset - - def utcoffset(self, dt): - return self.__offset - - def tzname(self, dt): - return str(self.__offset.total_seconds() / 3600) - - def __repr__(self): - return "".format(self.tzname(None)) - - def dst(self, dt): - return datetime.timedelta(0) - - def __getinitargs__(self): - return (self.__offset,) - - -try: - from datetime import timezone - - TZ_UTC = timezone.utc -except ImportError: - TZ_UTC = UTC() # type: ignore +TZ_UTC = datetime.timezone.utc _FLATTEN = re.compile(r"(? None: self.additional_properties: Optional[Dict[str, Any]] = {} - for k in kwargs: + 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): @@ -298,13 +262,23 @@ def __init__(self, **kwargs: Any) -> None: setattr(self, k, kwargs[k]) def __eq__(self, other: Any) -> bool: - """Compare objects by comparing all attributes.""" + """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.""" + """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: @@ -324,7 +298,11 @@ def is_xml_model(cls) -> bool: @classmethod def _create_xml_node(cls): - """Create XML node.""" + """Create XML node. + + :returns: The XML node + :rtype: xml.etree.ElementTree.Element + """ try: xml_map = cls._xml_map # type: ignore except AttributeError: @@ -344,7 +322,9 @@ def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: :rtype: dict """ serializer = Serializer(self._infer_class_models()) - return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) # type: ignore + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, keep_readonly=keep_readonly, **kwargs + ) def as_dict( self, @@ -378,12 +358,15 @@ def my_key_transformer(key, attr_desc, value): 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(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore + 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): @@ -393,30 +376,31 @@ def _infer_class_models(cls): 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: + 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: Type[ModelType], data: Any, content_type: Optional[str] = None) -> ModelType: + 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 + :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: Type[ModelType], + cls, data: Any, key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, content_type: Optional[str] = None, - ) -> ModelType: + ) -> Self: """Parse a dict using given key extractor return a model. By default consider key @@ -424,9 +408,11 @@ def from_dict( 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 @@ -446,21 +432,25 @@ def _flatten_subtype(cls, key, objects): return {} result = dict(cls._subtype_map[key]) for valuetype in cls._subtype_map[key].values(): - result.update(objects[valuetype]._flatten_subtype(key, objects)) + result.update(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. - Remove the polymorphic key from the initial data. + + :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.pop(rest_api_response_key, None) or response.pop(subtype_key, None) + 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: @@ -499,11 +489,13 @@ def _decode_attribute_map_key(key): 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(object): +class Serializer: # pylint: disable=too-many-public-methods """Request object model serializer.""" basic_types = {str: "str", int: "int", bool: "bool", float: "float"} @@ -538,7 +530,7 @@ class Serializer(object): "multiple": lambda x, y: x % y != 0, } - def __init__(self, classes: Optional[Mapping[str, type]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: self.serialize_type = { "iso-8601": Serializer.serialize_iso, "rfc-1123": Serializer.serialize_rfc, @@ -558,13 +550,16 @@ def __init__(self, classes: Optional[Mapping[str, type]] = None): self.key_transformer = full_restapi_key_transformer self.client_side_validation = True - def _serialize(self, target_obj, data_type=None, **kwargs): + 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 target_obj: The data to be serialized. + :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. + :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) @@ -590,12 +585,14 @@ def _serialize(self, target_obj, data_type=None, **kwargs): serialized = {} if is_xml_model_serialization: - serialized = target_obj._create_xml_node() + serialized = target_obj._create_xml_node() # pylint: disable=protected-access try: - attributes = target_obj._attribute_map + 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(attr_name, {}).get("readonly", False): + 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"] == "": @@ -631,7 +628,8 @@ def _serialize(self, target_obj, data_type=None, **kwargs): 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 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 @@ -662,17 +660,17 @@ def _serialize(self, target_obj, data_type=None, **kwargs): 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 - else: - return serialized + return serialized def body(self, data, data_type, **kwargs): """Serialize data intended for a request body. - :param data: The data to be serialized. + :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 + :raises SerializationError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized request body """ # Just in case this is a dict @@ -701,7 +699,7 @@ def body(self, data, data_type, **kwargs): attribute_key_case_insensitive_extractor, last_rest_key_case_insensitive_extractor, ] - data = deserializer._deserialize(data_type, data) + 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 @@ -710,11 +708,13 @@ def body(self, data, data_type, **kwargs): def url(self, name, data, data_type, **kwargs): """Serialize data intended for a URL path. - :param data: The data to be serialized. + :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 - :raises: TypeError if serialization fails. - :raises: ValueError if data is None + :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) @@ -726,21 +726,20 @@ def url(self, name, data, data_type, **kwargs): output = output.replace("{", quote("{")).replace("}", quote("}")) else: output = quote(str(output), safe="") - except SerializationError: - raise TypeError("{} must be type {}.".format(name, data_type)) - else: - return output + 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 data: The data to be serialized. + :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. - :keyword bool skip_quote: Whether to skip quote the serialized result. - Defaults to False. :rtype: str, list - :raises: TypeError if serialization fails. - :raises: ValueError if data is None + :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 @@ -757,19 +756,20 @@ def query(self, name, data, data_type, **kwargs): output = str(output) else: output = quote(str(output), safe="") - except SerializationError: - raise TypeError("{} must be type {}.".format(name, data_type)) - else: - return str(output) + 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 data: The data to be serialized. + :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 + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized header """ try: if data_type in ["[str]"]: @@ -778,21 +778,20 @@ def header(self, name, data, data_type, **kwargs): output = self.serialize_data(data, data_type, **kwargs) if data_type == "bool": output = json.dumps(output) - except SerializationError: - raise TypeError("{} must be type {}.".format(name, data_type)) - else: - return str(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 data: The data to be serialized. + :param object data: The data to be serialized. :param str data_type: The type to be serialized from. - :param bool required: Whether it's essential that the data not be - empty or None - :raises: AttributeError if required data is None. - :raises: ValueError if data is None - :raises: SerializationError if serialization fails. + :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") @@ -803,7 +802,7 @@ def serialize_data(self, data, data_type, **kwargs): if data_type in self.basic_types.values(): return self.serialize_basic(data, data_type, **kwargs) - elif data_type in self.serialize_type: + if data_type in self.serialize_type: return self.serialize_type[data_type](data, **kwargs) # If dependencies is empty, try with current data class @@ -819,11 +818,10 @@ def serialize_data(self, data, data_type, **kwargs): except (ValueError, TypeError) as err: msg = "Unable to serialize value: {!r} as type: {!r}." raise SerializationError(msg.format(data, data_type)) from err - else: - return self._serialize(data, **kwargs) + return self._serialize(data, **kwargs) @classmethod - def _get_custom_serializers(cls, data_type, **kwargs): + 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 @@ -839,23 +837,26 @@ def serialize_basic(cls, data, data_type, **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 data: Object to be serialized. + :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 + 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 data: Object to be serialized. + :param str data: Object to be serialized. :rtype: str + :return: serialized object """ try: # If I received an enum, return its value return data.value @@ -869,8 +870,7 @@ def serialize_unicode(cls, data): return data except NameError: return str(data) - else: - return str(data) + return str(data) def serialize_iter(self, data, iter_type, div=None, **kwargs): """Serialize iterable. @@ -880,15 +880,13 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): serialization_ctxt['type'] should be same as data_type. - is_xml bool : If set, serialize as XML - :param list attr: Object to be serialized. + :param list data: Object to be serialized. :param str iter_type: Type of object in the iterable. - :param bool required: Whether the objects in the iterable must - not be None or empty. :param str div: If set, this str will be used to combine the elements in the iterable into a combined string. Default is 'None'. - :keyword bool do_quote: Whether to quote the serialized result of each iterable element. Defaults to False. :rtype: list, str + :return: serialized iterable """ if isinstance(data, str): raise SerializationError("Refuse str type as a valid iter type.") @@ -943,9 +941,8 @@ def serialize_dict(self, attr, dict_type, **kwargs): :param dict attr: Object to be serialized. :param str dict_type: Type of object in the dictionary. - :param bool required: Whether the objects in the dictionary must - not be None or empty. :rtype: dict + :return: serialized dictionary """ serialization_ctxt = kwargs.get("serialization_ctxt", {}) serialized = {} @@ -969,7 +966,7 @@ def serialize_dict(self, attr, dict_type, **kwargs): return serialized - def serialize_object(self, attr, **kwargs): + 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 @@ -977,6 +974,7 @@ def serialize_object(self, attr, **kwargs): :param dict attr: Object to be serialized. :rtype: dict or str + :return: serialized object """ if attr is None: return None @@ -1001,7 +999,7 @@ def serialize_object(self, attr, **kwargs): return self.serialize_decimal(attr) # If it's a model or I know this dependency, serialize as a Model - elif obj_type in self.dependencies.values() or isinstance(attr, Model): + if obj_type in self.dependencies.values() or isinstance(attr, Model): return self._serialize(attr) if obj_type == dict: @@ -1032,56 +1030,61 @@ def serialize_enum(attr, enum_obj=None): try: enum_obj(result) # type: ignore return result - except ValueError: + 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)) + raise SerializationError(error.format(attr, enum_obj)) from exc @staticmethod - def serialize_bytearray(attr, **kwargs): + def serialize_bytearray(attr, **kwargs): # pylint: disable=unused-argument """Serialize bytearray into base-64 string. - :param attr: Object to be serialized. + :param str attr: Object to be serialized. :rtype: str + :return: serialized base64 """ return b64encode(attr).decode() @staticmethod - def serialize_base64(attr, **kwargs): + def serialize_base64(attr, **kwargs): # pylint: disable=unused-argument """Serialize str into base-64 string. - :param attr: Object to be serialized. + :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): + def serialize_decimal(attr, **kwargs): # pylint: disable=unused-argument """Serialize Decimal object to float. - :param attr: Object to be serialized. + :param decimal attr: Object to be serialized. :rtype: float + :return: serialized decimal """ return float(attr) @staticmethod - def serialize_long(attr, **kwargs): + def serialize_long(attr, **kwargs): # pylint: disable=unused-argument """Serialize long (Py2) or int (Py3). - :param attr: Object to be serialized. + :param int attr: Object to be serialized. :rtype: int/long + :return: serialized long """ return _long_type(attr) @staticmethod - def serialize_date(attr, **kwargs): + 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) @@ -1089,11 +1092,12 @@ def serialize_date(attr, **kwargs): return t @staticmethod - def serialize_time(attr, **kwargs): + 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) @@ -1103,30 +1107,32 @@ def serialize_time(attr, **kwargs): return t @staticmethod - def serialize_duration(attr, **kwargs): + 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): + 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. + :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: - raise TypeError("RFC1123 object must be valid Datetime object.") + 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], @@ -1139,12 +1145,13 @@ def serialize_rfc(attr, **kwargs): ) @staticmethod - def serialize_iso(attr, **kwargs): + 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. + :raises SerializationError: if format invalid. + :return: serialized iso """ if isinstance(attr, str): attr = isodate.parse_datetime(attr) @@ -1170,13 +1177,14 @@ def serialize_iso(attr, **kwargs): raise TypeError(msg) from err @staticmethod - def serialize_unix(attr, **kwargs): + 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 + :raises SerializationError: if format invalid + :return: serialied unix """ if isinstance(attr, int): return attr @@ -1184,11 +1192,11 @@ def serialize_unix(attr, **kwargs): if not attr.tzinfo: _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") return int(calendar.timegm(attr.utctimetuple())) - except AttributeError: - raise TypeError("Unix time object must be valid Datetime object.") + except AttributeError as exc: + raise TypeError("Unix time object must be valid Datetime object.") from exc -def rest_key_extractor(attr, attr_desc, data): +def rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument key = attr_desc["key"] working_data = data @@ -1209,7 +1217,9 @@ def rest_key_extractor(attr, attr_desc, data): return working_data.get(key) -def rest_key_case_insensitive_extractor(attr, attr_desc, data): +def rest_key_case_insensitive_extractor( # pylint: disable=unused-argument, inconsistent-return-statements + attr, attr_desc, data +): key = attr_desc["key"] working_data = data @@ -1230,17 +1240,29 @@ def rest_key_case_insensitive_extractor(attr, attr_desc, data): return attribute_key_case_insensitive_extractor(key, None, working_data) -def last_rest_key_extractor(attr, attr_desc, data): - """Extract the attribute in "data" based on the last part of the JSON path key.""" +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): +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) @@ -1277,7 +1299,7 @@ def _extract_name_from_internal_type(internal_type): return xml_name -def xml_key_extractor(attr, attr_desc, data): +def xml_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument,too-many-return-statements if isinstance(data, dict): return None @@ -1329,22 +1351,21 @@ def xml_key_extractor(attr, attr_desc, data): if is_iter_type: if is_wrapped: return None # is_wrapped no node, we want None - else: - return [] # not wrapped, assume empty list + 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 - else: # 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 - ) + # 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. + ) + 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: @@ -1352,7 +1373,7 @@ def xml_key_extractor(attr, attr_desc, data): return children[0] -class Deserializer(object): +class Deserializer: """Response object model deserializer. :param dict classes: Class type dictionary for deserializing complex types. @@ -1361,9 +1382,9 @@ class Deserializer(object): 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}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + 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): + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: self.deserialize_type = { "iso-8601": Deserializer.deserialize_iso, "rfc-1123": Deserializer.deserialize_rfc, @@ -1399,27 +1420,29 @@ def __call__(self, target_obj, response_data, content_type=None): :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. + :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): + 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. + :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(): + for attr, mapconfig in data._attribute_map.items(): # pylint: disable=protected-access if attr in constants: continue value = getattr(data, attr) @@ -1438,13 +1461,13 @@ def _deserialize(self, target_obj, data): if isinstance(response, str): return self.deserialize_data(data, response) - elif isinstance(response, type) and issubclass(response, Enum): + if isinstance(response, type) and issubclass(response, Enum): return self.deserialize_enum(data, response) - if data is None: + if data is None or data is CoreNull: return data try: - attributes = response._attribute_map # type: ignore + 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"... @@ -1474,9 +1497,8 @@ def _deserialize(self, target_obj, data): except (AttributeError, TypeError, KeyError) as err: msg = "Unable to deserialize to object: " + class_name # type: ignore raise DeserializationError(msg) from err - else: - additional_properties = self._build_additional_properties(attributes, data) - return self._instantiate_model(response, d_attrs, additional_properties) + 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: @@ -1503,6 +1525,8 @@ def _classify_target(self, target, data): :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 @@ -1514,7 +1538,7 @@ def _classify_target(self, target, data): return target, target try: - target = target._classify(data, self.dependencies) # type: ignore + 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 @@ -1529,10 +1553,12 @@ def failsafe_deserialize(self, target_obj, data, content_type=None): :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: + except: # pylint: disable=bare-except _LOGGER.debug( "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True ) @@ -1550,10 +1576,12 @@ def _unpack_content(raw_data, content_type=None): If raw_data is something else, bypass all logic and return it directly. - :param raw_data: Data to be processed. - :param content_type: How to parse if raw_data is a string/bytes. + :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", {}) @@ -1577,24 +1605,35 @@ def _unpack_content(raw_data, content_type=None): def _instantiate_model(self, response, attrs, additional_properties=None): """Instantiate a response model passing in deserialized args. - :param response: The response model class. - :param d_attrs: The deserialized response attributes. + :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() if v.get("readonly")] - const = [k for k, v in response._validation.items() if v.get("constant")] + 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 + 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)) + raise DeserializationError(msg + str(err)) from err else: try: for attr, value in attrs.items(): @@ -1603,15 +1642,16 @@ def _instantiate_model(self, response, attrs, additional_properties=None): except Exception as exp: msg = "Unable to populate response model. " msg += "Type: {}, Error: {}".format(type(response), exp) - raise DeserializationError(msg) + raise DeserializationError(msg) from exp - def deserialize_data(self, data, data_type): + 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. + :raises DeserializationError: if deserialization fails. :return: Deserialized object. + :rtype: object """ if data is None: return data @@ -1625,7 +1665,11 @@ def deserialize_data(self, data, data_type): if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): return data - is_a_text_parsing_type = lambda x: x not in ["object", "[]", r"{}"] + 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) @@ -1645,14 +1689,14 @@ def deserialize_data(self, data, data_type): msg = "Unable to deserialize response data." msg += " Data: {}, {}".format(data, data_type) raise DeserializationError(msg) from err - else: - return self._deserialize(obj_type, data) + 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: @@ -1669,6 +1713,7 @@ def deserialize_dict(self, attr, dict_type): :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): @@ -1679,13 +1724,14 @@ def deserialize_dict(self, attr, dict_type): 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): + 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. + :raises TypeError: if non-builtin datatype encountered. """ if attr is None: return None @@ -1718,11 +1764,10 @@ def deserialize_object(self, attr, **kwargs): pass return deserialized - else: - error = "Cannot deserialize generic object with type: " - raise TypeError(error + str(obj_type)) + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) - def deserialize_basic(self, attr, data_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 @@ -1730,8 +1775,9 @@ def deserialize_basic(self, attr, data_type): :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. + :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 @@ -1741,24 +1787,23 @@ def deserialize_basic(self, attr, data_type): if data_type == "str": # None or '', node is empty string. return "" - else: - # None or '', node with a strong type is None. - # Don't try to model "empty bool" or "empty int" - return None + # 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) - elif isinstance(attr, str): + if isinstance(attr, str): if attr.lower() in ["true", "1"]: return True - elif attr.lower() in ["false", "0"]: + 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 + return eval(data_type)(attr) # nosec # pylint: disable=eval-used @staticmethod def deserialize_unicode(data): @@ -1766,6 +1811,7 @@ def deserialize_unicode(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, @@ -1779,8 +1825,7 @@ def deserialize_unicode(data): return data except NameError: return str(data) - else: - return str(data) + return str(data) @staticmethod def deserialize_enum(data, enum_obj): @@ -1792,6 +1837,7 @@ def deserialize_enum(data, enum_obj): :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: @@ -1802,9 +1848,9 @@ def deserialize_enum(data, enum_obj): # Workaround. We might consider remove it in the future. try: return list(enum_obj.__members__.values())[data] - except IndexError: + except IndexError as exc: error = "{!r} is not a valid index for enum {!r}" - raise DeserializationError(error.format(data, enum_obj)) + raise DeserializationError(error.format(data, enum_obj)) from exc try: return enum_obj(str(data)) except ValueError: @@ -1820,8 +1866,9 @@ 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. + :raises TypeError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1832,8 +1879,9 @@ 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. + :raises TypeError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1847,8 +1895,9 @@ def deserialize_decimal(attr): """Deserialize string into Decimal object. :param str attr: response string to be deserialized. - :rtype: Decimal - :raises: DeserializationError if string format invalid. + :return: Deserialized decimal + :raises DeserializationError: if string format invalid. + :rtype: decimal """ if isinstance(attr, ET.Element): attr = attr.text @@ -1863,8 +1912,9 @@ 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. + :raises ValueError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1875,8 +1925,9 @@ 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. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1885,16 +1936,16 @@ def deserialize_duration(attr): except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize duration object." raise DeserializationError(msg) from err - else: - return duration + 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. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1908,8 +1959,9 @@ 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. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1922,31 +1974,32 @@ 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. + :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=_FixedOffset(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + *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 - else: - return date_obj + 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. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1974,8 +2027,7 @@ def deserialize_iso(attr): except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize datetime object." raise DeserializationError(msg) from err - else: - return date_obj + return date_obj @staticmethod def deserialize_unix(attr): @@ -1983,8 +2035,9 @@ def deserialize_unix(attr): This is represented as seconds. :param int attr: Object to be serialized. + :return: Deserialized datetime :rtype: Datetime - :raises: DeserializationError if format invalid + :raises DeserializationError: if format invalid """ if isinstance(attr, ET.Element): attr = int(attr.text) # type: ignore @@ -1994,5 +2047,4 @@ def deserialize_unix(attr): except ValueError as err: msg = "Cannot deserialize to unix datetime object." raise DeserializationError(msg) from err - else: - return date_obj + return date_obj diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/__init__.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/__init__.py index 3b2f1e1ffe83..54cb0e7f0b09 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/__init__.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/__init__.py @@ -1,14 +1,20 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.13.7) +# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.28.4) # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._client import AzureCommunicationRoomsService +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import AzureCommunicationRoomsService # type: ignore try: from ._patch import __all__ as _patch_all - from ._patch import * # pylint: disable=unused-wildcard-import + from ._patch import * except ImportError: _patch_all = [] from ._patch import patch_sdk as _patch_sdk @@ -16,6 +22,6 @@ __all__ = [ "AzureCommunicationRoomsService", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/_client.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/_client.py index 5fe9ee7977c8..38349ff1c2b9 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/_client.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/_client.py @@ -1,11 +1,12 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.13.7) +# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.28.4) # 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 @@ -16,7 +17,7 @@ from .operations import ParticipantsOperations, RoomsOperations -class AzureCommunicationRoomsService: # pylint: disable=client-accepts-api-version-keyword +class AzureCommunicationRoomsService: """Azure Communication Room Service. :ivar rooms: RoomsOperations operations @@ -25,7 +26,7 @@ class AzureCommunicationRoomsService: # pylint: disable=client-accepts-api-vers :vartype participants: azure.communication.rooms.aio.operations.ParticipantsOperations :param endpoint: The endpoint of the Azure Communication resource. Required. :type endpoint: str - :keyword api_version: Api Version. Default value is "2024-04-15". Note that overriding this + :keyword api_version: Api Version. Default value is "2025-03-07". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ @@ -91,7 +92,7 @@ def send_request( async def close(self) -> None: await self._client.close() - async def __aenter__(self) -> "AzureCommunicationRoomsService": + async def __aenter__(self) -> Self: await self._client.__aenter__() return self diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/_configuration.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/_configuration.py index d16cdcc0d1ea..b61a4825ad0a 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/_configuration.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/_configuration.py @@ -1,6 +1,6 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.13.7) +# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.28.4) # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- @@ -19,13 +19,13 @@ class AzureCommunicationRoomsServiceConfiguration: # pylint: disable=too-many-i :param endpoint: The endpoint of the Azure Communication resource. Required. :type endpoint: str - :keyword api_version: Api Version. Default value is "2024-04-15". Note that overriding this + :keyword api_version: Api Version. Default value is "2025-03-07". Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, **kwargs: Any) -> None: - api_version: str = kwargs.pop("api_version", "2024-04-15") + api_version: str = kwargs.pop("api_version", "2025-03-07") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/_patch.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/_patch.py index f7dd32510333..49900f6ab120 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/_patch.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/_patch.py @@ -2,6 +2,7 @@ # Copyright (c) Microsoft Corporation. # Licensed under the MIT License. # ------------------------------------ + """Customize generated code here. Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/operations/__init__.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/operations/__init__.py index 66faef91bac1..49831b68010c 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/operations/__init__.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/operations/__init__.py @@ -1,19 +1,25 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.13.7) +# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.28.4) # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._operations import RoomsOperations -from ._operations import ParticipantsOperations +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._operations import RoomsOperations # type: ignore +from ._operations import ParticipantsOperations # type: ignore from ._patch import __all__ as _patch_all -from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import * from ._patch import patch_sdk as _patch_sdk __all__ = [ "RoomsOperations", "ParticipantsOperations", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/operations/_operations.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/operations/_operations.py index 8de5fc317794..4b6e55bc1580 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/operations/_operations.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/operations/_operations.py @@ -1,7 +1,6 @@ -# pylint: disable=too-many-lines,too-many-statements # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.13.7) +# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.28.4) # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- from io import IOBase @@ -9,6 +8,7 @@ from typing import Any, AsyncIterable, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload import urllib.parse +from azure.core import AsyncPipelineClient from azure.core.async_paging import AsyncItemPaged, AsyncList from azure.core.exceptions import ( ClientAuthenticationError, @@ -24,6 +24,7 @@ from azure.core.tracing.decorator_async import distributed_trace_async from azure.core.utils import case_insensitive_dict +from ..._serialization import Deserializer, Serializer from ...operations._operations import ( build_participants_list_request, build_participants_update_request, @@ -33,11 +34,12 @@ build_rooms_list_request, build_rooms_update_request, ) +from .._configuration import AzureCommunicationRoomsServiceConfiguration if sys.version_info >= (3, 9): from collections.abc import MutableMapping else: - from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports + from typing import MutableMapping # type: ignore JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object T = TypeVar("T") ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] @@ -55,14 +57,15 @@ class RoomsOperations: def __init__(self, *args, **kwargs) -> None: input_args = list(args) - self._client = input_args.pop(0) if input_args else kwargs.pop("client") - self._config = input_args.pop(0) if input_args else kwargs.pop("config") - self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") - self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + self._client: AsyncPipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: AzureCommunicationRoomsServiceConfiguration = ( + input_args.pop(0) if input_args else kwargs.pop("config") + ) + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") @overload async def create(self, create_room_request: JSON, *, content_type: str = "application/json", **kwargs: Any) -> JSON: - # pylint: disable=line-too-long """Creates a new room. Creates a new room. @@ -83,39 +86,21 @@ async def create(self, create_room_request: JSON, *, content_type: str = "applic create_room_request = { "participants": { "str": { - "role": "str" # The role of a room participant. The default - value is Attendee. Required. Known values are: "Presenter", "Attendee", - and "Consumer". + "role": "str" } }, - "pstnDialOutEnabled": bool, # Optional. Set this flag to true if, at the - time of the call, dial out to a PSTN number is enabled in a particular room. By - default, this flag is set to false. - "validFrom": "2020-02-20 00:00:00", # Optional. The timestamp from when the - room is open for joining. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. The default value is the current date time. - "validUntil": "2020-02-20 00:00:00" # Optional. The timestamp from when the - room can no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. The default value is the current date time plus 180 - days. + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } # response body for status code(s): 201 response == { - "createdAt": "2020-02-20 00:00:00", # The timestamp when the room was - created at the server. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. - "id": "str", # Unique identifier of a room. This id is server generated. - Required. - "pstnDialOutEnabled": bool, # Set this flag to true if, at the time of the - call, dial out to a PSTN number is enabled in a particular room. By default, this - flag is set to false. Required. - "validFrom": "2020-02-20 00:00:00", # The timestamp from when the room is - open for joining. The timestamp is in RFC3339 format: ``yyyy-MM-ddTHH:mm:ssZ``. - Required. - "validUntil": "2020-02-20 00:00:00" # The timestamp from when the room can - no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. + "createdAt": "2020-02-20 00:00:00", + "id": "str", + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } """ @@ -123,7 +108,6 @@ async def create(self, create_room_request: JSON, *, content_type: str = "applic async def create( self, create_room_request: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> JSON: - # pylint: disable=line-too-long """Creates a new room. Creates a new room. @@ -142,26 +126,16 @@ async def create( # response body for status code(s): 201 response == { - "createdAt": "2020-02-20 00:00:00", # The timestamp when the room was - created at the server. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. - "id": "str", # Unique identifier of a room. This id is server generated. - Required. - "pstnDialOutEnabled": bool, # Set this flag to true if, at the time of the - call, dial out to a PSTN number is enabled in a particular room. By default, this - flag is set to false. Required. - "validFrom": "2020-02-20 00:00:00", # The timestamp from when the room is - open for joining. The timestamp is in RFC3339 format: ``yyyy-MM-ddTHH:mm:ssZ``. - Required. - "validUntil": "2020-02-20 00:00:00" # The timestamp from when the room can - no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. + "createdAt": "2020-02-20 00:00:00", + "id": "str", + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } """ @distributed_trace_async async def create(self, create_room_request: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: - # pylint: disable=line-too-long """Creates a new room. Creates a new room. @@ -180,42 +154,24 @@ async def create(self, create_room_request: Union[JSON, IO[bytes]], **kwargs: An create_room_request = { "participants": { "str": { - "role": "str" # The role of a room participant. The default - value is Attendee. Required. Known values are: "Presenter", "Attendee", - and "Consumer". + "role": "str" } }, - "pstnDialOutEnabled": bool, # Optional. Set this flag to true if, at the - time of the call, dial out to a PSTN number is enabled in a particular room. By - default, this flag is set to false. - "validFrom": "2020-02-20 00:00:00", # Optional. The timestamp from when the - room is open for joining. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. The default value is the current date time. - "validUntil": "2020-02-20 00:00:00" # Optional. The timestamp from when the - room can no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. The default value is the current date time plus 180 - days. + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } # response body for status code(s): 201 response == { - "createdAt": "2020-02-20 00:00:00", # The timestamp when the room was - created at the server. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. - "id": "str", # Unique identifier of a room. This id is server generated. - Required. - "pstnDialOutEnabled": bool, # Set this flag to true if, at the time of the - call, dial out to a PSTN number is enabled in a particular room. By default, this - flag is set to false. Required. - "validFrom": "2020-02-20 00:00:00", # The timestamp from when the room is - open for joining. The timestamp is in RFC3339 format: ``yyyy-MM-ddTHH:mm:ssZ``. - Required. - "validUntil": "2020-02-20 00:00:00" # The timestamp from when the room can - no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. + "createdAt": "2020-02-20 00:00:00", + "id": "str", + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -258,8 +214,6 @@ async def create(self, create_room_request: Union[JSON, IO[bytes]], **kwargs: An response = pipeline_response.http_response if response.status_code not in [201]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -275,7 +229,6 @@ async def create(self, create_room_request: Union[JSON, IO[bytes]], **kwargs: An @distributed_trace def list(self, **kwargs: Any) -> AsyncIterable[JSON]: - # pylint: disable=line-too-long """Retrieves all created rooms. Retrieves all created rooms. @@ -289,20 +242,11 @@ def list(self, **kwargs: Any) -> AsyncIterable[JSON]: # response body for status code(s): 200 response == { - "createdAt": "2020-02-20 00:00:00", # The timestamp when the room was - created at the server. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. - "id": "str", # Unique identifier of a room. This id is server generated. - Required. - "pstnDialOutEnabled": bool, # Set this flag to true if, at the time of the - call, dial out to a PSTN number is enabled in a particular room. By default, this - flag is set to false. Required. - "validFrom": "2020-02-20 00:00:00", # The timestamp from when the room is - open for joining. The timestamp is in RFC3339 format: ``yyyy-MM-ddTHH:mm:ssZ``. - Required. - "validUntil": "2020-02-20 00:00:00" # The timestamp from when the room can - no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. + "createdAt": "2020-02-20 00:00:00", + "id": "str", + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } """ _headers = kwargs.pop("headers", {}) or {} @@ -310,7 +254,7 @@ def list(self, **kwargs: Any) -> AsyncIterable[JSON]: cls: ClsType[JSON] = kwargs.pop("cls", None) - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -372,8 +316,6 @@ async def get_next(next_link=None): response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -383,7 +325,6 @@ async def get_next(next_link=None): @distributed_trace_async async def get(self, room_id: str, **kwargs: Any) -> JSON: - # pylint: disable=line-too-long """Retrieves an existing room by id. Retrieves an existing room by id. @@ -399,23 +340,14 @@ async def get(self, room_id: str, **kwargs: Any) -> JSON: # response body for status code(s): 200 response == { - "createdAt": "2020-02-20 00:00:00", # The timestamp when the room was - created at the server. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. - "id": "str", # Unique identifier of a room. This id is server generated. - Required. - "pstnDialOutEnabled": bool, # Set this flag to true if, at the time of the - call, dial out to a PSTN number is enabled in a particular room. By default, this - flag is set to false. Required. - "validFrom": "2020-02-20 00:00:00", # The timestamp from when the room is - open for joining. The timestamp is in RFC3339 format: ``yyyy-MM-ddTHH:mm:ssZ``. - Required. - "validUntil": "2020-02-20 00:00:00" # The timestamp from when the room can - no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. + "createdAt": "2020-02-20 00:00:00", + "id": "str", + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -447,8 +379,6 @@ async def get(self, room_id: str, **kwargs: Any) -> JSON: response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -471,7 +401,6 @@ async def update( content_type: str = "application/merge-patch+json", **kwargs: Any ) -> JSON: - # pylint: disable=line-too-long """Update a room with given changes. Update a room with given changes. @@ -492,33 +421,18 @@ async def update( # JSON input template you can fill out and use as your body input. update_room_request = { - "pstnDialOutEnabled": bool, # Optional. Set this flag to true if, at the - time of the call, dial out to a PSTN number is enabled in a particular room. By - default, this flag is set to false. - "validFrom": "2020-02-20 00:00:00", # Optional. (Optional) The timestamp - from when the room is open for joining. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. - "validUntil": "2020-02-20 00:00:00" # Optional. (Optional) The timestamp - from when the room can no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } # response body for status code(s): 200 response == { - "createdAt": "2020-02-20 00:00:00", # The timestamp when the room was - created at the server. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. - "id": "str", # Unique identifier of a room. This id is server generated. - Required. - "pstnDialOutEnabled": bool, # Set this flag to true if, at the time of the - call, dial out to a PSTN number is enabled in a particular room. By default, this - flag is set to false. Required. - "validFrom": "2020-02-20 00:00:00", # The timestamp from when the room is - open for joining. The timestamp is in RFC3339 format: ``yyyy-MM-ddTHH:mm:ssZ``. - Required. - "validUntil": "2020-02-20 00:00:00" # The timestamp from when the room can - no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. + "createdAt": "2020-02-20 00:00:00", + "id": "str", + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } """ @@ -531,7 +445,6 @@ async def update( content_type: str = "application/merge-patch+json", **kwargs: Any ) -> JSON: - # pylint: disable=line-too-long """Update a room with given changes. Update a room with given changes. @@ -552,26 +465,16 @@ async def update( # response body for status code(s): 200 response == { - "createdAt": "2020-02-20 00:00:00", # The timestamp when the room was - created at the server. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. - "id": "str", # Unique identifier of a room. This id is server generated. - Required. - "pstnDialOutEnabled": bool, # Set this flag to true if, at the time of the - call, dial out to a PSTN number is enabled in a particular room. By default, this - flag is set to false. Required. - "validFrom": "2020-02-20 00:00:00", # The timestamp from when the room is - open for joining. The timestamp is in RFC3339 format: ``yyyy-MM-ddTHH:mm:ssZ``. - Required. - "validUntil": "2020-02-20 00:00:00" # The timestamp from when the room can - no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. + "createdAt": "2020-02-20 00:00:00", + "id": "str", + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } """ @distributed_trace_async async def update(self, room_id: str, update_room_request: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: - # pylint: disable=line-too-long """Update a room with given changes. Update a room with given changes. @@ -590,36 +493,21 @@ async def update(self, room_id: str, update_room_request: Union[JSON, IO[bytes]] # JSON input template you can fill out and use as your body input. update_room_request = { - "pstnDialOutEnabled": bool, # Optional. Set this flag to true if, at the - time of the call, dial out to a PSTN number is enabled in a particular room. By - default, this flag is set to false. - "validFrom": "2020-02-20 00:00:00", # Optional. (Optional) The timestamp - from when the room is open for joining. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. - "validUntil": "2020-02-20 00:00:00" # Optional. (Optional) The timestamp - from when the room can no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } # response body for status code(s): 200 response == { - "createdAt": "2020-02-20 00:00:00", # The timestamp when the room was - created at the server. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. - "id": "str", # Unique identifier of a room. This id is server generated. - Required. - "pstnDialOutEnabled": bool, # Set this flag to true if, at the time of the - call, dial out to a PSTN number is enabled in a particular room. By default, this - flag is set to false. Required. - "validFrom": "2020-02-20 00:00:00", # The timestamp from when the room is - open for joining. The timestamp is in RFC3339 format: ``yyyy-MM-ddTHH:mm:ssZ``. - Required. - "validUntil": "2020-02-20 00:00:00" # The timestamp from when the room can - no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. + "createdAt": "2020-02-20 00:00:00", + "id": "str", + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -663,8 +551,6 @@ async def update(self, room_id: str, update_room_request: Union[JSON, IO[bytes]] response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -679,7 +565,7 @@ async def update(self, room_id: str, update_room_request: Union[JSON, IO[bytes]] return cast(JSON, deserialized) # type: ignore @distributed_trace_async - async def delete(self, room_id: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + async def delete(self, room_id: str, **kwargs: Any) -> None: """Delete a room. Delete a room. @@ -690,7 +576,7 @@ async def delete(self, room_id: str, **kwargs: Any) -> None: # pylint: disable= :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -722,8 +608,6 @@ async def delete(self, room_id: str, **kwargs: Any) -> None: # pylint: disable= response = pipeline_response.http_response if response.status_code not in [204]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -743,14 +627,15 @@ class ParticipantsOperations: def __init__(self, *args, **kwargs) -> None: input_args = list(args) - self._client = input_args.pop(0) if input_args else kwargs.pop("client") - self._config = input_args.pop(0) if input_args else kwargs.pop("config") - self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") - self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + self._client: AsyncPipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: AzureCommunicationRoomsServiceConfiguration = ( + input_args.pop(0) if input_args else kwargs.pop("config") + ) + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") @distributed_trace def list(self, room_id: str, **kwargs: Any) -> AsyncIterable[JSON]: - # pylint: disable=line-too-long """Get participants in a room. Get participants in a room. @@ -766,13 +651,8 @@ def list(self, room_id: str, **kwargs: Any) -> AsyncIterable[JSON]: # response body for status code(s): 200 response == { - "rawId": "str", # Raw ID representation of the communication identifier. - Please refer to the following document for additional information on Raw ID. - :code:`
` - https://learn.microsoft.com/azure/communication-services/concepts/identifiers?pivots=programming-language-rest#raw-id-representation. - Required. - "role": "str" # The role of a room participant. The default value is - Attendee. Required. Known values are: "Presenter", "Attendee", and "Consumer". + "rawId": "str", + "role": "str" } """ _headers = kwargs.pop("headers", {}) or {} @@ -780,7 +660,7 @@ def list(self, room_id: str, **kwargs: Any) -> AsyncIterable[JSON]: cls: ClsType[JSON] = kwargs.pop("cls", None) - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -843,8 +723,6 @@ async def get_next(next_link=None): response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -861,7 +739,6 @@ async def update( content_type: str = "application/merge-patch+json", **kwargs: Any ) -> JSON: - # pylint: disable=line-too-long """Update participants in a room. Update participants in a room. @@ -884,9 +761,7 @@ async def update( update_participants_request = { "participants": { "str": { - "role": "str" # The role of a room participant. The default - value is Attendee. Required. Known values are: "Presenter", "Attendee", - and "Consumer". + "role": "str" } } } @@ -919,7 +794,6 @@ async def update( @distributed_trace_async async def update(self, room_id: str, update_participants_request: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: - # pylint: disable=line-too-long """Update participants in a room. Update participants in a room. @@ -940,14 +814,12 @@ async def update(self, room_id: str, update_participants_request: Union[JSON, IO update_participants_request = { "participants": { "str": { - "role": "str" # The role of a room participant. The default - value is Attendee. Required. Known values are: "Presenter", "Attendee", - and "Consumer". + "role": "str" } } } """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -991,8 +863,6 @@ async def update(self, room_id: str, update_participants_request: Union[JSON, IO response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/operations/_patch.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/operations/_patch.py index f7dd32510333..49900f6ab120 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/operations/_patch.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/aio/operations/_patch.py @@ -2,6 +2,7 @@ # Copyright (c) Microsoft Corporation. # Licensed under the MIT License. # ------------------------------------ + """Customize generated code here. Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/operations/__init__.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/operations/__init__.py index 66faef91bac1..49831b68010c 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/operations/__init__.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/operations/__init__.py @@ -1,19 +1,25 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.13.7) +# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.28.4) # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._operations import RoomsOperations -from ._operations import ParticipantsOperations +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._operations import RoomsOperations # type: ignore +from ._operations import ParticipantsOperations # type: ignore from ._patch import __all__ as _patch_all -from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import * from ._patch import patch_sdk as _patch_sdk __all__ = [ "RoomsOperations", "ParticipantsOperations", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/operations/_operations.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/operations/_operations.py index d19bf6b0f157..9e327b88227c 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/operations/_operations.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/operations/_operations.py @@ -1,7 +1,7 @@ -# pylint: disable=too-many-lines,too-many-statements +# pylint: disable=too-many-lines # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.13.7) +# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.28.4) # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- import datetime @@ -11,6 +11,7 @@ import urllib.parse import uuid +from azure.core import PipelineClient from azure.core.exceptions import ( ClientAuthenticationError, HttpResponseError, @@ -25,12 +26,13 @@ from azure.core.tracing.decorator import distributed_trace from azure.core.utils import case_insensitive_dict -from .._serialization import Serializer +from .._configuration import AzureCommunicationRoomsServiceConfiguration +from .._serialization import Deserializer, Serializer if sys.version_info >= (3, 9): from collections.abc import MutableMapping else: - from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports + from typing import MutableMapping # type: ignore JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object T = TypeVar("T") ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] @@ -44,7 +46,7 @@ def build_rooms_create_request(**kwargs: Any) -> HttpRequest: _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-04-15")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-03-07")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -71,7 +73,7 @@ def build_rooms_list_request(**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-04-15")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-03-07")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -90,7 +92,7 @@ def build_rooms_get_request(room_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-04-15")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-03-07")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -115,7 +117,7 @@ def build_rooms_update_request(room_id: str, **kwargs: Any) -> HttpRequest: _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-04-15")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-03-07")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -141,7 +143,7 @@ def build_rooms_delete_request(room_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-04-15")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-03-07")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -165,7 +167,7 @@ def build_participants_list_request(room_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-04-15")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-03-07")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -190,7 +192,7 @@ def build_participants_update_request(room_id: str, **kwargs: Any) -> HttpReques _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-04-15")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-03-07")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -224,14 +226,15 @@ class RoomsOperations: def __init__(self, *args, **kwargs): input_args = list(args) - self._client = input_args.pop(0) if input_args else kwargs.pop("client") - self._config = input_args.pop(0) if input_args else kwargs.pop("config") - self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") - self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + self._client: PipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: AzureCommunicationRoomsServiceConfiguration = ( + input_args.pop(0) if input_args else kwargs.pop("config") + ) + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") @overload def create(self, create_room_request: JSON, *, content_type: str = "application/json", **kwargs: Any) -> JSON: - # pylint: disable=line-too-long """Creates a new room. Creates a new room. @@ -252,45 +255,26 @@ def create(self, create_room_request: JSON, *, content_type: str = "application/ create_room_request = { "participants": { "str": { - "role": "str" # The role of a room participant. The default - value is Attendee. Required. Known values are: "Presenter", "Attendee", - and "Consumer". + "role": "str" } }, - "pstnDialOutEnabled": bool, # Optional. Set this flag to true if, at the - time of the call, dial out to a PSTN number is enabled in a particular room. By - default, this flag is set to false. - "validFrom": "2020-02-20 00:00:00", # Optional. The timestamp from when the - room is open for joining. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. The default value is the current date time. - "validUntil": "2020-02-20 00:00:00" # Optional. The timestamp from when the - room can no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. The default value is the current date time plus 180 - days. + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } # response body for status code(s): 201 response == { - "createdAt": "2020-02-20 00:00:00", # The timestamp when the room was - created at the server. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. - "id": "str", # Unique identifier of a room. This id is server generated. - Required. - "pstnDialOutEnabled": bool, # Set this flag to true if, at the time of the - call, dial out to a PSTN number is enabled in a particular room. By default, this - flag is set to false. Required. - "validFrom": "2020-02-20 00:00:00", # The timestamp from when the room is - open for joining. The timestamp is in RFC3339 format: ``yyyy-MM-ddTHH:mm:ssZ``. - Required. - "validUntil": "2020-02-20 00:00:00" # The timestamp from when the room can - no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. + "createdAt": "2020-02-20 00:00:00", + "id": "str", + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } """ @overload def create(self, create_room_request: IO[bytes], *, content_type: str = "application/json", **kwargs: Any) -> JSON: - # pylint: disable=line-too-long """Creates a new room. Creates a new room. @@ -309,26 +293,16 @@ def create(self, create_room_request: IO[bytes], *, content_type: str = "applica # response body for status code(s): 201 response == { - "createdAt": "2020-02-20 00:00:00", # The timestamp when the room was - created at the server. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. - "id": "str", # Unique identifier of a room. This id is server generated. - Required. - "pstnDialOutEnabled": bool, # Set this flag to true if, at the time of the - call, dial out to a PSTN number is enabled in a particular room. By default, this - flag is set to false. Required. - "validFrom": "2020-02-20 00:00:00", # The timestamp from when the room is - open for joining. The timestamp is in RFC3339 format: ``yyyy-MM-ddTHH:mm:ssZ``. - Required. - "validUntil": "2020-02-20 00:00:00" # The timestamp from when the room can - no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. + "createdAt": "2020-02-20 00:00:00", + "id": "str", + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } """ @distributed_trace def create(self, create_room_request: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: - # pylint: disable=line-too-long """Creates a new room. Creates a new room. @@ -347,42 +321,24 @@ def create(self, create_room_request: Union[JSON, IO[bytes]], **kwargs: Any) -> create_room_request = { "participants": { "str": { - "role": "str" # The role of a room participant. The default - value is Attendee. Required. Known values are: "Presenter", "Attendee", - and "Consumer". + "role": "str" } }, - "pstnDialOutEnabled": bool, # Optional. Set this flag to true if, at the - time of the call, dial out to a PSTN number is enabled in a particular room. By - default, this flag is set to false. - "validFrom": "2020-02-20 00:00:00", # Optional. The timestamp from when the - room is open for joining. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. The default value is the current date time. - "validUntil": "2020-02-20 00:00:00" # Optional. The timestamp from when the - room can no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. The default value is the current date time plus 180 - days. + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } # response body for status code(s): 201 response == { - "createdAt": "2020-02-20 00:00:00", # The timestamp when the room was - created at the server. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. - "id": "str", # Unique identifier of a room. This id is server generated. - Required. - "pstnDialOutEnabled": bool, # Set this flag to true if, at the time of the - call, dial out to a PSTN number is enabled in a particular room. By default, this - flag is set to false. Required. - "validFrom": "2020-02-20 00:00:00", # The timestamp from when the room is - open for joining. The timestamp is in RFC3339 format: ``yyyy-MM-ddTHH:mm:ssZ``. - Required. - "validUntil": "2020-02-20 00:00:00" # The timestamp from when the room can - no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. + "createdAt": "2020-02-20 00:00:00", + "id": "str", + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -425,8 +381,6 @@ def create(self, create_room_request: Union[JSON, IO[bytes]], **kwargs: Any) -> response = pipeline_response.http_response if response.status_code not in [201]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -442,7 +396,6 @@ def create(self, create_room_request: Union[JSON, IO[bytes]], **kwargs: Any) -> @distributed_trace def list(self, **kwargs: Any) -> Iterable[JSON]: - # pylint: disable=line-too-long """Retrieves all created rooms. Retrieves all created rooms. @@ -456,20 +409,11 @@ def list(self, **kwargs: Any) -> Iterable[JSON]: # response body for status code(s): 200 response == { - "createdAt": "2020-02-20 00:00:00", # The timestamp when the room was - created at the server. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. - "id": "str", # Unique identifier of a room. This id is server generated. - Required. - "pstnDialOutEnabled": bool, # Set this flag to true if, at the time of the - call, dial out to a PSTN number is enabled in a particular room. By default, this - flag is set to false. Required. - "validFrom": "2020-02-20 00:00:00", # The timestamp from when the room is - open for joining. The timestamp is in RFC3339 format: ``yyyy-MM-ddTHH:mm:ssZ``. - Required. - "validUntil": "2020-02-20 00:00:00" # The timestamp from when the room can - no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. + "createdAt": "2020-02-20 00:00:00", + "id": "str", + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } """ _headers = kwargs.pop("headers", {}) or {} @@ -477,7 +421,7 @@ def list(self, **kwargs: Any) -> Iterable[JSON]: cls: ClsType[JSON] = kwargs.pop("cls", None) - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -539,8 +483,6 @@ def get_next(next_link=None): response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -550,7 +492,6 @@ def get_next(next_link=None): @distributed_trace def get(self, room_id: str, **kwargs: Any) -> JSON: - # pylint: disable=line-too-long """Retrieves an existing room by id. Retrieves an existing room by id. @@ -566,23 +507,14 @@ def get(self, room_id: str, **kwargs: Any) -> JSON: # response body for status code(s): 200 response == { - "createdAt": "2020-02-20 00:00:00", # The timestamp when the room was - created at the server. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. - "id": "str", # Unique identifier of a room. This id is server generated. - Required. - "pstnDialOutEnabled": bool, # Set this flag to true if, at the time of the - call, dial out to a PSTN number is enabled in a particular room. By default, this - flag is set to false. Required. - "validFrom": "2020-02-20 00:00:00", # The timestamp from when the room is - open for joining. The timestamp is in RFC3339 format: ``yyyy-MM-ddTHH:mm:ssZ``. - Required. - "validUntil": "2020-02-20 00:00:00" # The timestamp from when the room can - no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. + "createdAt": "2020-02-20 00:00:00", + "id": "str", + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -614,8 +546,6 @@ def get(self, room_id: str, **kwargs: Any) -> JSON: response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -638,7 +568,6 @@ def update( content_type: str = "application/merge-patch+json", **kwargs: Any ) -> JSON: - # pylint: disable=line-too-long """Update a room with given changes. Update a room with given changes. @@ -659,33 +588,18 @@ def update( # JSON input template you can fill out and use as your body input. update_room_request = { - "pstnDialOutEnabled": bool, # Optional. Set this flag to true if, at the - time of the call, dial out to a PSTN number is enabled in a particular room. By - default, this flag is set to false. - "validFrom": "2020-02-20 00:00:00", # Optional. (Optional) The timestamp - from when the room is open for joining. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. - "validUntil": "2020-02-20 00:00:00" # Optional. (Optional) The timestamp - from when the room can no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } # response body for status code(s): 200 response == { - "createdAt": "2020-02-20 00:00:00", # The timestamp when the room was - created at the server. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. - "id": "str", # Unique identifier of a room. This id is server generated. - Required. - "pstnDialOutEnabled": bool, # Set this flag to true if, at the time of the - call, dial out to a PSTN number is enabled in a particular room. By default, this - flag is set to false. Required. - "validFrom": "2020-02-20 00:00:00", # The timestamp from when the room is - open for joining. The timestamp is in RFC3339 format: ``yyyy-MM-ddTHH:mm:ssZ``. - Required. - "validUntil": "2020-02-20 00:00:00" # The timestamp from when the room can - no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. + "createdAt": "2020-02-20 00:00:00", + "id": "str", + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } """ @@ -698,7 +612,6 @@ def update( content_type: str = "application/merge-patch+json", **kwargs: Any ) -> JSON: - # pylint: disable=line-too-long """Update a room with given changes. Update a room with given changes. @@ -719,26 +632,16 @@ def update( # response body for status code(s): 200 response == { - "createdAt": "2020-02-20 00:00:00", # The timestamp when the room was - created at the server. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. - "id": "str", # Unique identifier of a room. This id is server generated. - Required. - "pstnDialOutEnabled": bool, # Set this flag to true if, at the time of the - call, dial out to a PSTN number is enabled in a particular room. By default, this - flag is set to false. Required. - "validFrom": "2020-02-20 00:00:00", # The timestamp from when the room is - open for joining. The timestamp is in RFC3339 format: ``yyyy-MM-ddTHH:mm:ssZ``. - Required. - "validUntil": "2020-02-20 00:00:00" # The timestamp from when the room can - no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. + "createdAt": "2020-02-20 00:00:00", + "id": "str", + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } """ @distributed_trace def update(self, room_id: str, update_room_request: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: - # pylint: disable=line-too-long """Update a room with given changes. Update a room with given changes. @@ -757,36 +660,21 @@ def update(self, room_id: str, update_room_request: Union[JSON, IO[bytes]], **kw # JSON input template you can fill out and use as your body input. update_room_request = { - "pstnDialOutEnabled": bool, # Optional. Set this flag to true if, at the - time of the call, dial out to a PSTN number is enabled in a particular room. By - default, this flag is set to false. - "validFrom": "2020-02-20 00:00:00", # Optional. (Optional) The timestamp - from when the room is open for joining. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. - "validUntil": "2020-02-20 00:00:00" # Optional. (Optional) The timestamp - from when the room can no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } # response body for status code(s): 200 response == { - "createdAt": "2020-02-20 00:00:00", # The timestamp when the room was - created at the server. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. - "id": "str", # Unique identifier of a room. This id is server generated. - Required. - "pstnDialOutEnabled": bool, # Set this flag to true if, at the time of the - call, dial out to a PSTN number is enabled in a particular room. By default, this - flag is set to false. Required. - "validFrom": "2020-02-20 00:00:00", # The timestamp from when the room is - open for joining. The timestamp is in RFC3339 format: ``yyyy-MM-ddTHH:mm:ssZ``. - Required. - "validUntil": "2020-02-20 00:00:00" # The timestamp from when the room can - no longer be joined. The timestamp is in RFC3339 format: - ``yyyy-MM-ddTHH:mm:ssZ``. Required. + "createdAt": "2020-02-20 00:00:00", + "id": "str", + "pstnDialOutEnabled": bool, + "validFrom": "2020-02-20 00:00:00", + "validUntil": "2020-02-20 00:00:00" } """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -830,8 +718,6 @@ def update(self, room_id: str, update_room_request: Union[JSON, IO[bytes]], **kw response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -857,7 +743,7 @@ def delete(self, room_id: str, **kwargs: Any) -> None: # pylint: disable=incons :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -889,8 +775,6 @@ def delete(self, room_id: str, **kwargs: Any) -> None: # pylint: disable=incons response = pipeline_response.http_response if response.status_code not in [204]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -910,14 +794,15 @@ class ParticipantsOperations: def __init__(self, *args, **kwargs): input_args = list(args) - self._client = input_args.pop(0) if input_args else kwargs.pop("client") - self._config = input_args.pop(0) if input_args else kwargs.pop("config") - self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") - self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + self._client: PipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: AzureCommunicationRoomsServiceConfiguration = ( + input_args.pop(0) if input_args else kwargs.pop("config") + ) + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") @distributed_trace def list(self, room_id: str, **kwargs: Any) -> Iterable[JSON]: - # pylint: disable=line-too-long """Get participants in a room. Get participants in a room. @@ -933,13 +818,8 @@ def list(self, room_id: str, **kwargs: Any) -> Iterable[JSON]: # response body for status code(s): 200 response == { - "rawId": "str", # Raw ID representation of the communication identifier. - Please refer to the following document for additional information on Raw ID. - :code:`
` - https://learn.microsoft.com/azure/communication-services/concepts/identifiers?pivots=programming-language-rest#raw-id-representation. - Required. - "role": "str" # The role of a room participant. The default value is - Attendee. Required. Known values are: "Presenter", "Attendee", and "Consumer". + "rawId": "str", + "role": "str" } """ _headers = kwargs.pop("headers", {}) or {} @@ -947,7 +827,7 @@ def list(self, room_id: str, **kwargs: Any) -> Iterable[JSON]: cls: ClsType[JSON] = kwargs.pop("cls", None) - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1010,8 +890,6 @@ def get_next(next_link=None): response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -1028,7 +906,6 @@ def update( content_type: str = "application/merge-patch+json", **kwargs: Any ) -> JSON: - # pylint: disable=line-too-long """Update participants in a room. Update participants in a room. @@ -1051,9 +928,7 @@ def update( update_participants_request = { "participants": { "str": { - "role": "str" # The role of a room participant. The default - value is Attendee. Required. Known values are: "Presenter", "Attendee", - and "Consumer". + "role": "str" } } } @@ -1086,7 +961,6 @@ def update( @distributed_trace def update(self, room_id: str, update_participants_request: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: - # pylint: disable=line-too-long """Update participants in a room. Update participants in a room. @@ -1107,14 +981,12 @@ def update(self, room_id: str, update_participants_request: Union[JSON, IO[bytes update_participants_request = { "participants": { "str": { - "role": "str" # The role of a room participant. The default - value is Attendee. Required. Known values are: "Presenter", "Attendee", - and "Consumer". + "role": "str" } } } """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1158,8 +1030,6 @@ def update(self, room_id: str, update_participants_request: Union[JSON, IO[bytes response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/operations/_patch.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/operations/_patch.py index f7dd32510333..49900f6ab120 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/operations/_patch.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_generated/operations/_patch.py @@ -2,6 +2,7 @@ # Copyright (c) Microsoft Corporation. # Licensed under the MIT License. # ------------------------------------ + """Customize generated code here. Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize diff --git a/sdk/communication/azure-communication-rooms/swagger/README.md b/sdk/communication/azure-communication-rooms/swagger/README.md index 9a04f0b8da2c..17782074c5a2 100644 --- a/sdk/communication/azure-communication-rooms/swagger/README.md +++ b/sdk/communication/azure-communication-rooms/swagger/README.md @@ -26,7 +26,7 @@ python: ```yaml title: Azure Communication Rooms Service require: - - https://raw.githubusercontent.com/Azure/azure-rest-api-specs/91813ca7a287fe944262e992413ce4d51d987276/specification/communication/data-plane/Rooms/readme.md + - https://raw.githubusercontent.com/Azure/azure-rest-api-specs/634e844ef2cc7a8968bc960683e44a531263ad63/specification/communication/data-plane/Rooms/readme.md output-folder: ../azure/communication/rooms/_generated namespace: azure.communication.rooms package-name: azure-communication-rooms From fff934c61c816f3d91f55f2e9ae7129c0ee93454 Mon Sep 17 00:00:00 2001 From: Paola Vicencio Date: Tue, 18 Feb 2025 21:30:21 -0600 Subject: [PATCH 2/7] Updating Rooms collaborator Role --- .../azure/communication/rooms/_models/_models.py | 1 + 1 file changed, 1 insertion(+) diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_models/_models.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_models/_models.py index 5fa115a914e3..6577960281ad 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_models/_models.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_models/_models.py @@ -19,6 +19,7 @@ class ParticipantRole(str, Enum, metaclass=CaseInsensitiveEnumMeta): PRESENTER = "Presenter" ATTENDEE = "Attendee" CONSUMER = "Consumer" + COLLABORATOR = "Collaborator" class RoomParticipant: From 81064fa0526105dfa8d29956142a30e0b57080b7 Mon Sep 17 00:00:00 2001 From: paola vicencio Date: Wed, 19 Feb 2025 01:40:13 -0600 Subject: [PATCH 3/7] updating sample and tests --- .../azure-communication-rooms/assets.json | 2 +- .../azure/communication/rooms/_api_versions.py | 3 ++- .../samples/rooms_client_sample.py | 12 ++++++++++++ .../tests/test_rooms_client.py | 16 +++++++++++++--- .../tests/test_rooms_client_async.py | 18 ++++++++++++++---- 5 files changed, 42 insertions(+), 9 deletions(-) diff --git a/sdk/communication/azure-communication-rooms/assets.json b/sdk/communication/azure-communication-rooms/assets.json index cbc996f28d15..1b698db806f3 100644 --- a/sdk/communication/azure-communication-rooms/assets.json +++ b/sdk/communication/azure-communication-rooms/assets.json @@ -2,5 +2,5 @@ "AssetsRepo": "Azure/azure-sdk-assets", "AssetsRepoPrefixPath": "python", "TagPrefix": "python/communication/azure-communication-rooms", - "Tag": "python/communication/azure-communication-rooms_8232264a76" + "Tag": "python/communication/azure-communication-rooms_191113872a" } diff --git a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_api_versions.py b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_api_versions.py index 6eea3ac3e5e6..de12cb9d91c8 100644 --- a/sdk/communication/azure-communication-rooms/azure/communication/rooms/_api_versions.py +++ b/sdk/communication/azure-communication-rooms/azure/communication/rooms/_api_versions.py @@ -10,6 +10,7 @@ class ApiVersion(str, Enum, metaclass=CaseInsensitiveEnumMeta): V2023_06_14 = "2023-06-14" V2024_04_15 = "2024-04-15" + V2025_03_07 = "2025-03-07" -DEFAULT_VERSION = ApiVersion.V2024_04_15 +DEFAULT_VERSION = ApiVersion.V2025_03_07 diff --git a/sdk/communication/azure-communication-rooms/samples/rooms_client_sample.py b/sdk/communication/azure-communication-rooms/samples/rooms_client_sample.py index 1e271955ab90..218615dd9020 100644 --- a/sdk/communication/azure-communication-rooms/samples/rooms_client_sample.py +++ b/sdk/communication/azure-communication-rooms/samples/rooms_client_sample.py @@ -149,6 +149,18 @@ def add_or_update_participants(self, room_id): except HttpResponseError as ex: print(ex) + # Starting in 1.2.0 release, we are introducing a new role called Collaborator + def add_or_update_participants_to_collaborator(self, room_id): + self.participant_1.role = ParticipantRole.COLLABORATOR + participants = [ + self.participant_1, # Update participant_1 role from Attendee to Collaborator + ] + + try: + self.rooms_client.add_or_update_participants(room_id=room_id, participants=participants) + except HttpResponseError as ex: + print(ex) + def list_participants(self, room_id): try: get_participants_response = self.rooms_client.list_participants(room_id=room_id) diff --git a/sdk/communication/azure-communication-rooms/tests/test_rooms_client.py b/sdk/communication/azure-communication-rooms/tests/test_rooms_client.py index 628cbc379d3e..4e629141ade6 100644 --- a/sdk/communication/azure-communication-rooms/tests/test_rooms_client.py +++ b/sdk/communication/azure-communication-rooms/tests/test_rooms_client.py @@ -24,6 +24,7 @@ def setup_method(self): sanitizedId2 = "8:acs:sanitized2" sanitizedId3 = "8:acs:sanitized3" sanitizedId4 = "8:acs:sanitized4" + sanitizedId5 = "8:acs:sanitized5" if is_live(): self.identity_client = CommunicationIdentityClient.from_connection_string(self.connection_str) @@ -31,15 +32,18 @@ def setup_method(self): self.id2 = self.identity_client.create_user().properties["id"] self.id3 = self.identity_client.create_user().properties["id"] self.id4 = self.identity_client.create_user().properties["id"] + self.id5 = self.identity_client.create_user().properties["id"] add_general_regex_sanitizer(regex=self.id1, value=sanitizedId1) add_general_regex_sanitizer(regex=self.id2, value=sanitizedId2) add_general_regex_sanitizer(regex=self.id3, value=sanitizedId3) add_general_regex_sanitizer(regex=self.id4, value=sanitizedId4) + add_general_regex_sanitizer(regex=self.id5, value=sanitizedId5) else: self.id1 = sanitizedId1 self.id2 = sanitizedId2 self.id3 = sanitizedId3 self.id4 = sanitizedId4 + self.id5 = sanitizedId5 self.rooms_client = RoomsClient.from_connection_string( self.connection_str, http_logging_policy=get_http_logging_policy() @@ -55,6 +59,9 @@ def setup_method(self): "chris": RoomParticipant( communication_identifier=CommunicationUserIdentifier(self.id3), role=ParticipantRole.ATTENDEE ), + "jordan": RoomParticipant( + communication_identifier=CommunicationUserIdentifier(self.id4), role=ParticipantRole.COLLABORATOR + ), } self.rooms_client = RoomsClient.from_connection_string( self.connection_str, http_logging_policy=get_http_logging_policy() @@ -69,7 +76,7 @@ def test_create_room_no_attributes(self): @recorded_by_proxy def test_create_room_only_participants(self): # add john and chris to room - participants = [self.users["john"], self.users["chris"]] + participants = [self.users["john"], self.users["chris"],self.users["jordan"]] response = self.rooms_client.create_room(participants=participants) # delete created room @@ -299,7 +306,7 @@ def test_update_room_exceed_max_timerange(self): @recorded_by_proxy def test_add_or_update_participants(self): # add john and chris to room - create_participants = [self.users["john"], self.users["chris"]] + create_participants = [self.users["john"], self.users["chris"],self.users["jordan"]] create_response = self.rooms_client.create_room(participants=create_participants) # update join to consumer and add fred to room @@ -316,6 +323,9 @@ def test_add_or_update_participants(self): RoomParticipant( communication_identifier=CommunicationUserIdentifier(self.id2), role=ParticipantRole.CONSUMER ), + RoomParticipant( + communication_identifier=CommunicationUserIdentifier(self.id4), role=ParticipantRole.COLLABORATOR + ), ] self.rooms_client.add_or_update_participants( @@ -325,7 +335,7 @@ def test_add_or_update_participants(self): participants = [] for participant in update_response: participants.append(participant) - assert len(participants) == 3 + assert len(participants) == 4 case = unittest.TestCase() case.assertCountEqual(expected_participants, participants) # delete created room diff --git a/sdk/communication/azure-communication-rooms/tests/test_rooms_client_async.py b/sdk/communication/azure-communication-rooms/tests/test_rooms_client_async.py index 4ad59a0bb74d..3f48c1769ba7 100644 --- a/sdk/communication/azure-communication-rooms/tests/test_rooms_client_async.py +++ b/sdk/communication/azure-communication-rooms/tests/test_rooms_client_async.py @@ -26,6 +26,7 @@ def setup_method(self): sanitizedId2 = "8:acs:sanitized2" sanitizedId3 = "8:acs:sanitized3" sanitizedId4 = "8:acs:sanitized4" + sanitizedId5 = "8:acs:sanitized5" if is_live(): self.identity_client = CommunicationIdentityClient.from_connection_string(self.connection_str) @@ -33,15 +34,18 @@ def setup_method(self): self.id2 = self.identity_client.create_user().properties["id"] self.id3 = self.identity_client.create_user().properties["id"] self.id4 = self.identity_client.create_user().properties["id"] + self.id5 = self.identity_client.create_user().properties["id"] add_general_regex_sanitizer(regex=self.id1, value=sanitizedId1) add_general_regex_sanitizer(regex=self.id2, value=sanitizedId2) add_general_regex_sanitizer(regex=self.id3, value=sanitizedId3) add_general_regex_sanitizer(regex=self.id4, value=sanitizedId4) + add_general_regex_sanitizer(regex=self.id5, value=sanitizedId5) else: self.id1 = sanitizedId1 self.id2 = sanitizedId2 self.id3 = sanitizedId3 self.id4 = sanitizedId4 + self.id5 = sanitizedId5 self.rooms_client = RoomsClient.from_connection_string( self.connection_str, http_logging_policy=get_http_logging_policy() @@ -56,6 +60,9 @@ def setup_method(self): "chris": RoomParticipant( communication_identifier=CommunicationUserIdentifier(self.id3), role=ParticipantRole.ATTENDEE ), + "jordan": RoomParticipant( + communication_identifier=CommunicationUserIdentifier(self.id4), role=ParticipantRole.COLLABORATOR + ) } @recorded_by_proxy_async @@ -68,7 +75,7 @@ async def test_create_room_no_attributes_async(self): @recorded_by_proxy_async async def test_create_room_only_participants_async(self): # add john and chris to room - participants = [self.users["john"], self.users["chris"]] + participants = [self.users["john"], self.users["chris"],self.users["jordan"]] async with self.rooms_client: response = await self.rooms_client.create_room(participants=participants) @@ -293,8 +300,8 @@ async def test_update_room_deleted_room_async(self): @recorded_by_proxy_async async def test_add_or_update_participant_async(self): # add john and chris to room - create_participants = [self.users["john"], self.users["chris"]] - # update join to consumer and add fred to room + create_participants = [self.users["john"], self.users["chris"],self.users["jordan"]] + # update john to consumer, and add fred to room self.users["john"].role = ParticipantRole.CONSUMER update_participants = [self.users["john"], self.users["fred"]] expected_participants = [ @@ -307,6 +314,9 @@ async def test_add_or_update_participant_async(self): RoomParticipant( communication_identifier=CommunicationUserIdentifier(self.id3), role=ParticipantRole.ATTENDEE ), + RoomParticipant( + communication_identifier=CommunicationUserIdentifier(self.id4), role=ParticipantRole.COLLABORATOR + ), ] async with self.rooms_client: create_response = await self.rooms_client.create_room(participants=create_participants) @@ -317,7 +327,7 @@ async def test_add_or_update_participant_async(self): participants = [] async for participant in update_response: participants.append(participant) - assert len(participants) == 3 + assert len(participants) == 4 case = unittest.TestCase() case.assertCountEqual(expected_participants, participants) # delete created room From 8d9e256c999159dfac0089be3a0853433dac1689 Mon Sep 17 00:00:00 2001 From: paola vicencio Date: Wed, 19 Feb 2025 02:58:13 -0600 Subject: [PATCH 4/7] updating sample and tests --- .../azure-communication-rooms/tests/conftest.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/sdk/communication/azure-communication-rooms/tests/conftest.py b/sdk/communication/azure-communication-rooms/tests/conftest.py index 3fb28aa4157d..c327028a6d67 100644 --- a/sdk/communication/azure-communication-rooms/tests/conftest.py +++ b/sdk/communication/azure-communication-rooms/tests/conftest.py @@ -30,6 +30,7 @@ add_header_regex_sanitizer, set_default_session_settings, remove_batch_sanitizers, + add_uri_regex_sanitizer, ) from azure.communication.rooms._shared.utils import parse_connection_str @@ -66,3 +67,7 @@ def add_sanitizers(test_proxy): # Remove the following sanitizers since certain fields are needed in tests and are non-sensitive: # - AZSDK3430: $..id remove_batch_sanitizers(["AZSDK3430"]) + + add_uri_regex_sanitizer( + regex="https://[^/]+/rooms.*?api", value="https://sanitized.communication.azure.com/rooms?api" + ) From 39a94398e0ed21d6e7c94ff9cdadafdb8e92433a Mon Sep 17 00:00:00 2001 From: paola vicencio Date: Wed, 19 Feb 2025 02:59:51 -0600 Subject: [PATCH 5/7] updating sample and tests --- sdk/communication/azure-communication-rooms/assets.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/communication/azure-communication-rooms/assets.json b/sdk/communication/azure-communication-rooms/assets.json index 1b698db806f3..18cc05681a1e 100644 --- a/sdk/communication/azure-communication-rooms/assets.json +++ b/sdk/communication/azure-communication-rooms/assets.json @@ -2,5 +2,5 @@ "AssetsRepo": "Azure/azure-sdk-assets", "AssetsRepoPrefixPath": "python", "TagPrefix": "python/communication/azure-communication-rooms", - "Tag": "python/communication/azure-communication-rooms_191113872a" + "Tag": "python/communication/azure-communication-rooms_b5ccdd3859" } From 7a6ec50ae47234711ba47dfc93c98086faca50a0 Mon Sep 17 00:00:00 2001 From: paola vicencio Date: Thu, 20 Feb 2025 23:01:15 -0600 Subject: [PATCH 6/7] updating tests --- sdk/communication/azure-communication-rooms/assets.json | 2 +- .../azure-communication-rooms/dev_requirements.txt | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 sdk/communication/azure-communication-rooms/sdk/communication/azure-communication-rooms/dev_requirements.txt diff --git a/sdk/communication/azure-communication-rooms/assets.json b/sdk/communication/azure-communication-rooms/assets.json index 18cc05681a1e..af9c3d4c8d14 100644 --- a/sdk/communication/azure-communication-rooms/assets.json +++ b/sdk/communication/azure-communication-rooms/assets.json @@ -2,5 +2,5 @@ "AssetsRepo": "Azure/azure-sdk-assets", "AssetsRepoPrefixPath": "python", "TagPrefix": "python/communication/azure-communication-rooms", - "Tag": "python/communication/azure-communication-rooms_b5ccdd3859" + "Tag": "python/communication/azure-communication-rooms_eb8f5163a4" } diff --git a/sdk/communication/azure-communication-rooms/sdk/communication/azure-communication-rooms/dev_requirements.txt b/sdk/communication/azure-communication-rooms/sdk/communication/azure-communication-rooms/dev_requirements.txt new file mode 100644 index 000000000000..76ef5b0b6073 --- /dev/null +++ b/sdk/communication/azure-communication-rooms/sdk/communication/azure-communication-rooms/dev_requirements.txt @@ -0,0 +1,8 @@ +-e ../../../tools/azure-sdk-tools +-e ../azure-communication-identity +../../core/azure-core +../../identity/azure-identity +aiohttp>=3.0 +typing_extensions>=3.7.2 +aiounittest>=1.4 +asyncio From 756b8209bb98001d6ba895c83b4426f2a53ecdc4 Mon Sep 17 00:00:00 2001 From: paola vicencio Date: Thu, 20 Feb 2025 23:02:31 -0600 Subject: [PATCH 7/7] updating tests --- .../azure-communication-rooms/dev_requirements.txt | 8 -------- 1 file changed, 8 deletions(-) delete mode 100644 sdk/communication/azure-communication-rooms/sdk/communication/azure-communication-rooms/dev_requirements.txt diff --git a/sdk/communication/azure-communication-rooms/sdk/communication/azure-communication-rooms/dev_requirements.txt b/sdk/communication/azure-communication-rooms/sdk/communication/azure-communication-rooms/dev_requirements.txt deleted file mode 100644 index 76ef5b0b6073..000000000000 --- a/sdk/communication/azure-communication-rooms/sdk/communication/azure-communication-rooms/dev_requirements.txt +++ /dev/null @@ -1,8 +0,0 @@ --e ../../../tools/azure-sdk-tools --e ../azure-communication-identity -../../core/azure-core -../../identity/azure-identity -aiohttp>=3.0 -typing_extensions>=3.7.2 -aiounittest>=1.4 -asyncio