diff --git a/lib/logitech_receiver/diversion.py b/lib/logitech_receiver/diversion.py index bacae45f4..8591c6ddf 100644 --- a/lib/logitech_receiver/diversion.py +++ b/lib/logitech_receiver/diversion.py @@ -512,8 +512,8 @@ def charging(f, r, d, _a): } -def compile_component(c): - if isinstance(c, Rule) or isinstance(c, Condition) or isinstance(c, Action): +def compile_component(c) -> Rule | type[ConditionProtocol] | type[ActionProtocol]: + 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())) @@ -523,16 +523,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 @@ -559,7 +559,22 @@ def data(self): return {"Rule": [c.data() for c in self.components]} -class Condition: +@typing.runtime_checkable +class ConditionProtocol(typing.Protocol): + def __init__(self, args: Any, warn: bool) -> None: + ... + + 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 @@ -572,7 +587,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] @@ -592,7 +607,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] @@ -605,9 +620,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 @@ -615,7 +630,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] @@ -677,7 +692,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()): @@ -708,7 +723,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()): @@ -739,7 +754,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] @@ -760,7 +775,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: @@ -782,7 +797,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: @@ -829,7 +844,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 @@ -859,7 +874,7 @@ def data(self): return {"Modifiers": [str(m) for m in self.modifiers]} -class Key(Condition): +class Key(ConditionProtocol): DOWN = "pressed" UP = "released" @@ -914,7 +929,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 @@ -958,7 +973,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 @@ -1000,7 +1015,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 ( @@ -1028,7 +1043,7 @@ def data(self): return {"TestBytes": self.test[:]} -class MouseGesture(Condition): +class MouseGesture(ConditionProtocol): MOVEMENTS = [ "Mouse Up", "Mouse Down", @@ -1083,7 +1098,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: @@ -1104,7 +1119,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: @@ -1124,7 +1139,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: @@ -1145,12 +1160,16 @@ def data(self): return {"Host": self.host} -class Action: - def __init__(self, *args): - pass +@typing.runtime_checkable +class ActionProtocol(typing.Protocol): + def __init__(self, args: Any, warn: bool) -> None: + ... - def evaluate(self, feature, notification: HIDPPNotification, device, last_result): - return None + def evaluate(self, feature, notification: HIDPPNotification, device, last_result) -> None: + ... + + def data(self) -> dict[str, Any]: + ... def keysym_to_keycode(keysym, _modifiers) -> Tuple[int, int]: # maybe should take shift into account @@ -1179,7 +1198,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): @@ -1269,7 +1288,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] @@ -1297,7 +1316,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] @@ -1336,7 +1355,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: @@ -1382,7 +1401,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] @@ -1406,7 +1425,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([]) @@ -1441,7 +1460,7 @@ def data(self): return {"Later": data} -COMPONENTS = { +COMPONENTS: dict[str, Rule | ConditionProtocol | ActionProtocol] = { "Rule": Rule, "Not": Not, "Or": Or, diff --git a/lib/solaar/ui/diversion_rules.py b/lib/solaar/ui/diversion_rules.py index 5151a7129..685207338 100644 --- a/lib/solaar/ui/diversion_rules.py +++ b/lib/solaar/ui/diversion_rules.py @@ -1205,7 +1205,7 @@ def left_label(cls, component): class ActionUI(RuleComponentUI): - CLASS = diversion.Action + CLASS = diversion.ActionProtocol @classmethod def icon_name(cls): diff --git a/lib/solaar/ui/rule_actions.py b/lib/solaar/ui/rule_actions.py index 0a738a678..9c0983314 100644 --- a/lib/solaar/ui/rule_actions.py +++ b/lib/solaar/ui/rule_actions.py @@ -36,7 +36,7 @@ class GtkSignal(Enum): 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 5ef513351..09c437572 100644 --- a/lib/solaar/ui/rule_conditions.py +++ b/lib/solaar/ui/rule_conditions.py @@ -36,7 +36,7 @@ class GtkSignal(Enum): class ConditionUI(RuleComponentUI): - CLASS = diversion.Condition + CLASS = diversion.ConditionProtocol @classmethod def icon_name(cls):