sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactor Key and ModifierKey __call__ methods

Browse Source 
- Add tests for ModifierKey chaining
- Rewrite ModifierKey.__call__ for correctness and readability
- __call__ now maintains handlers and meta, like clone()
This commit is contained in:
Ryan Rotter 2022-04-17 16:52:24 -05:00 committed by Kyle Brown
parent 7a51ce576f
commit 27a0bc1977
2 changed files with 115 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
kmk/keys.py
View File

@ -398,11 +398,14 @@ class Key:
if no_press is None and no_release is None:
return self
return Key(
return type(self)(
code=self.code,
has_modifiers=self.has_modifiers,
no_press=no_press,
no_release=no_release,
on_press=self._handle_press,
on_release=self._handle_release,
meta=self.meta,
)
def __repr__(self):
@ -557,43 +560,36 @@ class Key:
class ModifierKey(Key):
# FIXME this is atrocious to read. Please, please, please, strike down upon
# this with great vengeance and furious anger.
FAKE_CODE = const(-1)
def __call__(self, modified_code=None, no_press=None, no_release=None):
if modified_code is None and no_press is None and no_release is None:
return self
def __call__(self, modified_key=None, no_press=None, no_release=None):
if modified_key is None:
return super().__call__(no_press=no_press, no_release=no_release)
if modified_code is not None:
if isinstance(modified_code, ModifierKey):
new_keycode = ModifierKey(
ModifierKey.FAKE_CODE,
set() if self.has_modifiers is None else self.has_modifiers,
no_press=no_press,
no_release=no_release,
)
modifiers = set()
code = modified_key.code
if self.code != ModifierKey.FAKE_CODE:
new_keycode.has_modifiers.add(self.code)
if self.code != ModifierKey.FAKE_CODE:
modifiers.add(self.code)
if self.has_modifiers:
modifiers |= self.has_modifiers
if modified_key.has_modifiers:
modifiers |= modified_key.has_modifiers
if modified_code.code != ModifierKey.FAKE_CODE:
new_keycode.has_modifiers.add(modified_code.code)
else:
new_keycode = Key(
modified_code.code,
{self.code},
no_press=no_press,
no_release=no_release,
)
if isinstance(modified_key, ModifierKey):
if modified_key.code != ModifierKey.FAKE_CODE:
modifiers.add(modified_key.code)
code = ModifierKey.FAKE_CODE
if modified_code.has_modifiers:
new_keycode.has_modifiers |= modified_code.has_modifiers
else:
new_keycode = Key(self.code, no_press=no_press, no_release=no_release)
return new_keycode
return type(modified_key)(
code=code,
has_modifiers=modifiers,
no_press=no_press,
no_release=no_release,
on_press=modified_key._handle_press,
on_release=modified_key._handle_release,
meta=modified_key.meta,
)
def __repr__(self):
return 'ModifierKey(code={}, has_modifiers={})'.format(

87
tests/test_kmk_keys.py Normal file
View File

@ -0,0 +1,87 @@
import unittest
from kmk.keys import KC, Key, ModifierKey
from tests.keyboard_test import KeyboardTest
class TestKmkKeys(unittest.TestCase):
def test_basic_kmk_keyboard(self):
keyboard = KeyboardTest(
[],
[
[
KC.HASH,
KC.RALT(KC.HASH),
KC.RALT(KC.LSFT)(KC.N3),
KC.RALT(KC.LSFT),
KC.RALT,
]
],
)
keyboard.test(
'Shifted key',
[(0, True), (0, False)],
[
{
KC.N3,
KC.LSFT,
},
{},
],
)
keyboard.test(
'Shift+AltGr+key',
[(1, True), (1, False)],
[
{
KC.N3,
KC.LSFT,
KC.RALT,
},
{},
],
)
keyboard.test(
'Shift+AltGr+key, alternate chaining',
[(2, True), (2, False)],
[
{
KC.N3,
KC.LSFT,
KC.RALT,
},
{},
],
)
keyboard.test(
'Shift+AltGr',
[(3, True), (3, False)],
[
{
KC.LSFT,
KC.RALT,
},
{},
],
)
keyboard.test(
'AltGr',
[(4, True), (4, False)],
[
{
KC.RALT,
},
{},
],
)
assert isinstance(KC.RGUI(no_press=True), ModifierKey)
assert isinstance(KC.RALT(KC.RGUI), ModifierKey)
assert isinstance(KC.Q(no_press=True), Key)
assert not isinstance(KC.Q(no_press=True), ModifierKey)
assert isinstance(KC.RALT(KC.Q), Key)
assert not isinstance(KC.RALT(KC.Q), ModifierKey)
if __name__ == '__main__':
unittest.main()