Merge pull request #42 from cloudblue/add_append_option_for_resourceset

Add resourceset_append option to the client

Author: marcserrat

connect/client/fluent.py

@@ -31,6 +31,7 @@ def __init__(
         max_retries=0,
         logger=None,
         timeout=(180.0, 180.0),
+        resourceset_append=True,
     ):
         """
         Create a new instance of the ConnectClient.
@@ -39,13 +40,25 @@ def __init__(
         :type api_key: str
         :param endpoint: The API endpoint, defaults to CONNECT_ENDPOINT_URL
         :type endpoint: str, optional
+        :param use_specs: Use the Connect OpenAPI specification for interactive help.
+        :type specs_location: bool, optional
         :param specs_location: The Connect OpenAPI specification local path or URL, defaults to
                                CONNECT_SPECS_URL
         :type specs_location: str, optional
+        :param validate_using_specs: Use the Connect OpenAPI specification to validate the call.
+        :type validate_using_specs: bool, optional
         :param default_headers: Http headers to apply to each request, defaults to {}
         :type default_headers: dict, optional
-        :param logger: HTTPP Request logger class, defaults to None
+        :param default_limit: Default value for pagination limit parameter.
+        :type default_limit: int, optional
+        :param max_retries: Max number of retries for a request before raising an error.
+        :type max_retries: int, optional
+        :param logger: HTTP Request logger class, defaults to None
         :type logger: RequestLogger, optional
+        :param timeout: Timeout parameter to pass to the underlying http client.
+        :type timeout: int or tuple of int, optional
+        :param resourceset_append: Append all the page to the current resourceset.
+        :type resourceset_append: bool, optional
         """
         if default_headers and 'Authorization' in default_headers:
             raise ValueError('`default_headers` cannot contains `Authorization`')
@@ -65,6 +78,7 @@ def __init__(
         self.logger = logger
         self._help_formatter = DefaultFormatter(self.specs)
         self.timeout = timeout
+        self.resourceset_append = resourceset_append
 
     def __getattr__(self, name):
         """

connect/client/models/iterators.py

@@ -58,7 +58,10 @@ def __next__(self):
             if not results:
                 raise
             self._rs._content_range = cr
-            self._rs._results.extend(results)
+            if self._client.resourceset_append:
+                self._rs._results.extend(results)
+            else:
+                self._rs._results = results
             self._results_iterator = iter(results)
             item = next(self._results_iterator)
 
@@ -101,7 +104,10 @@ async def __anext__(self):
             if not results:
                 raise StopAsyncIteration
             self._rs._content_range = cr
-            self._rs._results.extend(results)
+            if self._client.resourceset_append:
+                self._rs._results.extend(results)
+            else:
+                self._rs._results = results
             self._results_iterator = iter(results)
             item = next(self._results_iterator)
 

tests/async_client/test_models.py

@@ -982,6 +982,32 @@ async def test_rs_pagination(mocker, async_client_mock, async_rs_factory):
     assert results == [{'id': i} for i in range(200)]
     assert rs._limit == 100
     assert rs._offset == 0
+    assert len(rs._results) == 200
+
+
+@pytest.mark.asyncio
+async def test_rs_pagination_no_append(mocker, async_client_mock, async_rs_factory):
+    mocker.patch(
+        'connect.client.models.iterators.parse_content_range',
+        side_effect=[
+            ContentRange(0, 99, 200),
+            ContentRange(100, 199, 200),
+        ],
+    )
+
+    rs = async_rs_factory(
+        client=async_client_mock(methods=['get']),
+    )
+    rs._client.resourceset_append = False
+    rs._client.get.side_effect = [
+        [{'id': i} for i in range(100)],
+        [{'id': i} for i in range(100, 200)],
+    ]
+    results = [item async for item in rs]
+    assert results == [{'id': i} for i in range(200)]
+    assert rs._limit == 100
+    assert rs._offset == 0
+    assert len(rs._results) == 100
 
 
 @pytest.mark.asyncio

tests/client/test_models.py

@@ -881,6 +881,29 @@ def test_rs_pagination(mocker, rs_factory):
     assert results == [{'id': i} for i in range(200)]
     assert rs._limit == 100
     assert rs._offset == 0
+    assert len(rs._results) == 200
+
+
+def test_rs_pagination_no_append(mocker, rs_factory):
+    mocker.patch(
+        'connect.client.models.iterators.parse_content_range',
+        side_effect=[
+            ContentRange(0, 99, 200),
+            ContentRange(100, 199, 200),
+        ],
+    )
+
+    rs = rs_factory()
+    rs._client.get = mocker.MagicMock(side_effect=[
+        [{'id': i} for i in range(100)],
+        [{'id': i} for i in range(100, 200)],
+    ])
+    rs._client.resourceset_append = False
+    results = list(rs)
+    assert results == [{'id': i} for i in range(200)]
+    assert rs._limit == 100
+    assert rs._offset == 0
+    assert len(rs._results) == 100
 
 
 def test_rs_values_list_pagination(mocker, rs_factory):