wizlib 3.0.0__py3-none-any.whl → 3.1.0__py3-none-any.whl

wizlib/app.py

@@ -22,9 +22,15 @@ class WizApp:
     """Root of all WizLib-based CLI applications. Subclass it. Can be
     instantiated and then run multiple commands."""
 
-    base_command = None
+    # Name of this app, used in argparse (override)
     name = ''
 
+    # Base command class, typically defined in command/__init__.py (override)
+    base = None
+
+    # List of Handler classes used by this app (override)
+    handlers = []
+
     # Set some default types so linting works
     ui: UI
 
@@ -37,13 +43,10 @@ class WizApp:
     def start(cls, *args, debug=False):
         """Call this from a Python entrypoint"""
         try:
-            parser = WizParser(prog=cls.name)
-            for handler in cls.base_command.handlers:
-                handler.add_args(parser)
-            ns, more = parser.parse_known_args(args)
-            app = cls.initialize(**vars(ns))
-            more = more if more else [cls.base_command.default]
-            app.run(*more)
+            cls.initialize()
+            ns = cls.parser.parse_args(args)
+            app = cls(**vars(ns))
+            app.run(**vars(ns))
         except AppCancellation as cancellation:
             if str(cancellation):
                 print(str(cancellation), file=sys.stderr)
@@ -57,38 +60,39 @@ class WizApp:
                 sys.exit(1)
 
     @classmethod
-    def initialize(cls, **vals):
-        """Converts argparse values (strings) into actual handlers and
-        instantiates the app"""
-        handlers = {}
-        for handler in cls.base_command.handlers:
-            val = vals[handler.name] if (
-                handler.name in vals) else handler.default
-            handlers[handler.name] = handler.setup(val)
-        return cls(**handlers)
-
-    def __init__(self, **handlers):
-        for name, handler in handlers.items():
-            handler.app = self
-            setattr(self, name, handler)
-        self.parser = WizParser()
-        subparsers = self.parser.add_subparsers(dest='command')
-        for command in self.base_command.family_members('name'):
+    def initialize(cls):
+        """Set up the parser for the app class"""
+        cls.parser = WizParser(prog=cls.name)
+        for handler in cls.handlers:
+            handler.add_args(cls.parser)
+        subparsers = cls.parser.add_subparsers(dest='command')
+        for command in cls.base.family_members('name'):
             key = command.get_member_attr('key')
             aliases = [key] if key else []
             subparser = subparsers.add_parser(command.name, aliases=aliases)
             command.add_args(subparser)
 
-    def run(self, *args):
-        vals = vars(self.parser.parse_args(args))
+    def __init__(self, **vals):
+        """Create the app. Only interested in the handlers from the parsed
+        values passed in"""
+        for hcls in self.handlers:
+            val = vals[hcls.name] if (hcls.name in vals) else hcls.default
+            handler = hcls.setup(val)
+            handler.app = self
+            setattr(self, hcls.name, handler)
+
+    def run(self, **vals):
+        """Perform a command. May be called more than once. Only interested in
+        the command itself and its specific arguments from the values passed
+        in."""
         if 'help' in vals:
             return WizHelpCommand(**vals)
-        command_name = vals.pop('command')
-        command_class = self.base_command.family_member(
-            'name', command_name)
-        if not command_class:
-            raise Exception(f"Unknown command {command_name}")
-        command = command_class(self, **vals)
+        c = 'command'
+        cname = (vals.pop(c) if c in vals else None) or self.base.default
+        ccls = self.base.family_member('name', cname)
+        if not ccls:
+            raise Exception(f"Unknown command {cname}")
+        command = ccls(self, **vals)
         result = command.execute()
         if result:
             print(result, end='')

wizlib/command.py

@@ -1,3 +1,5 @@
+# Note that commands once used dataclass, but no longer.
+
 from argparse import ArgumentParser
 from pathlib import Path
 
@@ -16,8 +18,6 @@ class WizCommand(ClassFamily, SuperWrapper):
     """Define all the args you want, but stdin always works."""
 
     status = ''
-    handlers = []
-    ui: UI = None
 
     @classmethod
     def add_args(self, parser):

wizlib/ui/__init__.py

@@ -127,12 +127,12 @@ class Chooser(Prompt):
         self.choices.append(choice)
 
     def choice_by_key(self, key):
-        if key == '\n':
-            choice = self.default
+        if key == '\n' and self.default:
+            choice = self.choices[0].value
         else:
             choice = next(
                 (o.value for o in self.choices if key in o.keys), None)
-        return choice() if callable(choice) else choice
+        return choice
 
     def choices_by_text(self, text):
         return [o.value for o in self.choices if o.hit_text(text)]

wizlib/ui/shell_ui.py

@@ -3,7 +3,6 @@ import sys
 
 from readchar import readkey
 
-from wizlib.rlinput import rlinput
 from wizlib.ui import UI, Chooser, Emphasis
 from wizlib.ui.shell.line_editor import ShellLineEditor
 from wizlib.ui.shell import S
@@ -54,7 +53,7 @@ class ShellUI(UI):
             self.send(out, emphasis=emphasis)
             if choice is not None:
                 break
