cli2 4.0.12__tar.gz → 4.0.14__tar.gz

{cli2-4.0.12/cli2.egg-info → cli2-4.0.14}/PKG-INFO

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

{cli2-4.0.12 → cli2-4.0.14}/cli2/cli.py

@@ -1161,6 +1161,9 @@ class Argument:
         command object.
 
         If the factory function takes an `arg` argument, it will pass self.
+
+        It will forward any argument to the factory function if detected in
+        it's signature.
         """
         kwargs = dict()
         sig = inspect.signature(self.factory)
@@ -1168,4 +1171,7 @@ class Argument:
             kwargs['cmd'] = self.cmd
         if 'arg' in sig.parameters:
             kwargs['arg'] = self
+        for key, arg in self.cmd.items():
+            if key in sig.parameters:
+                kwargs[key] = arg.value
         return self.factory(**kwargs)

{cli2-4.0.12 → cli2-4.0.14}/cli2/client.py

@@ -699,6 +699,11 @@ class ModelMetaclass(type):
             attributes['paginator'] = attributes['Paginator']
 
         cls = super().__new__(cls, name, bases, attributes)
+        cls.Command = type(
+            'ModelCommand',
+            (cls.Command,),
+            dict(model=cls),
+        )
         client = getattr(cls, 'client', None)
         if client:
             if not cls.paginator:
@@ -733,6 +738,19 @@ class ModelMetaclass(type):
 
         return cls
 
+    @property
+    def cli(cls):
+        if '_cli' not in cls.__dict__:
+            cli_kwargs = dict(
+                name=cls.__name__.lower(),
+                doc=inspect.getdoc(cls),
+                cmdclass=cls.Command,
+            )
+            cli_kwargs.update(cls.cli_kwargs)
+            cls._cli = Group(**cli_kwargs)
+            cls._cli.load(cls)
+        return cls._cli
+
 
 class Model(metaclass=ModelMetaclass):
     """
@@ -765,13 +783,29 @@ class Model(metaclass=ModelMetaclass):
     .. py:attribute:: url
 
         Object URL based on :py:attr:`url_detail` and :py:attr:`id_field`.
+
+    .. py:attribute:: cli_kwargs
+
+        Dict of kwargs to use to create the :py:class:`~cli2.cli.Group` for
+        this model.
+
+    .. py:attribute:: Command
+
+        Define a Command class inside the ModelClass to use a specific
+        :py:class:`~cli2.cli.Command` class for a model.
+        Don't inherit from anything: a new class will be generated for you
+        inheriting from both :py:class:`~cls.cli2.client.ModelCommand` and
+        :py:attr:`~cli2.cli.Client.Command`.
     """
     paginator = None
     model_command = ModelCommand
-    model_group = ModelGroup
     url_list = None
     url_detail = '{self.url_list}/{self.id_value}'
     id_field = 'id'
+    cli_kwargs = dict()
+
+    class Command(ModelCommand):
+        pass
 
     def __init__(self, data=None, **values):
         """
@@ -947,8 +981,15 @@ class ClientMetaclass(type):
     def __new__(cls, name, bases, attributes):
         if 'Paginator' in attributes:
             attributes['paginator'] = attributes['Paginator']
+
         cls = super().__new__(cls, name, bases, attributes)
 
+        cls.Command = type(
+            'ClientCommand',
+            (cls.Command, Command),
+            dict(),
+        )
+
         # bind ourself as _client_class to any inherited model
         cls.Model = type('Model', (Model,), dict(_client_class=cls))
         cls.models = []
@@ -964,12 +1005,13 @@ class ClientMetaclass(type):
                     cls=dict(factory=lambda: cls),
                     self=dict(factory=lambda: cls())
                 ),
+                cmdclass=cls.Command,
             )
             cli_kwargs.update(cls.cli_kwargs)
             cli = Group(**cli_kwargs)
             cli.load(cls)
             for model in cls.models:
-                group = ModelGroup(model)
+                group = model.cli
                 if len(group) > 1:
                     cli[model.__name__.lower()] = group
             cls._cli = cli
@@ -1236,6 +1278,13 @@ class Client(metaclass=ClientMetaclass):
             class YourClient(cli2.Client):
                 cli_kwargs = dict(cmdclass=YourCommandClass)
 
+    .. py:attribute:: Command
+
+        Define a Command class inside the Client class to use a specific
+        :py:class:`~cli2.cli.Command` class for a model.
+        Don't inherit from anything: a new class will be generated for you
+        inheriting from :py:attr:`~cli2.cli.Client.Command` for you.
+
     .. py:attribute:: debug
 
         Enforce full logging: quiet requests are logged, masking does not
@@ -1251,6 +1300,9 @@ class Client(metaclass=ClientMetaclass):
     mask = []
     debug = False
 
+    class Command:
+        pass
+
     def __init__(self, *args, handler=None, semaphore=None, mask=None,
                  debug=False, **kwargs):
         """

{cli2-4.0.12 → cli2-4.0.14/cli2.egg-info}/PKG-INFO

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

{cli2-4.0.12 → cli2-4.0.14}/setup.py

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

{cli2-4.0.12 → cli2-4.0.14}/tests/test_client.py

@@ -1145,3 +1145,19 @@ async def test_client_token_apply(client_class, httpx_mock):
     await client.client_reset()
     assert client.token == 2
     assert client.client.token == 2
+
+
+def test_client_command(client_class):
+    class Client(client_class):
+        class Command(cli2.Command):
+            pass
+
+    class Model(Client.Model):
+        url_list = '/foo'
+        class Command(Client.Command, cli2.Model.Command):
+            pass
+
+    assert issubclass(Client.cli.cmdclass, Client.Command)
+    assert issubclass(Client.cli['model'].cmdclass, Client.Command)
+    assert issubclass(Client.cli['model'].cmdclass, cli2.Model.Command)
+    assert 'get' in Client.cli['model']

{cli2-4.0.12 → cli2-4.0.14}/tests/test_command.py

@@ -707,3 +707,15 @@ def test_keyboard_interrupt_async():
     cmd()
     assert cmd.exit_code == 1
     assert cmd.post_result == 'foo'
+
+
+def test_factory_value_args():
+    def myfactory(foo):
+        return foo
+
+    @cli2.arg('bar', factory=myfactory)
+    def mycmd(foo, bar):
+        return foo
+
+    cmd = cli2.Command(mycmd)
+    assert cmd('a') == 'a'