Search Options

Display Count
Sort
Preferred Language
Advanced Search

Results 1 - 10 of 79 for response_class (0.1 seconds)

  1. fastapi/routing.py

        is_coroutine = dependant.is_coroutine_callable
        is_body_form = body_field and isinstance(body_field.field_info, params.Form)
        if isinstance(response_class, DefaultPlaceholder):
            actual_response_class: type[Response] = response_class.value
        else:
            actual_response_class = response_class
        is_sse_stream = lenient_issubclass(actual_response_class, EventSourceResponse)
        if isinstance(strict_content_type, DefaultPlaceholder):
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sun Mar 15 11:44:39 GMT 2026
    - 193K bytes
    - Click Count (0)
  2. docs_src/stream_data/tutorial002_py310.py

    class PNGStreamingResponse(StreamingResponse):
        media_type = "image/png"
    
    
    @app.get("/image/stream", response_class=PNGStreamingResponse)
    async def stream_image() -> AsyncIterable[bytes]:
        with read_image() as image_file:
            for chunk in image_file:
                yield chunk
    
    
    @app.get("/image/stream-no-async", response_class=PNGStreamingResponse)
    def stream_image_no_async() -> Iterable[bytes]:
        with read_image() as image_file:
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Feb 27 20:51:40 GMT 2026
    - 5.6K bytes
    - Click Count (0)
  3. tests/test_sse.py

    ]
    
    
    app = FastAPI()
    
    
    @app.get("/items/stream", response_class=EventSourceResponse)
    async def sse_items() -> AsyncIterable[Item]:
        for item in items:
            yield item
    
    
    @app.get("/items/stream-sync", response_class=EventSourceResponse)
    def sse_items_sync() -> Iterable[Item]:
        yield from items
    
    
    @app.get("/items/stream-no-annotation", response_class=EventSourceResponse)
    async def sse_items_no_annotation():
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sun Mar 01 09:21:52 GMT 2026
    - 9.8K bytes
    - Click Count (0)
  4. fastapi/.agents/skills/fastapi/references/streaming.md

    ## Stream bytes
    
    To stream bytes, declare a `response_class=` of `StreamingResponse` or a sub-class, and use `yield` to return the data.
    
    ```python
    from fastapi import FastAPI
    from fastapi.responses import StreamingResponse
    from app.utils import read_image
    
    app = FastAPI()
    
    
    class PNGStreamingResponse(StreamingResponse):
        media_type = "image/png"
    
    @app.get("/image", response_class=PNGStreamingResponse)
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sun Mar 01 10:05:57 GMT 2026
    - 2.5K bytes
    - Click Count (0)
  5. docs_src/stream_data/tutorial001_py310.py

    @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)
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Feb 27 18:56:47 GMT 2026
    - 2.2K bytes
    - Click Count (0)
  6. docs/en/docs/advanced/custom-response.md

    {* ../../docs_src/response_model/tutorial001_01_py310.py ln[15:17] hl[16] *}
    
    ## HTML Response { #html-response }
    
    To return a response with HTML directly from **FastAPI**, use `HTMLResponse`.
    
    * Import `HTMLResponse`.
    * Pass `HTMLResponse` as the parameter `response_class` of your *path operation decorator*.
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 05 18:13:19 GMT 2026
    - 11K bytes
    - Click Count (0)
  7. docs_src/server_sent_events/tutorial001_py310.py

    ]
    
    
    @app.get("/items/stream", response_class=EventSourceResponse)
    async def sse_items() -> AsyncIterable[Item]:
        for item in items:
            yield item
    
    
    @app.get("/items/stream-no-async", response_class=EventSourceResponse)
    def sse_items_no_async() -> Iterable[Item]:
        for item in items:
            yield item
    
    
    @app.get("/items/stream-no-annotation", response_class=EventSourceResponse)
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sun Mar 01 09:21:52 GMT 2026
    - 1.1K bytes
    - Click Count (0)
  8. docs_src/custom_response/tutorial009c_py310.py

        def render(self, content: Any) -> bytes:
            assert orjson is not None, "orjson must be installed"
            return orjson.dumps(content, option=orjson.OPT_INDENT_2)
    
    
    @app.get("/", response_class=CustomORJSONResponse)
    async def main():
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Feb 12 13:19:43 GMT 2026
    - 451 bytes
    - Click Count (0)
  9. docs/zh-hant/docs/advanced/custom-response.md

    簡而言之,若你想要最佳效能,請使用[回應模型](../tutorial/response-model.md),並且不要在「路徑操作裝飾器」中宣告 `response_class`。
    
    {* ../../docs_src/response_model/tutorial001_01_py310.py ln[15:17] hl[16] *}
    
    ## HTML 回應 { #html-response }
    
    要直接從 **FastAPI** 回傳 HTML,使用 `HTMLResponse`。
    
    - 匯入 `HTMLResponse`。
    - 在「路徑操作裝飾器」中,將 `HTMLResponse` 傳給 `response_class` 參數。
    
    {* ../../docs_src/custom_response/tutorial002_py310.py hl[2,7] *}
    
    /// info
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Mar 20 17:05:38 GMT 2026
    - 10.3K bytes
    - Click Count (0)
  10. tests/test_dump_json_fast_path.py

    @app.get("/default")
    def get_default() -> Item:
        return Item(name="widget", price=9.99)
    
    
    @app.get("/explicit", response_class=JSONResponse)
    def get_explicit() -> Item:
        return Item(name="widget", price=9.99)
    
    
    client = TestClient(app)
    
    
    def test_default_response_class_skips_json_dumps():
        """When no response_class is set, the fast path serializes directly to
        JSON bytes via Pydantic's dump_json and never calls json.dumps."""
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sun Feb 22 16:07:19 GMT 2026
    - 1.4K bytes
    - Click Count (0)
Back to Top