pandera.typing

Typing module.

For backwards compatibility, pandas types are exposed to the top-level scope of the typing module.

Pandas Types

DataFrame([data, index, columns, dtype, copy])

A generic type for pandas.DataFrame.

Index([data, dtype, copy, name, tupleize_cols])

Representation of pandas.Index, only used for type annotation.

Series([data, index, dtype, name, copy, ...])

Representation of pandas.Series, only used for type annotation.

GeoPandas Types

geopandas.GeoDataFrame([data, geometry, crs])

A generic type for geopandas.GeoDataFrame.

geopandas.GeoSeries([data, index, crs])

Representation of geopandas.GeoSeries, only used for type annotation.

Dask Types

dask.DataFrame(dsk, name, meta, divisions)

Representation of dask.dataframe.DataFrame, only used for type annotation.

dask.Series(dsk, name, meta, divisions)

Representation of pandas.Series, only used for type annotation.

dask.Index(dsk, name, meta, divisions)

Representation of pandas.Index, only used for type annotation.

Pyspark Pandas Types

pyspark.DataFrame([data, index, columns, ...])

Representation of dask.dataframe.DataFrame, only used for type annotation.

pyspark.Series([data, index, dtype, name, ...])

Representation of pandas.Series, only used for type annotation.

pyspark.Index([data, dtype, copy, name, ...])

Representation of pandas.Index, only used for type annotation.

Modin Types

pyspark.DataFrame([data, index, columns, ...])

Representation of dask.dataframe.DataFrame, only used for type annotation.

pyspark.Series([data, index, dtype, name, ...])

Representation of pandas.Series, only used for type annotation.

pyspark.Index([data, dtype, copy, name, ...])

Representation of pandas.Index, only used for type annotation.

FastAPI Types

fastapi.UploadFile(data, filename, file, ...)

Pandera-specific subclass of fastapi.UploadFile.

Serialization Formats

formats.Formats(value)

Data container serialization formats.

DataTypes

Bool()

Semantic representation of a boolean data type.

DateTime

alias of pandera.dtypes.Timestamp

Timedelta()

Semantic representation of a delta time data type.

Category([categories, ordered])

Semantic representation of a categorical data type.

Float()

Semantic representation of a floating data type.

Float16()

Semantic representation of a floating data type stored in 16 bits.

Float32()

Semantic representation of a floating data type stored in 32 bits.

Float64()

Semantic representation of a floating data type stored in 64 bits.

Int()

Semantic representation of an integer data type.

Int8()

Semantic representation of an integer data type stored in 8 bits.

Int16()

Semantic representation of an integer data type stored in 16 bits.

Int32()

Semantic representation of an integer data type stored in 32 bits.

Int64()

Semantic representation of an integer data type stored in 64 bits.

UInt8()

Semantic representation of an unsigned integer data type stored in 8 bits.

UInt16()

Semantic representation of an unsigned integer data type stored in 16 bits.

UInt32()

Semantic representation of an unsigned integer data type stored in 32 bits.

UInt64()

Semantic representation of an unsigned integer data type stored in 64 bits.

INT8()

Semantic representation of a pandas.Int8Dtype.

INT16()

Semantic representation of a pandas.Int16Dtype.

INT32()

Semantic representation of a pandas.Int32Dtype.

INT64()

Semantic representation of a pandas.Int64Dtype.

UINT8()

Semantic representation of a pandas.UInt8Dtype.

UINT16()

Semantic representation of a pandas.UInt16Dtype.

UINT32()

Semantic representation of a pandas.UInt32Dtype.

UINT64()

Semantic representation of a pandas.UInt64Dtype.

Object()

Semantic representation of a numpy.object_.

String()

Semantic representation of a string data type.

STRING([storage])

Semantic representation of a pandas.StringDtype.