Finalize hooking effect to widgets

Author: tekktrik

displayio_effects/throttle_effect.py

@@ -2,6 +2,7 @@
 # SPDX-FileCopyrightText: Copyright (c) 2022 Alec Delaney for CircuitPython Organization
 #
 # SPDX-License-Identifier: MIT
+# pylint: disable=protected-access
 """
 `displayio_effects.throttle_effect`
 ================================================================================
@@ -33,25 +34,29 @@ def throttle_effect(self):
     """
     return self._throttle_setting
 
+
 @throttle_effect.setter
 def throttle_effect(self, setting):
     if setting < 0:
         raise ValueError("Throttle effect setting must be larger than 0")
     if setting:
-        self._throttle_hold_value = self.value
+        self._throttle_hold_value = getattr(self, self._value_name)
     self._throttle_setting = setting
 
+
 @property
 def throttle_effect_move_rate(self):
     """The speed at which the throttle effect moves the widget vaalue
     per update"""
 
     return self._throttle_move_rate
 
+
 @throttle_effect_move_rate.setter
 def throttle_effect_move_rate(self, rate):
     self._throttle_move_rate = rate
 
+
 def throttle_update(self):
     """Updates the widget value and propagates the throttle effect refresh"""
 
@@ -62,33 +67,54 @@ def throttle_update(self):
     if self._throttle_destination in (None, self._throttle_hold_value):
         limit_bound = self._throttle_setting * 10
         self._throttle_destination = (
-            random.uniform(-limit_bound, limit_bound) / 10
-            + self._throttle_hold_value
+            random.uniform(-limit_bound, limit_bound) / 10 + self._throttle_hold_value
         )
 
-    self.value = (
-        self.value + self._throttle_move_rate
-        if self._throttle_destination > self.value
-        else self.value - self._throttle_move_rate
+    value = getattr(self, self._value_name)
+    value = (
+        value + self._throttle_move_rate
+        if self._throttle_destination > value
+        else value - self._throttle_move_rate
     )
+    setattr(self, self._value_name, value)
 
     threshold_check = (
-        self.value >= self._throttle_destination
+        value >= self._throttle_destination
         if self._throttle_destination >= self._throttle_hold_value
-        else self.value <= self._throttle_destination
+        else value <= self._throttle_destination
     )
     if threshold_check:
         self._throttle_destination = self._throttle_hold_value
 
-def hook_throttle_effect(*widget_classes):
-    for widget_class in widget_classes:
 
-        setattr(widget_class, "_throttle_destination", None)
-        setattr(widget_class, "_throttle_value", 0)
+def hook_throttle_effect(widget_class, value_name):
+    """Adds the throttle effect for the given classes
+
+    :param widget_classes: The widgets that should have this effect hooked
+        into them.
+    :param str value_name: The name of the attribute that sets the "value"
+        for this widget
+
+    For example, to hook this into the ``Dial`` widget, you would use the
+    following code:
+
+    .. code-block:: python
+
+        from displayio_dial import Dial
+        from displayio_effects import throttle_effect
+
+        throttle_effect.hook_throttle_effect(Dial, "value")
+
+    """
+
+    setattr(widget_class, "_value_name", value_name)
+
+    setattr(widget_class, "_throttle_destination", None)
+    setattr(widget_class, "_throttle_value", 0)
 
-        setattr(widget_class, "throttle_effect", throttle_effect)
-        setattr(widget_class, "_throttle_effect", 0)
-        setattr(widget_class, "throttle_effect_move_rate", throttle_effect_move_rate)
-        setattr(widget_class, "_throttle_move_rate", 0.1)
+    setattr(widget_class, "throttle_effect", throttle_effect)
+    setattr(widget_class, "_throttle_effect", 0)
+    setattr(widget_class, "throttle_effect_move_rate", throttle_effect_move_rate)
+    setattr(widget_class, "_throttle_move_rate", 0.1)
 
-        setattr(widget_class, "throttle_update", throttle_update)
+    setattr(widget_class, "throttle_update", throttle_update)