Task results and status in Django - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of task results in Django when using asynchronous task queues?

Task results store the output or status of a background task so you can check if it finished, failed, or is still running.

beginner

Which Django-compatible library is commonly used to manage task results and status?

Celery is a popular library used with Django to run background tasks and track their results and status.

intermediate

How can you check if a Celery task has finished in Django?

You can use the AsyncResult object and call its ready() method to see if the task is done.

intermediate

What does the state attribute of a Celery task result represent?

The state shows the current status of the task, such as PENDING, STARTED, SUCCESS, or FAILURE.

beginner

Why is it important to store task results in a backend like Redis or a database?

Storing results lets you retrieve the output later, check if tasks succeeded, and handle errors or retries properly.

In Django with Celery, which method checks if a task has completed?

A run()

B start()

C execute()

D ready()

The ready() method on AsyncResult returns True if the task finished.

What does the SUCCESS state mean for a task result?

A Task is still running

B Task completed without errors

C Task failed

D Task was never started

The SUCCESS state means the task finished correctly.

Which backend is commonly used to store Celery task results?

A Local file system

B SQLite

C Redis

D HTML

Redis is a fast in-memory store often used for task results.

What does the PENDING state indicate in a task result?

A Task is waiting to start or unknown

B Task finished successfully

C Task failed

D Task was revoked

PENDING means the task has not started or the status is unknown.

How do you get the actual output of a finished Celery task in Django?

A Call <code>get()</code> on AsyncResult

B Call <code>start()</code> on AsyncResult

C Call <code>stop()</code> on AsyncResult

D Call <code>run()</code> on AsyncResult

The get() method returns the task's result once it is ready.

Explain how Django with Celery manages task results and status tracking.

Think about how you check if a background job finished and get its output.

Describe why storing task results is important in a Django application using background tasks.

Imagine you asked a friend to do a job and want to know if they finished and what they found.

Practice

1. In Django with Celery, which object do you use to check the status and result of a background task by its ID?

easy

A. AsyncResult

B. TaskStatus

C. TaskResult

D. ResultChecker

Solution

1. Step 1: Identify the object for task tracking

   Celery provides AsyncResult to track task status and results using the task ID.

2. Step 2: Confirm usage in Django context

   In Django projects using Celery, AsyncResult is the standard way to check if a task is pending, running, or finished.

3. Final Answer:

   AsyncResult -> Option A

4. Quick Check:

   Task status and results = AsyncResult [OK]

Hint: Remember: AsyncResult tracks task status by ID [OK]

Common Mistakes:

• Confusing AsyncResult with task function names
• Using non-existent classes like TaskStatus
• Trying to access results directly without AsyncResult

2. Which of the following is the correct way to create an AsyncResult instance for a task with ID stored in task_id?

easy

A. result = AsyncResult(task=task_id)

B. result = AsyncResult.get(task_id)

C. result = AsyncResult.fetch(task_id)

D. result = AsyncResult(task_id)

Solution

1. Step 1: Recall AsyncResult constructor usage

   The AsyncResult class is instantiated by passing the task ID as the first argument.

2. Step 2: Check each option's syntax

   Only AsyncResult(task_id) correctly creates the instance. Methods like .get() or .fetch() are not constructors.

3. Final Answer:

   result = AsyncResult(task_id) -> Option D

4. Quick Check:

   Instantiate AsyncResult with task ID directly [OK]

Hint: Use AsyncResult(task_id) to create result object [OK]

Common Mistakes:

• Calling get() or fetch() as constructor
• Passing keyword argument 'task' instead of positional
• Confusing AsyncResult with task function calls

3. Given the code:

result = AsyncResult('abc123')
status = result.status
output = result.result

What will status and output represent if the task is still running?

medium

A. status is 'PENDING', output is None

B. status is 'RUNNING', output is None

C. status is 'FAILURE', output is the error info

D. status is 'SUCCESS', output is the task result

Solution

1. Step 1: Understand AsyncResult status values

   By default, while a task is running without calling update_state inside the task, result.status remains 'PENDING'.

2. Step 2: Check result property during running

   result.result returns None until the task completes.

3. Final Answer:

   status is 'PENDING', output is None -> Option A

4. Quick Check:

   Running task (default): status='PENDING', result=None [OK]

Hint: Default running tasks show status 'PENDING' and result None [OK]

Common Mistakes:

• Mistaking for 'RUNNING' status (doesn't exist)
• Confusing with 'STARTED' which requires explicit update_state
• Thinking result is available before completion

4. You wrote:

result = AsyncResult(task_id)
if result.status == 'SUCCESS':
    print(result.result)
else:
    print('Task not done')

But it always prints 'Task not done' even after task completion. What is the likely issue?

medium

A. You must call result.get() instead of accessing result.result

B. You should check for 'COMPLETED' instead of 'SUCCESS'

C. The task ID is incorrect or expired

D. AsyncResult does not have a status attribute

Solution

1. Step 1: Understand status checking logic

   The code checks if result.status equals 'SUCCESS' to print the result.

2. Step 2: Identify why status never shows 'SUCCESS'

   If the task ID is wrong or expired, AsyncResult will not find the task and status stays 'PENDING' or similar.

3. Final Answer:

   The task ID is incorrect or expired -> Option C

4. Quick Check:

   Wrong task ID causes status never to be 'SUCCESS' [OK]

Hint: Check task ID validity if status never changes [OK]

Common Mistakes:

• Using wrong status string like 'COMPLETED'
• Assuming result.result always updates without completion
• Ignoring task ID correctness

5. You want to handle a task result in Django only if it succeeded, otherwise log the error. Which code snippet correctly checks the task status and safely accesses the result or error?

hard

A. result = AsyncResult(task_id)
if result.ready():
handle(result.result)
else:
log_error('Task not ready')

B. result = AsyncResult(task_id)
try:
handle(result.get(timeout=1))
except Exception as e:
log_error(e)

C. result = AsyncResult(task_id)
if result.status == 'PENDING':
handle(result.result)
else:
log_error('Task failed')

D. result = AsyncResult(task_id)
if result.status == 'SUCCESS':
handle(result.result)
elif result.status == 'FAILURE':
log_error(result.get())

Solution

1. Step 1: Understand safe result retrieval

   Using result.get() with a timeout waits for completion and raises exceptions on failure.

2. Step 2: Check error handling approach

   Wrapping result.get() in try-except catches task failures and allows logging errors safely.

3. Step 3: Compare other options

   Options B, C, and D do not handle exceptions properly; C incorrectly treats 'PENDING' as success.

4. Final Answer:

   Use try-except with result.get() to handle success and failure -> Option B

5. Quick Check:

   Use result.get() with try-except for safe task result handling [OK]

Hint: Use try-except with result.get() to catch errors [OK]

Common Mistakes:

• Checking only status strings without exception handling
• Assuming ready() means success
• Treating PENDING as success