pandera.api.pandas.model_config.BaseConfig

class pandera.api.pandas.model_config.BaseConfig

Bases: BaseConfig

Define pandas DataFrameSchema-wide options.

Attributes

add_missing_columns	add columns to dataframe if they are missing
coerce	coerce types of all schema components
description	arbitrary textual description
drop_invalid_rows	drop invalid rows on validation
dtype	datatype of the dataframe.
from_format	data format before validation.
from_format_kwargs	a dictionary keyword arguments to pass into the reader function that converts the object of type from_format to a pandera-validate-able data structure.
metadata	a dictionary object to store key-value data at schema level
multiindex_coerce	coerce types of all MultiIndex components
multiindex_name	name of multiindex
multiindex_ordered	validate MultiIndex in order
multiindex_strict	make sure all specified columns are in validated MultiIndex - if "filter", removes indexes not specified in the schema
multiindex_unique	make sure the MultiIndex is unique along the list of columns
name	name of schema
on_missing_columns	action to take when an optional column is missing from the dataframe.
ordered	validate columns order
strict	make sure all specified columns are in the validated dataframe - if "filter", removes columns not specified in the schema
title	human-readable label for schema
to_format	data format to serialize into after validation.
to_format_buffer	Buffer to be provided when to_format is a custom callable.
to_format_kwargs	a dictionary keyword arguments to pass into the writer function that converts the pandera-validate-able object to type to_format.
unique	make sure certain column combinations are unique
unique_column_names	make sure dataframe column names are unique