pandera.model_components.dataframe_check

pandera.model_components.dataframe_check(_fn=None, **check_kwargs)[source]

Decorator to make SchemaModel method a dataframe-wide check function.

new in 0.5.0

Decorate a method on the SchemaModel indicating that it should be used to validate the DataFrame. The method will be converted to a classmethod. Therefore its signature must start with cls followed by regular check arguments. See the User Guide for more.

Parameters

check_kwargs – Keywords arguments forwarded to Check.

Return type

Callable[[Union[classmethod, Callable[…, Any]]], classmethod]