django-admin-background-task 0.4.0__tar.gz → 0.4.1__tar.gz

{django_admin_background_task-0.4.0 → django_admin_background_task-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-admin-background-task
-Version: 0.4.0
+Version: 0.4.1
 Summary: A set of tools for django apps to persist and monitor the status of background tasks
 Home-page: https://github.com/daphtdazz/django-bgtask
 License: Apache-2.0
@@ -58,4 +58,5 @@ urlpatterns = [
 from bgtask.models import BackgroundTask
 
 BackgroundTask.new(name)
+```
 

{django_admin_background_task-0.4.0 → django_admin_background_task-0.4.1}/README.md

@@ -39,3 +39,4 @@ urlpatterns = [
 from bgtask.models import BackgroundTask
 
 BackgroundTask.new(name)
+```

{django_admin_background_task-0.4.0 → django_admin_background_task-0.4.1}/bgtask/models.py

@@ -38,9 +38,11 @@ def locked(meth):
     return _locked_meth
 
 
-def only_if_state(state):
+def only_if_state(state, no_op_states=frozenset()):
     def only_if_state_decorator(meth):
-        def only_if_state_wrapper(self, *args, **kwargs):
+        def only_if_state_wrapper(self, *args, no_op_if_already_in_state=False, **kwargs):
+            if self.state in no_op_states:
+                return
             states = (state,) if isinstance(state, str) else tuple(state)
             if self.state not in states:
                 raise RuntimeError(
@@ -143,6 +145,11 @@ class BackgroundTask(models.Model):
             queued_at__lt=self.queued_at, state=self.STATES.queued
         ).count()
 
+    def set_steps_to_complete(self, steps_to_complete):
+        self.steps_to_complete = steps_to_complete
+        self.steps_completed = 0
+        self.save()
+
     @contextmanager
     def runs_single_step(self):
         try:
@@ -161,6 +168,14 @@ class BackgroundTask(models.Model):
         else:
             self.succeed()
 
+    @contextmanager
+    def fails_if_exception(self):
+        try:
+            yield
+        except Exception as exc:
+            self.fail(exc)
+            raise
+
     @locked
     @only_if_state(STATES.not_started)
     def queue(self):
@@ -170,7 +185,13 @@ class BackgroundTask(models.Model):
         self.save()
 
     @locked
-    @only_if_state((STATES.not_started, STATES.queued))
+    @only_if_state(
+        (STATES.not_started, STATES.queued),
+        # Allow start() to be called while running so that if a task's subtasks are queued and
+        # asynchronous each can call .start() independently so the first one that is executed will
+        # start the task.
+        no_op_states=(STATES.running,),
+    )
     def start(self):
         log.info("Background Task starting: %s", self.id)
         self.state = self.STATES.running

{django_admin_background_task-0.4.0 → django_admin_background_task-0.4.1}/bgtask/tests/test_bgtask.py

@@ -1,7 +1,11 @@
 import pytest
 
+from django.utils import timezone
+
 from bgtask.models import BackgroundTask
 
+pytestmark = pytest.mark.django_db
+
 
 @pytest.fixture
 def a_task():
@@ -30,6 +34,37 @@ def test_bgtask_immediate_failure(a_task):
     assert a_task.state == BackgroundTask.STATES.failed
 
     assert len(a_task.errors) == 1
-    assert a_task.errors[0]["datetime"] == "1970-01-01T00:00:00+00:00"
+    assert a_task.errors[0]["datetime"] == a_task.completed_at.isoformat()
     assert a_task.errors[0]["error_message"] == "Some global failure"
-    assert "test_bgtask_immediate_failure" in a_task.errors[0]["trackeback"]
+    assert "test_bgtask_immediate_failure" in a_task.errors[0]["traceback"]
+
+
+def test_bgtask_start_again(a_task):
+    a_task.start()
+    import time
+    time.sleep(0.001)
+
+    curr_started_at = a_task.started_at
+    assert timezone.now() > curr_started_at
+
+    # Starting again is no-op
+    a_task.start()
+    assert a_task.started_at == curr_started_at
+
+
+def test_fails_if_exception(a_task):
+    a_task.start()
+
+    with pytest.raises(Exception):
+        with a_task.fails_if_exception():
+            raise Exception("fail!")
+
+    assert a_task.state == BackgroundTask.STATES.failed
+
+
+def test_set_steps(a_task):
+    a_task.steps_completed = 10
+    a_task.set_steps_to_complete(20)
+    a_task.refresh_from_db()
+    assert a_task.steps_to_complete == 20
+    assert a_task.steps_completed == 0

{django_admin_background_task-0.4.0 → django_admin_background_task-0.4.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "django-admin-background-task"
-version = "0.4.0"
+version = "0.4.1"
 description = "A set of tools for django apps to persist and monitor the status of background tasks"
 authors = [
     "David Park <david@greenparksoftware.co.uk>",