File download responses in FastAPI - Practice Problems & Coding Challenges

Challenge - 5 Problems

❓ component_behavior

intermediate

What is the output of this FastAPI file download endpoint?

Consider this FastAPI endpoint code. What will the client receive when accessing /download?

FastAPI

from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get('/download')
async def download_file():
    return FileResponse('example.txt', media_type='text/plain', filename='example.txt')

A The server raises a FileNotFoundError because 'example.txt' is missing.

B The client downloads the file 'example.txt' with correct text content and filename.

C The client receives a JSON response with file metadata instead of the file content.

D The client receives an HTML page showing the file content inline.

💡 Hint

FileResponse sends the file content with headers to trigger download.

FileResponse streams the file content with the specified media type and sets headers so the browser downloads it with the given filename.

📝 Syntax

intermediate

Which option correctly sets a custom filename for download in FastAPI?

You want the client to download a file named 'report.pdf' regardless of the actual file name on disk. Which code snippet achieves this?

FastAPI

from fastapi.responses import FileResponse

# Assume 'files/12345.pdf' exists

@app.get('/get-report')
async def get_report():
    # Fill in the return statement

A return FileResponse('files/12345.pdf', filename='report.pdf')

B return FileResponse('files/12345.pdf', media_type='application/pdf')

C return FileResponse('files/12345.pdf', headers={'Content-Disposition': 'attachment; filename=report.pdf'})

D return FileResponse('files/12345.pdf', filename='files/12345.pdf')

💡 Hint

Use the filename parameter to set the download name.

The filename parameter in FileResponse sets the name the client sees when downloading, overriding the actual file path name.

🔧 Debug

advanced

Why does this FastAPI file download endpoint cause a 500 Internal Server Error?

Analyze the code below. Why does the server return a 500 error when the endpoint is called?

FastAPI

from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get('/download')
async def download():
    file_path = 'static/report.pdf'
    return FileResponse(path=file_path, media_type='application/pdf', filename='report.pdf')

A The file 'static/report.pdf' does not exist or path is incorrect, causing FileNotFoundError.

B The media_type 'application/pdf' is invalid and causes a runtime error.

C The filename parameter must be omitted to avoid errors.

D The endpoint must be synchronous, async causes the error.

💡 Hint

Check if the file path is correct and file exists on the server.

FileResponse raises an error if the file path does not exist, causing a 500 error. The media_type and filename are valid, and async is allowed.

❓ state_output

advanced

What headers are set by FastAPI's FileResponse for file downloads?

Given this endpoint, which HTTP header ensures the browser downloads the file instead of displaying it inline?

FastAPI

from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get('/file')
async def file():
    return FileResponse('data.csv', media_type='text/csv', filename='data.csv')

A Cache-Control: no-cache

B Content-Type: application/octet-stream

C Content-Encoding: gzip

D Content-Disposition: attachment; filename="data.csv"

💡 Hint

Look for the header that controls download behavior in browsers.

FileResponse sets the Content-Disposition header with 'attachment' and filename to prompt download. Other headers control content type or caching but not download behavior.

🧠 Conceptual

expert

How does FastAPI's FileResponse handle large files efficiently?

FastAPI's FileResponse is used to send large files to clients. How does it avoid loading the entire file into memory at once?

A It compresses the file fully before sending to reduce memory usage.

B It reads the entire file into memory and then sends it in one response.

C It streams the file in chunks using Python's file iterator, sending data progressively.

D It converts the file to base64 string and sends it as JSON.

💡 Hint

Think about how servers send big files without freezing or crashing.

FileResponse uses Python's file streaming to send data in chunks, which is memory efficient and allows clients to start receiving data immediately.

Practice

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

easy

A. To upload a file from the client to the server

B. To read the contents of a file on the server

C. To delete a file on the server

D. To send a file to the client for download

Solution

1. Step 1: Understand the role of FileResponse

   FileResponse is designed to send files from the server to the client, enabling downloads.

2. Step 2: Differentiate from other file operations

   Uploading, deleting, or reading files are different operations and not handled by FileResponse.

3. Final Answer:

   To send a file to the client for download -> Option D

4. Quick Check:

   FileResponse sends files to clients [OK]

Hint: FileResponse is for sending files to users, not receiving [OK]

