return bool from rate limited functions

Author: snopoke

taskbadger/sdk.py

@@ -334,7 +334,7 @@ def increment_progress(self, amount: int):
             DeprecationWarning,
             stacklevel=2,
         )
-        return self.increment_value(amount)
+        self.increment_value(amount)
 
     def increment_value(self, amount: int):
         """Increment the task progress by adding the specified amount to the current value.
@@ -353,14 +353,17 @@ def update_progress(self, value: int, value_step: int = None, rate_limit: int =
         )
         self.update_value(value, value_step, rate_limit)
 
-    def update_value(self, value: int, value_step: int = None, rate_limit: int = None):
+    def update_value(self, value: int, value_step: int = None, rate_limit: int = None) -> bool:
         """Update task progress.
 
         Arguments:
             value: The new value to set.
             value_step: The minimum change in value required to trigger an update.
             rate_limit: The minimum interval between updates in seconds.
 
+        Returns:
+            bool: True if the task was updated, False otherwise
+
         If either `value_step` or `rate_limit` is set, the task will only be updated if the
         specified conditions are met. If both are set, the task will be updated if either
         condition is met.
@@ -370,6 +373,8 @@ def update_value(self, value: int, value_step: int = None, rate_limit: int = Non
         value_check = value_step and self._check_update_value_interval(value, value_step)
         if skip_check or time_check or value_check:
             self.update(value=value)
+            return True
+        return False
 
     def set_value_max(self, value_max: int):
         """Set the `value_max`."""
@@ -424,16 +429,21 @@ def tag(self, tags: dict[str, str]):
         """Add tags to the task."""
         self.update(tags=tags)
 
-    def ping(self, rate_limit=None):
+    def ping(self, rate_limit=None) -> bool:
         """Update the task without changing any values. This can be used in conjunction
         with 'stale_timeout' to indicate that the task is still running.
 
         Arguments:
             rate_limit: The minimum interval between pings in seconds. If set this will only
                 update the task if the last update was more than `rate_limit` seconds ago.
+
+        Returns:
+            bool: True if the task was updated, False otherwise
         """
         if self._check_update_time_interval(rate_limit):
             self.update()
+            return True
+        return False
 
     @property
     def tags(self):

tests/test_sdk.py

@@ -172,18 +172,18 @@ def test_ping(settings, patched_update):
 
     updated_at = task.updated
     patched_update.return_value = Response(HTTPStatus.OK, b"", {}, task_for_test())
-    task.ping(rate_limit=1)
+    assert not task.ping(rate_limit=1)
     assert len(patched_update.call_args_list) == 0
 
-    task.ping()
+    assert task.ping()
     _verify_update(settings, patched_update)
     assert task.updated > updated_at
 
-    task.ping(rate_limit=1)
+    assert not task.ping(rate_limit=1)
     assert len(patched_update.call_args_list) == 1
 
     task._task.updated = task._task.updated - datetime.timedelta(seconds=1)
-    task.ping(rate_limit=1)
+    assert task.ping(rate_limit=1)
     assert len(patched_update.call_args_list) == 2
 
 
@@ -192,18 +192,18 @@ def test_update_progress_rate_limit(settings, patched_update):
 
     updated_at = task.updated
     patched_update.return_value = Response(HTTPStatus.OK, b"", {}, task_for_test())
-    task.update_value(2, rate_limit=1)
+    assert not task.update_value(2, rate_limit=1)
     assert len(patched_update.call_args_list) == 0
 
-    task.update_value(2)
+    assert task.update_value(2)
     _verify_update(settings, patched_update, value=2)
     assert task.updated > updated_at
 
-    task.update_value(3, rate_limit=1)
+    assert not task.update_value(3, rate_limit=1)
     assert len(patched_update.call_args_list) == 1
 
     task._task.updated = task._task.updated - datetime.timedelta(seconds=1)
-    task.update_value(3, rate_limit=1)
+    assert task.update_value(3, rate_limit=1)
     assert len(patched_update.call_args_list) == 2