|
| 1 | +# Path: sshkeyboard.py |
| 2 | +from collections import deque |
| 3 | +from logging import getLogger, Logger |
| 4 | +from threading import Thread |
| 5 | +from typing import Callable |
| 6 | +from sshkeyboard import listen_keyboard, stop_listening |
| 7 | +from .base import BaseKeyMonitor |
| 8 | +from ..const.keys import EMetaKey |
| 9 | + |
| 10 | + |
| 11 | +class SSHKeyboardBasedKeyMonitor(BaseKeyMonitor): |
| 12 | + |
| 13 | + def __init__( |
| 14 | + self, |
| 15 | + logger: Logger = getLogger(__name__), |
| 16 | + ): |
| 17 | + self._on_press_callback: Callable[[EMetaKey | str | None], bool | None] | None = None # noqa |
| 18 | + self._on_release_callback: Callable[[EMetaKey | str | None], bool | None] | None = None # noqa |
| 19 | + self._logger = logger |
| 20 | + |
| 21 | + self.__thread: Thread | None = None |
| 22 | + self.__keys_queue: deque = deque() |
| 23 | + |
| 24 | + def start(self): |
| 25 | + self.__thread = Thread( |
| 26 | + target=listen_keyboard, |
| 27 | + kwargs=dict( |
| 28 | + on_press=self._on_press_callback_wrapper, |
| 29 | + on_release=self._on_release_callback_wrapper, |
| 30 | + ) |
| 31 | + ) |
| 32 | + self.__thread.start() |
| 33 | + self.__thread.join() |
| 34 | + |
| 35 | + def stop(self): |
| 36 | + |
| 37 | + if self.__thread is None: |
| 38 | + self._logger.warning(f'{self.__class__.__name__}() has not been started.') # noqa |
| 39 | + return |
| 40 | + |
| 41 | + # send stop command |
| 42 | + stop_listening() |
| 43 | + # reset keys queue |
| 44 | + self._reset_keys_queue() |
| 45 | + # reset thread |
| 46 | + self.__thread = None |
| 47 | + |
| 48 | + def _reset_keys_queue(self): |
| 49 | + self.__keys_queue.clear() |
| 50 | + |
| 51 | + def _clean_key(self, key: str) -> EMetaKey | str | None: |
| 52 | + if len(key) == 1: |
| 53 | + return key |
| 54 | + elif key.lower() == 'tab': |
| 55 | + return EMetaKey.TAB |
| 56 | + elif key.lower() == 'esc': |
| 57 | + return EMetaKey.ESC |
| 58 | + elif key.lower() == 'space': |
| 59 | + return ' ' |
| 60 | + else: |
| 61 | + self._logger.warning(f'Invalid key: {key}') |
| 62 | + return None |
| 63 | + |
| 64 | + def _on_press_callback_wrapper(self, key: str): |
| 65 | + self._logger.debug(f'pressed key: {key}') |
| 66 | + # record key |
| 67 | + if len(key) == 1: |
| 68 | + # NOTE: key can be two or more characters when it is a special key like "tab" # noqa |
| 69 | + self.__keys_queue.append(key) |
| 70 | + # preprocess |
| 71 | + key_ = self._clean_key(key) |
| 72 | + # callback |
| 73 | + if self._on_press_callback is None: |
| 74 | + self._logger.warning(f'{self.__class__.__name__}._on_press_callback is None.') # noqa |
| 75 | + return |
| 76 | + return self._on_press_callback(key_) |
| 77 | + |
| 78 | + def _on_release_callback_wrapper(self, key: str): |
| 79 | + self._logger.debug(f'released key: {key}') |
| 80 | + if self._on_release_callback is None: |
| 81 | + self._logger.warning(f'{self.__class__.__name__}._on_release_callback is None.') # noqa |
| 82 | + return |
| 83 | + return self._on_release_callback(self._clean_key(key)) |
0 commit comments