cli2 3.3.29__tar.gz → 3.3.31__tar.gz

{cli2-3.3.29/cli2.egg-info → cli2-3.3.31}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cli2
-Version: 3.3.29
+Version: 3.3.31
 Summary: image:: https://yourlabs.io/oss/cli2/badges/master/pipeline.svg
 Home-page: https://yourlabs.io/oss/cli2
 Author: James Pic

{cli2-3.3.29 → cli2-3.3.31}/cli2/client.py

@@ -75,9 +75,14 @@ class Paginator:
     .. py:attribute:: model
 
         :py:class:`Model` class or ``dict`` by default.
+
+    .. py:attribute:: callback
+
+        Callback called for every item.
     """
 
-    def __init__(self, client, url, params=None, model=None, expressions=None):
+    def __init__(self, client, url, params=None, model=None, expressions=None,
+                 callback=None):
         """
         Initialize a paginator object with a client on a URL with parameters.
 
@@ -93,6 +98,7 @@ class Paginator:
         self.page_start = 1
         self.per_page = None
         self.initialized = False
+        self.callback = callback
         self.expressions = []
         for expression in (expressions or []):
             if not isinstance(expression, Expression):
@@ -270,6 +276,8 @@ class Paginator:
         """
         Asynchronous iterator.
         """
+        callback = callback or self.callback
+
         if self._reverse and not self.total_pages:
             first_page_response = await self.page_response(1)
             page = self.total_pages
@@ -287,6 +295,8 @@ class Paginator:
 
             for item in items:
                 if not python_filter or python_filter.matches(item):
+                    if callback:
+                        callback(item)
                     yield item
 
             if self._reverse:
@@ -298,6 +308,8 @@ class Paginator:
                     items = self.response_items(first_page_response)
                     for item in reversed(items):
                         if not python_filter or python_filter.matches(item):
+                            if callback:
+                                callback(item)
                             yield item
                     break
             else:
@@ -1038,7 +1050,7 @@ class Handler:
                 raise response
             # httpx session is rendered unusable after a TransportError
             if isinstance(response, httpx.TransportError):
-                log.warn('reconnect', exception=str(response))
+                log.warn('reconnect', error=repr(response))
                 await client.client_reset()
             return
 
@@ -1337,15 +1349,20 @@ class Client(metaclass=ClientMetaclass):
         By default, this method does nothing. Implement it to your likings.
 
         This method is supposed to return the token, but doesn't do anything
-        with it by itself: it's up to you to call something like:
+        with it by itself.
+
+        You also need to implement the :py:meth:`client_token_apply` which is
+        in charge of updating the actual httpx client object with the said
+        token.
 
         .. code-block::
 
             async def token_get(self):
                 response = await self.post('/login', dict(...))
-                token = response.json()['token']
-                self.client.headers['token'] = f'Bearer {token}'
-                return token
+                return response.json()['token']
+
+            def client_token_apply(self, client):
+                client.headers['X-ApiKey'] = self.token
         """
         raise NotImplementedError()
 
@@ -1406,7 +1423,6 @@ class Client(metaclass=ClientMetaclass):
                         the response, set to False if you want only 1 try.
         :param accepts: Override for :py:attr:`Handler.accepts`
         :param refuses: Override for :py:attr:`Handler.refuses`
-        :param retries: Override for :py:attr:`Handler.retries`
         :param tries: Override for :py:attr:`Handler.tries`
         :param backoff: Override for :py:attr:`Handler.backoff`
         :param semaphore: Override for :py:attr:`Client.semaphore`

{cli2-3.3.29 → cli2-3.3.31}/cli2/test_client.py

@@ -266,7 +266,10 @@ async def test_handler(client_class):
 
     assert not client.client_reset.await_count
     result = await handler(client, httpx.TransportError('foo'), 0, [], log)
-    log.warn.assert_called_once_with('reconnect', exception='foo')
+    log.warn.assert_called_once_with(
+        'reconnect',
+        error="TransportError('foo')",
+    )
     assert not result
     assert client.client_reset.await_count == 1
 
@@ -344,7 +347,13 @@ async def test_pagination(httpx_mock):
     httpx_mock.add_response(url='http://lol/?page=2', json=[dict(a=2)])
     httpx_mock.add_response(url='http://lol/?page=3', json=[])
     client = Client(base_url='http://lol')
-    assert await client.paginate('/').list() == [dict(a=1), dict(a=2)]
+    paginator = client.paginate('/')
+    paginator.callback = mock.Mock()
+    assert await paginator.list() == [dict(a=1), dict(a=2)]
+    assert paginator.callback.call_args_list == [
+        mock.call({'a': 1}),
+        mock.call({'a': 2})
+    ]
 
 
 @pytest.mark.asyncio

{cli2-3.3.29 → cli2-3.3.31/cli2.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cli2
-Version: 3.3.29
+Version: 3.3.31
 Summary: image:: https://yourlabs.io/oss/cli2/badges/master/pipeline.svg
 Home-page: https://yourlabs.io/oss/cli2
 Author: James Pic

{cli2-3.3.29 → cli2-3.3.31}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup
 
 setup(
     name='cli2',
-    version='3.3.29',
+    version='3.3.31',
     setup_requires='setupmeta',
     install_requires=[
         'docstring_parser',