From 4c315e387f18010ba0b5661744ad3c792f21d2d1 Mon Sep 17 00:00:00 2001 From: Scott Gasch Date: Wed, 15 Sep 2021 09:32:08 -0700 Subject: Adding doctests. Also added a logging filter. --- input_utils.py | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'input_utils.py') diff --git a/input_utils.py b/input_utils.py index 648ee30..153641b 100644 --- a/input_utils.py +++ b/input_utils.py @@ -17,6 +17,8 @@ def single_keystroke_response( default_response: str = None, timeout_seconds: int = None, ) -> str: + """Get a single keystroke response to a prompt.""" + def _handle_timeout(signum, frame) -> None: raise exceptions.TimeoutError() @@ -56,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() -- cgit v1.3