Move collections into collect space

[python_utils.git] / input_utils.py

diff --git a/input_utils.py b/input_utils.py
index 913146a313608398d902a03eef7fe824399cd6fc..153641b135cfd7debb9b4e20e60ca400316c4dca 100644 (file)
--- a/input_utils.py
+++ b/input_utils.py
@@ -7,6 +7,8 @@ import signal
 import sys
 from typing import List
 
+import exceptions
+
 
 def single_keystroke_response(
     valid_responses: List[str],
@@ -15,15 +17,15 @@ def single_keystroke_response(
     default_response: str = None,
     timeout_seconds: int = None,
 ) -> str:
-    class TimeoutError(Exception):
-        pass
+    """Get a single keystroke response to a prompt."""
 
     def _handle_timeout(signum, frame) -> None:
-        raise TimeoutError()
+        raise exceptions.TimeoutError()
 
     def _single_keystroke_response_internal(
         valid_responses: List[str], timeout_seconds=None
     ) -> str:
+        os_special_keystrokes = [3, 26]  # ^C, ^Z
         if timeout_seconds is not None:
             signal.signal(signal.SIGALRM, _handle_timeout)
             signal.alarm(timeout_seconds)
@@ -33,6 +35,8 @@ def single_keystroke_response(
                 response = readchar.readchar()
                 if response in valid_responses:
                     break
+                if ord(response) in os_special_keystrokes:
+                    break
             return response
         finally:
             if timeout_seconds is not None:
@@ -45,7 +49,7 @@ def single_keystroke_response(
         response = _single_keystroke_response_internal(
             valid_responses, timeout_seconds
         )
-    except TimeoutError:
+    except exceptions.TimeoutError:
         if default_response is not None:
             response = default_response
     if prompt is not None:
@@ -54,12 +58,16 @@ def single_keystroke_response(
 
 
 def yn_response(prompt: str = None, *, timeout_seconds=None) -> str:
+    """Get a Y/N response to a prompt."""
+
     return single_keystroke_response(
         ["y", "n", "Y", "N"], prompt=prompt, timeout_seconds=timeout_seconds
     ).lower()
 
 
 def keystroke_helper() -> None:
+    """Misc util to watch keystrokes and report what they were."""
+
     print("Watching for keystrokes; ^C to quit.")
     while True:
         key = readchar.readkey()