Streaming responses in FastAPI - Step-by-Step Execution

Concept Flow - Streaming responses

Client sends request

↓

Server starts processing

↓

Server yields data chunks

↓

Client receives chunks progressively

↓

Streaming ends when all data sent

↓

Connection closes

The server sends data in small pieces as they become ready, letting the client receive it bit by bit without waiting for all data.

Execution Sample

FastAPI

from fastapi import FastAPI
from fastapi.responses import StreamingResponse

app = FastAPI()

@app.get("/stream")
async def stream():
    async def generator():
        for i in range(3):
            yield f"chunk {i}\n"
    return StreamingResponse(generator(), media_type="text/plain")

This FastAPI endpoint streams three text chunks to the client one by one.

Execution Table

Step	Action	Generator State	Data Yielded	Client Receives
1	Request received, generator starts	Not started	None	None
2	Generator yields 'chunk 0\n'	Yielded 0	'chunk 0\n'	'chunk 0\n' received
3	Generator yields 'chunk 1\n'	Yielded 1	'chunk 1\n'	'chunk 1\n' received
4	Generator yields 'chunk 2\n'	Yielded 2	'chunk 2\n'	'chunk 2\n' received
5	Generator ends, streaming complete	Completed	None	Streaming finished
6	Connection closes	N/A	N/A	Connection closed

💡 All chunks yielded and sent; streaming ends and connection closes

Variable Tracker

Variable	Start	After 1	After 2	After 3	Final
i	N/A	0	1	2	N/A
generator state	Not started	Yielded 0	Yielded 1	Yielded 2	Completed

Key Moments - 3 Insights

Why does the client receive data in parts instead of all at once?

Because the server uses a generator that yields chunks one by one (see execution_table steps 2-4), so data is sent progressively.

What happens when the generator finishes yielding all chunks?

StreamingResponse detects the generator is done (step 5), finishes sending data, and closes the connection (step 6).

Can the client start processing data before the entire response is ready?

Yes, the client receives each chunk as soon as it is yielded (execution_table steps 2-4), allowing immediate processing.

Visual Quiz - 3 Questions

Look at the execution table, what is the generator state after step 3?

A Not started

B Yielded 1

C Completed

D Yielded 2

💡 Hint

Check the 'Generator State' column at step 3 in the execution_table

At which step does the client receive the last chunk?

A Step 4

B Step 5

C Step 2

D Step 6

💡 Hint

Look at the 'Client Receives' column for the last 'chunk 2\n' in the execution_table

If the generator yielded 5 chunks instead of 3, how would the variable 'i' change in variable_tracker?

A It would stay at 3

B It would go from 1 to 5

C It would go from 0 to 4 across iterations

D It would not change

💡 Hint

Variable 'i' tracks the loop index; see variable_tracker values for 'i'

Concept Snapshot

Streaming responses in FastAPI:
- Use a generator function to yield data chunks
- Return StreamingResponse(generator, media_type)
- Client receives data progressively
- Useful for large or slow data
- Connection closes after all chunks sent

Full Transcript

Streaming responses in FastAPI let the server send data bit by bit instead of all at once. When a client requests the streaming endpoint, the server starts a generator that yields small pieces of data. Each chunk is sent immediately to the client, who can start processing it right away. This continues until the generator finishes yielding all chunks. Then the server closes the connection. This method is helpful when sending large files or data that takes time to prepare. The example code shows a generator yielding three text chunks. The execution table traces each step: starting the generator, yielding chunks, client receiving them, and closing the connection. Variables like the loop index 'i' update with each yield. Understanding this flow helps beginners see how streaming responses work in FastAPI.

Practice

1. What is the main benefit of using StreamingResponse in FastAPI?

easy

A. It compresses the entire response into a single file.

B. It automatically caches all responses for faster access.

C. It converts JSON data into XML format before sending.

D. It sends data in small parts instead of all at once, improving efficiency.

Solution

1. Step 1: Understand what streaming means

   Streaming sends data in chunks, not all at once, which helps with large data or slow connections.

2. Step 2: Identify the role of StreamingResponse

   FastAPI's StreamingResponse helps send these chunks efficiently to the client.

3. Final Answer:

   It sends data in small parts instead of all at once, improving efficiency. -> Option D

4. Quick Check:

   Streaming = sending data in parts [OK]

Hint: Streaming sends data bit by bit, not all at once [OK]

Common Mistakes:

• Thinking StreamingResponse caches data
• Confusing streaming with data compression
• Assuming it changes data format automatically

2. Which of the following is the correct way to import StreamingResponse in FastAPI?

easy

