File

Declares a file parameter for an API endpoint, allowing specification of default values, media type, aliases, validation rules, and OpenAPI documentation details.

def File(
    default: Any = Undefined,
    default_factory: Callable[[], Any] | None = _Unset,
    media_type: str = multipart/form-data,
    alias: str | None = None,
    alias_priority: int | None = _Unset,
    validation_alias: str | AliasPath | AliasChoices | None = None,
    serialization_alias: str | None = None,
    title: str | None = None,
    description: str | None = None,
    gt: float | None = None,
    ge: float | None = None,
    lt: float | None = None,
    le: float | None = None,
    min_length: int | None = None,
    max_length: int | None = None,
    pattern: str | None = None,
    regex: str | None = None,
    discriminator: str | None = None,
    strict: bool | None = _Unset,
    multiple_of: float | None = _Unset,
    allow_inf_nan: bool | None = _Unset,
    max_digits: int | None = _Unset,
    decimal_places: int | None = _Unset,
    examples: list[Any] | None = None,
    example: Any | None = _Unset,
    openapi_examples: dict[str, Example] | None = None,
    deprecated: deprecated | str | bool | None = None,
    include_in_schema: bool = True,
    json_schema_extra: dict[str, Any] | None = None,
    extra: Any
) - > Any

Creates a File parameter field with various validation and OpenAPI generation options. This function is used to define how file uploads are handled and documented in an API.

Parameters

Name	Type	Description
default	`Any` = Undefined	Default value if the parameter field is not set.
default_factory	`Callable[[], Any]	None` = _Unset
media_type	`str` = multipart/form-data	The media type of this parameter field. Changing it would affect the generated OpenAPI, but currently it doesn't affect the parsing of the data.
alias	`str	None` = None
alias_priority	`int	None` = _Unset
validation_alias	`str	AliasPath
serialization_alias	`str	None` = None
title	`str	None` = None
description	`str	None` = None
gt	`float	None` = None
ge	`float	None` = None
lt	`float	None` = None
le	`float	None` = None
min_length	`int	None` = None
max_length	`int	None` = None
pattern	`str	None` = None
regex	`str	None` = None
discriminator	`str	None` = None
strict	`bool	None` = _Unset
multiple_of	`float	None` = _Unset
allow_inf_nan	`bool	None` = _Unset
max_digits	`int	None` = _Unset
decimal_places	`int	None` = _Unset
examples	`list[Any]	None` = None
example	`Any	None` = _Unset
openapi_examples	`dict[str, Example]	None` = None
deprecated	`deprecated	str
include_in_schema	`bool` = True	To include (or not) this parameter field in the generated OpenAPI. You probably don't need it, but it's available. This affects the generated OpenAPI (e.g. visible at `/docs`).
json_schema_extra	`dict[str, Any]	None` = None
extra	`Any`	Include extra fields used by the JSON Schema. The `extra` kwargs is deprecated. Use `json_schema_extra` instead.

Returns

Type	Description
`Any`	A configured File parameter field.

Parameters​

Returns​

Parameters

Returns