Background tasks in FastAPI - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a background task in FastAPI?

A background task in FastAPI is a function that runs after returning a response to the client, allowing the server to handle other requests without waiting for the task to finish.

beginner

How do you add a background task to a FastAPI endpoint?

You add a background task by importing BackgroundTasks from fastapi and including it as a parameter in your endpoint function. Then, use background_tasks.add_task(your_function, *args) to schedule the task.

beginner

Why use background tasks instead of running code directly in the endpoint?

Background tasks let the server respond quickly to the client without waiting for long operations, improving user experience and server efficiency.

intermediate

Can background tasks access the request or response objects in FastAPI?

No, background tasks run after the response is sent, so they cannot access the request or response objects directly.

intermediate

What happens if a background task raises an exception in FastAPI?

If a background task raises an exception, it does not affect the response already sent to the client, but the error should be handled or logged to avoid silent failures.

Which FastAPI class is used to schedule background tasks?

A BackgroundTasks

B TaskScheduler

C AsyncTask

D TaskRunner

FastAPI provides the BackgroundTasks class to schedule functions to run after the response is sent.

When do background tasks run in FastAPI?

A At the same time as the response

B Before the response is sent

C After the response is sent

D Only on server startup

Background tasks run after the response is sent to the client, allowing the server to continue processing.

How do you add a background task inside a FastAPI endpoint?

A Call the function directly

B Use background_tasks.add_task(function, args)

C Use await function(args)

D Use threading.Thread

You use background_tasks.add_task to schedule the function to run in the background after the response.

Can background tasks access the HTTP request data after response?

A No, because response is already sent

B Only if passed explicitly

C Yes, always

D Only in synchronous endpoints

Background tasks run after the response is sent, so they cannot access the request or response objects.

What happens if a background task fails with an error?

A The client receives an error response

B The task retries automatically

C The server crashes

D The error is silent unless handled

Errors in background tasks do not affect the client response and must be handled or logged to avoid silent failures.

Explain how to use background tasks in FastAPI and why they are useful.

Think about how to run slow tasks without making the user wait.

Describe the limitations and error handling considerations when using background tasks in FastAPI.

Consider what background tasks cannot do and what happens if they fail.

Practice

1. What is the main purpose of using BackgroundTasks in FastAPI?

easy

A. To handle database connections synchronously

B. To replace the main event loop in FastAPI

C. To block the request until a task finishes

D. To run code after sending the response without delaying the user

Solution

1. Step 1: Understand what BackgroundTasks do

   BackgroundTasks allow running code after the response is sent, so the user is not delayed.

2. Step 2: Compare options with this behavior

   Only To run code after sending the response without delaying the user describes running code after response without delay; others describe blocking or unrelated tasks.

3. Final Answer:

   To run code after sending the response without delaying the user -> Option D

4. Quick Check:

   BackgroundTasks run code after response = B [OK]

Hint: BackgroundTasks run after response to avoid user wait [OK]

Common Mistakes:

• Thinking BackgroundTasks block the response
• Confusing BackgroundTasks with synchronous code
• Assuming BackgroundTasks replace main event loop

2. Which of the following is the correct way to add a background task in a FastAPI endpoint?

easy

A. Import BackgroundTasks but do not use it

B. Call your_function() directly inside the endpoint

C. Use background_tasks.add_task(your_function, arg1, arg2) inside the endpoint

D. Use await your_function() inside the endpoint

Solution

1. Step 1: Recall how to add background tasks in FastAPI

   You add tasks by calling background_tasks.add_task(function, args) inside the endpoint function.

2. Step 2: Check each option

   Use background_tasks.add_task(your_function, arg1, arg2) inside the endpoint correctly uses add_task. Call your_function() directly inside the endpoint calls function immediately, blocking. Use await your_function() inside the endpoint awaits function, blocking. Import BackgroundTasks but do not use it does nothing.

3. Final Answer:

   Use background_tasks.add_task(your_function, arg1, arg2) inside the endpoint -> Option C

4. Quick Check:

   Use add_task to schedule background work = D [OK]

Hint: Use add_task method on BackgroundTasks instance [OK]

Common Mistakes:

• Calling the function directly instead of scheduling
• Awaiting the function which blocks response
• Importing BackgroundTasks but not using it

3. Given this FastAPI code snippet, what will be printed after the response is sent?

from fastapi import FastAPI, BackgroundTasks

app = FastAPI()

def write_log(message: str):
    print(f"Log: {message}")

@app.get("/items/{item_id}")
async def read_item(item_id: int, background_tasks: BackgroundTasks):
    background_tasks.add_task(write_log, f"Item {item_id} accessed")
    return {"item_id": item_id}

medium

A. Log: Item {item_id} accessed is printed after response

B. Log: Item {item_id} accessed is printed before response

C. Nothing is printed because print is not awaited

D. SyntaxError because BackgroundTasks is not imported

Solution

1. Step 1: Understand background task behavior

   The function write_log is scheduled as a background task, so it runs after the response is sent.

2. Step 2: Analyze print timing

   Print inside write_log will execute after response, printing the log message with the item_id value.

3. Final Answer:

   Log: Item {item_id} accessed is printed after response -> Option A

4. Quick Check:

   Background task runs after response = C [OK]

Hint: Background tasks run after response, so print happens later [OK]

Common Mistakes:

• Thinking print runs before response
• Assuming print won't run without await
• Missing import of BackgroundTasks (actually imported here)

4. Identify the error in this FastAPI code using background tasks:

from fastapi import FastAPI, BackgroundTasks

app = FastAPI()

def send_email(email: str):
    print(f"Sending email to {email}")

@app.post("/send")
async def send(background_tasks: BackgroundTasks, email: str):
    background_tasks.add_task(send_email)
    return {"message": "Email scheduled"}

medium

A. Missing argument when adding task to background_tasks

B. BackgroundTasks should not be a parameter

C. send_email should be async

D. Email parameter must be inside the function send_email

Solution

1. Step 1: Check how add_task is called

   The function send_email requires an argument email, but add_task is called without arguments.

2. Step 2: Identify the missing argument

   The call should be background_tasks.add_task(send_email, email) to pass the email parameter.

3. Final Answer:

   Missing argument when adding task to background_tasks -> Option A

4. Quick Check:

   add_task needs function arguments = A [OK]

Hint: Pass all function args in add_task call [OK]

Common Mistakes:

• Forgetting to pass required arguments to add_task
• Thinking BackgroundTasks can't be a parameter
• Assuming send_email must be async

5. You want to log user activity and send a welcome email after a user registers. Which is the best way to do this using FastAPI background tasks?

hard

A. Call logging and email functions directly inside the endpoint synchronously

B. Add two background tasks: one for logging, one for sending email, both added via background_tasks.add_task

C. Use await on both logging and email functions inside the endpoint

D. Run logging in background task but send email synchronously

Solution

1. Step 1: Understand the goal

   We want to run both logging and sending email after response without delaying user.

2. Step 2: Evaluate options

   Add two background tasks: one for logging, one for sending email, both added via background_tasks.add_task schedules both tasks as background tasks, so they run after response. Options B and C block response. Run logging in background task but send email synchronously delays sending email.

3. Final Answer:

   Add two background tasks: one for logging, one for sending email, both added via background_tasks.add_task -> Option B

4. Quick Check:

   Schedule all post-response tasks with add_task = A [OK]

Hint: Add all post-response jobs as background tasks [OK]

Common Mistakes:

• Running tasks synchronously blocking response
• Mixing sync and async incorrectly
• Scheduling only one task in background