⬆ Bump actions/upload-artifact from 6 to 7

Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 6 to 7.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v6...v7)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

.github/workflows/build-docs.yml

@@ -97,7 +97,7 @@ jobs:
           path: docs/${{ matrix.lang }}/.cache
       - name: Build Docs
         run: uv run ./scripts/docs.py build-lang ${{ matrix.lang }}
-      - uses: actions/upload-artifact@v6
+      - uses: actions/upload-artifact@v7
         with:
           name: docs-site-${{ matrix.lang }}
           path: ./site/**

.github/workflows/test.yml

@@ -114,7 +114,7 @@ jobs:
       # Do not store coverage for all possible combinations to avoid file size max errors in Smokeshow
       - name: Store coverage files
         if: matrix.coverage == 'coverage'
-        uses: actions/upload-artifact@v6
+        uses: actions/upload-artifact@v7
         with:
           name: coverage-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('**/coverage/.coverage.*') }}
           path: coverage
@@ -185,7 +185,7 @@ jobs:
       - run: uv run coverage combine coverage
       - run: uv run coverage html --title "Coverage for ${{ github.sha }}"
       - name: Store coverage HTML
-        uses: actions/upload-artifact@v6
+        uses: actions/upload-artifact@v7
         with:
           name: coverage-html
           path: htmlcov

docs/de/docs/advanced/websockets.md

@@ -38,13 +38,13 @@ In der Produktion hätten Sie eine der oben genannten Optionen.
 
 Aber es ist der einfachste Weg, sich auf die Serverseite von WebSockets zu konzentrieren und ein funktionierendes Beispiel zu haben:
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[2,6:38,41:43] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *}
 
 ## Einen `websocket` erstellen { #create-a-websocket }
 
 Erstellen Sie in Ihrer **FastAPI**-Anwendung einen `websocket`:
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[1,46:47] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *}
 
 /// note | Technische Details
 
@@ -58,7 +58,7 @@ Sie könnten auch `from starlette.websockets import WebSocket` verwenden.
 
 In Ihrer WebSocket-Route können Sie Nachrichten `await`en und Nachrichten senden.
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[48:52] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *}
 
 Sie können Binär-, Text- und JSON-Daten empfangen und senden.
 
