pandera.typing.fastapi.UploadFile#

class pandera.typing.fastapi.UploadFile(data, filename, file, *args, **kwargs)[source]#

Pandera-specific subclass of fastapi.UploadFile.

This type uses pandera.typing.DataFrame to read files into dataframe format based on the pandera.api.pandas.models.DataFrameModel configuration.

Initialize UploadFile object that has a data property that contains validated data.

Parameters

data (Any) – pandera-validated data

Filename

Attributes

data

filename

file

headers

content_type

rtype

Optional[str]

Methods

__init__

Initialize UploadFile object that has a data property that contains validated data.

pydantic_validate

Pydantic validation method for validating dataframes in the context of a file upload.