cli2 3.3.36__tar.gz → 3.3.40__tar.gz

{cli2-3.3.36/cli2.egg-info → cli2-3.3.40}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: cli2
-Version: 3.3.36
+Version: 3.3.40
 Summary: image:: https://yourlabs.io/oss/cli2/badges/master/pipeline.svg
 Home-page: https://yourlabs.io/oss/cli2
 Author: James Pic
@@ -23,6 +23,17 @@ Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: pytest-mock; extra == "test"
 Requires-Dist: pytest-asyncio; extra == "test"
 Requires-Dist: pytest-httpx; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 .. image:: https://yourlabs.io/oss/cli2/badges/master/pipeline.svg
    :target: https://yourlabs.io/oss/cli2/pipelines

{cli2-3.3.36 → cli2-3.3.40}/cli2/client.py

@@ -34,19 +34,11 @@ class Paginator:
     """
     Generic pagination class.
 
-    You don't have to override that class to do basic paginator customization,
-    instead, you can also implement pagination specifics into:
+    Should work with most paginations by default, if you're extending this then
+    override:
 
-    - the :py:class:`~Client` class with the
-      :py:meth:`~Client.pagination_initialize` and
-      :py:meth:`~Client.pagination_parameters` methods
-
-    - or also, per model, in the :py:class:`~Model` class with the
-      :py:meth:`~Model.pagination_initialize` and
-      :py:meth:`~Model.pagination_parameters` methods
-
-    Refer to :py:meth:`pagination_parameters` and
-    :py:meth:`pagination_initialize` for details.
+    - :py:meth:`~Paginator.pagination_initialize`
+    - :py:meth:`~Paginator.pagination_parameters`
 
     .. py:attribute:: total_pages
 
@@ -76,17 +68,15 @@ class Paginator:
 
         :py:class:`Model` class or ``dict`` by default.
 
-    .. py:attribute:: postfilter
-
-        Callback called for every item after filtering.
-
-    .. py:attribute:: prefilter
+    .. py:attribute:: callback
 
-        Callback called for every item before filtering.
+        Callback called for every item before filtering by expressions.
+        This must return True or the item will be filtered *out* of yielded
+        results.
     """
 
     def __init__(self, client, url, params=None, model=None, expressions=None,
-                 prefilter=None, postfilter=None):
+                 callback=None):
         """
         Initialize a paginator object with a client on a URL with parameters.
 
@@ -102,8 +92,7 @@ class Paginator:
         self.page_start = 1
         self.per_page = None
         self.initialized = False
-        self.prefilter = prefilter
-        self.postfilter = postfilter
+        self.callback = callback
         self.expressions = []
         for expression in (expressions or []):
             if not isinstance(expression, Expression):
@@ -180,12 +169,6 @@ class Paginator:
 
         :param data: Data of the first response
         """
-        try:
-            self.model.pagination_initialize
-        except AttributeError:
-            return self.client.pagination_initialize(self, data)
-        else:
-            return self.model.pagination_initialize(self, data)
 
     def pagination_parameters(self, page_number):
         """
@@ -199,15 +182,12 @@ class Paginator:
 
         .. code-block:: python
 
-            def pagination_parameters(self, paginator, page_number):
+            def pagination_parameters(self, page_number):
+                # this is the default implementation
                 return dict(page=page_number)
         """
-        try:
-            self.model.pagination_parameters
-        except AttributeError:
-            return self.client.pagination_parameters(self, page_number)
-        else:
-            return self.model.pagination_parameters(self, page_number)
+        if page_number > 1:
+            return dict(page=page_number)
 
     def response_items(self, response):
         """
@@ -277,16 +257,17 @@ class Paginator:
             await self.initialize(response)
         return response
 
-    async def __aiter__(self, prefilter=None, postfilter=None):
+    async def __aiter__(self, callback=None):
         """
         Asynchronous iterator.
         """
-        prefilter = prefilter or self.prefilter
-        postfilter = postfilter or self.postfilter
+        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
+            if not self.total_pages:
+                raise Exception('Reverse pagination without total_pages')
         else:
             page = self.page_start
 
@@ -294,11 +275,10 @@ class Paginator:
 
         async def yielder(items):
             for item in items:
-                if prefilter:
-                    await async_resolve(prefilter(item))
+                if callback:
+                    if not await async_resolve(callback(item)):
+                        continue
                 if not python_filter or python_filter.matches(item):
-                    if postfilter:
-                        await async_resolve(postfilter(item))
                     yield item
 
         while items := await self.page_items(page):
@@ -708,6 +688,8 @@ class ModelMetaclass(type):
         cls = super().__new__(cls, name, bases, attributes)
         client = getattr(cls, 'client', None)
         if client:
+            if not cls.paginator:
+                cls.paginator = client.paginator
             return cls
 
         client_class = getattr(cls, '_client_class', None)
@@ -776,7 +758,7 @@ class Model(metaclass=ModelMetaclass):
 
         Object URL based on :py:attr:`url_detail` and :py:attr:`id_field`.
     """
