fix: allow for custom states in status field (#407)

* fix: allow for custom states in status field

From #366 (comment)

Thanks to @cdevacc1 for the idea. I just decided to write up the PR as
it only takes a couple of minutes. This should resolve the bug where
custom states are not shown at all in the admin panel.

* Add database tests for custom states

From #407 (comment)

Thanks to @AllexVeldman for the tests!

* Add new migrations for custom states

* Fix format lint

Author: ericswpark

django_celery_results/migrations/0014_alter_taskresult_status.py

@@ -0,0 +1,26 @@
+# Generated by Django 5.1.7 on 2025-03-08 06:18
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        (
+            "django_celery_results",
+            "0013_taskresult_django_cele_periodi_1993cf_idx"
+        ),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="taskresult",
+            name="status",
+            field=models.CharField(
+                default="PENDING",
+                help_text="Current state of the task being run",
+                max_length=50,
+                verbose_name="Task State",
+            ),
+        ),
+    ]

django_celery_results/models.py

@@ -51,7 +51,6 @@ class TaskResult(models.Model):
                     'used with the task'))
     status = models.CharField(
         max_length=50, default=states.PENDING,
-        choices=TASK_STATE_CHOICES,
         verbose_name=_('Task State'),
         help_text=_('Current state of the task being run'))
     worker = models.CharField(

t/unit/backends/test_database.py

@@ -955,6 +955,19 @@ def test_backend_result_extended_is_false(self):
         assert tr.task_args is None
         assert tr.task_kwargs is None
 
+    def test_custom_state(self):
+        tid = uuid()
+
+        assert self.b.get_status(tid) == states.PENDING
+
+        self.b.store_result(tid, state="Progress", result={"progress": 10})
+        assert self.b.get_status(tid) == "Progress"
+        assert self.b.get_result(tid) == {"progress": 10}
+
+        self.b.mark_as_done(tid, 42)
+        assert self.b.get_status(tid) == states.SUCCESS
+        assert self.b.get_result(tid) == 42
+
 
 class DjangoCeleryResultRouter:
     route_app_labels = {"django_celery_results"}