wizlib 3.1.2__py3-none-any.whl → 3.1.4__py3-none-any.whl

wizlib/app.py

@@ -70,15 +70,18 @@ class WizApp:
         """Set up the parser for the app class"""
         cls.parser = WizParser(prog=cls.name)
         subparsers = cls.parser.add_subparsers(dest='command')
+        cls.dparser = WizParser(prog=f"{cls.name} {cls.base.default}")
         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)
             if command.name == cls.base.default:
-                cls.dparser = subparser
+                command.add_args(cls.dparser)
             command.add_args(subparser)
         for handler in cls.handlers:
             handler.add_args(cls.parser)
+            # Throws ArgumentError if the default command includes an optional
+            # argument that overlaps with one of the handlers
             handler.add_args(cls.dparser)
 
     def __init__(self, **vals):

wizlib/io.py

@@ -0,0 +1,21 @@
+# Primitive i/o functions referenced elsewhere, useful for test patching (a
+# sort of dependency injection
+
+import sys
+
+import readchar
+
+
+ISATTY = sys.stdin.isatty()
+
+
+def isatty():
+    return ISATTY
+
+
+def stream():
+    return '' if ISATTY else sys.stdin.read()
+
+
+def ttyin():
+    return readchar.readkey()

wizlib/stream_handler.py

@@ -1,13 +1,17 @@
+# In a non-interactive, non-testing mode, route input from stdin to the output.
+# When testing, read from the object provided (probably a StreamIO)
+
 from pathlib import Path
 import sys
 
 from wizlib.handler import Handler
 from wizlib.parser import WizParser
-
-INTERACTIVE = sys.stdin.isatty()
+import wizlib.io
 
 
 class StreamHandler(Handler):
+    """Handle non-interactive input, such as via a pipe in a shell. Only runs
+    when not in a tty."""
 
     name = 'stream'
     text: str = ''
@@ -15,8 +19,8 @@ class StreamHandler(Handler):
     def __init__(self, file=None, stdin=True):
         if file:
             self.text = Path(file).read_text()
-        elif stdin and (not INTERACTIVE):
-            self.text = sys.stdin.read()
+        elif not wizlib.io.isatty():
+            self.text = wizlib.io.stream()
 
     def __str__(self):
         return self.text

wizlib/test_case.py

@@ -0,0 +1,36 @@
+# Patch inputs and outputs for easy testing
+
+from io import StringIO
+from unittest import TestCase
+from unittest.mock import Mock, patch
+
+
+class WizLibTestCase(TestCase):
+    """Wrap your test cases in this class to use the patches correctly"""
+
+    def setUp(self):
+        self.notty = patch('wizlib.io.isatty', Mock(return_value=False))
+        self.notty.start()
+
+    def tearDown(self):
+        self.notty.stop()
+
+    @staticmethod
+    def patch_stream(val: str):
+        """Patch stream input such as pipes for stream handler"""
+        mock = Mock(return_value=val)
+        return patch('wizlib.io.stream', mock)
+
+    @staticmethod
+    def patch_ttyin(val: str):
+        """Patch input typed by a user in shell ui"""
+        mock = Mock(side_effect=val)
+        return patch('wizlib.io.ttyin', mock)
+
+    @staticmethod
+    def patcherr():  # pragma: nocover
+        return patch('sys.stderr', StringIO())
+
+    @staticmethod
+    def patchout():  # pragma: nocover
+        return patch('sys.stdout', StringIO())

wizlib/ui/shell/line_editor.py

@@ -2,10 +2,8 @@ from enum import Enum
 import sys
 import re
 
-from readchar import readkey
-
 from wizlib.ui.shell import S
-
+import wizlib.io
 
 if (sys.platform == "win32"):
     import ctypes
@@ -89,7 +87,7 @@ class ShellLineEditor:  # pragma: nocover
         write(S.RESET)
         while True:
             self.write_fill()
-            key = readkey()
+            key = wizlib.io.ttyin()
             self.clear_fill()
             if key == S.RETURN:
                 break

wizlib/ui/shell_ui.py

@@ -1,13 +1,10 @@
 from enum import StrEnum
 import sys
 
-from readchar import readkey
-
 from wizlib.ui import UI, Chooser, Emphasis
 from wizlib.ui.shell.line_editor import ShellLineEditor
 from wizlib.ui.shell import S
