Skip to content

Remove deprecated update_progress / increment_progress #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
snopoke merged 1 commit into from
May 5, 2026
Merged

Remove deprecated update_progress / increment_progress #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions taskbadger/sdk.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,14 +367,6 @@ def update_status(self, status: StatusEnum):
"""Update the task status"""
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,
)
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`.
Expand All @@ -384,14 +376,6 @@ def increment_value(self, amount: int):
new_amount = value_norm + amount
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) -> bool:
"""Update task progress.

Expand Down
35 changes: 11 additions & 24 deletions tests/test_sdk.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ def test_ping(settings, patched_update):
assert len(patched_update.call_args_list) == 2


def test_update_progress_rate_limit(settings, patched_update):
def test_update_value_rate_limit(settings, patched_update):
task = Task(task_for_test(value=1))

updated_at = task.updated
Expand All @@ -210,58 +210,45 @@ def test_update_progress_rate_limit(settings, patched_update):
assert len(patched_update.call_args_list) == 2


def test_update_progress_value_step(settings, patched_update):
def test_update_value_value_step(settings, patched_update):
task = Task(task_for_test(value=1))

patched_update.return_value = Response(HTTPStatus.OK, b"", {}, task_for_test(value=4))
task.update_progress(4, value_step=5)
task.update_value(4, value_step=5)
assert len(patched_update.call_args_list) == 0

task.update_progress(4)
task.update_value(4)
_verify_update(settings, patched_update, value=4)

task.update_progress(8, value_step=5)
task.update_value(8, value_step=5)
assert len(patched_update.call_args_list) == 1

task.update_progress(9, value_step=5)
task.update_value(9, value_step=5)
assert len(patched_update.call_args_list) == 2


def test_update_progress_min_interval_both(settings, patched_update):
def test_update_value_min_interval_both(settings, patched_update):
task = Task(task_for_test(value=1))

patched_update.return_value = Response(HTTPStatus.OK, b"", {}, task_for_test(value=4))
# neither checks pass
task.update_progress(4, rate_limit=1, value_step=5)
task.update_value(4, rate_limit=1, value_step=5)
assert len(patched_update.call_args_list) == 0

# value check passes
task.update_progress(6, rate_limit=1, value_step=5)
task.update_value(6, rate_limit=1, value_step=5)
_verify_update(settings, patched_update, value=6)

# neither checks pass
task.update_progress(8, rate_limit=1, value_step=5)
task.update_value(8, rate_limit=1, value_step=5)
assert len(patched_update.call_args_list) == 1

# time check passes
task._task.updated = task._task.updated - datetime.timedelta(seconds=1)
task.update_progress(6, rate_limit=1, value_step=5)
task.update_value(6, rate_limit=1, value_step=5)
assert len(patched_update.call_args_list) == 2


def test_increment_progress(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_progress(10)
_verify_update(settings, patched_update, value=10)

task.increment_progress(10)
_verify_update(settings, patched_update, value=20)


def test_update_timeouts(settings, patched_update):
api_task = task_for_test()
task = Task(api_task)
Expand Down
Loading