A. from fastapi import StreamingResponse

B. import StreamingResponse from fastapi.responses

C. from fastapi.responses import StreamingResponse

D. import StreamingResponse as sr from fastapi

Solution

1. Step 1: Recall FastAPI import syntax

   FastAPI uses standard Python import syntax: from module import class/function.

2. Step 2: Identify correct module for StreamingResponse

   StreamingResponse is in fastapi.responses, so correct import is from fastapi.responses import StreamingResponse.

3. Final Answer:

   from fastapi.responses import StreamingResponse -> Option C

4. Quick Check:

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

Hint: Use 'from fastapi.responses import StreamingResponse' [OK]

Common Mistakes:

• Using incorrect import syntax like 'import StreamingResponse from ...'
• Importing directly from 'fastapi' instead of 'fastapi.responses'
• Trying to alias import incorrectly

3. Given this FastAPI endpoint code, what will the client receive?

from fastapi import FastAPI
from fastapi.responses import StreamingResponse

app = FastAPI()

def generate_numbers():
    for i in range(3):
        yield f"Number: {i}\n"

@app.get("/numbers")
def numbers():
    return StreamingResponse(generate_numbers(), media_type="text/plain")

medium

A. A streamed response sending 'Number: 0\n', then 'Number: 1\n', then 'Number: 2\n' in parts

B. A single response with 'Number: 0\nNumber: 1\nNumber: 2\n' all at once

C. Three separate responses, each with one number

D. An error because StreamingResponse cannot use generators

Solution

1. Step 1: Understand the generator function

   The function generate_numbers yields strings one by one for i in 0 to 2.

2. Step 2: Analyze StreamingResponse behavior

   StreamingResponse sends data chunks as they are yielded, so client receives parts streamed.

3. Final Answer:

   A streamed response sending 'Number: 0\n', then 'Number: 1\n', then 'Number: 2\n' in parts -> Option A

4. Quick Check:

   Generator + StreamingResponse = streamed chunks [OK]

Hint: Generators yield chunks; StreamingResponse streams them [OK]

Common Mistakes:

• Thinking all data sends at once
• Expecting multiple separate HTTP responses
• Assuming StreamingResponse rejects generators

4. Identify the error in this FastAPI streaming endpoint code:

from fastapi import FastAPI
from fastapi.responses import StreamingResponse

app = FastAPI()

def stream_data():
    data = ["a", "b", "c"]
    for d in data:
        return d

@app.get("/stream")
def stream():
    return StreamingResponse(stream_data(), media_type="text/plain")

medium

A. The function stream_data uses return inside the loop instead of yield.

B. StreamingResponse requires media_type to be 'application/json'.

C. The endpoint path should be '/stream_data' not '/stream'.

D. FastAPI does not support StreamingResponse with string data.

Solution

1. Step 1: Check stream_data function logic

   Inside the loop, return exits the function immediately, so only first item 'a' is returned.

2. Step 2: Understand streaming requires yield

   StreamingResponse expects an iterable or generator; yield produces chunks one by one.

3. Final Answer:

   The function stream_data uses return inside the loop instead of yield. -> Option A

4. Quick Check:

   Use yield, not return, for streaming generators [OK]

Hint: Use yield inside loops for streaming, not return [OK]

Common Mistakes:

• Using return inside generator loops
• Wrong media_type for StreamingResponse
• Confusing endpoint path naming
• Believing StreamingResponse can't stream strings

5. You want to stream a large CSV file line by line using FastAPI. Which approach correctly combines streaming with file reading?

hard

A. Use StreamingResponse with a function that returns the file size.

B. Use a generator that opens the file and yields each line, then return StreamingResponse with that generator.

C. Return StreamingResponse with the file path string directly.

D. Read the entire file into memory, then return StreamingResponse with a list of lines.

Solution

1. Step 1: Understand streaming large files

   Reading line by line with a generator avoids loading whole file into memory.

2. Step 2: Match StreamingResponse usage

   StreamingResponse accepts an iterable like a generator that yields file lines.

3. Step 3: Evaluate options

   Use a generator that opens the file and yields each line, then return StreamingResponse with that generator. This uses a generator to yield lines, which is efficient and correct. Others either load all data or misuse StreamingResponse.

4. Final Answer:

   Use a generator that opens the file and yields each line, then return StreamingResponse with that generator. -> Option B

5. Quick Check:

   Generator + StreamingResponse = efficient file streaming [OK]

Hint: Stream files by yielding lines in a generator [OK]

Common Mistakes:

• Loading entire file into memory before streaming
• Passing file path string instead of iterable
• Returning file size instead of content