-
-INTERACTIVE = sys.stdin.isatty()
+import wizlib.io
 
 COLOR = {
     Emphasis.INFO: S.BLUE,
@@ -38,13 +35,11 @@ class ShellUI(UI):
             sys.stderr.flush()
 
     def get_option(self, chooser: Chooser):
-        """Get a choice from the user with a single keystroke"""
+        """Get a choice from the user with a single keystroke. Only works when
+        in a tty."""
         while True:
             self.ask(chooser.prompt_string)
-            if INTERACTIVE:
-                key = readkey()
-            else:
-                key = sys.stdin.read(1)
+            key = wizlib.io.ttyin()
             out = chooser.default if key == '\n' else \
                 key if key.isprintable() else ''
             choice = chooser.choice_by_key(key)
@@ -59,8 +54,7 @@ class ShellUI(UI):
         """Allow the user to input an arbitrary line of text, with possible tab
         completion"""
         self.ask(prompt)
-        if INTERACTIVE:
-            value = ShellLineEditor(choices, default).edit()
-        else:
-            value = input()
+        value = ShellLineEditor(choices, default).edit()
+        # else:
+        #     value = input()
         return value

{wizlib-3.1.2.dist-info → wizlib-3.1.4.dist-info}/METADATA

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

{wizlib-3.1.2.dist-info → wizlib-3.1.4.dist-info}/RECORD

@@ -1,19 +1,20 @@
 wizlib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-wizlib/app.py,sha256=imR_lfyQtYzKObu1tLZVGgJQGmdz43M7E9qAMMokyD4,3962
+wizlib/app.py,sha256=ke0NbaYC6ArmdtLTySl6VIGIGicxTsIuzW9wag6b7rU,4180
 wizlib/class_family.py,sha256=tORSVAaPeWTQMcz2DX-MQClj1GQR3vCmkALPXxHa_pk,4506
 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/io.py,sha256=KAMYTyHyKO2zY2kbymO5c8QpIWfHoTipWsDWzBJzDSw,307
 wizlib/parser.py,sha256=yLHV0fENeApFomCRWa3I6sB1x4lk1ag4vKejWVsic64,1550
-wizlib/stream_handler.py,sha256=i1EgcBrDiYhFK-CI8At7JtUtMCNunJmSkJLSlili-as,663
+wizlib/stream_handler.py,sha256=UUPDpvXmfYOwG0Mmz2YMA8SKxeqau14_bK1z9vZHHp0,896
 wizlib/super_wrapper.py,sha256=msitlfFfEwnrskzTtQBEY975sh9TQPicdLVo67imuqU,315
+wizlib/test_case.py,sha256=T5cX7yWy94hf8JuherDeBCH9Gve5tx2x_PZOte4udC0,1017
 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=f2GErMJg09GPZDS4uK0q8Qq8WEssQFP1dqQyg4ycznI,2029
+wizlib/ui/shell/line_editor.py,sha256=vXXsCS_i4ZCjP0su2X9W_yD1CS6MiazPAtxpiaXQ6Jc,7413
+wizlib/ui/shell_ui.py,sha256=jre7E_5vP_SceNH7GYenfXZpFf4h9Sbh9cWZZycTYk8,1911
 wizlib/ui_handler.py,sha256=JoZadtw9DKAtGvHKP3_BJF2NaYqmcQYNdsY4PeRnOjg,634
-wizlib/util.py,sha256=x1SyL3iXot0ET2r8Jjb2ySTd_J-3Uu7J1b_CHvFgzew,156
-wizlib-3.1.2.dist-info/METADATA,sha256=4HzwBU_sp2F4ycdTb1XvCTDO5i7DeIMdOhl63JfCzNs,1780
-wizlib-3.1.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-wizlib-3.1.2.dist-info/RECORD,,
+wizlib-3.1.4.dist-info/METADATA,sha256=uCYiS39PTHiOjCjA-POguOE1SpJUby4k_hAMx_MYzrA,1780
+wizlib-3.1.4.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+wizlib-3.1.4.dist-info/RECORD,,

wizlib/util.py

@@ -1,8 +0,0 @@
-from unittest.mock import Mock, patch
-
-
-RK = 'wizlib.ui.shell.line_editor.readkey'
-
-
-def mock_keys(keys: str):
-    return patch(RK, Mock(side_effect=keys))