read() — fastapi Function Reference

Architecture documentation for the read() function in datastructures.py from the fastapi codebase.

Function python FastAPI Applications called by 1

Entity Profile

FastAPI→ Applications→ read() — fastapi Function Reference

Dependency Diagram

graph TD
  1d8546f2_90ed_9120_dbc5_d713e7cf8085["read()"]
  e7f7f9d0_3e61_b391_e95f_2212c3046b08["UploadFile"]
  1d8546f2_90ed_9120_dbc5_d713e7cf8085 -->|defined in| e7f7f9d0_3e61_b391_e95f_2212c3046b08
  2070de0b_f99d_ce4d_bb36_162d825290f1["test_upload_file()"]
  2070de0b_f99d_ce4d_bb36_162d825290f1 -->|calls| 1d8546f2_90ed_9120_dbc5_d713e7cf8085
  style 1d8546f2_90ed_9120_dbc5_d713e7cf8085 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

fastapi/datastructures.py lines 88–104

    async def read(
        self,
        size: Annotated[
            int,
            Doc(
                """
                The number of bytes to read from the file.
                """
            ),
        ] = -1,
    ) -> bytes:
        """
        Read some bytes from the file.

        To be awaitable, compatible with async, this is run in threadpool.
        """
        return await super().read(size)