Common Mistakes:

• Confusing file download with upload
• Thinking FileResponse reads file content internally
• Assuming FileResponse deletes files

2. Which of the following is the correct way to import FileResponse in a FastAPI app?

easy

A. from fastapi.responses import FileResponse

B. from fastapi import FileResponse

C. import FileResponse from fastapi.responses

D. from fastapi.responses import file_response

Solution

1. Step 1: Recall correct import syntax

   FastAPI's FileResponse is located in the fastapi.responses module and imported using Python's standard import syntax.

2. Step 2: Check each option

   from fastapi.responses import FileResponse uses correct syntax and casing. from fastapi import FileResponse misses the responses submodule. import FileResponse from fastapi.responses uses wrong import order. from fastapi.responses import file_response uses incorrect casing.

3. Final Answer:

   from fastapi.responses import FileResponse -> Option A

4. Quick Check:

   Correct import = from fastapi.responses import FileResponse [OK]

Hint: Import FileResponse from fastapi.responses exactly [OK]

Common Mistakes:

• Omitting the 'responses' submodule
• Using wrong import syntax order
• Incorrect capitalization of FileResponse

3. Given this FastAPI endpoint code, what will the client receive when accessing /download?

from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get('/download')
async def download_file():
    return FileResponse('files/report.pdf', media_type='application/pdf', filename='report.pdf')

medium

A. The server returns a 404 error because the file path is missing

B. The client receives a JSON response with file metadata

C. The client downloads the file named 'report.pdf' with PDF content

D. The client downloads a file named 'files/report.pdf' without content type

Solution

1. Step 1: Analyze FileResponse parameters

   The path 'files/report.pdf' is given, media type is set to 'application/pdf', and filename is 'report.pdf'. This means the file will be sent as a PDF download named 'report.pdf'.

2. Step 2: Understand client behavior

   The client will receive the file content with correct media type and suggested filename, triggering a download.

3. Final Answer:

   The client downloads the file named 'report.pdf' with PDF content -> Option C

4. Quick Check:

   FileResponse sends file with given name and media type [OK]

Hint: FileResponse sends file content with given filename and media type [OK]

Common Mistakes:

• Assuming JSON response instead of file
• Thinking filename is the full path sent to client
• Ignoring media_type affects download behavior

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

from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get('/getfile')
def get_file():
    return FileResponse(path='myfile.txt', media_type='text/plain', filename=myfile.txt)

medium

A. FileResponse must be awaited since endpoint is async

B. Filename argument is not a string (missing quotes)

C. Path argument should be a URL, not a file path

D. Missing import for FileResponse

Solution

1. Step 1: Check filename argument syntax

   The filename argument is written as filename=myfile.txt without quotes, so Python treats it as a variable, causing a NameError.

2. Step 2: Verify other parts

   The endpoint is synchronous which is allowed. Path can be a file path. FileResponse is imported correctly. So only filename syntax is wrong.

3. Final Answer:

   Filename argument is not a string (missing quotes) -> Option B

4. Quick Check:

   Filename must be a string literal [OK]

Hint: Always quote filename strings in FileResponse [OK]

Common Mistakes:

• Forgetting quotes around filename string
• Assuming async needed for FileResponse
• Confusing file path with URL

5. You want to create a FastAPI endpoint that lets users download a CSV file named data.csv stored in static/files/. The file path may not exist sometimes. Which is the best way to handle this safely?

hard

A. Use FileResponse with a try-except block to catch file not found errors and return 404

B. Return FileResponse directly without checking; client will get an error if file missing

C. Use StreamingResponse without checking file existence

D. Send the file content as a plain string response

Solution

1. Step 1: Understand file existence risk

   Since the file may not exist, directly returning FileResponse risks server errors or confusing client errors.

2. Step 2: Implement error handling

   Using a try-except block to catch FileNotFoundError and returning a 404 response is best practice for user-friendly error handling.

3. Final Answer:

   Use FileResponse with a try-except block to catch file not found errors and return 404 -> Option A

4. Quick Check:

   Check file existence and handle errors gracefully [OK]

Hint: Always check file exists before FileResponse to avoid errors [OK]

Common Mistakes:

• Not handling missing files causing server errors
• Using StreamingResponse without reason
• Sending raw file content as string