Changed interface of list functions for sip routing async client to r… (Azure#29461)

* Changed interface of list functions for sip routing async client to return AsyncPagedIterable.

* Fixing comments from review.

* Fixing whitespace.

* Changed synchronous client to use ItemPaged return instead of Iterable.

* Updated changelog.

Author: jiriburant

sdk/communication/azure-communication-phonenumbers/CHANGELOG.md

@@ -13,6 +13,7 @@
 - Adds missing API version `2022-12-01` to the list of supported API versions.
 
 ### Other Changes
+- Changed list_routes and list_trunks functions on SIP routing client to return (Async)ItemPaged object.
 
 ## 1.1.0b3 (2023-01-10)
 - Users can now manage SIP configuration for Direct routing.

sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/siprouting/_sip_routing_client.py

@@ -8,6 +8,7 @@
 from urllib.parse import urlparse
 
 from azure.core.tracing.decorator import distributed_trace
+from azure.core.paging import ItemPaged
 
 from._models import SipTrunk, SipTrunkRoute
 from ._generated.models import (
@@ -152,35 +153,54 @@ def delete_trunk(
     def list_trunks(
         self,
         **kwargs  # type: Any
-    ):  # type: (...) -> Iterable[SipTrunk]
-        """Retrieves an iterable of currently configured SIP trunks.
+    ):  # type: (...) -> ItemPaged[SipTrunk]
+        """Retrieves the currently configured SIP trunks.
 
         :returns: Current SIP trunks configuration.
-        :rtype: Iterable[~azure.communication.siprouting.models.SipTrunk]
+        :rtype: ItemPaged[~azure.communication.siprouting.models.SipTrunk]
         :raises: ~azure.core.exceptions.HttpResponseError
         """
-        return self._list_trunks_(**kwargs)
+        def extract_data(config):
+            list_of_elem = [SipTrunk(
+                fqdn=k,
+                sip_signaling_port=v.sip_signaling_port) for k,v in config.trunks.items()]
+            return None, list_of_elem
+
+        # pylint: disable=unused-argument
+        def get_next(nextLink=None):
+            return self._rest_service.sip_routing.get(
+                **kwargs
+                )
+
+        return ItemPaged(get_next, extract_data)
 
     @distributed_trace
     def list_routes(
         self,
         **kwargs  # type: Any
-    ):  # type: (...) -> Iterable[SipTrunkRoute]
-        """Retrieves an iterable of currently configured SIP routes.
+    ):  # type: (...) -> ItemPaged[SipTrunkRoute]
+        """Retrieves the currently configured SIP routes.
 
         :returns: Current SIP routes configuration.
-        :rtype: Iterable[~azure.communication.siprouting.models.SipTrunkRoute]
+        :rtype: ItemPaged[~azure.communication.siprouting.models.SipTrunkRoute]
         :raises: ~azure.core.exceptions.HttpResponseError
         """
-        config = self._rest_service.sip_routing.get(
-            **kwargs
-        )
-        return [SipTrunkRoute(
-            description=x.description,
-            name=x.name,
-            number_pattern=x.number_pattern,
-            trunks=x.trunks
-            ) for x in config.routes]
+
+        def extract_data(config):
+            list_of_elem =  [SipTrunkRoute(
+                description=x.description,
+                name=x.name,
+                number_pattern=x.number_pattern,
+                trunks=x.trunks) for x in config.routes]
+            return None, list_of_elem
+
+        # pylint: disable=unused-argument
+        def get_next(nextLink=None):
+            return  self._rest_service.sip_routing.get(
+                **kwargs
+            )
+
+        return ItemPaged(get_next, extract_data)
 
     @distributed_trace
     def set_trunks(

sdk/communication/azure-communication-phonenumbers/azure/communication/phonenumbers/siprouting/aio/_sip_routing_client_async.py

@@ -7,6 +7,9 @@
 from typing import TYPE_CHECKING  # pylint: disable=unused-import
 from urllib.parse import urlparse
 
+from azure.core.async_paging import AsyncItemPaged, AsyncList
+
+from azure.core.tracing.decorator import distributed_trace
 from azure.core.tracing.decorator_async import distributed_trace_async
 
 from .._models import SipTrunk, SipTrunkRoute
@@ -23,7 +26,7 @@
 from ..._version import SDK_MONIKER
 
 if TYPE_CHECKING:
-    from typing import Optional, Iterable, List, Any
+    from typing import List, Any
     from azure.core.credentials_async import AsyncTokenCredential
 
 
@@ -152,39 +155,59 @@ async def delete_trunk(
             body=SipConfiguration(trunks={trunk_fqdn:None}),
             **kwargs)
 
-    @distributed_trace_async
-    async def list_trunks(
+    @distributed_trace
+    def list_trunks(
         self,
         **kwargs  # type: Any
-    ):  # type: (...) -> Iterable[SipTrunk]
-        """Retrieves an iterable of currently configured SIP trunks.
+    ):  # type: (...) -> AsyncItemPaged[SipTrunk]
+        """Retrieves list of currently configured SIP trunks.
 
         :returns: Current SIP trunks configuration.
-        :rtype: Iterable[~azure.communication.siprouting.models.SipTrunk]
+        :rtype: AsyncItemPaged[~azure.communication.siprouting.models.SipTrunk]
         :raises: ~azure.core.exceptions.HttpResponseError
         """
-        return await self._list_trunks_(**kwargs)
 
-    @distributed_trace_async
-    async def list_routes(
+        async def extract_data(config):
+            list_of_elem = [SipTrunk(
+                fqdn=k,
+                sip_signaling_port=v.sip_signaling_port) for k,v in config.trunks.items()]
+            return None, AsyncList(list_of_elem)
+
+        # pylint: disable=unused-argument
+        async def get_next(nextLink=None):
+            return await self._rest_service.sip_routing.get(
+                **kwargs
+                )
+
+        return AsyncItemPaged(get_next, extract_data)
+
+    @distributed_trace
+    def list_routes(
         self,
         **kwargs  # type: Any
-    ):  # type: (...) -> Iterable[SipTrunkRoute]
-        """Retrieves an iterable of currently configured SIP routes.
+    ):  # type: (...) -> AsyncItemPaged[SipTrunkRoute]
+        """Retrieves list of currently configured SIP routes.
 
         :returns: Current SIP routes configuration.
-        :rtype: Iterable[~azure.communication.siprouting.models.SipTrunkRoute]
+        :rtype: AsyncItemPaged[~azure.communication.siprouting.models.SipTrunkRoute]
         :raises: ~azure.core.exceptions.HttpResponseError
         """
-        config = await self._rest_service.sip_routing.get(
-            **kwargs
-        )
-        return [SipTrunkRoute(
-            description=x.description,
-            name=x.name,
-            number_pattern=x.number_pattern,
-            trunks=x.trunks
-            ) for x in config.routes]
+
+        async def extract_data(config):
+            list_of_elem =  [SipTrunkRoute(
+                description=x.description,
+                name=x.name,
+                number_pattern=x.number_pattern,
+                trunks=x.trunks) for x in config.routes]
+            return None, AsyncList(list_of_elem)
+
+        # pylint: disable=unused-argument
+        async def get_next(nextLink=None):
+            return await self._rest_service.sip_routing.get(
+                **kwargs
+                )
+
+        return AsyncItemPaged(get_next, extract_data)
 
     @distributed_trace_async
     async def set_trunks(

sdk/communication/azure-communication-phonenumbers/samples/siprouting/get_sip_routes_sample_async.py

@@ -25,9 +25,9 @@
 
 async def get_sip_routes_sample():
     async with client:
-        sip_routes = await client.list_routes()
+        sip_routes = client.list_routes()
 
-        for route in sip_routes:
+        async for route in sip_routes:
             print(route.name)
             print(route.description)
             print(route.number_pattern)

sdk/communication/azure-communication-phonenumbers/samples/siprouting/get_sip_trunks_sample_async.py

@@ -25,11 +25,11 @@
 
 async def get_sip_trunks_sample():
     async with client:
-        sip_trunks = await client.list_trunks()
+        sip_trunks = client.list_trunks()
 
-    for trunk in sip_trunks:
-        print(trunk.fqdn)
-        print(trunk.sip_signaling_port)
+        async for trunk in sip_trunks:
+            print(trunk.fqdn)
+            print(trunk.sip_signaling_port)
 
 if __name__ == "__main__":
     asyncio.run(get_sip_trunks_sample())

sdk/communication/azure-communication-phonenumbers/test/test_sip_routing_client_e2e.py

@@ -30,45 +30,45 @@ def setup_method(self):
     @recorded_by_proxy
     def test_get_trunks(self, **kwargs):
         trunks = self._sip_routing_client.list_trunks()
-        assert trunks is not None, "No trunks were returned."
-        assert_trunks_are_equal(trunks,[self.first_trunk,self.second_trunk])
+        trunks_list = self._get_as_list(trunks)
+        assert_trunks_are_equal(trunks_list,[self.first_trunk,self.second_trunk])
 
     @recorded_by_proxy
     def test_get_trunks_from_managed_identity(self, **kwargs):
         client = self._get_sip_client_managed_identity()
         trunks = client.list_trunks()
-        assert trunks is not None, "No trunks were returned."
-        assert_trunks_are_equal(trunks,[self.first_trunk,self.second_trunk])
+        trunks_list = self._get_as_list(trunks)
+        assert_trunks_are_equal(trunks_list,[self.first_trunk,self.second_trunk])
 
     @recorded_by_proxy
     def test_get_routes(self, **kwargs):
         self._sip_routing_client.set_routes([self.first_route])
         routes = self._sip_routing_client.list_routes()
-        assert routes is not None, "No routes were returned."
-        assert_routes_are_equal(routes,[self.first_route])
+        routes_list = self._get_as_list(routes)
+        assert_routes_are_equal(routes_list,[self.first_route])
 
     @recorded_by_proxy
     def test_get_routes_from_managed_identity(self, **kwargs):
         client = self._get_sip_client_managed_identity()
         client.set_routes([self.first_route])
         routes = client.list_routes()
-        assert routes is not None, "No routes were returned."
-        assert_routes_are_equal(routes,[self.first_route])
+        routes_list = self._get_as_list(routes)
+        assert_routes_are_equal(routes_list,[self.first_route])
 
     @recorded_by_proxy
     def test_set_trunks(self, **kwargs):
         self._sip_routing_client.set_trunks([self.additional_trunk])
         result_trunks = self._sip_routing_client.list_trunks()
-        assert result_trunks is not None, "No trunks were returned."
-        assert_trunks_are_equal(result_trunks,[self.additional_trunk])
+        trunks_list = self._get_as_list(result_trunks)
+        assert_trunks_are_equal(trunks_list,[self.additional_trunk])
 
     @recorded_by_proxy
     def test_set_trunks_from_managed_identity(self, **kwargs):
         client = self._get_sip_client_managed_identity()
         client.set_trunks([self.additional_trunk])
         result_trunks = client.list_trunks()
-        assert result_trunks is not None, "No trunks were returned."
-        assert_trunks_are_equal(result_trunks,[self.additional_trunk])
+        trunks_list = self._get_as_list(result_trunks)
+        assert_trunks_are_equal(trunks_list,[self.additional_trunk])
 
     @recorded_by_proxy
     def test_set_trunks_empty_list(self, **kwargs):
@@ -86,8 +86,8 @@ def test_set_routes(self, **kwargs):
         self._sip_routing_client.set_routes([self.first_route])
         self._sip_routing_client.set_routes(new_routes)
         result_routes = self._sip_routing_client.list_routes()
-        assert result_routes is not None, "No routes were returned."
-        assert_routes_are_equal(result_routes,new_routes)
+        routes_list = self._get_as_list(result_routes)
+        assert_routes_are_equal(routes_list,new_routes)
 
     @recorded_by_proxy
     def test_set_routes_from_managed_identity(self, **kwargs):
@@ -96,36 +96,40 @@ def test_set_routes_from_managed_identity(self, **kwargs):
         client.set_routes([self.first_route])
         client.set_routes(new_routes)
         result_routes = client.list_routes()
-        assert result_routes is not None, "No routes were returned."
-        assert_routes_are_equal(result_routes,new_routes)
+        routes_list = self._get_as_list(result_routes)
+        assert_routes_are_equal(routes_list,new_routes)
 
     @recorded_by_proxy
     def test_delete_trunk(self, **kwargs):
         trunk_to_delete = self.second_trunk.fqdn
         self._sip_routing_client.delete_trunk(trunk_to_delete)
         new_trunks = self._sip_routing_client.list_trunks()
-        assert_trunks_are_equal(new_trunks,[self.first_trunk])
+        trunks_list = self._get_as_list(new_trunks)
+        assert_trunks_are_equal(trunks_list,[self.first_trunk])
 
     @recorded_by_proxy
     def test_delete_trunk_from_managed_identity(self, **kwargs):
         trunk_to_delete = self.second_trunk.fqdn
         client = self._get_sip_client_managed_identity()
         client.delete_trunk(trunk_to_delete)
         new_trunks = client.list_trunks()
-        assert_trunks_are_equal(new_trunks,[self.first_trunk])
+        trunks_list = self._get_as_list(new_trunks)
+        assert_trunks_are_equal(trunks_list,[self.first_trunk])
 
     @recorded_by_proxy
     def test_add_trunk(self, **kwargs):
         self._sip_routing_client.set_trunk(self.additional_trunk)
         new_trunks = self._sip_routing_client.list_trunks()
-        assert_trunks_are_equal(new_trunks,[self.first_trunk,self.second_trunk,self.additional_trunk])
+        trunks_list = self._get_as_list(new_trunks)
+        assert_trunks_are_equal(trunks_list,[self.first_trunk,self.second_trunk,self.additional_trunk])
 
     @recorded_by_proxy
     def test_add_trunk_from_managed_identity(self, **kwargs):
         client = self._get_sip_client_managed_identity()
         client.set_trunk(self.additional_trunk)
         new_trunks = client.list_trunks()
-        assert_trunks_are_equal(new_trunks,[self.first_trunk,self.second_trunk,self.additional_trunk])
+        trunks_list = self._get_as_list(new_trunks)
+        assert_trunks_are_equal(trunks_list,[self.first_trunk,self.second_trunk,self.additional_trunk])
 
     @recorded_by_proxy
     def test_get_trunk(self, **kwargs):
@@ -150,17 +154,26 @@ def test_set_trunk(self, **kwargs):
         modified_trunk = SipTrunk(fqdn=self.second_trunk.fqdn,sip_signaling_port=7777)
         self._sip_routing_client.set_trunk(modified_trunk)
         new_trunks = self._sip_routing_client.list_trunks()
-        assert_trunks_are_equal(new_trunks,[self.first_trunk,modified_trunk])
+        trunks_list = self._get_as_list(new_trunks)
+        assert_trunks_are_equal(trunks_list,[self.first_trunk,modified_trunk])
 
     @recorded_by_proxy
     def test_set_trunk_from_managed_identity(self, **kwargs):
         modified_trunk = SipTrunk(fqdn=self.second_trunk.fqdn,sip_signaling_port=7777)
         client = self._get_sip_client_managed_identity()
         client.set_trunk(modified_trunk)
         new_trunks = client.list_trunks()
-        assert_trunks_are_equal(new_trunks,[self.first_trunk,modified_trunk])
+        trunks_list = self._get_as_list(new_trunks)
+        assert_trunks_are_equal(trunks_list,[self.first_trunk,modified_trunk])
 
     def _get_sip_client_managed_identity(self):
         endpoint, *_ = parse_connection_str(self.connection_str)
         credential = create_token_credential()
         return SipRoutingClient(endpoint, credential)
+    
+    def _get_as_list(self,iter):
+        assert iter is not None, "No iterable was returned."
+        items = []
+        for item in iter:
+            items.append(item)
+        return items