cli2 2.6.2__tar.gz → 3.0.2__tar.gz

{cli2-2.6.2/cli2.egg-info → cli2-3.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cli2
-Version: 2.6.2
+Version: 3.0.2
 Summary: image:: https://yourlabs.io/oss/cli2/badges/master/pipeline.svg
 Home-page: https://yourlabs.io/oss/cli2
 Author: James Pic
@@ -9,7 +9,14 @@ License: MIT
 Keywords: cli
 Requires-Python: >=3.6
 Description-Content-Type: text/x-rst
+Requires-Dist: docstring_parser
+Requires-Dist: pyyaml
+Requires-Dist: rich
 Provides-Extra: test
+Requires-Dist: freezegun; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
 
 .. image:: https://yourlabs.io/oss/cli2/badges/master/pipeline.svg
    :target: https://yourlabs.io/oss/cli2/pipelines

{cli2-2.6.2 → cli2-3.0.2}/cli2/__init__.py

@@ -3,6 +3,7 @@ from .argument import Argument
 from .colors import colors as c
 from .command import Command
 from .decorators import arg, cmd
+from .display import console, diff, print
 from .group import Group
 from .node import Node
 from .table import Table

{cli2-2.6.2 → cli2-3.0.2}/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:
@@ -285,7 +288,7 @@ class Argument:
 
     def aliasmatch(self, arg):
         """Return True if the CLI arg matches an alias of this argument."""
-        if arg == self.negate:
+        if arg in self.negates:
             return True
         if self.iskw and self.param.annotation == bool and arg in self.alias:
             return True
@@ -362,3 +365,20 @@ class Argument:
         if value is not None:
             self.value = self.cast(value)
             return True
+
+    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)

{cli2-2.6.2 → cli2-3.0.2}/cli2/colors.py

