deprecate 'increment_progress' and 'update_progress'

Author: snopoke

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "taskbadger"
-version = "1.6.0"
+version = "1.6.1"
 description = "The official Python SDK for Task Badger"
 requires-python = ">=3.9"
 authors = []

taskbadger/sdk.py

@@ -1,6 +1,7 @@
 import datetime
 import logging
 import os
+import warnings
 from typing import Any
 
 from taskbadger.exceptions import (
@@ -328,6 +329,14 @@ def update_status(self, status: StatusEnum):
         self.update(status=status)
 
     def increment_progress(self, amount: int):
+        warnings.warn(
+            "'task.increment_progress' will be removed in v1.7.0. Use 'task.increment_value' instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.increment_value(amount)
+
+    def increment_value(self, amount: int):
         """Increment the task progress by adding the specified amount to the current value.
         If the task value is not set it will be set to `amount`.
         """
@@ -337,6 +346,14 @@ def increment_progress(self, amount: int):
         self.update(value=new_amount)
 
     def update_progress(self, value: int, value_step: int = None, rate_limit: int = None):
+        warnings.warn(
+            "'task.update_progress' will be removed in v1.7.0. Use 'task.update_value' instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        self.update_value(value, value_step, rate_limit)
+
+    def update_value(self, value: int, value_step: int = None, rate_limit: int = None):
         """Update task progress.
 
         Arguments:

tests/test_sdk.py

@@ -154,6 +154,19 @@ def test_update_data(settings, patched_update):
     _verify_update(settings, patched_update, data={"a": 1})
 
 
+def test_increment_value(settings, patched_update):
+    api_task = task_for_test()
+    task = Task(api_task)
+
+    patched_update.return_value = Response(HTTPStatus.OK, b"", {}, task_for_test(value=10))
+
+    task.increment_value(10)
+    _verify_update(settings, patched_update, value=10)
+
+    task.increment_value(5)
+    _verify_update(settings, patched_update, value=15)
+
+
 def test_ping(settings, patched_update):
     task = Task(task_for_test())
 
@@ -179,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_progress(2, rate_limit=1)
+    task.update_value(2, rate_limit=1)
     assert len(patched_update.call_args_list) == 0
 
-    task.update_progress(2)
+    task.update_value(2)
     _verify_update(settings, patched_update, value=2)
     assert task.updated > updated_at
 
-    task.update_progress(3, rate_limit=1)
+    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_progress(3, rate_limit=1)
+    task.update_value(3, rate_limit=1)
     assert len(patched_update.call_args_list) == 2