Background file processing in FastAPI

Introduction

Background file processing lets your app handle big or slow tasks without making users wait. It runs tasks behind the scenes while your app stays fast and responsive.

Uploading large files that need extra work like resizing or scanning

Processing files after a user submits a form without blocking the response

Running virus scans or validations on uploaded files without delay

Generating reports or thumbnails from uploaded files after saving

Any time you want to keep the app quick while doing slow file tasks

Syntax

FastAPI

from fastapi import FastAPI, BackgroundTasks, UploadFile

app = FastAPI()

def process_file(file_path: str):
    # Your file processing logic here
    pass

@app.post("/upload")
async def upload_file(background_tasks: BackgroundTasks, file: UploadFile):
    file_location = f"files/{file.filename}"
    with open(file_location, "wb") as f:
        f.write(await file.read())
    background_tasks.add_task(process_file, file_location)
    return {"message": "File uploaded and processing started"}

Use BackgroundTasks to add tasks that run after the response is sent.

File processing functions should be normal functions, not async, to avoid blocking.

Examples

A simple background task that prints the file path.

FastAPI

def process_file(file_path: str):
    print(f"Processing {file_path}")

Adds the process_file function to run in the background with the file path argument.

FastAPI

background_tasks.add_task(process_file, "files/myfile.txt")

Uploads a file, saves it, and starts background processing without waiting.

FastAPI

@app.post("/upload")
async def upload(background_tasks: BackgroundTasks, file: UploadFile):
    file_location = f"files/{file.filename}"
    with open(file_location, "wb") as f:
        f.write(await file.read())
    background_tasks.add_task(process_file, file_location)
    return {"message": "Upload successful"}

Sample Program

This FastAPI app uploads a file, saves it, and then processes it in the background. The user gets an immediate response while the file is processed behind the scenes.

FastAPI

from fastapi import FastAPI, BackgroundTasks, UploadFile
import time

app = FastAPI()

def process_file(file_path: str):
    # Simulate a slow file processing task
    print(f"Start processing {file_path}")
    time.sleep(3)  # pretend to do work
    print(f"Finished processing {file_path}")

@app.post("/upload")
async def upload(background_tasks: BackgroundTasks, file: UploadFile):
    file_location = f"files/{file.filename}"
    with open(file_location, "wb") as f:
        f.write(await file.read())
    background_tasks.add_task(process_file, file_location)
    return {"message": "File uploaded and processing started"}

Important Notes

Background tasks run after the response is sent, so users don't wait.

Make sure the file saving happens before starting background processing.

Background tasks are good for small to medium jobs; for heavy jobs consider task queues like Celery.

Summary

Background file processing keeps your app fast by running slow tasks after response.

Use FastAPI's BackgroundTasks to add these tasks easily.

Always save files first, then start background processing.

Practice

1. What is the main benefit of using BackgroundTasks in FastAPI for file processing?

easy

A. It allows slow tasks to run after sending the response, keeping the app fast.

B. It automatically compresses files before saving.

C. It blocks the request until the file is fully processed.

D. It encrypts files during upload.

Solution

1. Step 1: Understand the role of BackgroundTasks

   BackgroundTasks in FastAPI lets you run tasks after the response is sent, so the user doesn't wait.

2. Step 2: Identify the benefit for file processing

   Running slow file processing in the background keeps the app responsive and fast for users.

3. Final Answer:

   It allows slow tasks to run after sending the response, keeping the app fast. -> Option A

4. Quick Check:

   BackgroundTasks = run slow tasks after response [OK]

Hint: BackgroundTasks run after response to keep app fast [OK]

Common Mistakes:

• Thinking BackgroundTasks block the response
• Assuming BackgroundTasks handle file encryption
• Believing BackgroundTasks compress files automatically

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

easy

A. def upload(file: UploadFile, background_tasks: BackgroundTasks): process_file(file)

B. def upload(file: UploadFile): process_file(file) background_tasks.add_task()

C. def upload(file: UploadFile): background_tasks = BackgroundTasks() process_file(file)

D. def upload(file: UploadFile, background_tasks: BackgroundTasks): background_tasks.add_task(process_file, file)

Solution

1. Step 1: Check function parameters

   To use BackgroundTasks, it must be a parameter in the endpoint function.

2. Step 2: Add the task correctly

   Use background_tasks.add_task(function, args) to schedule the task after response.

3. Final Answer:

   def upload(file: UploadFile, background_tasks: BackgroundTasks): background_tasks.add_task(process_file, file) -> Option D