@@ -1,3 +1,19 @@
+"""
+Define a bunch of arbitrary color ANSI color codes.
+
+This module is available in the `cli2.c` namespace.
+
+Example:
+
+.. code-block:: python
+
+    import cli2
+    print(f'{cli2.c.green2bold}OK{cli2.c.reset}')
+
+See the following for details.
+"""
+
+
 colors = dict(
     cyan='\u001b[38;5;51m',
     cyan1='\u001b[38;5;87m',

cli2-3.0.2/cli2/command.py

@@ -0,0 +1,417 @@
+import asyncio
+import cli2
+import inspect
+import sys
+
+from docstring_parser import parse
+from rich.console import Console
+from rich.traceback import install
+
+from . import display
+from .argument import Argument
+from .colors import colors
+from .entry_point import EntryPoint
+
+
+console = Console()
+install(show_locals=True, suppress=[cli2])
+
+
+class Command(EntryPoint, dict):
+    """Represents a command bound to a target callable."""
+
+    def __new__(cls, target, *args, **kwargs):
+        overrides = getattr(target, 'cli2', {})
+        cls = overrides.get('cls', cls)
+        return super().__new__(cls, *args, **kwargs)
+
+    def __init__(self, target, name=None, color=None, doc=None, posix=False,
+                 help_hack=True, outfile=None, log=True):
+        self.target = target
+        self.posix = posix
+        self.parent = None
+        self.help_hack = help_hack
+
+        overrides = getattr(target, 'cli2', {})
+        for key, value in overrides.items():
+            setattr(self, key, value)
+
+        if name:
+            self.name = name
+        elif 'name' not in overrides:
+            self.name = getattr(target, '__name__', type(target).__name__)
+
+        self.parsed = parse(inspect.getdoc(target))
+        if doc:
+            self.doc = doc
+        elif 'doc' not in overrides:
+            self.doc = ''
+            if self.parsed.short_description:
+                self.doc += self.parsed.short_description.replace('\n', ' ')
+            if self.parsed.long_description:
+                if self.doc:
+                    self.doc += '\n'
+                self.doc += self.parsed.long_description
+
+        if color:
+            self.color = color
+        elif 'color' not in overrides:
+            self.color = 'orange'
+
+        self.positions = dict()
+        self.sig = inspect.signature(target)
+        self.setargs()
+        EntryPoint.__init__(self, outfile=outfile, log=log)
+
+    def setargs(self):
+        """Reset arguments."""
+        for name, param in self.sig.parameters.items():
+            overrides = getattr(self.target, 'cli2_' + name, {})
+            cls = overrides.get('cls', Argument)
+            self[name] = cls(self, param)
+            for key, value in overrides.items():
+                setattr(self[name], key, value)
+
+    @classmethod
+    def cmd(cls, *args, **kwargs):
+        def override(target):
+            overrides = getattr(target, 'cli2', {})
+            overrides.update(kwargs)
+            overrides['cls'] = cls
+            target.cli2 = overrides
+
+        if len(args) == 1 and not kwargs:
+            # simple @YourCommand.cmd syntax
+            target = args[0]
+            override(target)
+            return target
+        elif not args:
+            def wrap(cb):
+                override(cb)
+                return cb
+            return wrap
+        else:
+            raise Exception('Only kwargs are supported by Group.cmd')
+
+    def help(self, error=None, short=False, missing=None):
+        """Show help for a command."""
+        if short:
+            if self.doc:
+                return self.doc.replace('\n', ' ').split('.')[0]
+            return ''
+
+        if missing:
+            error = (
+                f'missing {len(missing)} required argument'
+                f'{"s" if len(missing) > 1 else ""}'
+                f': {", ".join(missing)}'
+            )
+
+        if error:
+            self.print('RED', 'ERROR: ' + colors.reset + error, end='\n\n')
+
+        self.print('ORANGE', 'SYNOPSYS')
+        chain = []
+        current = self
+        while current is not None:
+            chain.insert(0, current.name)
+            current = current.parent
+        for arg in self.values():
+            chain.append(str(arg))
+        self.print(' '.join(map(str, chain)), end='\n\n')
+
+        self.print('ORANGE', 'DESCRIPTION')
+        self.print(self.doc)
+
+        shown_posargs = False
+        shown_kwargs = False
+        for arg in self.values():
+            self.print()
+
+            if not arg.iskw and not shown_posargs:
+                self.print('ORANGE', 'POSITIONAL ARGUMENTS')
+                shown_posargs = True
+
+            varkw = arg.param.kind == arg.param.VAR_KEYWORD
+            if (arg.iskw or varkw) and not shown_kwargs:
+                self.print('ORANGE', 'NAMED ARGUMENTS')
+                shown_kwargs = True
+            arg.help()
+
+    def parse(self, *argv):
+        """Parse arguments into BoundArguments."""
+        self.setargs()
+        self.bound = self.sig.bind_partial()
+        extra = []
+        for current in argv:
+            taken = False
+            for arg in self.values():
+                taken = arg.take(current)
+                if taken:
+                    break
+
+            if not taken:
+                extra.append(current)
+
+        if extra:
+            return 'No parameters for these arguments: ' + ', '.join(extra)
+
+        for name, arg in self.items(factories=None):
+            if arg.factory:
+                if self.async_function(arg.factory):
+                    arg.value = 'to_be_computed'
+                else:
+                    arg.value = arg.factory_value()
+                continue
+            if not arg.default:
+                continue
+            if name in self.bound.arguments:
+                continue
+            arg.value = arg.default
+
+    def async_function(self, function):
+        """ Return True if function is async """
+        return (
+            inspect.iscoroutinefunction(function)
+            or inspect.isasyncgenfunction(function)
+        )
+
+    def async_mode(self):
+        """ Return True if any callable we'll deal with is async """
+        for arg in self.values():
+            if self.async_function(arg.factory):
+                return True
+        if (
+            self.async_function(self.target)
+            or self.async_function(self.post_call)
+        ):
+            return True
+
+        for name, arg in self.items(factories=True):
+            if arg.factory and self.async_function(arg.factory):
+                return True
+        return False
+
+    def async_iter(self, obj):
+        return inspect.isasyncgen(obj) or hasattr(obj, '__aiter__')
+
+    async def async_resolve(self, result, output=False):
+        """ Recursively resolve awaitables. """
+        while inspect.iscoroutine(result):
+            result = await result
+        if self.async_iter(result):
+            results = []
+            async for _ in result:
+                if output:
+                    if (
+                        not inspect.iscoroutine(_)
+                        and not inspect.isasyncgen(_)
+                    ):
+                        display.print(_)
+                    else:
+                        await self.async_resolve(_, output=output)
+                else:
+                    results.append(await self.async_resolve(_))
+            return None if output else results
+        return result
+
+    def call(self, *args, **kwargs):
+        """Execute command target with bound arguments."""
+        return self.target(*args, **kwargs)
+
+    def missing(self):
+        return [
+            name
+            for name, arg in self.items()
+            if name not in self.bound.arguments
+            and name not in self.bound.kwargs
+            and arg.param.default == arg.param.empty
+            and arg.param.kind in (
+                arg.param.POSITIONAL_ONLY,
+                arg.param.POSITIONAL_OR_KEYWORD,
+            )
+        ]
+
+    def __call__(self, *argv):
+        """Execute command with args from sysargs."""
+        self.exit_code = 0
+
+        if self.help_hack and '--help' in argv:
+            self.exit_code = 1
+            return self.help()
+
+        if self.async_mode():
+            return asyncio.run(self.async_call(*argv))
+
+        error = self.parse(*argv)
+        if error:
+            self.exit_code = 1
+            return self.help(error=error)
+
+        missing = self.missing()
+        if missing:
+            self.exit_code = 1
+            return self.help(missing=missing)
+
+        try:
+            result = self.call(*self.bound.args, **self.bound.kwargs)
+            if (
+                inspect.isgenerator(result)
+                or isinstance(result, (list, tuple))
+            ):
+                for _ in result:
+                    display.print(_)
+                result = None
+        except KeyboardInterrupt:
+            print('exiting')
+            sys.exit(1)
+        finally:
+            self.post_result = self.post_call()
+        return result
+
+    async def async_call(self, *argv):
+        """ Call with async stuff in single event loop """
+        error = self.parse(*argv)
+        if error:
+            self.exit_code = 1
+            return self.help(error=error)
+
+        missing = self.missing()
+        if missing:
+            self.exit_code = 1
+            return self.help(missing=missing)
+
+        factories = self.values(factories=True)
+        if factories:
+            results = await asyncio.gather(*[
+                self.async_resolve(arg.factory_value())
+                for arg in factories
+            ])
+            for _, arg in enumerate(factories):
+                arg.value = results[_]
+
+        try:
+            result = self.call(*self.bound.args, **self.bound.kwargs)
+            result = await self.async_resolve(result, output=True)
+        except KeyboardInterrupt:
+            print('exiting')
+            sys.exit(1)
+        finally:
+            self.post_result = await self.async_resolve(self.post_call())
+        return result
+
+    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(factories=factories)}
+
+    def values(self, factories=False):
+        """
+        Return ordered values.
+
+        :param factories: Show only arguments with factory.
+        """
+        return self.ordered(factories=factories).values()
+
+    def items(self, factories=False):
+        """
+        Return ordered items.
+
+        :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,
+            inspect.Parameter.VAR_POSITIONAL,
+            inspect.Parameter.KEYWORD_ONLY,
+            inspect.Parameter.VAR_KEYWORD,
+        )
+        keys = []
+        for kind in order:
+            for name, arg in super().items():
+                if factories is False and arg.factory:
+                    continue
+                if factories is True and not arg.factory:
+                    continue
+                if name in self.positions:
+                    continue
+                if arg.param.kind == kind:
+                    keys.append(name)
+        for key, position in self.positions.items():
+            if factories and not self[key].factory:
+                continue
+            keys.insert(position, key)
+        return keys
+
+    def __iter__(self):
+        return self.ordered().__iter__()
+
+    def arg(
+        self,
+        name,
+        *,
+        kind: str = None,
+        position: int = None,
+        doc=None,
+        color=None,
+        default=inspect.Parameter.empty,
+        annotation=inspect.Parameter.empty,
+    ):
+        """
+        Inject new :py:class:`~cli2.argument.Argument` into this command.
+
+        The new argument will appear in documentation, but won't be bound to
+        the callable: it will only be avalaible in `self`.
+
+        For example, you are deleting an "http_client" argument in
+        :py:meth:`setargs()` so that it doesn't appear to the CLI user, to whom
+        you want to expose a couple of arguments such as "base_url" and
+        "ssl_verify" that you are adding programatically with this method, so
+        that you can use `self['base_url'].value` and
+        `self['ssl_verify'].value` in to generate a "http_client" argument in
+        :py:meth:`call()`.
+
+        The tutorial has a more comprehensive example in the "CLI only
+        arguments" section.
+
+        :param name: Name of the argument to add
+        :param kind: Name of the inspect parameter kind
+        :param position: Position of the argument in the CLI
+        :param doc: Documentation for the argument
+        :param color: Color of the argument
+        :param default: Default value for the argument
+        :param annotation: Type of argument
+        """
+        self[name] = Argument(
+            self,
+            inspect.Parameter(
+                name,
+                kind=getattr(
+                    inspect.Parameter,
+                    kind or "POSITIONAL_OR_KEYWORD",
+                ),
+                default=default,
+                annotation=annotation,
+            ),
+            doc=doc,
+            color=color,
+        )
+        if position is not None:
+            self.positions[name] = position
+
+    def post_call(self):
+        """
+        Implement your cleaner here
+        """
+        pass

cli2-3.0.2/cli2/display.py

@@ -0,0 +1,92 @@
+"""
+Generic pretty display utils.
+
+This module defines a print function that's supposed to be able to pretty-print
+anything, as well as a pretty diff printer.
+"""
+import os
+
+from rich.console import Console
+from rich.syntax import Syntax
+
+
+console_kwargs = dict()
+if os.getenv('CI'):
+    console_kwargs['force_terminal'] = True
+console = Console(**console_kwargs)
+
+
+NO_COLOR = bool(os.getenv('NO_COLOR', ''))
+_print = print
+
+
+def highlight(string, lexer):
+    if NO_COLOR:
+        return string
+
+    return Syntax(string, lexer)
+
+
+def yaml_dump(data):
+    import yaml
+    if isinstance(data, dict):
+        # ensure that objects inheriting from dict render nicely
+        data = dict(data)
+    return yaml.dump(data, indent=4, width=float('inf'))
+
+
+def print(*args, **kwargs):
+    """
+    Try to print the args, pass the kwargs to actual print method.
+
+    If any arg is parseable as JSON then it'l be parsed.
+
+    Then, it'll be dumped as colored YAML.
+
+    Set the env var `NO_COLORS` to anything to
+    prevent `cli2.print` from printing colors.
+
+    .. code-block:: python
+
+        import cli2
+
+        # pretty print some_object
+        cli2.print(some_object)
+
+    This outputs colors by default, set the env var `NO_COLORS` to anything to
+    prevent printing colors.
+    """
+    try:
+        import jsonlight as json
+    except ImportError:
+        import json
+
+    for arg in args:
+        try:  # deal with response objects
+            arg = arg.json()
+        except (TypeError, AttributeError):
+            pass
+
+        try:  # is this json?
+            arg = json.loads(arg)
+        except:  # noqa
+            pass
+
+        string = arg if isinstance(arg, str) else yaml_dump(arg)
+        console.print(highlight(string.strip(), 'yaml'), **kwargs)
+
+
+def diff(diff, **kwargs):
+    """
+    Pretty-print a diff generated by Python's standard difflib.unified_diff
+    method.
+
+    .. code-block:: python
+
+        # pretty print a diff
+        cli2.diff(difflib.unified_diff(old, new))
+    """
+    string = "\n".join([
+        line.strip() for line in diff if line.strip()
+    ])
+    console.print(highlight(string, 'diff'), **kwargs)

{cli2-2.6.2 → cli2-3.0.2}/cli2/entry_point.py

@@ -3,7 +3,7 @@ import logging
 import sys
 
 from .colors import colors
-from .table import Table
+from . import display
 
 
 class EntryPoint:
@@ -28,14 +28,9 @@ class EntryPoint:
 
         result = self(*args[1:])
         if result is not None:
-            if isinstance(result, (list, tuple)):
-                try:
-                    table = Table.factory(*result)
-                except:  # noqa
-                    print(result)
-                else:
-                    table.print()
-            else:
+            try:
+                display.print(result)
+            except:  # noqa
                 print(result)
         sys.exit(self.exit_code)
 

{cli2-2.6.2 → cli2-3.0.2}/cli2/group.py

@@ -1,4 +1,5 @@
 import inspect
+import textwrap
 
 from .colors import colors
 from .command import Command
@@ -13,7 +14,10 @@ class Group(EntryPoint, dict):
     def __init__(self, name=None, doc=None, color=None, posix=False,
                  outfile=None, cmdclass=None, log=True):
         self.name = name
-        self.doc = doc or inspect.getdoc(self)
+        if doc:
+            self.doc = textwrap.dedent(doc).strip()
+        else:
+            self.doc = inspect.getdoc(self)
         self.color = color or colors.green
         self.posix = posix
         self.parent = None
@@ -31,6 +35,8 @@ class Group(EntryPoint, dict):
         return self
 
     def __setitem__(self, key, value):
+        if isinstance(value, Group):
+            value.name = key
         value.posix = self.posix
         value.parent = self
         value.outfile = self.outfile
@@ -54,7 +60,8 @@ class Group(EntryPoint, dict):
 
     def group(self, name, **kwargs):
         """Return a new sub-group."""
-        self[name] = Group(name, cmdclass=self.cmdclass, **kwargs)
+        kwargs.setdefault('cmdclass', self.cmdclass)
+        self[name] = Group(name, **kwargs)
         return self[name]
 
     def help(self, *args, error=None, short=False):