U e@sddlmZmZmZmZmZmZmZmZm Z ddl m Z m Z m Z mZmZddlmZddlmZddlmZddlmZddlmZddlmZdd lmZdd lmZmZGd d d eZGd ddZedZeedddZdS)) AnyBinaryIOCallableDictIterableOptionalTypeTypeVarcast) PYDANTIC_V2 CoreSchemaGetJsonSchemaHandlerJsonSchemaValue"with_info_plain_validator_function)URL)Address)FormData)Headers) QueryParams)State) UploadFile) AnnotatedDoccseZdZUdZeeedfed<eee edfed<eee edfed<ee edfed <eee ed fed <ee ed fd dfdd Z d0ee edfe dfdd Zee edfd dfdd Zd dfdd Zeedeedefddd Zeedeed!d"d#Zeeedd$d%d&Zesheee efd d'd(d)Zeeeed*d+d,Zeeeeegefed-d.d/Z Z!S)1raA A file uploaded in a request. Define it as a *path operation function* (or dependency) parameter. If you are using a regular `def` function, you can use the `upload_file.file` attribute to access the raw standard Python file (blocking, not async), useful and needed for non-async code. Read more about it in the [FastAPI docs for Request Files](https://fastapi.tiangolo.com/tutorial/request-files/). ## Example ```python from typing import Annotated from fastapi import FastAPI, File, UploadFile app = FastAPI() @app.post("/files/") async def create_file(file: Annotated[bytes, File()]): return {"file_size": len(file)} @app.post("/uploadfile/") async def create_upload_file(file: UploadFile): return {"filename": file.filename} ``` z,The standard Python file object (non-async).filezThe original file name.filenamezThe size of the file in bytes.sizezThe headers of the request.headersz2The content type of the request, from the headers. content_typezA The bytes to write to the file. N)datareturncst|IdHS)z Write some bytes to the file. You normally wouldn't use this from a file you read in a request. To be awaitable, compatible with async, this is run in threadpool. N)superwrite)selfr __class__:/tmp/pip-unpacked-wheel-8a3sx6sf/fastapi/datastructures.pyr!KszUploadFile.writezL The number of bytes to read from the file. )rrcst|IdHS)z| Read some bytes from the file. To be awaitable, compatible with async, this is run in threadpool. N)r read)r"rr#r%r&r(_szUploadFile.readzO The position in bytes to seek to in the file. )offsetrcst|IdHS)z Move to a position in the file. Any next read or write will be done from that position. To be awaitable, compatible with async, this is run in threadpool. N)r seek)r"r)r#r%r&r*qszUploadFile.seekrcstIdHS)zm Close the file. To be awaitable, compatible with async, this is run in threadpool. N)r closer"r#r%r&r,szUploadFile.close.)clsrccs |jVdSN)validate)r.r%r%r&__get_validators__szUploadFile.__get_validators__)r.vrcCs t|tstdt||SNzExpected UploadFile, received: ) isinstanceStarletteUploadFile ValueErrortype)r.r2r%r%r&r0s zUploadFile.validate)_UploadFile__input_value_rcCs&t|tstdt|tt|Sr3)r4r5r6r7r r)r.r8r9r%r%r& _validates zUploadFile._validate) field_schemarcCs|ddddSNstringbinary)r7format)update)r.r;r%r%r&__modify_schema__szUploadFile.__modify_schema__) core_schemahandlerrcCs dddSr<r%)r.rBrCr%r%r&__get_pydantic_json_schema__sz'UploadFile.__get_pydantic_json_schema__)sourcerCrcCs t|jSr/)rr:)r.rErCr%r%r&__get_pydantic_core_schema__sz'UploadFile.__get_pydantic_core_schema__)r')"__name__ __module__ __qualname____doc__rrr__annotations__rstrintrbytesr!r(r*r, classmethodrrrrr1r0r:r rrAr r rrDrF __classcell__r%r%r#r&rsz !" rc@s<eZdZdZedddZedddZeedd d Z d S) DefaultPlaceholderz You shouldn't use this class directly. It's used internally to recognize when a default value has been overwritten, even if the overridden default value was truthy. valuecCs ||_dSr/rR)r"rSr%r%r&__init__szDefaultPlaceholder.__init__r+cCs t|jSr/)boolrSr-r%r%r&__bool__szDefaultPlaceholder.__bool__)orcCst|to|j|jkSr/)r4rQrS)r"rWr%r%r&__eq__szDefaultPlaceholder.__eq__N) rGrHrIrJrrTrUrVobjectrXr%r%r%r&rQsrQ DefaultType)rSrcCst|S)z You shouldn't use this function directly. It's used internally to recognize when a default value has been overwritten, even if the overridden default value was truthy. )rQrRr%r%r&Defaultsr[N)typingrrrrrrrr r Zfastapi._compatr r r rrZstarlette.datastructuresrrrrrrrr5Ztyping_extensionsrrrQrZr[r%r%r%r&s,