-        return choice
+        return choice() if callable(choice) else choice
 
     def get_text(self, prompt='', choices=[], default=''):
         """Allow the user to input an arbitrary line of text, with possible tab

{wizlib-3.0.0.dist-info → wizlib-3.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wizlib
-Version: 3.0.0
+Version: 3.1.0
 Summary: Framework for flexible and powerful command-line applications
 License: MIT
 Author: Steampunk Wizard

{wizlib-3.0.0.dist-info → wizlib-3.1.0.dist-info}/RECORD

@@ -1,20 +1,19 @@
 wizlib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-wizlib/app.py,sha256=O5126FXF2_JSGlHycMv3-ec7EfYI875wzuYsDrxq5ZI,3263
+wizlib/app.py,sha256=Sb35ib0UzB-84l9JRjAkBbOhpHekUbiJcNL7Gkr35Pg,3350
 wizlib/class_family.py,sha256=tORSVAaPeWTQMcz2DX-MQClj1GQR3vCmkALPXxHa_pk,4506
-wizlib/command.py,sha256=aiDYMBXuhKTwPN5xdv_qOrvxvXGibLnqxwQgW0aUVQo,1686
+wizlib/command.py,sha256=NO1558EYuXxfkpSmX6ljjzae8n8g4w6yytZKTJtigvo,1708
 wizlib/config_handler.py,sha256=hoDavSMiGM_7PAHI8XIwC8nxPWOZDk302ryyjluoLGg,2588
 wizlib/error.py,sha256=ypwdMOYhtgKWd48ccfOX8idmCXmm-Skwx3gkPwqJB3c,46
 wizlib/handler.py,sha256=Oz80aPhDyeY9tdppZ1dvtN-19JU5ydEDVW6jtppVoD4,446
 wizlib/parser.py,sha256=O34azN4ttVfwwAsza0hujxGxDpzc4xUEVAf26DXJS5g,1505
-wizlib/rlinput.py,sha256=l00Pa3rxNeY6LJgz8Aws_rTKoEchw33fuL8yqHF9_-o,1754
 wizlib/stream_handler.py,sha256=i1EgcBrDiYhFK-CI8At7JtUtMCNunJmSkJLSlili-as,663
 wizlib/super_wrapper.py,sha256=F834ytHqA7zegTD1ezk_uxlF9PLygh84wReuiqcI7BI,272
-wizlib/ui/__init__.py,sha256=JIFBvlqPpHyU6hnyXoherf9va1_ynFuDKlMnJn1SCm8,4249
+wizlib/ui/__init__.py,sha256=ve_p_g4aBujh4jIJMgKkJ6cE5PT0aeY5AgRlneDswGg,4241
 wizlib/ui/shell/__init__.py,sha256=sPrYe4bG_Xf7Nwssx_dqXVk9jeyYBFUjh4oLdlSOeRY,943
 wizlib/ui/shell/line_editor.py,sha256=frpsqU5NggcvEz3XeB8YyqgmlExlyx6K1CKPzvARtPk,7419
-wizlib/ui/shell_ui.py,sha256=qg7DRAYTkkIfe7BKCfclcaupA42YaAk2expIV1fSm40,2030
+wizlib/ui/shell_ui.py,sha256=f2GErMJg09GPZDS4uK0q8Qq8WEssQFP1dqQyg4ycznI,2029
 wizlib/ui_handler.py,sha256=JoZadtw9DKAtGvHKP3_BJF2NaYqmcQYNdsY4PeRnOjg,634
 wizlib/util.py,sha256=x1SyL3iXot0ET2r8Jjb2ySTd_J-3Uu7J1b_CHvFgzew,156
-wizlib-3.0.0.dist-info/METADATA,sha256=t1ESltdsHBUdEP5dp4WR4VnWcYVxfLfPwULW57KPQRA,1780
-wizlib-3.0.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-wizlib-3.0.0.dist-info/RECORD,,
+wizlib-3.1.0.dist-info/METADATA,sha256=9xX6eax7rHG8yulshf0MVGfNYLLbmxFsmx-JO9ddTW0,1780
+wizlib-3.1.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+wizlib-3.1.0.dist-info/RECORD,,

wizlib/rlinput.py

@@ -1,71 +0,0 @@
-try:  # pragma: nocover
-    import gnureadline as readline
-except ImportError:  # pragma: nocover
-    import readline
-import sys
-
-
-# Use tab for completion
-readline.parse_and_bind('tab: complete')
-
-# Only a space separates words
-readline.set_completer_delims(' ')
-
-
-# Readline defaults to complete with local filenames. Definitely not what we
-# want.
-
-def null_complete(text, start):  # pragma: nocover
-    return None
-
-
-readline.set_completer(null_complete)
-
-
-def rlinput(prompt: str = "", default: str = "",
-            options: list = None):  # pragma: nocover
-    """
-    Get input with preset default and/or tab completion of options
-
-    Parameters:
-
-    prompt:str - string to output before requesting input, same as in the
-    input() function
-
-    default:str - value with which to prepopulate the response, can be cleared
-    with ctrl-a, ctrl-k
-
-    options:list - list of choices for tab completion
-    """
-
-    # Clean out the options
-    options = [o.strip() + " " for o in options] if options else []
-
-    # Create the completer using the options
-    def complete(text, state):
-        results = [x for x in options if x.startswith(text)] + [None]
-        return results[state]
-    readline.set_completer(complete)
-
-    # Insert the default when we launch
-    def start():
-        readline.insert_text(default)
-    readline.set_startup_hook(start)
-
-    # Actually perform the input
-    try:
-        value = input(prompt)
-    finally:
-        readline.set_startup_hook()
-        readline.set_completer(null_complete)
-    return value.strip()
-
-
-def tryit():  # pragma: nocover
-    """Quick and dirty tester function"""
-    return rlinput(prompt='>',
-                   options=['a-b', 'a-c', 'b-a'])
-
-
-if __name__ == '__main__':
-    tryit()