cli2 5.2.2__tar.gz → 6.0.0rc4__tar.gz

cli2-6.0.0rc4/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: cli2
+Version: 6.0.0rc4
+Home-page: https://yourlabs.io/oss/cli2
+Author: James Pic
+Author-email: jamespic@gmail.com
+License: MIT
+Keywords: cli
+Requires-Python: >=3.6
+Requires-Dist: docstring_parser
+Requires-Dist: pyyaml
+Requires-Dist: pygments
+Requires-Dist: structlog
+Requires-Dist: aiofiles
+Provides-Extra: httpx
+Requires-Dist: chttpx; extra == "httpx"
+Provides-Extra: ansible
+Requires-Dist: cansible; extra == "ansible"
+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"
+Requires-Dist: pytest-asyncio; extra == "test"
+Requires-Dist: pytest-httpx; extra == "test"
+Requires-Dist: pytest-env; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python

{cli2-5.2.2 → cli2-6.0.0rc4}/cli2/__init__.py

@@ -1,4 +1,8 @@
 # flake8: noqa
+
+from .configuration import Configuration, cfg
+cfg.defaults['CLI2_TRACEBACK_DISABLE'] = ''
+
 from .cli import (
     cmd,
     arg,
@@ -11,13 +15,12 @@ from .cli import (
     Cli2Error,
     Cli2ValueError,
 )
-from .asyncio import async_resolve, Queue
+from .asyncio import async_resolve, files_read
+from .queue import Queue
 from .colors import colors as c
 from .theme import theme, t
-
-from .configuration import Configuration, cfg
 from .display import diff, diff_data, render, print, highlight, yaml_highlight
-from .interactive import choice, editor
+from .interactive import confirm, choice, editor
 try:
     import fcntl
 except ImportError:
@@ -29,9 +32,17 @@ from .log import configure, log, parse
 from .mask import Mask
 from .notlevenshtein import closest, closest_path
 from .proc import Proc
+from .find import Find
 from .table import Table
 
 
+import os
+
+if not bool(cfg['CLI2_TRACEBACK_DISABLE']):
+    from .traceback import enable
+    enable()
+
+
 def which(cmd):
     """ Wrapper around shutil.which, and also check for ~/.local/bin. """
     import shutil
@@ -39,6 +50,7 @@ def which(cmd):
     if path:
         return path
 
+    from pathlib import Path
     path = Path(os.getenv('HOME')) / '.local/bin' / cmd
     if path.exists():
         return str(path)

cli2-6.0.0rc4/cli2/asyncio.py

@@ -0,0 +1,65 @@
+import aiofiles
+import inspect
+from . import display
+from .queue import Queue
+
+
+def async_iter(obj):
+    """ Check if an object is an async iterable. """
+    return inspect.isasyncgen(obj) or hasattr(obj, '__aiter__')
+
+
+async def async_resolve(result, output=False):
+    """
+    Recursively resolve awaitables and async iterables.
+
+    :param result: The awaitable or async iterable to resolve
+    :param output: If True, print results as they are resolved. If False,
+                   collect results.
+
+    :return: The resolved value(s). If output is True, returns None. If output
+             is False, returns a list of resolved values from async iterables.
+    """
+    while inspect.iscoroutine(result):
+        result = await result
+
+    if async_iter(result):
+        results = []
+        async for _ in result:
+            if output:
+                if (
+                    not inspect.iscoroutine(_)
+                    and not inspect.isasyncgen(_)
+                ):
+                    display.print(_)
+                else:
+                    await async_resolve(_, output=output)
+            else:
+                results.append(await async_resolve(_))
+        return None if output else results
+    return result
+
+
+async def files_read(paths, num_workers=None, mode='r', silent=False):
+    """
+    Read a list of files asynchronously with anyio.
+
+    :param paths: File paths to read.
+    :param num_workers: Number of workers, cpucount*2 by default.
+    :return: Dict of path=content
+    """
+
+    result = dict()
+
+    async def file_read(path):
+        try:
+            async with aiofiles.open(str(path), mode) as f:
+                result[path] = await f.read()
+        except:  # noqa
+            if not silent:
+                raise
+
+    queue = Queue(num_workers=num_workers)
+    await queue.run(*[file_read(path) for path in paths])
+
+    return {key: result[key] for key in sorted(result)}

{cli2-5.2.2 → cli2-6.0.0rc4}/cli2/cli.py

@@ -10,12 +10,10 @@ import textwrap
 from docstring_parser import parse
 
 from . import display
-from .asyncio import async_resolve
 from .colors import colors
-
-
-class Cli2Error(Exception):
-    pass
+from .asyncio import async_resolve
+from .theme import t
+from .exceptions import Cli2Error, NotFoundError
 
 
 class Cli2ValueError(Cli2Error):
@@ -115,17 +113,30 @@ class EntryPoint:
         sys.exit(self.exit_code)
 
     def print(self, *args, sep=' ', end='\n', file=None, color=None):
-        if args and args[0].lower() in colors.__dict__ and not color:
+        if args and args[0].lower() in t.__dict__ and not color:
+            color_name = args[0]
+            args = args[1:]
+            color = getattr(t, color_name.lower())
+            if color_name.lower() != color_name:
+                color = getattr(color, 'bold')
+        elif args and args[0].lower() in colors.__dict__ and not color:
+            # backward compatibility
             color = args[0]
             args = args[1:]
             if color.lower() != color:
                 color = color.lower() + 'bold'
             color = getattr(colors, color)
+        elif color:
+            color = getattr(t, color)
 
         msg = sep.join(map(str, args))
 
         if color:
-            msg = color + msg + colors.reset
+            if isinstance(color, str):
+                # backward compatibility
+                msg = color + msg + colors.reset
+            else:
+                msg = color(msg)
 
         print(msg, end=end, file=file or self.outfile, flush=True)
 
@@ -164,7 +175,7 @@ class Group(EntryPoint, dict):
             self.doc = textwrap.dedent(doc).strip()
         else:
             self.doc = inspect.getdoc(self)
-        self.color = color or colors.green
+        self.color = color or 'green'
         self.posix = posix
         self.parent = None
         self.cmdclass = cmdclass or Command
@@ -247,7 +258,7 @@ class Group(EntryPoint, dict):
             return ''
 
         if error:
-            self.print('RED', 'ERROR: ' + colors.reset + error, end='\n\n')
+            self.print('RED', 'ERROR: ' + t.reset + error, end='\n\n')
 
         self.print('ORANGE', 'SYNOPSYS')
         chain = []
@@ -271,7 +282,7 @@ class Group(EntryPoint, dict):
         table = Table(*[
             (
                 (
-                    getattr(colors, command.color, command.color),
+                    getattr(t, command.color, command.color),
                     name,
                 ),
                 command.help(short=True),
@@ -283,6 +294,11 @@ class Group(EntryPoint, dict):
     help.cli2 = dict(color='green')
 
     def load(self, obj):
+        if loader := getattr(obj, 'cli2_load', None):
+            loading = getattr(obj, '_cli2_loading', False)
+            if not loading:
+                obj._cli2_loading = True
+                return loader(self)
         if isinstance(obj, type):
             return self.load_cls(obj)
         return self.load_obj(obj)
@@ -365,8 +381,11 @@ class Command(EntryPoint, dict):
 
     def __new__(cls, target, *args, **kwargs):
         overrides = getattr(target, 'cli2', {})
-        cls = overrides.get('cls', cls)
-        return super().__new__(cls, *args, **kwargs)
+        other_cls = overrides.get('cls', cls)
+        if other_cls:
+            cls = other_cls
+        result = super().__new__(cls, *args, **kwargs)
+        return result
 
     def __init__(self, target, name=None, color=None, doc=None, posix=False,
                  help_hack=True, outfile=None, log=True, overrides=None):
@@ -483,8 +502,8 @@ class Command(EntryPoint, dict):
     def cmd(cls, *args, **kwargs):
         def override(target):
             overrides = getattr(target, 'cli2', {})
-            overrides.update(kwargs)
             overrides['cls'] = cls
+            overrides.update(kwargs)
             target.cli2 = overrides
 
         if len(args) == 1 and not kwargs:
@@ -516,7 +535,7 @@ class Command(EntryPoint, dict):
             )
 
         if error:
-            self.print('RED', 'ERROR: ' + colors.reset + error, end='\n\n')
+            self.print('RED', 'ERROR: ' + t.reset + error, end='\n\n')
 
         self.print('ORANGE', 'SYNOPSYS')
         chain = []
@@ -640,7 +659,13 @@ class Command(EntryPoint, dict):
             finally:
                 self.post_result = asyncio.run(async_resolve(self.post_call()))
 
-        error = self.parse(*argv)
+        try:
+            error = self.parse(*argv)
+        except Cli2ValueError as exc:
+            return self.help(error=exc.args[0])
+        except Exception as exc:
+            return self.handle_exception(exc)
+
         if error:
             self.exit_code = 1
             return self.help(error=error)
@@ -666,11 +691,27 @@ class Command(EntryPoint, dict):
             self.post_result = self.post_call()
 
     def handle_exception(self, exc):
+        if isinstance(exc, NotFoundError):
+            print(t.red.bold(exc.title) + f': {exc.name}\n')
+            if exc.available:
+                print(t.green.bold('AVAILABLE') + ':')
+                display.print(exc.available)
+                return
+            elif exc.searched:
+                print(t.green.bold('SEARCHED') + ':')
+                display.print(exc.searched)
+                return
         raise exc
 
     async def async_call(self, *argv):
         """ Call with async stuff in single event loop """
-        error = self.parse(*argv)
+        try:
+            error = self.parse(*argv)
+        except Cli2ValueError as exc:
+            return self.help(error=exc.args[0])
+        except Exception as exc:
+            return self.handle_exception(exc)
+
         if error:
             self.exit_code = 1
             return self.help(error=error)
@@ -816,6 +857,9 @@ class Command(EntryPoint, dict):
         """
         pass
 
+    def __repr__(self):
+        return f'{type(self).__name__}(name={self.name})'
+
 
 class Argument:
     """
@@ -923,25 +967,20 @@ class Argument:
 
     def __str__(self):
         if self.alias:
-            out = '[' + colors.orange + self.alias[-1]
-            out += colors.reset
+            out = '[' + t.orange(self.alias[-1])
 
             if self.type != bool:
-                out += '=' + colors.green + self.param.name.upper()
-                out += colors.reset
+                out += '=' + t.green(self.param.name.upper())
 
             if self.negates:
-                out += '|' + colors.orange + self.negates[-1]
-                out += colors.reset
+                out += '|' + t.orange(self.negates[-1])
 
             out += ']'
             return out
         elif self.param.kind == self.param.VAR_POSITIONAL:
             return (
                 '['
-                + colors.green
-                + self.param.name.upper()
-                + colors.reset
+                + t.green(self.param.name.upper())
                 + ']...'
             )
         elif self.param.kind == self.param.VAR_KEYWORD:
@@ -949,27 +988,23 @@ class Argument:
             return (
                 '['
                 + prefix
-                + colors.green
-                + self.param.name.upper()
-                + colors.reset
+                + t.green(self.param.name.upper())
                 + '='
-                + colors.green
-                + 'VALUE'
-                + colors.reset
+                + t.green('VALUE')
                 + ']...'
             )
         else:
-            return colors.green + self.param.name.upper() + colors.reset
+            return t.green(self.param.name.upper())
 
     def help(self):
         """Render help for this argument."""
         if self.alias:
             out = ''
             for alias in self.alias:
-                out += colors.orange + alias + colors.reset
+                out += t.orange(alias)
                 if self.type != bool:
                     out += '='
-                    out += colors.green
+                    out += str(t.green)
                     if self.type:
                         if isinstance(self.type, str):
                             out += self.type
@@ -977,17 +1012,16 @@ class Argument:
                             out += self.type.__name__
                     else:
                         out += self.param.name.upper()
-                out += colors.reset
+                out += str(t.reset)
                 out += ' '
             self.cmd.print(out)
         else:
-            self.cmd.print(str(self) + colors.reset)
+            self.cmd.print(f'{self}{t.reset}')
 
         if self.negates:
             out = ''
             for negate in self.negates:
-                out += colors.orange + negate + colors.reset
-                out += colors.reset
+                out += t.orange(negate)
                 out += ' '
             self.cmd.print(out)
 
@@ -997,9 +1031,7 @@ class Argument:
         ):
             self.cmd.print(
                 'Default: '
-                + colors.blue3
-                + str(self.default or self.param.default)
-                + colors.reset
+                + t.cyan(self.default or self.param.default)
             )
 
         if (
@@ -1009,9 +1041,7 @@ class Argument:
         ):
             self.cmd.print(
                 'Accepted: '
-                + colors.blue3
-                + 'yes, 1, true, no, 0, false'
-                + colors.reset
+                + t.cyan('yes, 1, true, no, 0, false')
             )
 
         if self.param.kind == self.param.VAR_KEYWORD:
@@ -1019,12 +1049,9 @@ class Argument:
             if self.cmd.posix:
                 self.cmd.print(
                     '--'
-                    + colors.green
-                    + 'something'
-                    + colors.reset
+                    + t.green('something')
                     + '='
-                    + colors.green
-                    + 'somearg'
+                    + t.green('somearg')
                 )
             else:
                 self.cmd.print('something=somearg')

{cli2-5.2.2 → cli2-6.0.0rc4}/cli2/configuration.py

@@ -31,8 +31,6 @@ import shlex
 import textwrap
 from pathlib import Path
 
-from .log import log
-
 
 class Configuration(dict):
     """
@@ -168,7 +166,12 @@ class Configuration(dict):
 
         if key in self.defaults:
             value = self.defaults[key]
-            log.debug(f'Defaulting {key} to {value}')
+            try:
+                from .log import log
+            except ImportError:
+                pass
+            else:
+                log.debug(f'Defaulting {key} to {value}')
             return value
 
         prompt = self.questions.get(key, key)

{cli2-5.2.2 → cli2-6.0.0rc4}/cli2/display.py

@@ -5,6 +5,10 @@ Generic pretty display utils.
 
     By default, we will not color strings in non-interactive ttys, but you can
     force it with :envvar:`FORCE_COLOR`, ie. gitlab-ci etc
+
+.. envvar:: CLI2_PYGMENTS_STYLE
+
+    Pygments style to use when highlighting code, monokai by default.
 """
 import difflib
 import json
@@ -15,6 +19,12 @@ import yaml
 _print = print
 
 
+def color_enabled():
+    if 'FORCE_COLOR' in os.environ:
+        return bool(os.getenv('FORCE_COLOR', ''))
+    return sys.stdout.isatty()
+
+
 def highlight(string, lexer):
     """
     Use pygments to render a string with a lexer.
@@ -22,8 +32,7 @@ def highlight(string, lexer):
     :param string: String to render
     :param lexer: Lexer name, Yaml, Diff, etc
     """
-    FORCE_COLOR = bool(os.getenv('FORCE_COLOR', ''))
-    if not sys.stdout.isatty() and not FORCE_COLOR:
+    if not color_enabled():
         return string
 
     try:
@@ -33,9 +42,11 @@ def highlight(string, lexer):
     except ImportError:
         return string
 
-    formatter = pygments.formatters.TerminalFormatter()
+    formatter = pygments.formatters.Terminal256Formatter(
+        style=os.getenv('CLI2_PYGMENTS_STYLE', 'monokai'),
+    )
     lexer = getattr(pygments.lexers, lexer + 'Lexer')()
-    return pygments.highlight(string, lexer, formatter)
+    return pygments.highlight(string, lexer, formatter).rstrip()
 
 
 def yaml_dump(data):