4. Quick Check:

   Use add_task with BackgroundTasks parameter [OK]

Hint: Add tasks using background_tasks.add_task inside endpoint [OK]

Common Mistakes:

• Calling process_file directly inside endpoint
• Not including BackgroundTasks as a parameter
• Creating BackgroundTasks inside the function without adding tasks

3. Given this FastAPI code snippet, what will be the response behavior when a file is uploaded?

from fastapi import FastAPI, UploadFile, BackgroundTasks
app = FastAPI()

def save_file(file: UploadFile):
    with open(f"saved_{file.filename}", "wb") as f:
        f.write(file.file.read())

@app.post("/upload")
async def upload(file: UploadFile, background_tasks: BackgroundTasks):
    background_tasks.add_task(save_file, file)
    return {"message": "File upload started"}

medium

A. The response returns immediately with message, while file saving happens in background.

B. The response waits until the file is saved, then returns the message.

C. The file is saved before the response, but no message is returned.

D. The code will raise an error because file.file.read() is not allowed.

Solution

1. Step 1: Analyze background task usage

   The save_file function is added as a background task, so it runs after response.

2. Step 2: Understand response timing

   The endpoint returns the message immediately, without waiting for save_file to finish.

3. Final Answer:

   The response returns immediately with message, while file saving happens in background. -> Option A

4. Quick Check:

   BackgroundTasks run after response = immediate reply [OK]

Hint: BackgroundTasks run after response, so response is immediate [OK]

Common Mistakes:

• Assuming file saving blocks response
• Thinking file.file.read() causes error here
• Believing no message is returned

4. Identify the error in this FastAPI endpoint for background file processing:

from fastapi import FastAPI, UploadFile, BackgroundTasks
app = FastAPI()

def process_file(file: UploadFile):
    content = file.file.read()
    with open(f"processed_{file.filename}", "wb") as f:
        f.write(content)

@app.post("/upload")
async def upload(file: UploadFile, background_tasks: BackgroundTasks):
    background_tasks.add_task(process_file, file.file.read())
    return {"message": "Processing started"}

medium

A. Missing await keyword before background_tasks.add_task call.

B. Passing file.file.read() instead of file causes the file to be read too early.

C. process_file should be async but is defined as sync.

D. File is not saved before background task starts.

Solution

1. Step 1: Check argument passed to add_task

   The code passes file.file.read() which reads the file immediately, not the file object.

2. Step 2: Understand why this is a problem

   Reading the file before background task means the task gets raw bytes, not the file to read later, causing errors or empty data.

3. Final Answer:

   Passing file.file.read() instead of file causes the file to be read too early. -> Option B

4. Quick Check:

   Pass file object, not file.file.read() to background task [OK]

Hint: Pass file object, not file.file.read(), to background task [OK]

Common Mistakes:

• Thinking add_task needs await
• Believing process_file must be async
• Ignoring file saving order

5. You want to save an uploaded file immediately and then process it in the background. Which FastAPI code snippet correctly implements this pattern?

hard

A. async def upload(file: UploadFile, background_tasks: BackgroundTasks):
background_tasks.add_task(process_file, file)
return {"message": "Processing started"}

B. async def upload(file: UploadFile):
contents = await file.read()
with open(f"saved_{file.filename}", "wb") as f:
f.write(contents)
process_file(f"saved_{file.filename}")
return {"message": "File saved and processed"}

C. async def upload(file: UploadFile, background_tasks: BackgroundTasks):
contents = await file.read()
with open(f"saved_{file.filename}", "wb") as f:
f.write(contents)
background_tasks.add_task(process_file, f"saved_{file.filename}")
return {"message": "File saved and processing started"}

D. async def upload(file: UploadFile, background_tasks: BackgroundTasks):
background_tasks.add_task(process_file, file.file.read())
return {"message": "Processing started"}

Solution

1. Step 1: Save file before background processing

   The file is read and saved immediately using await file.read() and writing to disk.

2. Step 2: Add background task with saved filename

   The background task processes the saved file path, ensuring file exists before processing.

3. Final Answer:

   Save file first, then add background task with saved filename. -> Option C

4. Quick Check:

   Save file first, then background task with filename [OK]

Hint: Save file first, then add background task with filename [OK]

Common Mistakes:

• Adding background task before saving file
• Passing file.file.read() instead of file or filename
• Calling process_file synchronously inside endpoint