-    paginator = Paginator
+    paginator = None
     model_command = ModelCommand
     model_group = ModelGroup
     url_list = None
@@ -834,32 +816,6 @@ class Model(metaclass=ModelMetaclass):
         """
         return cls.paginator(cls.client, url, params, cls, expressions)
 
-    @classmethod
-    def pagination_initialize(cls, paginator, data):
-        """
-        Implement Model-specific pagination initialization here.
-
-        Otherwise, :py:meth:`Client.pagination_initialize` will
-        take place.
-
-        Refer to :py:meth:`Paginator.pagination_initialize` for
-        details.
-        """
-        cls.client.pagination_initialize(paginator, data)
-
-    @classmethod
-    def pagination_parameters(cls, paginator, page_number):
-        """
-        Implement Model-specific pagination parameters here.
-
-        Otherwise, :py:meth:`Client.pagination_parameters` will
-        take place.
-
-        Refer to :py:meth:`Paginator.pagination_parameters` for
-        details.
-        """
-        return cls.client.pagination_parameters(paginator, page_number)
-
     @property
     def cli2_display(self):
         return self.data
@@ -1177,9 +1133,7 @@ class Client(metaclass=ClientMetaclass):
 
     .. py:attribute:: paginator
 
-        :py:class:`Paginator` class, you can leave it by default and just
-        implement :py:meth:`pagination_initialize` and
-        :py:meth:`pagination_parameters`.
+        :py:class:`Paginator` class
 
     .. py:attribute:: semaphore
 
@@ -1605,7 +1559,8 @@ class Client(metaclass=ClientMetaclass):
         """ DELETE Request """
         return await self.request('DELETE', url, *args, **kwargs)
 
-    def paginate(self, url, params=None, model=None):
+    def paginate(self, url, *expressions, params=None, model=None,
+                 callback=None):
         """
         Return a paginator to iterate over results
 