@@ -109,7 +109,7 @@ In WebSocket-Endpunkten können Sie Folgendes aus `fastapi` importieren und verw
 
 Diese funktionieren auf die gleiche Weise wie für andere FastAPI-Endpunkte/*Pfadoperationen*:
 
-{* ../../docs_src/websockets_/tutorial002_an_py310.py hl[68:69,82] *}
+{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}
 
 /// info | Info
 
@@ -154,7 +154,7 @@ Damit können Sie den WebSocket verbinden und dann Nachrichten senden und empfan
 
 Wenn eine WebSocket-Verbindung geschlossen wird, löst `await websocket.receive_text()` eine `WebSocketDisconnect`-Exception aus, die Sie dann wie in folgendem Beispiel abfangen und behandeln können.
 
-{* ../../docs_src/websockets_/tutorial003_py310.py hl[79:81] *}
+{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *}
 
 Zum Ausprobieren:
 

docs/en/docs/advanced/stream-data.md

@@ -1,99 +0,0 @@
-# Stream Data { #stream-data }
-
-If you want to stream data that can be structured as JSON, you should [Stream JSON Lines](../tutorial/stream-json-lines.md){.internal-link target=_blank}.
-
-But if you want to **stream pure binary data** or strings, here's how you can do it.
-
-## Use Cases { #use-cases }
-
-You could use this if you want to stream pure strings, for example directly from the output of an **AI LLM** service.
-
-You could also use it to stream **large binary files**, where you stream each chunk of data as you read it, without having to read it all in memory at once.
-
-You could also stream **video** or **audio** this way, it could even be generated as you process and send it.
-
-## A `StreamingResponse` with `yield` { #a-streamingresponse-with-yield }
-
-If you declare a `response_class=StreamingResponse` in your *path operation function*, you can use `yield` to send each chunk of data in turn.
-
-{* ../../docs_src/stream_data/tutorial001_py310.py ln[1:23] hl[20,23] *}
-
-FastAPI will give each chunk of data to the `StreamingResponse` as is, it won't try to convert it to JSON or anything similar.
-
-### Non-async *path operation functions* { #non-async-path-operation-functions }
-
-You can also use regular `def` functions (without `async`), and use `yield` the same way.
-
-{* ../../docs_src/stream_data/tutorial001_py310.py ln[26:29] hl[27] *}
-
-### No Annotation { #no-annotation }
-
-You don't really need to declare the return type annotation for streaming binary data.
-
-As FastAPI will not try to convert the data to JSON with Pydantic or serialize it in any way, in this case, the type annotation is only for your editor and tools to use, it won't be used by FastAPI.
-
-{* ../../docs_src/stream_data/tutorial001_py310.py ln[32:35] hl[33] *}
-
-This also means that with `StreamingResponse` you have the **freedom** and **responsibility** to produce and encode the data bytes exactly as you need them to be sent, independent of the type annotations. 🤓
-
-### Stream Bytes { #stream-bytes }
-
-One of the main use cases would be to stream `bytes` instead of strings, you can of course do it.
-
-{* ../../docs_src/stream_data/tutorial001_py310.py ln[44:47] hl[47] *}
-
-## A Custom `PNGStreamingResponse` { #a-custom-pngstreamingresponse }
-
-In the examples above, the data bytes were streamed, but the response didn't have a `Content-Type` header, so the client didn't know what type of data it was receiving.
-
-You can create a custom sub-class of `StreamingResponse` that sets the `Content-Type` header to the type of data you're streaming.
-
-For example, you can create a `PNGStreamingResponse` that sets the `Content-Type` header to `image/png` using the `media_type` attribute:
-
-{* ../../docs_src/stream_data/tutorial002_py310.py ln[6,19:20] hl[20] *}
-
-Then you can use this new class in `response_class=PNGStreamingResponse` in your *path operation function*:
-
-{* ../../docs_src/stream_data/tutorial002_py310.py ln[23:26] hl[23] *}
-
-### Simulate a File { #simulate-a-file }
-
-In this example, we are simulating a file with `io.BytesIO`, which is a file-like object that lives only in memory, but lets us use the same interface.
-
-For example, we can iterate over it to consume its contents, as we could with a file.
-
-{* ../../docs_src/stream_data/tutorial002_py310.py ln[1:26] hl[3,12:13,25] *}
-
-/// note | Technical Details
-
-The other two variables, `image_base64` and `binary_image`, are an image encoded in Base64, and then converted to bytes, to then pass it to `io.BytesIO`.
-
-Only so that it can live in the same file for this example and you can copy it and run it as is. 🥚
-
-///
-
-### Files and Async { #files-and-async }
-
-In most cases, file-like objects are not compatible with async and await by default.
-
-For example, they don't have an `await file.read()`, or `async for chunk in file`.
-
-And in many cases, reading them would be a blocking operation (that could block the event loop), because they are read from disk or from the network.
-
-/// info
-
-The example above is actually an exception, because the `io.BytesIO` object is already in memory, so reading it won't block anything.
-
-But in many cases reading a file or a file-like object would block.
-
-///
-
-To avoid blocking the event loop, you can simply declare the *path operation function* with regular `def` instead of `async def`, that way FastAPI will run it on a threadpool worker, to avoid blocking the main loop.
-
-{* ../../docs_src/stream_data/tutorial002_py310.py ln[29:32] hl[30] *}
-
-/// tip
-
-If you need to call blocking code from inside of an async function, or an async function from inside of a blocking function, you could use <a href="https://asyncer.tiangolo.com" class="external-link" target="_blank">Asyncer</a>, a sibling library to FastAPI.
-
-///

docs/en/docs/advanced/websockets.md

@@ -38,13 +38,13 @@ In production you would have one of the options above.
 
 But it's the simplest way to focus on the server-side of WebSockets and have a working example:
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[2,6:38,41:43] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *}
 
 ## Create a `websocket` { #create-a-websocket }
 
 In your **FastAPI** application, create a `websocket`:
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[1,46:47] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *}
 
 /// note | Technical Details
 
@@ -58,7 +58,7 @@ You could also use `from starlette.websockets import WebSocket`.
 
 In your WebSocket route you can `await` for messages and send messages.
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[48:52] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *}
 
 You can receive and send binary, text, and JSON data.
 
@@ -109,7 +109,7 @@ In WebSocket endpoints you can import from `fastapi` and use:
 
 They work the same way as for other FastAPI endpoints/*path operations*:
 
-{* ../../docs_src/websockets_/tutorial002_an_py310.py hl[68:69,82] *}
+{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}
 
 /// info
 
@@ -154,7 +154,7 @@ With that you can connect the WebSocket and then send and receive messages:
 
 When a WebSocket connection is closed, the `await websocket.receive_text()` will raise a `WebSocketDisconnect` exception, which you can then catch and handle like in this example.
 
-{* ../../docs_src/websockets_/tutorial003_py310.py hl[79:81] *}
+{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *}
 
 To try it out:
 

docs/en/docs/tutorial/stream-json-lines.md

@@ -1,105 +0,0 @@
-# Stream JSON Lines { #stream-json-lines }
-
-You could have a sequence of data that you would like to send in a "**stream**", you could do it with **JSON Lines**.
-
-## What is a Stream? { #what-is-a-stream }
-
-"**Streaming**" data means that your app will start sending data items to the client without waiting for the entire sequence of items to be ready.
-
-So, it will send the first item, the client will receive and start processing it, and you might still be producing the next item.
-
-```mermaid
-sequenceDiagram
-    participant App
-    participant Client
-
-    App->>App: Produce Item 1
-    App->>Client: Send Item 1
-    App->>App: Produce Item 2
-    Client->>Client: Process Item 1
-    App->>Client: Send Item 2
-    App->>App: Produce Item 3
-    Client->>Client: Process Item 2
-    App->>Client: Send Item 3
-    Client->>Client: Process Item 3
-    Note over App: Keeps producing...
-    Note over Client: Keeps consuming...
-```
-
-It could even be an infinite stream, where you keep sending data.
-
-## JSON Lines { #json-lines }
-
-In these cases, it's common to send "**JSON Lines**", which is a format where you send one JSON object per line.
-
-A response would have a content type of `application/jsonl` (instead of `application/json`) and the body would be something like:
-
-```json
-{"name": "Plumbus", "description": "A multi-purpose household device."}
-{"name": "Portal Gun", "description": "A portal opening device."}
-{"name": "Meeseeks Box", "description": "A box that summons a Meeseeks."}
-```
-
-It's very similar to a JSON array (equivalent of a Python list), but instead of being wrapped in `[]` and having `,` between the items, it has **one JSON object per line**, they are separated by a new line character.
-
-/// info
-
-The important point is that your app will be able to produce each line in turn, while the client consumes the previous lines.
-
-///
-
-/// note | Technical Details
-
-Because each JSON object will be separated by a new line, they can't contain literal new line characters in their content, but they can contain escaped new lines (`\n`), which is part of the JSON standard.
-
-But normally you won't have to worry about it, it's done automatically, continue reading. 🤓
-
-///
-
-## Use Cases { #use-cases }
-
-You could use this to stream data from an **AI LLM** service, from **logs** or **telemetry**, or from other types of data that can be structured in **JSON** items.
-
-/// tip
-
-If you want to stream binary data, for example video or audio, check the advanced guide: [Stream Data](../advanced/stream-data.md).
-
-///
-
-## Stream JSON Lines with FastAPI { #stream-json-lines-with-fastapi }
-
-To stream JSON Lines with FastAPI you can, instead of using `return` in your *path operation function*, use `yield` to produce each item in turn.
-
-{* ../../docs_src/stream_json_lines/tutorial001_py310.py ln[1:24] hl[24] *}
-
-If each JSON item you want to send back is of type `Item` (a Pydantic model) and it's an async function, you can declare the return type as `AsyncIterable[Item]`:
-
-{* ../../docs_src/stream_json_lines/tutorial001_py310.py ln[1:24] hl[9:11,22] *}
-
-If you declare the return type, FastAPI will use it to **validate** the data, **document** it in OpenAPI, **filter** it, and **serialize** it using Pydantic.
-
-/// tip
-
-As Pydantic will serialize it in the **Rust** side, you will get much higher **performance** than if you don't declare a return type.
-
-///
-
-### Non-async *path operation functions* { #non-async-path-operation-functions }
-
-You can also use regular `def` functions (without `async`), and use `yield` the same way.
-
-FastAPI will make sure it's run correctly so that it doesn't block the event loop.
-
-As in this case the function is not async, the right return type would be `Iterable[Item]`:
-
-{* ../../docs_src/stream_json_lines/tutorial001_py310.py ln[27:30] hl[28] *}
-
-### No Return Type { #no-return-type }
-
-You can also omit the return type. FastAPI will then use the [`jsonable_encoder`](./encoder.md){.internal-link target=_blank} to convert the data to something that can be serialized to JSON and then send it as JSON Lines.
-
-{* ../../docs_src/stream_json_lines/tutorial001_py310.py ln[33:36] hl[34] *}
-
-## Server Sent Events (SSE) { #server-sent-events-sse }
-
-A future version of FastAPI will also have first-class support for Server Sent Events (SSE), which are quite similar, but with a couple of extra details. 🤓

docs/en/mkdocs.yml

@@ -154,7 +154,6 @@ nav:
     - tutorial/cors.md
     - tutorial/sql-databases.md
     - tutorial/bigger-applications.md
-    - tutorial/stream-json-lines.md
     - tutorial/background-tasks.md
     - tutorial/metadata.md
     - tutorial/static-files.md
@@ -162,7 +161,6 @@ nav:
     - tutorial/debugging.md
   - Advanced User Guide:
     - advanced/index.md
-    - advanced/stream-data.md
     - advanced/path-operation-advanced-configuration.md
     - advanced/additional-status-codes.md
     - advanced/response-directly.md

docs/es/docs/advanced/websockets.md

@@ -38,13 +38,13 @@ En producción tendrías una de las opciones anteriores.
 
 Pero es la forma más sencilla de enfocarse en el lado del servidor de WebSockets y tener un ejemplo funcional:
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[2,6:38,41:43] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *}
 
 ## Crear un `websocket` { #create-a-websocket }
 
 En tu aplicación de **FastAPI**, crea un `websocket`:
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[1,46:47] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *}
 
 /// note | Detalles Técnicos
 
@@ -58,7 +58,7 @@ También podrías usar `from starlette.websockets import WebSocket`.
 
 En tu ruta de WebSocket puedes `await` para recibir mensajes y enviar mensajes.
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[48:52] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *}
 
 Puedes recibir y enviar datos binarios, de texto y JSON.
 
@@ -109,7 +109,7 @@ En endpoints de WebSocket puedes importar desde `fastapi` y usar:
 
 Funcionan de la misma manera que para otros endpoints de FastAPI/*path operations*:
 
-{* ../../docs_src/websockets_/tutorial002_an_py310.py hl[68:69,82] *}
+{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}
 
 /// info | Información
 
@@ -154,7 +154,7 @@ Con eso puedes conectar el WebSocket y luego enviar y recibir mensajes:
 
 Cuando una conexión de WebSocket se cierra, el `await websocket.receive_text()` lanzará una excepción `WebSocketDisconnect`, que puedes capturar y manejar como en este ejemplo.
 
-{* ../../docs_src/websockets_/tutorial003_py310.py hl[79:81] *}
+{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *}
 
 Para probarlo:
 

docs/fr/docs/advanced/websockets.md

@@ -38,13 +38,13 @@ En production, vous auriez l'une des options ci-dessus.
 
 Mais c'est la façon la plus simple de se concentrer sur la partie serveur des WebSockets et d'avoir un exemple fonctionnel :
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[2,6:38,41:43] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *}
 
 ## Créer un `websocket` { #create-a-websocket }
 
 Dans votre application **FastAPI**, créez un `websocket` :
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[1,46:47] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *}
 
 /// note | Détails techniques
 
@@ -58,7 +58,7 @@ Vous pourriez aussi utiliser `from starlette.websockets import WebSocket`.
 
 Dans votre route WebSocket, vous pouvez `await` des messages et envoyer des messages.
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[48:52] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *}
 
 Vous pouvez recevoir et envoyer des données binaires, texte et JSON.
 
@@ -109,7 +109,7 @@ Dans les endpoints WebSocket, vous pouvez importer depuis `fastapi` et utiliser
 
 Ils fonctionnent de la même manière que pour les autres endpoints/*chemins d'accès* FastAPI :
 
-{* ../../docs_src/websockets_/tutorial002_an_py310.py hl[68:69,82] *}
+{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}
 
 /// info
 
@@ -154,7 +154,7 @@ Avec cela, vous pouvez connecter le WebSocket puis envoyer et recevoir des messa
 
 Lorsqu'une connexion WebSocket est fermée, l'instruction `await websocket.receive_text()` lèvera une exception `WebSocketDisconnect`, que vous pouvez ensuite intercepter et gérer comme dans cet exemple.
 
-{* ../../docs_src/websockets_/tutorial003_py310.py hl[79:81] *}
+{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *}
 
 Pour l'essayer :
 

docs/ja/docs/advanced/websockets.md

@@ -38,13 +38,13 @@ $ pip install websockets
 
 しかし、これはWebSocketsのサーバーサイドに焦点を当て、動作する例を示す最も簡単な方法です。
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[2,6:38,41:43] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *}
 
 ## `websocket` を作成する { #create-a-websocket }
 
 **FastAPI** アプリケーションで、`websocket` を作成します。
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[1,46:47] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *}
 
 /// note | 技術詳細
 
@@ -58,7 +58,7 @@ $ pip install websockets
 
 WebSocketルートでは、メッセージを待機して送信するために `await` を使用できます。
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[48:52] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *}
 
 バイナリやテキストデータ、JSONデータを送受信できます。
 
@@ -109,7 +109,7 @@ WebSocketエンドポイントでは、`fastapi` から以下をインポート
 
 これらは、他のFastAPI エンドポイント/*path operations* の場合と同じように機能します。
 
-{* ../../docs_src/websockets_/tutorial002_an_py310.py hl[68:69,82] *}
+{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}
 
 /// info | 情報
 
@@ -154,7 +154,7 @@ $ fastapi dev main.py
 
 WebSocket接続が閉じられると、 `await websocket.receive_text()` は例外 `WebSocketDisconnect` を発生させ、この例のようにキャッチして処理することができます。
 
-{* ../../docs_src/websockets_/tutorial003_py310.py hl[79:81] *}
+{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *}
 
 試してみるには、
 

docs/ko/docs/advanced/websockets.md

@@ -38,13 +38,13 @@ $ pip install websockets
 
 그러나 이는 WebSockets의 서버 측에 집중하고 동작하는 예제를 제공하는 가장 간단한 방법입니다:
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[2,6:38,41:43] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *}
 
 ## `websocket` 생성하기 { #create-a-websocket }
 
 **FastAPI** 애플리케이션에서 `websocket`을 생성합니다:
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[1,46:47] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *}
 
 /// note | 기술 세부사항
 
@@ -58,7 +58,7 @@ $ pip install websockets
 
 WebSocket 경로에서 메시지를 대기(`await`)하고 전송할 수 있습니다.
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[48:52] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *}
 
 여러분은 이진 데이터, 텍스트, JSON 데이터를 받을 수 있고 전송할 수 있습니다.
 
@@ -109,7 +109,7 @@ WebSocket 엔드포인트에서 `fastapi`에서 다음을 가져와 사용할
 
 이들은 다른 FastAPI 엔드포인트/*경로 처리*와 동일하게 동작합니다:
 
-{* ../../docs_src/websockets_/tutorial002_an_py310.py hl[68:69,82] *}
+{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}
 
 /// info | 정보
 
@@ -154,7 +154,7 @@ $ fastapi dev main.py
 
 WebSocket 연결이 닫히면, `await websocket.receive_text()`가 `WebSocketDisconnect` 예외를 발생시킵니다. 그러면 이 예제처럼 이를 잡아 처리할 수 있습니다.
 
-{* ../../docs_src/websockets_/tutorial003_py310.py hl[79:81] *}
+{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *}
 
 테스트해보기:
 

docs/pt/docs/advanced/websockets.md

@@ -38,13 +38,13 @@ Na produção, você teria uma das opções acima.
 
 Mas é a maneira mais simples de focar no lado do servidor de WebSockets e ter um exemplo funcional:
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[2,6:38,41:43] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *}
 
 ## Crie um `websocket` { #create-a-websocket }
 
 Em sua aplicação **FastAPI**, crie um `websocket`:
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[1,46:47] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *}
 
 /// note | Detalhes Técnicos
 
@@ -58,7 +58,7 @@ A **FastAPI** fornece o mesmo `WebSocket` diretamente apenas como uma conveniên
 
 Em sua rota WebSocket você pode esperar (`await`) por mensagens e enviar mensagens.
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[48:52] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *}
 
 Você pode receber e enviar dados binários, de texto e JSON.
 
@@ -109,7 +109,7 @@ Nos endpoints WebSocket você pode importar do `fastapi` e usar:
 
 Eles funcionam da mesma forma que para outros endpoints FastAPI/*operações de rota*:
 
-{* ../../docs_src/websockets_/tutorial002_an_py310.py hl[68:69,82] *}
+{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}
 
 /// info | Informação
 
@@ -154,7 +154,7 @@ Com isso você pode conectar o WebSocket e então enviar e receber mensagens:
 
 Quando uma conexão WebSocket é fechada, o `await websocket.receive_text()` levantará uma exceção `WebSocketDisconnect`, que você pode então capturar e lidar como neste exemplo.
 
-{* ../../docs_src/websockets_/tutorial003_py310.py hl[79:81] *}
+{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *}
 
 Para testar:
 

docs/ru/docs/advanced/websockets.md

@@ -38,13 +38,13 @@ $ pip install websockets
 
 Для примера нам нужен наиболее простой способ, который позволит сосредоточиться на серверной части веб‑сокетов и получить рабочий код:
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[2,6:38,41:43] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *}
 
 ## Создание `websocket` { #create-a-websocket }
 
 Создайте `websocket` в своем **FastAPI** приложении:
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[1,46:47] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *}
 
 /// note | Технические детали
 
@@ -58,7 +58,7 @@ $ pip install websockets
 
 Через эндпоинт веб-сокета вы можете получать и отправлять сообщения.
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[48:52] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *}
 
 Вы можете получать и отправлять двоичные, текстовые и JSON данные.
 
@@ -109,7 +109,7 @@ $ fastapi dev main.py
 
 Они работают так же, как и в других FastAPI эндпоинтах/*операциях пути*:
 
-{* ../../docs_src/websockets_/tutorial002_an_py310.py hl[68:69,82] *}
+{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}
 
 /// info | Примечание
 
@@ -154,7 +154,7 @@ $ fastapi dev main.py
 
 Если веб-сокет соединение закрыто, то `await websocket.receive_text()` вызовет исключение `WebSocketDisconnect`, которое можно поймать и обработать как в этом примере:
 
-{* ../../docs_src/websockets_/tutorial003_py310.py hl[79:81] *}
+{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *}
 
 Чтобы воспроизвести пример:
 

docs/tr/docs/advanced/websockets.md

@@ -38,13 +38,13 @@ Production'da yukarıdaki seçeneklerden birini kullanırsınız.
 
 Ama WebSockets'in server tarafına odaklanmak ve çalışan bir örnek görmek için en basit yol bu:
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[2,6:38,41:43] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *}
 
 ## Bir `websocket` Oluşturun { #create-a-websocket }
 
 **FastAPI** uygulamanızda bir `websocket` oluşturun:
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[1,46:47] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *}
 
 /// note | Teknik Detaylar
 
@@ -58,7 +58,7 @@ Ama WebSockets'in server tarafına odaklanmak ve çalışan bir örnek görmek i
 
 WebSocket route'unuzda mesajları `await` edebilir ve mesaj gönderebilirsiniz.
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[48:52] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *}
 
 Binary, text ve JSON verisi alıp gönderebilirsiniz.
 
@@ -109,7 +109,7 @@ WebSocket endpoint'lerinde `fastapi` içinden import edip şunları kullanabilir
 
 Diğer FastAPI endpoint'leri/*path operations* ile aynı şekilde çalışırlar:
 
-{* ../../docs_src/websockets_/tutorial002_an_py310.py hl[68:69,82] *}
+{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}
 
 /// info | Bilgi
 
@@ -154,7 +154,7 @@ Bununla WebSocket'e bağlanabilir, ardından mesaj gönderip alabilirsiniz:
 
 Bir WebSocket bağlantısı kapandığında, `await websocket.receive_text()` bir `WebSocketDisconnect` exception'ı raise eder; ardından bunu bu örnekteki gibi yakalayıp (catch) yönetebilirsiniz.
 
-{* ../../docs_src/websockets_/tutorial003_py310.py hl[79:81] *}
+{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *}
 
 Denemek için:
 

docs/uk/docs/advanced/websockets.md

@@ -38,13 +38,13 @@ $ pip install websockets
 
 Але це найпростіший спосіб зосередитися на серверній частині WebSockets і мати робочий приклад:
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[2,6:38,41:43] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *}
 
 ## Створіть `websocket` { #create-a-websocket }
 
 У вашому застосунку **FastAPI** створіть `websocket`:
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[1,46:47] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *}
 
 /// note | Технічні деталі
 
@@ -58,7 +58,7 @@ $ pip install websockets
 
 У вашому маршруті WebSocket ви можете `await` повідомлення і надсилати повідомлення.
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[48:52] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *}
 
 Ви можете отримувати та надсилати бінарні, текстові та JSON-дані.
 
@@ -109,7 +109,7 @@ $ fastapi dev main.py
 
 Вони працюють так само, як для інших ендпойнтів FastAPI/*операцій шляху*:
 
-{* ../../docs_src/websockets_/tutorial002_an_py310.py hl[68:69,82] *}
+{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}
 
 /// info
 
@@ -154,7 +154,7 @@ $ fastapi dev main.py
 
 Коли з'єднання WebSocket закривається, `await websocket.receive_text()` підніме виняток `WebSocketDisconnect`, який ви можете перехопити й обробити, як у цьому прикладі.
 
-{* ../../docs_src/websockets_/tutorial003_py310.py hl[79:81] *}
+{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *}
 
 Щоб спробувати:
 

docs/zh-hant/docs/advanced/websockets.md

@@ -38,13 +38,13 @@ $ pip install websockets
 
 但這是能讓我們專注於 WebSocket 伺服端並跑起一個可運作範例的最簡單方式：
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[2,6:38,41:43] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *}
 
 ## 建立一個 `websocket` { #create-a-websocket }
 
 在你的 **FastAPI** 應用中，建立一個 `websocket`：
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[1,46:47] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *}
 
 /// note | 技術細節
 
@@ -58,7 +58,7 @@ $ pip install websockets
 
 在你的 WebSocket 路由中，你可以 `await` 接收訊息並傳送訊息。
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[48:52] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *}
 
 你可以接收與傳送二進位、文字與 JSON 資料。
 
@@ -109,7 +109,7 @@ $ fastapi dev main.py
 
 它們的運作方式與其他 FastAPI 端點/*路徑操作* 相同：
 
-{* ../../docs_src/websockets_/tutorial002_an_py310.py hl[68:69,82] *}
+{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}
 
 /// info
 
@@ -154,7 +154,7 @@ $ fastapi dev main.py
 
 當 WebSocket 連線關閉時，`await websocket.receive_text()` 會拋出 `WebSocketDisconnect` 例外，你可以像範例中那樣捕捉並處理。
 
-{* ../../docs_src/websockets_/tutorial003_py310.py hl[79:81] *}
+{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *}
 
 試用方式：
 

docs/zh/docs/advanced/websockets.md

@@ -38,13 +38,13 @@ $ pip install websockets
 
 但这是一种专注于 WebSockets 的服务器端并提供一个工作示例的最简单方式：
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[2,6:38,41:43] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[2,6:38,41:43] *}
 
 ## 创建 `websocket` { #create-a-websocket }
 
 在您的 **FastAPI** 应用程序中，创建一个 `websocket`：
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[1,46:47] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[1,46:47] *}
 
 /// note | 技术细节
 
@@ -58,7 +58,7 @@ $ pip install websockets
 
 在您的 WebSocket 路由中，您可以使用 `await` 等待消息并发送消息。
 
-{* ../../docs_src/websockets_/tutorial001_py310.py hl[48:52] *}
+{* ../../docs_src/websockets/tutorial001_py310.py hl[48:52] *}
 
 您可以接收和发送二进制、文本和 JSON 数据。
 
@@ -109,7 +109,7 @@ $ fastapi dev main.py
 
 它们的工作方式与其他 FastAPI 端点/*路径操作* 相同：
 
-{* ../../docs_src/websockets_/tutorial002_an_py310.py hl[68:69,82] *}
+{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}
 
 /// info
 
@@ -154,7 +154,7 @@ $ fastapi dev main.py
 
 当 WebSocket 连接关闭时，`await websocket.receive_text()` 将引发 `WebSocketDisconnect` 异常，您可以捕获并处理该异常，就像本示例中的示例一样。
 
-{* ../../docs_src/websockets_/tutorial003_py310.py hl[79:81] *}
+{* ../../docs_src/websockets/tutorial003_py310.py hl[79:81] *}
 
 尝试以下操作：
 

docs_src/stream_data/tutorial001_py310.py

@@ -1,65 +0,0 @@
-from collections.abc import AsyncIterable, Iterable
-
-from fastapi import FastAPI
-from fastapi.responses import StreamingResponse
-
-app = FastAPI()
-
-
-message = """
-Rick: (stumbles in drunkenly, and turns on the lights) Morty! You gotta come on. You got--... you gotta come with me.
-Morty: (rubs his eyes) What, Rick? What's going on?
-Rick: I got a surprise for you, Morty.
-Morty: It's the middle of the night. What are you talking about?
-Rick: (spills alcohol on Morty's bed) Come on, I got a surprise for you. (drags Morty by the ankle) Come on, hurry up. (pulls Morty out of his bed and into the hall)
-Morty: Ow! Ow! You're tugging me too hard!
-Rick: We gotta go, gotta get outta here, come on. Got a surprise for you Morty.
-"""
-
-
-@app.get("/story/stream", response_class=StreamingResponse)
-async def stream_story() -> AsyncIterable[str]:
-    for line in message.splitlines():
-        yield line
-
-
-@app.get("/story/stream-no-async", response_class=StreamingResponse)
-def stream_story_no_async() -> Iterable[str]:
-    for line in message.splitlines():
-        yield line
-
-
-@app.get("/story/stream-no-annotation", response_class=StreamingResponse)
-async def stream_story_no_annotation():
-    for line in message.splitlines():
-        yield line
-
-
-@app.get("/story/stream-no-async-no-annotation", response_class=StreamingResponse)
-def stream_story_no_async_no_annotation():
-    for line in message.splitlines():
-        yield line
-
-
-@app.get("/story/stream-bytes", response_class=StreamingResponse)
-async def stream_story_bytes() -> AsyncIterable[bytes]:
-    for line in message.splitlines():
-        yield line.encode("utf-8")
-
-
-@app.get("/story/stream-no-async-bytes", response_class=StreamingResponse)
-def stream_story_no_async_bytes() -> Iterable[bytes]:
-    for line in message.splitlines():
-        yield line.encode("utf-8")
-
-
-@app.get("/story/stream-no-annotation-bytes", response_class=StreamingResponse)
-async def stream_story_no_annotation_bytes():
-    for line in message.splitlines():
-        yield line.encode("utf-8")
-
-
-@app.get("/story/stream-no-async-no-annotation-bytes", response_class=StreamingResponse)
-def stream_story_no_async_no_annotation_bytes():
-    for line in message.splitlines():
-        yield line.encode("utf-8")

docs_src/stream_data/tutorial002_py310.py

@@ -1,44 +0,0 @@
-import base64
-from collections.abc import AsyncIterable, Iterable
-from io import BytesIO
-
-from fastapi import FastAPI
-from fastapi.responses import StreamingResponse
-
-image_base64 = "iVBORw0KGgoAAAANSUhEUgAAAB0AAAAdCAYAAABWk2cPAAAAbnpUWHRSYXcgcHJvZmlsZSB0eXBlIGV4aWYAAHjadYzRDYAwCET/mcIRDoq0jGOiJm7g+NJK0vjhS4DjIEfHfZ20DKqSrrWZmyFQV5ctRMOLACxglNCcXk7zVqFzJzF8kV6R5vOJ97yVH78HjfYAtg0ged033ZgAAAoCaVRYdFhNTDpjb20uYWRvYmUueG1wAAAAAAA8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/Pgo8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJYTVAgQ29yZSA0LjQuMC1FeGl2MiI+CiA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPgogIDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiCiAgICB4bWxuczpleGlmPSJodHRwOi8vbnMuYWRvYmUuY29tL2V4aWYvMS4wLyIKICAgIHhtbG5zOnRpZmY9Imh0dHA6Ly9ucy5hZG9iZS5jb20vdGlmZi8xLjAvIgogICBleGlmOlBpeGVsWERpbWVuc2lvbj0iMjkiCiAgIGV4aWY6UGl4ZWxZRGltZW5zaW9uPSIyOSIKICAgdGlmZjpJbWFnZVdpZHRoPSIyOSIKICAgdGlmZjpJbWFnZUxlbmd0aD0iMjkiCiAgIHRpZmY6T3JpZW50YXRpb249IjEiLz4KIDwvcmRmOlJERj4KPC94OnhtcG1ldGE+CiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAKPD94cGFja2V0IGVuZD0idyI/PnQkBZAAAAAEc0JJVAgICAh8CGSIAAABoklEQVRIx8VXwY7FIAjE5iXWU+P/f6RHPNW9LIaOoHYP+0yMShVkwNGG1lqjfy4HfaF0oyEEt+oSQqBaa//m9Wd6PlqhhbRMDiEQM3e59FNKw5qZHpnQfuPaW6lazsztvu/eElFj5j63lNLlMz2ttbZtVMu1MTGo5Sujn93gMzOllKiUQjHGB9QxxneZhJ5iwZ1rL2fwenoGeL0q3wVGhBPHMz0PeFccIfASEeWcO8xEROd50q6eAV6s1s5XXoncas1EKqVQznnwUBdJJmm1l3hmmdlOMrGO8Vl5gZ56Y0y8IZF0BuqkQWM4B6HXrRCKa1SEqyzEo7KK59RT/VHDjX3ZvSefeW3CO6O6vsiA1NrwVkxxAcYTCcHyTjZmJd00pugBQoTnzjvn+kzLBh9GtRDjhleZFwbx3kugP3GvFzdkqRlbDYw0u/HxKjuOw2QxZCGL5V5f4l7cd6qsffUa1DcLM9N1XcTMvep5ul1e4jNPtZfWGIkE6dI8MquXg/dS2CGVJQ2ushd5GmlxFdOw+1tRa32MY4zDQ9yaZ60J3/iX+QG4U3qGrFHmswAAAABJRU5ErkJggg=="
-binary_image = base64.b64decode(image_base64)
-
-
-def read_image() -> BytesIO:
-    return BytesIO(binary_image)
-
-
-app = FastAPI()
-
-
-class PNGStreamingResponse(StreamingResponse):
-    media_type = "image/png"
-
-
-@app.get("/image/stream", response_class=PNGStreamingResponse)
-async def stream_image() -> AsyncIterable[bytes]:
-    for chunk in read_image():
-        yield chunk
-
-
-@app.get("/image/stream-no-async", response_class=PNGStreamingResponse)
-def stream_image_no_async() -> Iterable[bytes]:
-    for chunk in read_image():
-        yield chunk
-
-
-@app.get("/image/stream-no-annotation", response_class=PNGStreamingResponse)
-async def stream_image_no_annotation():
-    for chunk in read_image():
-        yield chunk
-
-
-@app.get("/image/stream-no-async-no-annotation", response_class=PNGStreamingResponse)
-def stream_image_no_async_no_annotation():
-    for chunk in read_image():
-        yield chunk

docs_src/stream_json_lines/tutorial001_py310.py

@@ -1,42 +0,0 @@
-from collections.abc import AsyncIterable, Iterable
-
-from fastapi import FastAPI
-from pydantic import BaseModel
-
-app = FastAPI()
-
-
-class Item(BaseModel):
-    name: str
-    description: str | None
-
-
-items = [
-    Item(name="Plumbus", description="A multi-purpose household device."),
-    Item(name="Portal Gun", description="A portal opening device."),
-    Item(name="Meeseeks Box", description="A box that summons a Meeseeks."),
-]
-
-
-@app.get("/items/stream")
-async def stream_items() -> AsyncIterable[Item]:
-    for item in items:
-        yield item
-
-
-@app.get("/items/stream-no-async")
-def stream_items_no_async() -> Iterable[Item]:
-    for item in items:
-        yield item
-
-
-@app.get("/items/stream-no-annotation")
-async def stream_items_no_annotation():
-    for item in items:
-        yield item
-
-
-@app.get("/items/stream-no-async-no-annotation")
-def stream_items_no_async_no_annotation():
-    for item in items:
-        yield item

fastapi/dependencies/utils.py

@@ -1,17 +1,7 @@
 import dataclasses
 import inspect
 import sys
-from collections.abc import (
-    AsyncGenerator,
-    AsyncIterable,
-    AsyncIterator,
-    Callable,
-    Generator,
-    Iterable,
-    Iterator,
-    Mapping,
-    Sequence,
-)
+from collections.abc import Callable, Mapping, Sequence
 from contextlib import AsyncExitStack, contextmanager
 from copy import copy, deepcopy
 from dataclasses import dataclass
@@ -261,26 +251,6 @@ def get_typed_return_annotation(call: Callable[..., Any]) -> Any:
     return get_typed_annotation(annotation, globalns)
 
 
-_STREAM_ORIGINS = {
-    AsyncIterable,
-    AsyncIterator,
-    AsyncGenerator,
-    Iterable,
-    Iterator,
-    Generator,
-}
-
-
-def get_stream_item_type(annotation: Any) -> Any | None:
-    origin = get_origin(annotation)
-    if origin is not None and origin in _STREAM_ORIGINS:
-        type_args = get_args(annotation)
-        if type_args:
-            return type_args[0]
-        return Any
-    return None
-
-
 def get_dependant(
     *,
     path: str,

fastapi/openapi/utils.py

@@ -355,40 +355,25 @@ def get_openapi_path(
             operation.setdefault("responses", {}).setdefault(status_code, {})[
                 "description"
             ] = route.response_description
-            if is_body_allowed_for_status_code(route.status_code):
-                # Check for JSONL streaming (generator endpoints)
-                if route.is_json_stream:
-                    jsonl_content: dict[str, Any] = {}
-                    if route.stream_item_field:
-                        item_schema = get_schema_from_model_field(
-                            field=route.stream_item_field,
+            if route_response_media_type and is_body_allowed_for_status_code(
+                route.status_code
+            ):
+                response_schema = {"type": "string"}
+                if lenient_issubclass(current_response_class, JSONResponse):
+                    if route.response_field:
+                        response_schema = get_schema_from_model_field(
+                            field=route.response_field,
                             model_name_map=model_name_map,
                             field_mapping=field_mapping,
                             separate_input_output_schemas=separate_input_output_schemas,
                         )
-                        jsonl_content["itemSchema"] = item_schema
                     else:
-                        jsonl_content["itemSchema"] = {}
-                    operation.setdefault("responses", {}).setdefault(
-                        status_code, {}
-                    ).setdefault("content", {})["application/jsonl"] = jsonl_content
-                elif route_response_media_type:
-                    response_schema = {"type": "string"}
-                    if lenient_issubclass(current_response_class, JSONResponse):
-                        if route.response_field:
-                            response_schema = get_schema_from_model_field(
-                                field=route.response_field,
-                                model_name_map=model_name_map,
-                                field_mapping=field_mapping,
-                                separate_input_output_schemas=separate_input_output_schemas,
-                            )
-                        else:
-                            response_schema = {}
-                    operation.setdefault("responses", {}).setdefault(
-                        status_code, {}
-                    ).setdefault("content", {}).setdefault(
-                        route_response_media_type, {}
-                    )["schema"] = response_schema
+                        response_schema = {}
+                operation.setdefault("responses", {}).setdefault(
+                    status_code, {}
+                ).setdefault("content", {}).setdefault(route_response_media_type, {})[
+                    "schema"
+                ] = response_schema
             if route.responses:
                 operation_responses = operation.setdefault("responses", {})
                 for (
@@ -468,9 +453,9 @@ def get_fields_from_routes(
     request_fields_from_routes: list[ModelField] = []
     callback_flat_models: list[ModelField] = []
     for route in routes:
-        if not isinstance(route, routing.APIRoute):
-            continue
-        if route.include_in_schema:
+        if getattr(route, "include_in_schema", None) and isinstance(
+            route, routing.APIRoute
+        ):
             if route.body_field:
                 assert isinstance(route.body_field, ModelField), (
                     "A request body must be a Pydantic Field"
@@ -480,8 +465,6 @@ def get_fields_from_routes(
                 responses_from_routes.append(route.response_field)
             if route.response_fields:
                 responses_from_routes.extend(route.response_fields.values())
-            if route.stream_item_field:
-                responses_from_routes.append(route.stream_item_field)
             if route.callbacks:
                 callback_flat_models.extend(get_fields_from_routes(route.callbacks))
             params = get_flat_params(route.dependant)

fastapi/routing.py

@@ -11,7 +11,6 @@ from collections.abc import (
     Collection,
     Coroutine,
     Generator,
-    Iterator,
     Mapping,
     Sequence,
 )
@@ -28,7 +27,6 @@ from typing import (
     TypeVar,
 )
 
-import anyio
 from annotated_doc import Doc
 from fastapi import params
 from fastapi._compat import (
@@ -44,7 +42,6 @@ from fastapi.dependencies.utils import (
     get_dependant,
     get_flat_dependant,
     get_parameterless_sub_dependant,
-    get_stream_item_type,
     get_typed_return_annotation,
     solve_dependencies,
 )
@@ -69,7 +66,7 @@ from starlette._utils import is_async_callable
 from starlette.concurrency import run_in_threadpool
 from starlette.exceptions import HTTPException
 from starlette.requests import Request
-from starlette.responses import JSONResponse, Response, StreamingResponse
+from starlette.responses import JSONResponse, Response
 from starlette.routing import (
     BaseRoute,
     Match,
@@ -318,24 +315,6 @@ async def run_endpoint_function(
         return await run_in_threadpool(dependant.call, **values)
 
 
-def _build_response_args(
-    *, status_code: int | None, solved_result: Any
-) -> dict[str, Any]:
-    response_args: dict[str, Any] = {
-        "background": solved_result.background_tasks,
-    }
-    # If status_code was set, use it, otherwise use the default from the
-    # response class, in the case of redirect it's 307
-    current_status_code = (
-        status_code if status_code else solved_result.response.status_code
-    )
-    if current_status_code is not None:
-        response_args["status_code"] = current_status_code
-    if solved_result.response.status_code:
-        response_args["status_code"] = solved_result.response.status_code
-    return response_args
-
-
 def get_request_handler(
     dependant: Dependant,
     body_field: ModelField | None = None,
@@ -351,8 +330,6 @@ def get_request_handler(
     dependency_overrides_provider: Any | None = None,
     embed_body_fields: bool = False,
     strict_content_type: bool | DefaultPlaceholder = Default(True),
-    stream_item_field: ModelField | None = None,
-    is_json_stream: bool = False,
 ) -> Callable[[Request], Coroutine[Any, Any, Response]]:
     assert dependant.call is not None, "dependant.call must be a function"
     is_coroutine = dependant.is_coroutine_callable
@@ -450,130 +427,61 @@ def get_request_handler(
             embed_body_fields=embed_body_fields,
         )
         errors = solved_result.errors
-        assert dependant.call  # For types
         if not errors:
-            if is_json_stream:
-                # Generator endpoint: stream as JSONL
-                gen = dependant.call(**solved_result.values)
-
-                def _serialize_item(item: Any) -> bytes:
-                    if stream_item_field:
-                        value, errors = stream_item_field.validate(
-                            item, {}, loc=("response",)
-                        )
-                        if errors:
-                            ctx = endpoint_ctx or EndpointContext()
-                            raise ResponseValidationError(
-                                errors=errors,
-                                body=item,
-                                endpoint_ctx=ctx,
-                            )
-                        line = stream_item_field.serialize_json(
-                            value,
-                            include=response_model_include,
-                            exclude=response_model_exclude,
-                            by_alias=response_model_by_alias,
-                            exclude_unset=response_model_exclude_unset,
-                            exclude_defaults=response_model_exclude_defaults,
-                            exclude_none=response_model_exclude_none,
-                        )
-                        return line + b"\n"
-                    else:
-                        data = jsonable_encoder(item)
-                        return json.dumps(data).encode("utf-8") + b"\n"
-
-                if dependant.is_async_gen_callable:
-
-                    async def _async_stream_jsonl() -> AsyncIterator[bytes]:
-                        async for item in gen:
-                            yield _serialize_item(item)
-                            # To allow for cancellation to trigger
-                            # Ref: https://github.com/fastapi/fastapi/issues/14680
-                            await anyio.sleep(0)
-
-                    stream_content: AsyncIterator[bytes] | Iterator[bytes] = (
-                        _async_stream_jsonl()
-                    )
-                else:
-
-                    def _sync_stream_jsonl() -> Iterator[bytes]:
-                        for item in gen:
-                            yield _serialize_item(item)
-
-                    stream_content = _sync_stream_jsonl()
-
-                response = StreamingResponse(
-                    stream_content,
-                    media_type="application/jsonl",
-                    background=solved_result.background_tasks,
-                )
-                response.headers.raw.extend(solved_result.response.headers.raw)
-            elif dependant.is_async_gen_callable or dependant.is_gen_callable:
-                # Raw streaming with explicit response_class (e.g. StreamingResponse)
-                gen = dependant.call(**solved_result.values)
-                if dependant.is_async_gen_callable:
-
-                    async def _async_stream_raw(
-                        async_gen: AsyncIterator[Any],
-                    ) -> AsyncIterator[Any]:
-                        async for chunk in async_gen:
-                            yield chunk
-                            # To allow for cancellation to trigger
-                            # Ref: https://github.com/fastapi/fastapi/issues/14680
-                            await anyio.sleep(0)
-
-                    gen = _async_stream_raw(gen)
-                response_args = _build_response_args(
-                    status_code=status_code, solved_result=solved_result
-                )
-                response = actual_response_class(content=gen, **response_args)
-                response.headers.raw.extend(solved_result.response.headers.raw)
+            raw_response = await run_endpoint_function(
+                dependant=dependant,
+                values=solved_result.values,
+                is_coroutine=is_coroutine,
+            )
+            if isinstance(raw_response, Response):
+                if raw_response.background is None:
+                    raw_response.background = solved_result.background_tasks
+                response = raw_response
             else:
-                raw_response = await run_endpoint_function(
-                    dependant=dependant,
-                    values=solved_result.values,
-                    is_coroutine=is_coroutine,
+                response_args: dict[str, Any] = {
+                    "background": solved_result.background_tasks
+                }
+                # If status_code was set, use it, otherwise use the default from the
+                # response class, in the case of redirect it's 307
+                current_status_code = (
+                    status_code if status_code else solved_result.response.status_code
                 )
-                if isinstance(raw_response, Response):
-                    if raw_response.background is None:
-                        raw_response.background = solved_result.background_tasks
-                    response = raw_response
+                if current_status_code is not None:
+                    response_args["status_code"] = current_status_code
+                if solved_result.response.status_code:
+                    response_args["status_code"] = solved_result.response.status_code
+                # Use the fast path (dump_json) when no custom response
+                # class was set and a response field with a TypeAdapter
+                # exists. Serializes directly to JSON bytes via Pydantic's
+                # Rust core, skipping the intermediate Python dict +
+                # json.dumps() step.
+                use_dump_json = response_field is not None and isinstance(
+                    response_class, DefaultPlaceholder
+                )
+                content = await serialize_response(
+                    field=response_field,
+                    response_content=raw_response,
+                    include=response_model_include,
+                    exclude=response_model_exclude,
+                    by_alias=response_model_by_alias,
+                    exclude_unset=response_model_exclude_unset,
+                    exclude_defaults=response_model_exclude_defaults,
+                    exclude_none=response_model_exclude_none,
+                    is_coroutine=is_coroutine,
+                    endpoint_ctx=endpoint_ctx,
+                    dump_json=use_dump_json,
+                )
+                if use_dump_json:
+                    response = Response(
+                        content=content,
+                        media_type="application/json",
+                        **response_args,
+                    )
                 else:
-                    response_args = _build_response_args(
-                        status_code=status_code, solved_result=solved_result
-                    )
-                    # Use the fast path (dump_json) when no custom response
-                    # class was set and a response field with a TypeAdapter
-                    # exists. Serializes directly to JSON bytes via Pydantic's
-                    # Rust core, skipping the intermediate Python dict +
-                    # json.dumps() step.
-                    use_dump_json = response_field is not None and isinstance(
-                        response_class, DefaultPlaceholder
-                    )
-                    content = await serialize_response(
-                        field=response_field,
-                        response_content=raw_response,
-                        include=response_model_include,
-                        exclude=response_model_exclude,
-                        by_alias=response_model_by_alias,
-                        exclude_unset=response_model_exclude_unset,
-                        exclude_defaults=response_model_exclude_defaults,
-                        exclude_none=response_model_exclude_none,
-                        is_coroutine=is_coroutine,
-                        endpoint_ctx=endpoint_ctx,
-                        dump_json=use_dump_json,
-                    )
-                    if use_dump_json:
-                        response = Response(
-                            content=content,
-                            media_type="application/json",
-                            **response_args,
-                        )
-                    else:
-                        response = actual_response_class(content, **response_args)
-                    if not is_body_allowed_for_status_code(response.status_code):
-                        response.body = b""
-                    response.headers.raw.extend(solved_result.response.headers.raw)
+                    response = actual_response_class(content, **response_args)
+                if not is_body_allowed_for_status_code(response.status_code):
+                    response.body = b""
+                response.headers.raw.extend(solved_result.response.headers.raw)
         if errors:
             validation_error = RequestValidationError(
                 errors, body=body, endpoint_ctx=endpoint_ctx
@@ -701,21 +609,12 @@ class APIRoute(routing.Route):
     ) -> None:
         self.path = path
         self.endpoint = endpoint
-        self.stream_item_type: Any | None = None
         if isinstance(response_model, DefaultPlaceholder):
             return_annotation = get_typed_return_annotation(endpoint)
             if lenient_issubclass(return_annotation, Response):
                 response_model = None
             else:
-                stream_item = get_stream_item_type(return_annotation)
-                if stream_item is not None:
-                    # Only extract item type for JSONL streaming when no
-                    # explicit response_class (e.g. StreamingResponse) was set
-                    if isinstance(response_class, DefaultPlaceholder):
-                        self.stream_item_type = stream_item
-                    response_model = None
-                else:
-                    response_model = return_annotation
+                response_model = return_annotation
         self.response_model = response_model
         self.summary = summary
         self.response_description = response_description
@@ -764,15 +663,6 @@ class APIRoute(routing.Route):
             )
         else:
             self.response_field = None  # type: ignore
-        if self.stream_item_type:
-            stream_item_name = "StreamItem_" + self.unique_id
-            self.stream_item_field: ModelField | None = create_model_field(
-                name=stream_item_name,
-                type_=self.stream_item_type,
-                mode="serialization",
-            )
-        else:
-            self.stream_item_field = None
         self.dependencies = list(dependencies or [])
         self.description = description or inspect.cleandoc(self.endpoint.__doc__ or "")
         # if a "form feed" character (page break) is found in the description text,
@@ -814,11 +704,6 @@ class APIRoute(routing.Route):
             name=self.unique_id,
             embed_body_fields=self._embed_body_fields,
         )
-        # Detect generator endpoints that should stream as JSONL
-        # (only when no explicit response_class like StreamingResponse is set)
-        self.is_json_stream = isinstance(response_class, DefaultPlaceholder) and (
-            self.dependant.is_async_gen_callable or self.dependant.is_gen_callable
-        )
         self.app = request_response(self.get_route_handler())
 
     def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:
@@ -837,8 +722,6 @@ class APIRoute(routing.Route):
             dependency_overrides_provider=self.dependency_overrides_provider,
             embed_body_fields=self._embed_body_fields,
             strict_content_type=self.strict_content_type,
-            stream_item_field=self.stream_item_field,
-            is_json_stream=self.is_json_stream,
         )
 
     def matches(self, scope: Scope) -> tuple[Match, Scope]:

pyproject.toml

@@ -42,7 +42,7 @@ classifiers = [
     "Topic :: Internet :: WWW/HTTP",
 ]
 dependencies = [
-    "starlette>=0.46.0",
+    "starlette>=0.40.0",
     "pydantic>=2.7.0",
     "typing-extensions>=4.8.0",
     "typing-inspection>=0.4.2",
@@ -321,9 +321,6 @@ ignore = [
 "docs_src/security/tutorial005_py310.py" = ["B904"]
 "docs_src/security/tutorial005_py39.py" = ["B904"]
 "docs_src/json_base64_bytes/tutorial001_py310.py" = ["UP012"]
-"docs_src/stream_json_lines/tutorial001_py310.py" = ["UP028"]
-"docs_src/stream_data/tutorial001_py310.py" = ["UP028"]
-"docs_src/stream_data/tutorial002_py310.py" = ["UP028"]
 
 [tool.ruff.lint.isort]
 known-third-party = ["fastapi", "pydantic", "starlette"]

tests/test_stream_bare_type.py

@@ -1,42 +0,0 @@
-import json
-from typing import AsyncIterable, Iterable  # noqa: UP035 to test coverage
-
-from fastapi import FastAPI
-from fastapi.testclient import TestClient
-from pydantic import BaseModel
-
-
-class Item(BaseModel):
-    name: str
-
-
-app = FastAPI()
-
-
-@app.get("/items/stream-bare-async")
-async def stream_bare_async() -> AsyncIterable:
-    yield {"name": "foo"}
-
-
-@app.get("/items/stream-bare-sync")
-def stream_bare_sync() -> Iterable:
-    yield {"name": "bar"}
-
-
-client = TestClient(app)
-
-
-def test_stream_bare_async_iterable():
-    response = client.get("/items/stream-bare-async")
-    assert response.status_code == 200
-    assert response.headers["content-type"] == "application/jsonl"
-    lines = [json.loads(line) for line in response.text.strip().splitlines()]
-    assert lines == [{"name": "foo"}]
-
-
-def test_stream_bare_sync_iterable():
-    response = client.get("/items/stream-bare-sync")
-    assert response.status_code == 200
-    assert response.headers["content-type"] == "application/jsonl"
-    lines = [json.loads(line) for line in response.text.strip().splitlines()]
-    assert lines == [{"name": "bar"}]

tests/test_stream_cancellation.py

@@ -1,88 +0,0 @@
-"""
-Test that async streaming endpoints can be cancelled without hanging.
-
-Ref: https://github.com/fastapi/fastapi/issues/14680
-"""
-
-from collections.abc import AsyncIterable
-
-import anyio
-import pytest
-from fastapi import FastAPI
-from fastapi.responses import StreamingResponse
-
-pytestmark = [
-    pytest.mark.anyio,
-    pytest.mark.filterwarnings("ignore::pytest.PytestUnraisableExceptionWarning"),
-]
-
-
-app = FastAPI()
-
-
-@app.get("/stream-raw", response_class=StreamingResponse)
-async def stream_raw() -> AsyncIterable[str]:
-    """Async generator with no internal await - would hang without checkpoint."""
-    i = 0
-    while True:
-        yield f"item {i}\n"
-        i += 1
-
-
-@app.get("/stream-jsonl")
-async def stream_jsonl() -> AsyncIterable[int]:
-    """JSONL async generator with no internal await."""
-    i = 0
-    while True:
-        yield i
-        i += 1
-
-
-async def _run_asgi_and_cancel(app: FastAPI, path: str, timeout: float) -> bool:
-    """Call the ASGI app for *path* and cancel after *timeout* seconds.
-
-    Returns `True` if the cancellation was delivered (i.e. it did not hang).
-    """
-    chunks: list[bytes] = []
-
-    async def receive():  # type: ignore[no-untyped-def]
-        # Simulate a client that never disconnects, rely on cancellation
-        await anyio.sleep(float("inf"))
-        return {"type": "http.disconnect"}
-
-    async def send(message: dict) -> None:  # type: ignore[type-arg]
-        if message["type"] == "http.response.body":
-            chunks.append(message.get("body", b""))
-
-    scope = {
-        "type": "http",
-        "asgi": {"version": "3.0", "spec_version": "2.0"},
-        "http_version": "1.1",
-        "method": "GET",
-        "path": path,
-        "query_string": b"",
-        "root_path": "",
-        "headers": [],
-        "server": ("test", 80),
-    }
-
-    with anyio.move_on_after(timeout) as cancel_scope:
-        await app(scope, receive, send)  # type: ignore[arg-type]
-
-    # If we got here within the timeout the generator was cancellable.
-    # cancel_scope.cancelled_caught is True when move_on_after fired.
-    return cancel_scope.cancelled_caught or len(chunks) > 0
-
-
-async def test_raw_stream_cancellation() -> None:
-    """Raw streaming endpoint should be cancellable within a reasonable time."""
-    cancelled = await _run_asgi_and_cancel(app, "/stream-raw", timeout=3.0)
-    # The key assertion: we reached this line at all (didn't hang).
-    # cancelled will be True because the infinite generator was interrupted.
-    assert cancelled
-
-
-async def test_jsonl_stream_cancellation() -> None:
-    """JSONL streaming endpoint should be cancellable within a reasonable time."""
-    cancelled = await _run_asgi_and_cancel(app, "/stream-jsonl", timeout=3.0)
-    assert cancelled

tests/test_stream_json_validation_error.py

@@ -1,40 +0,0 @@
-from collections.abc import AsyncIterable, Iterable
-
-import pytest
-from fastapi import FastAPI
-from fastapi.exceptions import ResponseValidationError
-from fastapi.testclient import TestClient
-from pydantic import BaseModel
-
-
-class Item(BaseModel):
-    name: str
-    price: float
-
-
-app = FastAPI()
-
-
-@app.get("/items/stream-invalid")
-async def stream_items_invalid() -> AsyncIterable[Item]:
-    yield {"name": "valid", "price": 1.0}
-    yield {"name": "invalid", "price": "not-a-number"}
-
-
-@app.get("/items/stream-invalid-sync")
-def stream_items_invalid_sync() -> Iterable[Item]:
-    yield {"name": "valid", "price": 1.0}
-    yield {"name": "invalid", "price": "not-a-number"}
-
-
-client = TestClient(app)
-
-
-def test_stream_json_validation_error_async():
-    with pytest.raises(ResponseValidationError):
-        client.get("/items/stream-invalid")
-
-
-def test_stream_json_validation_error_sync():
-    with pytest.raises(ResponseValidationError):
-        client.get("/items/stream-invalid-sync")

tests/test_tutorial/test_stream_data/test_tutorial001.py

@@ -1,154 +0,0 @@
-import importlib
-
-import pytest
-from fastapi.testclient import TestClient
-from inline_snapshot import snapshot
-
-
-@pytest.fixture(
-    name="client",
-    params=[
-        pytest.param("tutorial001_py310"),
-    ],
-)
-def get_client(request: pytest.FixtureRequest):
-    mod = importlib.import_module(f"docs_src.stream_data.{request.param}")
-
-    client = TestClient(mod.app)
-    return client
-
-
-expected_text = (
-    ""
-    "Rick: (stumbles in drunkenly, and turns on the lights)"
-    " Morty! You gotta come on. You got--... you gotta come with me."
-    "Morty: (rubs his eyes) What, Rick? What's going on?"
-    "Rick: I got a surprise for you, Morty."
-    "Morty: It's the middle of the night. What are you talking about?"
-    "Rick: (spills alcohol on Morty's bed) Come on, I got a surprise for you."
-    " (drags Morty by the ankle) Come on, hurry up."
-    " (pulls Morty out of his bed and into the hall)"
-    "Morty: Ow! Ow! You're tugging me too hard!"
-    "Rick: We gotta go, gotta get outta here, come on."
-    " Got a surprise for you Morty."
-)
-
-
-@pytest.mark.parametrize(
-    "path",
-    [
-        "/story/stream",
-        "/story/stream-no-async",
-        "/story/stream-no-annotation",
-        "/story/stream-no-async-no-annotation",
-        "/story/stream-bytes",
-        "/story/stream-no-async-bytes",
-        "/story/stream-no-annotation-bytes",
-        "/story/stream-no-async-no-annotation-bytes",
-    ],
-)
-def test_stream_story(client: TestClient, path: str):
-    response = client.get(path)
-    assert response.status_code == 200, response.text
-    assert response.text == expected_text
-
-
-def test_openapi_schema(client: TestClient):
-    response = client.get("/openapi.json")
-    assert response.status_code == 200, response.text
-    assert response.json() == snapshot(
-        {
-            "openapi": "3.1.0",
-            "info": {"title": "FastAPI", "version": "0.1.0"},
-            "paths": {
-                "/story/stream": {
-                    "get": {
-                        "summary": "Stream Story",
-                        "operationId": "stream_story_story_stream_get",
-                        "responses": {
-                            "200": {
-                                "description": "Successful Response",
-                            }
-                        },
-                    }
-                },
-                "/story/stream-no-async": {
-                    "get": {
-                        "summary": "Stream Story No Async",
-                        "operationId": "stream_story_no_async_story_stream_no_async_get",
-                        "responses": {
-                            "200": {
-                                "description": "Successful Response",
-                            }
-                        },
-                    }
-                },
-                "/story/stream-no-annotation": {
-                    "get": {
-                        "summary": "Stream Story No Annotation",
-                        "operationId": "stream_story_no_annotation_story_stream_no_annotation_get",
-                        "responses": {
-                            "200": {
-                                "description": "Successful Response",
-                            }
-                        },
-                    }
-                },
-                "/story/stream-no-async-no-annotation": {
-                    "get": {
-                        "summary": "Stream Story No Async No Annotation",
-                        "operationId": "stream_story_no_async_no_annotation_story_stream_no_async_no_annotation_get",
-                        "responses": {
-                            "200": {
-                                "description": "Successful Response",
-                            }
-                        },
-                    }
-                },
-                "/story/stream-bytes": {
-                    "get": {
-                        "summary": "Stream Story Bytes",
-                        "operationId": "stream_story_bytes_story_stream_bytes_get",
-                        "responses": {
-                            "200": {
-                                "description": "Successful Response",
-                            }
-                        },
-                    }
-                },
-                "/story/stream-no-async-bytes": {
-                    "get": {
-                        "summary": "Stream Story No Async Bytes",
-                        "operationId": "stream_story_no_async_bytes_story_stream_no_async_bytes_get",
-                        "responses": {
-                            "200": {
-                                "description": "Successful Response",
-                            }
-                        },
-                    }
-                },
-                "/story/stream-no-annotation-bytes": {
-                    "get": {
-                        "summary": "Stream Story No Annotation Bytes",
-                        "operationId": "stream_story_no_annotation_bytes_story_stream_no_annotation_bytes_get",
-                        "responses": {
-                            "200": {
-                                "description": "Successful Response",
-                            }
-                        },
-                    }
-                },
-                "/story/stream-no-async-no-annotation-bytes": {
-                    "get": {
-                        "summary": "Stream Story No Async No Annotation Bytes",
-                        "operationId": "stream_story_no_async_no_annotation_bytes_story_stream_no_async_no_annotation_bytes_get",
-                        "responses": {
-                            "200": {
-                                "description": "Successful Response",
-                            }
-                        },
-                    }
-                },
-            },
-        }
-    )

tests/test_tutorial/test_stream_data/test_tutorial002.py

@@ -1,106 +0,0 @@
-import importlib
-
-import pytest
-from fastapi.testclient import TestClient
-from inline_snapshot import snapshot
-
-
-@pytest.fixture(
-    name="mod",
-    params=[
-        pytest.param("tutorial002_py310"),
-    ],
-)
-def get_mod(request: pytest.FixtureRequest):
-    return importlib.import_module(f"docs_src.stream_data.{request.param}")
-
-
-@pytest.fixture(name="client")
-def get_client(mod):
-    client = TestClient(mod.app)
-    return client
-
-
-@pytest.mark.parametrize(
-    "path",
-    [
-        "/image/stream",
-        "/image/stream-no-async",
-        "/image/stream-no-annotation",
-        "/image/stream-no-async-no-annotation",
-    ],
-)
-def test_stream_image(mod, client: TestClient, path: str):
-    response = client.get(path)
-    assert response.status_code == 200
-    assert response.headers["content-type"] == "image/png"
-    assert response.content == mod.binary_image
-
-
-def test_openapi_schema(client: TestClient):
-    response = client.get("/openapi.json")
-    assert response.status_code == 200, response.text
-    assert response.json() == snapshot(
-        {
-            "openapi": "3.1.0",
-            "info": {"title": "FastAPI", "version": "0.1.0"},
-            "paths": {
-                "/image/stream": {
-                    "get": {
-                        "summary": "Stream Image",
-                        "operationId": "stream_image_image_stream_get",
-                        "responses": {
-                            "200": {
-                                "description": "Successful Response",
-                                "content": {
-                                    "image/png": {"schema": {"type": "string"}}
-                                },
-                            }
-                        },
-                    }
-                },
-                "/image/stream-no-async": {
-                    "get": {
-                        "summary": "Stream Image No Async",
-                        "operationId": "stream_image_no_async_image_stream_no_async_get",
-                        "responses": {
-                            "200": {
-                                "description": "Successful Response",
-                                "content": {
-                                    "image/png": {"schema": {"type": "string"}}
-                                },
-                            }
-                        },
-                    }
-                },
-                "/image/stream-no-annotation": {
-                    "get": {
-                        "summary": "Stream Image No Annotation",
-                        "operationId": "stream_image_no_annotation_image_stream_no_annotation_get",
-                        "responses": {
-                            "200": {
-                                "description": "Successful Response",
-                                "content": {
-                                    "image/png": {"schema": {"type": "string"}}
-                                },
-                            }
-                        },
-                    }
-                },
-                "/image/stream-no-async-no-annotation": {
-                    "get": {
-                        "summary": "Stream Image No Async No Annotation",
-                        "operationId": "stream_image_no_async_no_annotation_image_stream_no_async_no_annotation_get",
-                        "responses": {
-                            "200": {
-                                "description": "Successful Response",
-                                "content": {
-                                    "image/png": {"schema": {"type": "string"}}
-                                },
-                            }
-                        },
-                    }
-                },
-            },
-        }
-    )

tests/test_tutorial/test_stream_json_lines/test_tutorial001.py

@@ -1,143 +0,0 @@
-import importlib
-import json
-
-import pytest
-from fastapi.testclient import TestClient
-from inline_snapshot import snapshot
-
-
-@pytest.fixture(
-    name="client",
-    params=[
-        pytest.param("tutorial001_py310"),
-    ],
-)
-def get_client(request: pytest.FixtureRequest):
-    mod = importlib.import_module(f"docs_src.stream_json_lines.{request.param}")
-
-    client = TestClient(mod.app)
-    return client
-
-
-expected_items = [
-    {"name": "Plumbus", "description": "A multi-purpose household device."},
-    {"name": "Portal Gun", "description": "A portal opening device."},
-    {"name": "Meeseeks Box", "description": "A box that summons a Meeseeks."},
-]
-
-
-@pytest.mark.parametrize(
-    "path",
-    [
-        "/items/stream",
-        "/items/stream-no-async",
-        "/items/stream-no-annotation",
-        "/items/stream-no-async-no-annotation",
-    ],
-)
-def test_stream_items(client: TestClient, path: str):
-    response = client.get(path)
-    assert response.status_code == 200, response.text
-    assert response.headers["content-type"] == "application/jsonl"
-    lines = [json.loads(line) for line in response.text.strip().splitlines()]
-    assert lines == expected_items
-
-
-def test_openapi_schema(client: TestClient):
-    response = client.get("/openapi.json")
-    assert response.status_code == 200, response.text
-    assert response.json() == snapshot(
-        {
-            "openapi": "3.1.0",
-            "info": {"title": "FastAPI", "version": "0.1.0"},
-            "paths": {
-                "/items/stream": {
-                    "get": {
-                        "responses": {
-                            "200": {
-                                "description": "Successful Response",
-                                "content": {
-                                    "application/jsonl": {
-                                        "itemSchema": {
-                                            "$ref": "#/components/schemas/Item"
-                                        },
-                                    }
-                                },
-                            }
-                        },
-                        "summary": "Stream Items",
-                        "operationId": "stream_items_items_stream_get",
-                    }
-                },
-                "/items/stream-no-async": {
-                    "get": {
-                        "responses": {
-                            "200": {
-                                "description": "Successful Response",
-                                "content": {
-                                    "application/jsonl": {
-                                        "itemSchema": {
-                                            "$ref": "#/components/schemas/Item"
-                                        },
-                                    }
-                                },
-                            }
-                        },
-                        "summary": "Stream Items No Async",
-                        "operationId": "stream_items_no_async_items_stream_no_async_get",
-                    }
-                },
-                "/items/stream-no-annotation": {
-                    "get": {
-                        "responses": {
-                            "200": {
-                                "description": "Successful Response",
-                                "content": {
-                                    "application/jsonl": {
-                                        "itemSchema": {},
-                                    }
-                                },
-                            }
-                        },
-                        "summary": "Stream Items No Annotation",
-                        "operationId": "stream_items_no_annotation_items_stream_no_annotation_get",
-                    }
-                },
-                "/items/stream-no-async-no-annotation": {
-                    "get": {
-                        "responses": {
-                            "200": {
-                                "description": "Successful Response",
-                                "content": {
-                                    "application/jsonl": {
-                                        "itemSchema": {},
-                                    }
-                                },
-                            }
-                        },
-                        "summary": "Stream Items No Async No Annotation",
-                        "operationId": "stream_items_no_async_no_annotation_items_stream_no_async_no_annotation_get",
-                    }
-                },
-            },
-            "components": {
-                "schemas": {
-                    "Item": {
-                        "properties": {
-                            "name": {"type": "string", "title": "Name"},
-                            "description": {
-                                "anyOf": [
-                                    {"type": "string"},
-                                    {"type": "null"},
-                                ],
-                                "title": "Description",
-                            },
-                        },
-                        "type": "object",
-                        "required": ["name", "description"],
-                        "title": "Item",
-                    }
-                }
-            },
-        }
-    )

tests/test_tutorial/test_websockets/test_tutorial001.py

@@ -2,7 +2,7 @@ import pytest
 from fastapi.testclient import TestClient
 from fastapi.websockets import WebSocketDisconnect
 
-from docs_src.websockets_.tutorial001_py310 import app
+from docs_src.websockets.tutorial001_py310 import app
 
 client = TestClient(app)
 

tests/test_tutorial/test_websockets/test_tutorial002.py

@@ -16,7 +16,7 @@ from ...utils import needs_py310
     ],
 )
 def get_app(request: pytest.FixtureRequest):
-    mod = importlib.import_module(f"docs_src.websockets_.{request.param}")
+    mod = importlib.import_module(f"docs_src.websockets.{request.param}")
 
     return mod.app
 

tests/test_tutorial/test_websockets/test_tutorial003.py

@@ -13,7 +13,7 @@ from fastapi.testclient import TestClient
     ],
 )
 def get_mod(request: pytest.FixtureRequest):
-    mod = importlib.import_module(f"docs_src.websockets_.{request.param}")
+    mod = importlib.import_module(f"docs_src.websockets.{request.param}")
 
     return mod
 

uv.lock

@@ -1259,7 +1259,7 @@ requires-dist = [
     { name = "python-multipart", marker = "extra == 'standard'", specifier = ">=0.0.18" },
     { name = "python-multipart", marker = "extra == 'standard-no-fastapi-cloud-cli'", specifier = ">=0.0.18" },
     { name = "pyyaml", marker = "extra == 'all'", specifier = ">=5.3.1" },
-    { name = "starlette", specifier = ">=0.46.0" },
+    { name = "starlette", specifier = ">=0.40.0" },
     { name = "typing-extensions", specifier = ">=4.8.0" },
     { name = "typing-inspection", specifier = ">=0.4.2" },
     { name = "uvicorn", extras = ["standard"], marker = "extra == 'all'", specifier = ">=0.12.0" },