cli2 2.7.2__tar.gz → 2.8.0__tar.gz

{cli2-2.7.2/cli2.egg-info → cli2-2.8.0}/PKG-INFO

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

{cli2-2.7.2 → cli2-2.8.0}/cli2/argument.py

@@ -1,3 +1,4 @@
+import inspect
 import re
 import json
 
@@ -10,12 +11,14 @@ class Argument:
     """
     # TODO: why not split this into a bunch of simpler sub-classes now that
     # it's pretty featureful ?
-    def __init__(self, cmd, param, doc=None, color=None, **kwargs):
+    def __init__(self, cmd, param, doc=None, color=None, factory=None,
+                 **kwargs):
         self.cmd = cmd
         self.param = param
         self.color = color
         # Let default be set to None :)
         self.default = kwargs.pop('default', param.default)
+        self.factory = factory
 
         self.doc = doc or ''
         if not doc:
@@ -227,6 +230,23 @@ class Argument:
             )
         )
 
+    def factory_value(self):
+        """
+        Run the factory function and return the value.
+
+        If the factory function takes a `cmd` argument, it will pass the
+        command object.
+
+        If the factory function takes an `arg` argument, it will pass self.
+        """
+        kwargs = dict()
+        sig = inspect.signature(self.factory)
+        if 'cmd' in sig.parameters:
+            kwargs['cmd'] = self.cmd
+        if 'arg' in sig.parameters:
+            kwargs['arg'] = self
+        return self.factory(**kwargs)
+
     @property
     def value(self):
         """Return the value bound to this argument."""

{cli2-2.7.2 → cli2-2.8.0}/cli2/command.py

@@ -141,7 +141,10 @@ class Command(EntryPoint, dict):
         if extra:
             return 'No parameters for these arguments: ' + ', '.join(extra)
 
-        for name, arg in self.items():
+        for name, arg in self.items(factories=None):
+            if arg.factory:
+                arg.value = arg.factory_value()
+                continue
             if not arg.default:
                 continue
             if name in self.bound.arguments:
@@ -188,41 +191,41 @@ class Command(EntryPoint, dict):
             result = self.call(*self.bound.args, **self.bound.kwargs)
             if inspect.iscoroutine(result):
                 result = asyncio.run(result)
-        except TypeError as exc:
-            # keeping this as fallback for now, in case the above missing
-            # detection doesn't work
-            self.exit_code = 1
-            if hasattr(self.target, '__name__'):
-                rep = getattr(self.target, '__name__')
-            elif hasattr(self.target, '__call__'):
-                rep = '__call__'
-            error = str(exc)
-            function = error.split(' ')[0].split('.')[-1]
-            if function.startswith(rep + '('):
-                return self.help(error=error.replace(rep + '()', self.name))
-            raise
         except KeyboardInterrupt:
             print('exiting')
             sys.exit(1)
         return result
 
-    @property
-    def ordered(self):
+    def ordered(self, factories=False):
         """
         Order the parameters by priority.
+
+        :param factories: Show only arguments with factory.
         """
-        return {key: self[key] for key in self.keys()}
+        return {key: self[key] for key in self.keys(factories=factories)}
 
-    def values(self):
-        """ Return ordered values """
-        return self.ordered.values()
+    def values(self, factories=False):
+        """
+        Return ordered values.
 
-    def items(self):
-        """ Return ordered items """
-        return self.ordered.items()
+        :param factories: Show only arguments with factory.
+        """
+        return self.ordered(factories=factories).values()
+
+    def items(self, factories=False):
+        """
+        Return ordered items.
 
-    def keys(self):
-        """ Return ordered keys """
+        :param factories: Show only arguments with factory.
+        """
+        return self.ordered(factories=factories).items()
+
+    def keys(self, factories=False):
+        """
+        Return ordered keys.
+
+        :param factories: Show only arguments with factory.
+        """
         order = (
             inspect.Parameter.POSITIONAL_ONLY,
             inspect.Parameter.POSITIONAL_OR_KEYWORD,
@@ -233,6 +236,8 @@ class Command(EntryPoint, dict):
         keys = []
         for kind in order:
             for name, arg in super().items():
+                if factories is False and arg.factory:
+                    continue
                 if name in self.positions:
                     continue
                 if arg.param.kind == kind:
@@ -242,7 +247,7 @@ class Command(EntryPoint, dict):
         return keys
 
     def __iter__(self):
-        return self.ordered.__iter__()
+        return self.ordered().__iter__()
 
     def arg(
         self,

{cli2-2.7.2 → cli2-2.8.0}/cli2/test_command.py

@@ -1,6 +1,7 @@
 import inspect
 import pytest
 
+from .decorators import arg
 from .argument import Argument
 from .command import Command
 from .test import autotest, Outfile
@@ -521,3 +522,14 @@ def test_helphack():
     cmd('a', 'b', '--help')
     assert cmd.exit_code == 0
     assert not getattr(cmd, 'help_shown', False)
+
+
+def test_factory():
+    class Foo:
+        @arg('self', factory=lambda cmd, arg: Foo())
+        @arg('auto', factory=lambda: 'autoval')
+        def test(self, auto, arg):
+            return auto, arg
+
+    cmd = Command(Foo.test)
+    assert cmd('hello') == ('autoval', 'hello')

{cli2-2.7.2 → cli2-2.8.0/cli2.egg-info}/PKG-INFO

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

{cli2-2.7.2 → cli2-2.8.0}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup
 
 setup(
     name='cli2',
-    version='2.7.2',
+    version='2.8.0',
     setup_requires='setupmeta',
     install_requires=['docstring_parser'],
     extras_require=dict(