@@ -1613,23 +1568,8 @@ class Client(metaclass=ClientMetaclass):
         :param params: GET parameters
         :param model: Model class to cast for items
         """
-        return self.paginator(self, url, params or {}, model or dict)
-
-    def pagination_parameters(self, paginator, page_number):
-        """
-        Implement Model-specific pagination parameters here.
-
-        Refer to :py:meth:`Paginator.pagination_parameters` for
-        details.
-        """
-
-    def pagination_initialize(self, paginator, data):
-        """
-        Implement Model-specific pagination initialization here.
-
-        Refer to :py:meth:`Paginator.pagination_initialize` for
-        details.
-        """
+        return self.paginator(self, url, params or {}, model or dict,
+                              expressions, callback)
 
 
 class Expression:

{cli2-3.3.36 → cli2-3.3.40}/cli2/test_client.py

@@ -49,6 +49,7 @@ async def test_client_cli(client_class, httpx_mock):
     assert isinstance(result.client, client_class)
 
     httpx_mock.add_response(url='http://lol/', json=[dict(a=1)])
+    httpx_mock.add_response(url='http://lol/?page=2', json=[])
     await client_class.cli['testmodel']['find'].async_call()
 
     class TestModel2(client_class.Model):
@@ -124,6 +125,7 @@ async def test_async_factory(httpx_mock):
         url_list = '/2'
 
     httpx_mock.add_response(url='http://bar/2', json=[dict(a=1)])
+    httpx_mock.add_response(url='http://bar/2?page=2', json=[])
     await TestClient.cli['testmodel']['find'].async_call()
 
 
@@ -369,33 +371,48 @@ async def test_token(httpx_mock):
 
 @pytest.mark.asyncio
 async def test_pagination(httpx_mock):
-    httpx_mock.add_response(url='http://lol/?page=1', json=[dict(a=1)])
+    httpx_mock.add_response(url='http://lol/', json=[dict(a=1)])
     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')
-    paginator = client.paginate('/')
 
-    def prefilter(item):
+    def callback(item):
         item['b'] = item['a']
+        return True
 
-    def postfilter(item):
-        item['c'] = item['b']
-
-    paginator.prefilter = prefilter
-    paginator.postfilter = postfilter
+    paginator = client.paginate(
+        '/',
+        lambda item: item['b'] == 2,
+        callback=callback,
+    )
     assert await paginator.list() == [
-        dict(a=1, b=1, c=1),
-        dict(a=2, b=2, c=2)
+        dict(a=2, b=2)
     ]
 
 
+def test_paginator(client_class):
+    class Client(client_class):
+        paginator = 'foo'
+
+    class Model1(Client.Model):
+        pass
+
+    class Model2(Client.Model):
+        paginator = 'bar'
+
+    client = Client()
+    assert client.Model1.paginator == 'foo'
+    assert client.Model2.paginator == 'bar'
+
+
 @pytest.mark.asyncio
 async def test_pagination_initialize(httpx_mock):
-    httpx_mock.add_response(url='http://lol/?page=1', json=dict(
+    httpx_mock.add_response(url='http://lol/', json=dict(
         total_pages=2,
         items=[dict(a=1)],
     ))
     httpx_mock.add_response(url='http://lol/?page=2', json=[dict(a=2)])
+    httpx_mock.add_response(url='http://lol/?page=3', json=[])
 
     class PaginatedClient(Client):
         def pagination_initialize(self, paginator, data):
@@ -404,7 +421,7 @@ async def test_pagination_initialize(httpx_mock):
     client = PaginatedClient(base_url='http://lol')
     assert await client.paginate('/').list() == [dict(a=1), dict(a=2)]
 
-    httpx_mock.add_response(url='http://lol/?page=1', json=dict(
+    httpx_mock.add_response(url='http://lol/', json=dict(
         total_pages=2,
         items=[dict(a=1)],
     ))
@@ -414,7 +431,7 @@ async def test_pagination_initialize(httpx_mock):
 @pytest.mark.asyncio
 async def test_token_get(httpx_mock):
     httpx_mock.add_response(url='http://lol/token', json=dict(token=123))
-    httpx_mock.add_response(url='http://lol/?page=1', json=[])
+    httpx_mock.add_response(url='http://lol/', json=[])
 
     class TokenClient(Client):
         async def token_get(self):
@@ -431,7 +448,7 @@ async def test_pagination_model(httpx_mock):
     class Model(dict):
         pass
 
-    httpx_mock.add_response(url='http://lol/?page=1', json=[dict(a=2)])
+    httpx_mock.add_response(url='http://lol/', json=[dict(a=2)])
     httpx_mock.add_response(url='http://lol/?page=2', json=[])
     client = Client(base_url='http://lol')
     result = await client.paginate('/', model=Model).list()
@@ -450,47 +467,50 @@ async def test_pagination_patterns(httpx_mock):
     # I'm dealing with APIs which have a different pagination system on
     # different resources, and on some resources no pagination at all
     # Would like to define that per model
+
+    class TotalPaginator(cli2.Paginator):
+        def pagination_initialize(self, data):
+            self.total_items = data['total_items']
+            self.per_page = len(data['items'])
+
     class TotalModel(Client.Model):
+        paginator = TotalPaginator
         url_list = '/foo'
 
-        @classmethod
-        def pagination_initialize(cls, paginator, data):
-            paginator.total_items = data['total_items']
-            paginator.per_page = len(data['items'])
-
     httpx_mock.add_response(
-        url='http://lol/foo?page=1',
+        url='http://lol/foo',
         json=dict(total_items=2, items=[dict(a=1)]),
     )
 
+    class PagesPaginator(cli2.Paginator):
+        def pagination_initialize(self, data):
+            self.total_pages = data['total_pages']
+            self.per_page = len(data['items'])
+
     class Pages(Client.Model):
         url_list = '/bar'
-
-        @classmethod
-        def pagination_initialize(cls, paginator, data):
-            paginator.total_pages = data['total_pages']
-            paginator.per_page = len(data['items'])
+        paginator = PagesPaginator
 
     httpx_mock.add_response(
-        url='http://lol/bar?page=1',
+        url='http://lol/bar',
         json=dict(total_pages=1, items=[dict(a=1)]),
     )
 
-    class Offset(Client.Model):
-        url_list = '/off'
+    class OffsetPaginator(cli2.Paginator):
+        def pagination_initialize(self, data):
+            self.total_items = data['total']
 
-        @classmethod
-        def pagination_initialize(cls, paginator, data):
-            paginator.total_items = data['total']
-
-        @classmethod
-        def pagination_parameters(cls, paginator, page_number):
-            paginator.per_page = 1
+        def pagination_parameters(self, page_number):
+            self.per_page = 1
             return dict(
                 offset=(page_number - 1) * paginator.per_page,
                 limit=paginator.per_page,
             )
 
+    class Offset(Client.Model):
+        url_list = '/off'
+        paginator = OffsetPaginator
+
     httpx_mock.add_response(
         url='http://lol/off?offset=0&limit=1',
         json=dict(total=2, items=[dict(a=1)]),
@@ -519,7 +539,7 @@ async def test_pagination_patterns(httpx_mock):
 @pytest.mark.asyncio
 async def test_pagination_reverse(httpx_mock):
     httpx_mock.add_response(
-        url='http://lol/bar?page=1',
+        url='http://lol/bar',
         json=dict(total_pages=3, items=[dict(a=1), dict(a=2)]),
     )
     httpx_mock.add_response(
@@ -531,13 +551,13 @@ async def test_pagination_reverse(httpx_mock):
         json=dict(total_pages=3, items=[dict(a=5)]),
     )
 
+    class Paginator(cli2.Paginator):
+        def pagination_initialize(self, data):
+            self.total_pages = data['total_pages']
+
     # test that we can reverse pagination too
     class Client(cli2.Client):
-        def pagination_initialize(self, paginator, data):
-            paginator.total_pages = data['total_pages']
-
-        def pagination_parameters(self, paginator, page_number):
-            return dict(page=page_number)
+        paginator = Paginator
 
     client = Client(base_url='http://lol')
     paginator = client.paginate('/bar')
@@ -663,17 +683,18 @@ def test_relation_many():
 
 @pytest.mark.asyncio
 async def test_python_expression(httpx_mock):
+    class Paginator(cli2.Paginator):
+        def pagination_initialize(self, data):
+            self.total_pages = data['total_pages']
+
     class Model(Client.Model):
         url_list = '/foo'
         a = cli2.Field()
         b = cli2.Field()
-
-        @classmethod
-        def pagination_initialize(cls, paginator, data):
-            paginator.total_pages = data['total_pages']
+        paginator = Paginator
 
     def mock():
-        httpx_mock.add_response(url='http://lol/foo?page=1', json=dict(
+        httpx_mock.add_response(url='http://lol/foo', json=dict(
             total_pages=2,
             items=[dict(a=1, b=1), dict(a=2, b=2), dict(a=3, b=1)],
         ))
@@ -723,7 +744,7 @@ async def test_expression_parameter(httpx_mock):
         a = cli2.Field()
         b = cli2.Field(parameter='b')
 
-    httpx_mock.add_response(url='http://lol/foo?page=1&b=1', json=dict(
+    httpx_mock.add_response(url='http://lol/foo?b=1', json=dict(
         items=[dict(a=1, b=1), dict(a=3, b=1)],
     ))
     httpx_mock.add_response(url='http://lol/foo?page=2&b=1', json=dict())
@@ -769,7 +790,7 @@ async def test_client_cli2(httpx_mock):
 
     meth = Client.cli['foo']['find']
     httpx_mock.add_response(
-        url='http://lol/foo?page=1',
+        url='http://lol/foo',
         json=[dict(id=1, a=2)],
     )
     httpx_mock.add_response(url='http://lol/foo?page=2', json=[])

{cli2-3.3.36 → cli2-3.3.40/cli2.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: cli2
-Version: 3.3.36
+Version: 3.3.40
 Summary: image:: https://yourlabs.io/oss/cli2/badges/master/pipeline.svg
 Home-page: https://yourlabs.io/oss/cli2
 Author: James Pic
@@ -23,6 +23,17 @@ Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: pytest-mock; extra == "test"
 Requires-Dist: pytest-asyncio; extra == "test"
 Requires-Dist: pytest-httpx; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 .. image:: https://yourlabs.io/oss/cli2/badges/master/pipeline.svg
    :target: https://yourlabs.io/oss/cli2/pipelines

{cli2-3.3.36 → cli2-3.3.40}/setup.py

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