Task status monitoring in Flask - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is task status monitoring in a Flask application?

Task status monitoring means checking and tracking the progress or result of a background task or job in a Flask app, so users know if it is running, completed, or failed.

beginner

Which Flask extension is commonly used for running and monitoring background tasks?

Celery is a popular tool used to run background tasks asynchronously and monitor their status in Flask applications.

intermediate

How can you check the status of a Celery task in Flask?

You can check the status by calling the task's AsyncResult object and using its status property, like task_result.status, which returns states like PENDING, STARTED, SUCCESS, or FAILURE.

beginner

What does the status 'PENDING' mean for a background task?

It means the task has been received but has not started running yet.

beginner

Why is task status monitoring important in web applications?

It improves user experience by informing users about progress, prevents confusion, and helps developers debug or handle errors in background jobs.

Which Flask extension helps run background tasks asynchronously?

A Celery

B Flask-SQLAlchemy

C Flask-WTF

D Flask-Login

Celery is designed for running and monitoring background tasks asynchronously in Flask.

What does the 'SUCCESS' status indicate for a background task?

A Task is waiting to start

B Task is currently running

C Task completed successfully

D Task failed

SUCCESS means the task finished without errors.

How do you get the status of a Celery task in Flask?

A Call task.run() again

B Check task_result.status

C Use Flask's request object

D Check Flask app config

The AsyncResult object has a status property that shows the task's current state.

Why should users see task status updates?

A To hide errors

B To confuse them

C To slow down the app

D To improve user experience

Showing task status keeps users informed and improves their experience.

What does the 'FAILURE' status mean for a task?

A Task encountered an error

B Task completed successfully

C Task is running

D Task is pending

FAILURE means the task did not complete due to an error.

Explain how you would implement task status monitoring in a Flask app using Celery.

Think about how to start a task and then check its progress.

Why is it important to show task status to users in web applications?

Consider what happens if users don’t know if a task is done.

Practice

1. What is the main purpose of task status monitoring in a Flask application?

easy

A. To store user login credentials securely

B. To speed up the Flask server response time

C. To let users see the progress of background jobs

D. To automatically restart the Flask app on errors

Solution

1. Step 1: Understand task status monitoring

   Task status monitoring is about showing users how background jobs are progressing.

2. Step 2: Identify the correct purpose

   Among the options, only letting users see job progress matches the purpose.

3. Final Answer:

   To let users see the progress of background jobs -> Option C

4. Quick Check:

   Task status monitoring = show job progress [OK]

Hint: Task status monitoring shows job progress to users [OK]

Common Mistakes:

• Confusing task monitoring with server speed optimization
• Thinking it manages user authentication
• Assuming it restarts the app automatically

2. Which Flask route method is best to check the status of a running background task?

easy

A. POST

B. GET

C. DELETE

D. PUT

Solution

1. Step 1: Understand HTTP methods for status checking

   GET is used to retrieve information without changing server state.

2. Step 2: Match method to task status check

   Checking task status is a read operation, so GET is appropriate.

3. Final Answer:

   GET -> Option B

4. Quick Check:

   Check status = GET request [OK]

Hint: Use GET to fetch status without changing data [OK]

Common Mistakes:

• Using POST which changes data
• Choosing DELETE which removes data
• Using PUT which updates data

3. Given this Flask code snippet, what will be the output when accessing /status/task1 if tasks = {'task1': 'running'}?

from flask import Flask, jsonify
app = Flask(__name__)
tasks = {'task1': 'running'}

@app.route('/status/<task_id>')
def status(task_id):
    state = tasks.get(task_id, 'not found')
    return jsonify({'task': task_id, 'status': state})

medium

A. {"task": "task1", "status": "running"}

B. {"task": "task1", "status": "not found"}

C. 404 Not Found error

D. SyntaxError

Solution

1. Step 1: Check the tasks dictionary for 'task1'

   The dictionary has 'task1' with value 'running'.

2. Step 2: Understand the route function output

   The function returns JSON with task id and its status from the dictionary.

3. Final Answer:

   {"task": "task1", "status": "running"} -> Option A

4. Quick Check:

   tasks['task1'] = running [OK]

Hint: Check dictionary key presence for status [OK]

Common Mistakes:

• Assuming missing key returns error instead of default
• Confusing JSON string with Python dict
• Expecting 404 error without explicit handling

4. Identify the error in this Flask route for checking task status:

@app.route('/status/<task_id>')
def status(task_id):
    state = tasks[task_id]
    return {'task': task_id, 'status': state}

medium

A. Using tasks[task_id] without checking if key exists

B. Returning a dictionary instead of JSON response

C. Missing @app.route decorator

D. Incorrect route URL syntax

Solution

1. Step 1: Analyze dictionary access

   Accessing tasks[task_id] without checking key causes KeyError if missing.

2. Step 2: Confirm other parts are correct

   Returning dict is allowed by Flask; decorator and route syntax are correct.

3. Final Answer:

   Using tasks[task_id] without checking if key exists -> Option A

4. Quick Check:

   Direct dict access risks KeyError [OK]

Hint: Always check dict keys before access to avoid errors [OK]

Common Mistakes:

• Thinking returning dict is wrong in Flask
• Ignoring possible KeyError on missing keys
• Assuming route decorator is missing

5. You want to monitor multiple background tasks in Flask and update their status safely. Which approach is best to store and update task states?

hard

A. Store task states only in local variables inside routes

B. Store task states in a file without synchronization

C. Use print statements to track task progress in console

D. Use a global dictionary with thread locks to store task states

Solution

1. Step 1: Consider concurrency in Flask background tasks

   Multiple tasks may update states concurrently, so thread safety is needed.

2. Step 2: Evaluate storage options

   Global dictionary with thread locks ensures safe updates; local vars or files without sync cause errors.

3. Final Answer:

   Use a global dictionary with thread locks to store task states -> Option D

4. Quick Check:

   Safe shared state needs locks [OK]

Hint: Use locks with shared dict for safe task status updates [OK]

Common Mistakes:

• Using local variables which don't persist
• Ignoring thread safety causing race conditions
• Relying on print statements for monitoring