mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-06-05 03:29:12 +00:00
Code Issues 32 Releases Wiki Activity

Rename "Complete" tasks to "Succeeded"

Browse Source 
"Complete" could imply it completed unsuccessfully
This commit is contained in:
Jake Howard 2024-11-21 13:31:29 +00:00
parent 5aa5ca95cd
commit a418a8d6e9
No known key found for this signature in database
GPG Key ID: 57AFB45680EDD477
6 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
django/tasks/backends/immediate.py
View File

@ -57,7 +57,7 @@ class ImmediateBackend(BaseTaskBackend):
task_finished.send(type(self), task_result=task_result) task_finished.send(type(self), task_result=task_result)
else: else:
object.__setattr__(task_result, "finished_at", timezone.now()) object.__setattr__(task_result, "finished_at", timezone.now())
object.__setattr__(task_result, "status", ResultStatus.COMPLETE) object.__setattr__(task_result, "status", ResultStatus.SUCCEEDED)
task_finished.send(type(self), task_result=task_result) task_finished.send(type(self), task_result=task_result)

6
django/tasks/task.py
View File

@ -32,7 +32,7 @@ class ResultStatus(TextChoices):
NEW = ("NEW", _("New")) NEW = ("NEW", _("New"))
RUNNING = ("RUNNING", _("Running")) RUNNING = ("RUNNING", _("Running"))
FAILED = ("FAILED", _("Failed")) FAILED = ("FAILED", _("Failed"))
COMPLETE = ("COMPLETE", _("Complete")) SUCCEEDED = ("SUCCEEDED", _("Succeeded"))
@dataclass(frozen=True) @dataclass(frozen=True)
@ -237,13 +237,13 @@ class TaskResult:
""" """
Get the return value of the task. Get the return value of the task.
If the task didn't complete successfully, an exception is raised. If the task didn't succeed, an exception is raised.
This is to distinguish against the task returning None. This is to distinguish against the task returning None.
""" """
if self.status == ResultStatus.FAILED: if self.status == ResultStatus.FAILED:
raise ValueError("Task failed") raise ValueError("Task failed")
elif self.status != ResultStatus.COMPLETE: elif self.status != ResultStatus.SUCCEEDED:
raise ValueError("Task has not finished yet") raise ValueError("Task has not finished yet")
return self._return_value return self._return_value

4
docs/ref/tasks.txt
View File

@ -136,7 +136,7 @@ Task results
The :class:`Task` raised an exception during execution, or was unable The :class:`Task` raised an exception during execution, or was unable
to start. to start.
.. attribute:: ResultStatus.COMPLETE .. attribute:: ResultStatus.SUCCEEDED
The :class:`Task` has finished executing successfully. The :class:`Task` has finished executing successfully.
@ -175,7 +175,7 @@ Attributes of ``TaskResult`` cannot be modified.
.. attribute:: TaskResult.finished_at .. attribute:: TaskResult.finished_at
The time when the task finished execution, whether it failed or completed. The time when the task finished execution, whether it failed or succeeded.
.. attribute:: TaskResult.backend .. attribute:: TaskResult.backend

4
docs/topics/tasks.txt
View File

@ -307,7 +307,7 @@ To refresh the values, call the :meth:`django.tasks.TaskResult.refresh` method::
result.refresh() # or await result.arefresh() result.refresh() # or await result.arefresh()
result.status # COMPLETE result.status # SUCCEEDED
Return values Return values
------------- -------------
@ -322,7 +322,7 @@ If the task has not finished executing, or has failed, :exc:`ValueError` is rais
Exceptions Exceptions
---------- ----------
If the task doesn't complete successfully, and instead raises an exception, either If the task doesn't succeed, and instead raises an exception, either
as part of the task or as part of running it, the exception instance is saved as part of the task or as part of running it, the exception instance is saved
to the :attr:`django.tasks.TaskResult.exception` attribute:: to the :attr:`django.tasks.TaskResult.exception` attribute::

8
tests/tasks/test_dummy_backend.py
View File

@ -78,11 +78,11 @@ class DummyBackendTestCase(SimpleTestCase):
) )
enqueued_result = default_task_backend.results[0] enqueued_result = default_task_backend.results[0]
object.__setattr__(enqueued_result, "status", ResultStatus.COMPLETE) object.__setattr__(enqueued_result, "status", ResultStatus.SUCCEEDED)
self.assertEqual(result.status, ResultStatus.NEW) self.assertEqual(result.status, ResultStatus.NEW)
result.refresh() result.refresh()
self.assertEqual(result.status, ResultStatus.COMPLETE) self.assertEqual(result.status, ResultStatus.SUCCEEDED)
async def test_refresh_result_async(self): async def test_refresh_result_async(self):
result = await default_task_backend.aenqueue( result = await default_task_backend.aenqueue(
@ -90,11 +90,11 @@ class DummyBackendTestCase(SimpleTestCase):
) )
enqueued_result = default_task_backend.results[0] enqueued_result = default_task_backend.results[0]
object.__setattr__(enqueued_result, "status", ResultStatus.COMPLETE) object.__setattr__(enqueued_result, "status", ResultStatus.SUCCEEDED)
self.assertEqual(result.status, ResultStatus.NEW) self.assertEqual(result.status, ResultStatus.NEW)
await result.arefresh() await result.arefresh()
self.assertEqual(result.status, ResultStatus.COMPLETE) self.assertEqual(result.status, ResultStatus.SUCCEEDED)
async def test_get_missing_result(self): async def test_get_missing_result(self):
with self.assertRaises(ResultDoesNotExist): with self.assertRaises(ResultDoesNotExist):

