diff --git a/lib/logitech_receiver/diversion.py b/lib/logitech_receiver/diversion.py index 3dd6809f7..9f7b9495b 100644 --- a/lib/logitech_receiver/diversion.py +++ b/lib/logitech_receiver/diversion.py @@ -511,7 +511,7 @@ def charging(f, r, d, _a): def compile_component(c): - if isinstance(c, Rule) or isinstance(c, Condition) or isinstance(c, Action): + if isinstance(c, Rule) or isinstance(c, ConditionProtocol) or isinstance(c, ActionProtocol): return c elif isinstance(c, dict) and len(c) == 1: k, v = next(iter(c.items())) @@ -520,16 +520,16 @@ def compile_component(c): except KeyError: pass logger.warning("illegal component in rule: %s", c) - return FalllbackCondition() + return FallbackCondition() def _evaluate(components, feature, notification: HIDPPNotification, device, result) -> Any: res = True for component in components: res = component.evaluate(feature, notification, device, result) - if not isinstance(component, Action) and res is None: + if not isinstance(component, ActionProtocol) and res is None: return None - if isinstance(component, Condition) and not res: + if isinstance(component, ConditionProtocol) and not res: return res return res @@ -556,7 +556,19 @@ def data(self): return {"Rule": [c.data() for c in self.components]} -class Condition: +@typing.runtime_checkable +class ConditionProtocol(typing.Protocol): + def __str__(self) -> str: + ... + + def evaluate(self, feature, notification: HIDPPNotification, device, last_result) -> bool: + ... + + def data(self) -> dict[str, Any]: + ... + + +class FallbackCondition(ConditionProtocol): def __init__(self, *args): pass @@ -569,7 +581,7 @@ def evaluate(self, feature, notification: HIDPPNotification, device, last_result return False -class Not(Condition): +class Not(ConditionProtocol): def __init__(self, op, warn=True): if isinstance(op, list) and len(op) == 1: op = op[0] @@ -589,7 +601,7 @@ def data(self): return {"Not": self.component.data()} -class Or(Condition): +class Or(ConditionProtocol): def __init__(self, args, warn=True): self.components = [compile_component(a) for a in args] @@ -602,9 +614,9 @@ def evaluate(self, feature, notification: HIDPPNotification, device, last_result result = False for component in self.components: result = component.evaluate(feature, notification, device, last_result) - if not isinstance(component, Action) and result is None: + if not isinstance(component, ActionProtocol) and result is None: return None - if isinstance(component, Condition) and result: + if isinstance(component, ConditionProtocol) and result: return result return result @@ -612,7 +624,7 @@ def data(self): return {"Or": [c.data() for c in self.components]} -class And(Condition): +class And(ConditionProtocol): def __init__(self, args, warn=True): self.components = [compile_component(a) for a in args] @@ -674,7 +686,7 @@ def gnome_dbus_pointer_prog(): return (wm_class,) if wm_class else None -class Process(Condition): +class Process(ConditionProtocol): def __init__(self, process, warn=True): self.process = process if (not wayland and not x11_setup()) or (wayland and not gnome_dbus_interface_setup()): @@ -705,7 +717,7 @@ def data(self): return {"Process": str(self.process)} -class MouseProcess(Condition): +class MouseProcess(ConditionProtocol): def __init__(self, process, warn=True): self.process = process if (not wayland and not x11_setup()) or (wayland and not gnome_dbus_interface_setup()): @@ -736,7 +748,7 @@ def data(self): return {"MouseProcess": str(self.process)} -class Feature(Condition): +class Feature(ConditionProtocol): def __init__(self, feature: str, warn: bool = True): try: self.feature = SupportedFeature[feature] @@ -757,7 +769,7 @@ def data(self): return {"Feature": str(self.feature)} -class Report(Condition): +class Report(ConditionProtocol): def __init__(self, report, warn=True): if not (isinstance(report, int)): if warn: @@ -779,7 +791,7 @@ def data(self): # Setting(device, setting, [key], value...) -class Setting(Condition): +class Setting(ConditionProtocol): def __init__(self, args, warn=True): if not (isinstance(args, list) and len(args) > 2): if warn: @@ -826,7 +838,7 @@ def data(self): MODIFIER_MASK = MODIFIERS["Shift"] + MODIFIERS["Control"] + MODIFIERS["Alt"] + MODIFIERS["Super"] -class Modifiers(Condition): +class Modifiers(ConditionProtocol): def __init__(self, modifiers, warn=True): modifiers = [modifiers] if isinstance(modifiers, str) else modifiers self.desired = 0 @@ -856,7 +868,7 @@ def data(self): return {"Modifiers": [str(m) for m in self.modifiers]} -class Key(Condition): +class Key(ConditionProtocol): DOWN = "pressed" UP = "released" @@ -911,7 +923,7 @@ def data(self): return {"Key": [str(self.key), self.action]} -class KeyIsDown(Condition): +class KeyIsDown(ConditionProtocol): def __init__(self, args, warn=True): default_key = 0 @@ -955,7 +967,7 @@ def range_test_helper(_f, _r, d): return range_test_helper -class Test(Condition): +class Test(ConditionProtocol): def __init__(self, test, warn=True): self.test = "" self.parameter = None @@ -997,7 +1009,7 @@ def data(self): return {"Test": ([self.test, self.parameter] if self.parameter is not None else [self.test])} -class TestBytes(Condition): +class TestBytes(ConditionProtocol): def __init__(self, test, warn=True): self.test = test if ( @@ -1025,7 +1037,7 @@ def data(self): return {"TestBytes": self.test[:]} -class MouseGesture(Condition): +class MouseGesture(ConditionProtocol): MOVEMENTS = [ "Mouse Up", "Mouse Down", @@ -1080,7 +1092,7 @@ def data(self): return {"MouseGesture": [str(m) for m in self.movements]} -class Active(Condition): +class Active(ConditionProtocol): def __init__(self, devID, warn=True): if not (isinstance(devID, str)): if warn: @@ -1101,7 +1113,7 @@ def data(self): return {"Active": self.devID} -class Device(Condition): +class Device(ConditionProtocol): def __init__(self, devID, warn=True): if not (isinstance(devID, str)): if warn: @@ -1121,7 +1133,7 @@ def data(self): return {"Device": self.devID} -class Host(Condition): +class Host(ConditionProtocol): def __init__(self, host, warn=True): if not (isinstance(host, str)): if warn: @@ -1142,12 +1154,13 @@ def data(self): return {"Host": self.host} -class Action: - def __init__(self, *args): - pass +@typing.runtime_checkable +class ActionProtocol(typing.Protocol): + def evaluate(self, feature, notification: HIDPPNotification, device, last_result) -> None: + ... - def evaluate(self, feature, notification: HIDPPNotification, device, last_result): - return None + def data(self) -> dict[str, Any]: + ... def keysym_to_keycode(keysym, _modifiers) -> Tuple[int, int]: # maybe should take shift into account @@ -1176,7 +1189,7 @@ def keysym_to_keycode(keysym, _modifiers) -> Tuple[int, int]: # maybe should ta return keycode, level -class KeyPress(Action): +class KeyPress(ActionProtocol): def __init__(self, args, warn=True): self.key_names, self.action = self.regularize_args(args) if not isinstance(self.key_names, list): @@ -1266,7 +1279,7 @@ def data(self): # super().keyUp(self.keys, current_key_modifiers) -class MouseScroll(Action): +class MouseScroll(ActionProtocol): def __init__(self, amounts, warn=True): if len(amounts) == 1 and isinstance(amounts[0], list): amounts = amounts[0] @@ -1294,7 +1307,7 @@ def data(self): return {"MouseScroll": self.amounts[:]} -class MouseClick(Action): +class MouseClick(ActionProtocol): def __init__(self, args, warn=True): if len(args) == 1 and isinstance(args[0], list): args = args[0] @@ -1333,7 +1346,7 @@ def data(self): return {"MouseClick": [self.button, self.count]} -class Set(Action): +class Set(ActionProtocol): def __init__(self, args, warn=True): if not (isinstance(args, list) and len(args) > 2): if warn: @@ -1379,7 +1392,7 @@ def data(self): return {"Set": self.args[:]} -class Execute(Action): +class Execute(ActionProtocol): def __init__(self, args, warn=True): if isinstance(args, str): args = [args] @@ -1403,7 +1416,7 @@ def data(self): return {"Execute": self.args[:]} -class Later(Action): +class Later(ActionProtocol): def __init__(self, args, warn=True): self.delay = 0 self.rule = Rule([]) diff --git a/lib/solaar/ui/diversion_rules.py b/lib/solaar/ui/diversion_rules.py index 901e149c3..335d84781 100644 --- a/lib/solaar/ui/diversion_rules.py +++ b/lib/solaar/ui/diversion_rules.py @@ -1171,7 +1171,7 @@ def left_label(cls, component): class ActionUI(RuleComponentUI): - CLASS = _DIV.Action + CLASS = _DIV.ActionProtocol @classmethod def icon_name(cls): diff --git a/lib/solaar/ui/rule_actions.py b/lib/solaar/ui/rule_actions.py index 347947b7a..2d705a6e0 100644 --- a/lib/solaar/ui/rule_actions.py +++ b/lib/solaar/ui/rule_actions.py @@ -30,7 +30,7 @@ class ActionUI(RuleComponentUI): - CLASS = diversion.Action + CLASS = diversion.ActionProtocol @classmethod def icon_name(cls): diff --git a/lib/solaar/ui/rule_conditions.py b/lib/solaar/ui/rule_conditions.py index 82fb8429e..4999587a5 100644 --- a/lib/solaar/ui/rule_conditions.py +++ b/lib/solaar/ui/rule_conditions.py @@ -27,7 +27,7 @@ class ConditionUI(RuleComponentUI): - CLASS = diversion.Condition + CLASS = diversion.ConditionProtocol @classmethod def icon_name(cls):