pandera.api.pyspark.model_config.BaseConfig

class pandera.api.pyspark.model_config.BaseConfig[source]

Bases: BaseModelConfig

Define DataFrameSchema-wide options.

new in 0.16.0

Attributes

coerce

coerce types of all schema components

description

arbitrary textual description

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

name

name of schema

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