wizlib 3.1.3__tar.gz → 3.1.5__tar.gz

{wizlib-3.1.3 → wizlib-3.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wizlib
-Version: 3.1.3
+Version: 3.1.5
 Summary: Framework for flexible and powerful command-line applications
 License: MIT
 Author: Steampunk Wizard
@@ -43,4 +43,3 @@ WizLib wraps the built-in ArgumentParser with a set of functions, classes, and c
 Logo by [Freepik](https://www.freepik.com/?_gl=1*1y9rvc9*test_ga*Mjc1MTIzODYxLjE2ODA3OTczNTg.*test_ga_523JXC6VL7*MTY4MDc5NzM1OC4xLjEuMTY4MDc5NzQxNS4zLjAuMA..*fp_ga*Mjc1MTIzODYxLjE2ODA3OTczNTg.*fp_ga_1ZY8468CQB*MTY4MDc5NzM1OC4xLjEuMTY4MDc5NzQxNS4zLjAuMA..)
 
 
-

{wizlib-3.1.3 → wizlib-3.1.5}/README.md

@@ -24,4 +24,3 @@ WizLib wraps the built-in ArgumentParser with a set of functions, classes, and c
 
 Logo by [Freepik](https://www.freepik.com/?_gl=1*1y9rvc9*test_ga*Mjc1MTIzODYxLjE2ODA3OTczNTg.*test_ga_523JXC6VL7*MTY4MDc5NzM1OC4xLjEuMTY4MDc5NzQxNS4zLjAuMA..*fp_ga*Mjc1MTIzODYxLjE2ODA3OTczNTg.*fp_ga_1ZY8468CQB*MTY4MDc5NzM1OC4xLjEuMTY4MDc5NzQxNS4zLjAuMA..)
 
-

{wizlib-3.1.3 → wizlib-3.1.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "wizlib"
-version = "3.1.3"
+version = "3.1.5"
 description = "Framework for flexible and powerful command-line applications"
 authors = ["Steampunk Wizard <wizlib@steampunkwizard.ca>"]
 license = "MIT"

wizlib-3.1.5/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-3.1.3 → wizlib-3.1.5}/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-3.1.5/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-3.1.3 → wizlib-3.1.5}/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-3.1.3 → wizlib-3.1.5}/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.3/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))