cli2 3.3.31__tar.gz → 3.3.33__tar.gz

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

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

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

@@ -76,13 +76,17 @@ class Paginator:
 
         :py:class:`Model` class or ``dict`` by default.
 
-    .. py:attribute:: callback
+    .. py:attribute:: postfilter
 
-        Callback called for every item.
+        Callback called for every item after filtering.
+
+    .. py:attribute:: prefilter
+
+        Callback called for every item before filtering.
     """
 
     def __init__(self, client, url, params=None, model=None, expressions=None,
-                 callback=None):
+                 prefilter=None, postfilter=None):
         """
         Initialize a paginator object with a client on a URL with parameters.
 
@@ -98,7 +102,8 @@ class Paginator:
         self.page_start = 1
         self.per_page = None
         self.initialized = False
-        self.callback = callback
+        self.prefilter = prefilter
+        self.postfilter = postfilter
         self.expressions = []
         for expression in (expressions or []):
             if not isinstance(expression, Expression):
@@ -272,11 +277,12 @@ class Paginator:
             await self.initialize(response)
         return response
 
-    async def __aiter__(self, callback=None):
+    async def __aiter__(self, prefilter=None, postfilter=None):
         """
         Asynchronous iterator.
         """
-        callback = callback or self.callback
+        prefilter = prefilter or self.prefilter
+        postfilter = postfilter or self.postfilter
 
         if self._reverse and not self.total_pages:
             first_page_response = await self.page_response(1)
@@ -286,18 +292,24 @@ class Paginator:
 
         python_filter = self.python_filter()
 
+        async def yielder(items):
+            for item in items:
+                if prefilter:
+                    await async_resolve(prefilter(item))
+                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):
-            if items == 'continue':
+            if not items:
                 continue
 
             if self._reverse:
                 items = reversed(items)
 
-            for item in items:
-                if not python_filter or python_filter.matches(item):
-                    if callback:
-                        callback(item)
-                    yield item
+            async for item in yielder(items):
+                yield item
 
             if self._reverse:
                 page -= 1
@@ -306,11 +318,8 @@ class Paginator:
                 if page == 1:
                     # use cached first page response
                     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
+                    async for item in yielder(reversed(items)):
+                        yield item
                     break
             else:
                 if page == self.total_pages:
@@ -691,13 +700,7 @@ class ModelGroup(Group):
                 dict(model=cls),
             )
         )
-
-        url_list_methods = ['find', 'get', 'delete', 'create']
-        if cls.url_list:
-            for name in url_list_methods:
-                self.cmd(getattr(cls, name))
-
-        self.load_cls(cls, exclude=url_list_methods)
+        self.load_cls(cls)
 
 
 class ModelMetaclass(type):
@@ -811,7 +814,7 @@ class Model(metaclass=ModelMetaclass):
 
     @classmethod
     @hide('expressions')
-    @cmd(color='green')
+    @cmd(color='green', condition=lambda cls: cls.url_list)
     def find(cls, *expressions, **params):
         """
         Find objects filtered by GET params
@@ -865,7 +868,7 @@ class Model(metaclass=ModelMetaclass):
             raise Exception(f'{type(self).__name__}.url_list not set')
         return self.url_detail.format(self=self)
 
-    @cmd(color='red')
+    @cmd(color='red', condition=lambda cls: cls.url_list)
     async def delete(self):
         """
         Delete model.
@@ -875,7 +878,7 @@ class Model(metaclass=ModelMetaclass):
         return await self.client.delete(self.url)
 
     @classmethod
-    @cmd(doc="""
+    @cmd(condition=lambda cls: cls.url_list, doc="""
     POST request to create.
 
     Example:
@@ -891,7 +894,7 @@ class Model(metaclass=ModelMetaclass):
         return obj
 
     @classmethod
-    @cmd(color='green', doc="""
+    @cmd(color='green', condition=lambda cls: cls.url_list, doc="""
     Get a model based on kwargs.
 
     Example:

{cli2-3.3.31 → cli2-3.3.33}/cli2/group.py

@@ -177,21 +177,35 @@ class Group(EntryPoint, dict):
                 self.group(name).load(target, parent=obj)
         return self
 
-    def load_cls(self, cls, exclude=None):
+    def load_cls(self, cls, leaf=None):
         """
         Load all methods which have been decorated with @cmd
+
+        Note that you can define conditions, this is how we hide functions such
+        as create/delete/get from models without url_list:
+
+        .. code-block:: python
+
+            @cli2.cmd(condition=lambda cls: cls.url_list)
         """
-        exclude = exclude or []
+        leaf = leaf if leaf else cls
+        for base in cls.__bases__:
+            self.load_cls(base, leaf=leaf)
+
         for name, method in cls.__dict__.items():
-            if name in exclude:
-                continue
             wrapped_method = getattr(method, '__func__', None)
-            if hasattr(wrapped_method, 'cli2'):
-                self.cmd(wrapped_method)
-            elif hasattr(method, 'cli2'):
-                self.cmd(method)
-        for base in cls.__bases__:
-            self.load_cls(base, exclude=exclude)
+            cfg = getattr(
+                wrapped_method,
+                'cli2',
+                getattr(method, 'cli2', None),
+            )
+            if cfg is None:
+                continue
+            condition = cfg.get('condition', None)
+            if condition:
+                if not condition(leaf):
+                    continue
+            self.cmd(method)
 
     def __call__(self, *argv):
         self.exit_code = 0

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

@@ -68,6 +68,15 @@ async def test_client_cli_override(client_class, httpx_mock):
             return cls.url_list
     assert await Client.cli['testmodel']['find'].async_call('bar') == 'bar/foo'
 
+    class TestModel2(Client.Model):
+        @classmethod
+        @cli2.cmd
+        async def find(cls):
+            return 'foo'
+
+    assert await Client.cli['testmodel2']['find'].async_call() == 'foo'
+    assert 'get' not in Client.cli['testmodel2']
+
 
 def test_client_model(client_class):
     assert issubclass(client_class.Model, cli2.Model)
@@ -348,11 +357,18 @@ async def test_pagination(httpx_mock):
     httpx_mock.add_response(url='http://lol/?page=3', json=[])
     client = Client(base_url='http://lol')
     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})
+
+    def prefilter(item):
+        item['b'] = item['a']
+
+    def postfilter(item):
+        item['c'] = item['b']
+
+    paginator.prefilter = prefilter
+    paginator.postfilter = postfilter
+    assert await paginator.list() == [
+        dict(a=1, b=1, c=1),
+        dict(a=2, b=2, c=2)
     ]
 
 

{cli2-3.3.31 → cli2-3.3.33}/cli2/test_group.py

@@ -225,11 +225,11 @@ def test_load_cls():
         def test2(self):
             pass
 
-        @cli2.cmd
+        @cli2.cmd(condition=lambda cls: False)
         def exclude(self):
             pass
     group = Group()
-    group.load_cls(Foo, exclude=['exclude'])
+    group.load_cls(Foo)
     assert 'bar' not in group
     assert 'test' in group
     assert 'test2' in group

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

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

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

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