18
tests/tasks/test_immediate_backend.py
View File

@ -29,7 +29,7 @@ class ImmediateBackendTestCase(SimpleTestCase):
with self.subTest(task): with self.subTest(task):
result = cast(Task, task).enqueue(1, two=3) result = cast(Task, task).enqueue(1, two=3)
self.assertEqual(result.status, ResultStatus.COMPLETE) self.assertEqual(result.status, ResultStatus.SUCCEEDED)
self.assertIsNotNone(result.started_at) self.assertIsNotNone(result.started_at)
self.assertIsNotNone(result.finished_at) self.assertIsNotNone(result.finished_at)
self.assertGreaterEqual(result.started_at, result.enqueued_at) self.assertGreaterEqual(result.started_at, result.enqueued_at)
@ -44,7 +44,7 @@ class ImmediateBackendTestCase(SimpleTestCase):
with self.subTest(task): with self.subTest(task):
result = await cast(Task, task).aenqueue() result = await cast(Task, task).aenqueue()
self.assertEqual(result.status, ResultStatus.COMPLETE) self.assertEqual(result.status, ResultStatus.SUCCEEDED)
self.assertIsNotNone(result.started_at) self.assertIsNotNone(result.started_at)
self.assertIsNotNone(result.finished_at) self.assertIsNotNone(result.finished_at)
self.assertGreaterEqual(result.started_at, result.enqueued_at) self.assertGreaterEqual(result.started_at, result.enqueued_at)
@ -125,7 +125,7 @@ class ImmediateBackendTestCase(SimpleTestCase):
test_tasks.calculate_meaning_of_life, [], {} test_tasks.calculate_meaning_of_life, [], {}
) )
self.assertEqual(result.status, ResultStatus.COMPLETE) self.assertEqual(result.status, ResultStatus.SUCCEEDED)
self.assertEqual(result.return_value, 42) self.assertEqual(result.return_value, 42)
async def test_result_async(self): async def test_result_async(self):
@ -133,7 +133,7 @@ class ImmediateBackendTestCase(SimpleTestCase):
test_tasks.calculate_meaning_of_life, [], {} test_tasks.calculate_meaning_of_life, [], {}
) )
self.assertEqual(result.status, ResultStatus.COMPLETE) self.assertEqual(result.status, ResultStatus.SUCCEEDED)
self.assertEqual(result.return_value, 42) self.assertEqual(result.return_value, 42)
async def test_cannot_get_result(self): async def test_cannot_get_result(self):
@ -213,7 +213,7 @@ class ImmediateBackendTransactionTestCase(TransactionTestCase):
self.assertIsNone(result.enqueued_at) self.assertIsNone(result.enqueued_at)
self.assertEqual(result.status, ResultStatus.NEW) self.assertEqual(result.status, ResultStatus.NEW)
self.assertEqual(result.status, ResultStatus.COMPLETE) self.assertEqual(result.status, ResultStatus.SUCCEEDED)
self.assertIsNotNone(result.enqueued_at) self.assertIsNotNone(result.enqueued_at)
@override_settings( @override_settings(
@ -235,9 +235,9 @@ class ImmediateBackendTransactionTestCase(TransactionTestCase):
self.assertIsNotNone(result.enqueued_at) self.assertIsNotNone(result.enqueued_at)
self.assertEqual(result.status, ResultStatus.COMPLETE) self.assertEqual(result.status, ResultStatus.SUCCEEDED)
self.assertEqual(result.status, ResultStatus.COMPLETE) self.assertEqual(result.status, ResultStatus.SUCCEEDED)
@override_settings( @override_settings(
TASKS={ TASKS={
@ -258,7 +258,7 @@ class ImmediateBackendTransactionTestCase(TransactionTestCase):
self.assertIsNone(result.enqueued_at) self.assertIsNone(result.enqueued_at)
self.assertEqual(result.status, ResultStatus.NEW) self.assertEqual(result.status, ResultStatus.NEW)
self.assertEqual(result.status, ResultStatus.COMPLETE) self.assertEqual(result.status, ResultStatus.SUCCEEDED)
@override_settings( @override_settings(
TASKS={ TASKS={
@ -283,4 +283,4 @@ class ImmediateBackendTransactionTestCase(TransactionTestCase):
self.assertIsNone(result.enqueued_at) self.assertIsNone(result.enqueued_at)
self.assertEqual(result.status, ResultStatus.NEW) self.assertEqual(result.status, ResultStatus.NEW)
self.assertEqual(result.status, ResultStatus.COMPLETE) self.assertEqual(result.status, ResultStatus.SUCCEEDED)