pandera.model_components.check

pandera.model_components.check(*fields, regex=False, **check_kwargs)[source]

Decorator to make SchemaModel method a column/index check function.

new in 0.5.0

This indicates that the decorated method should be used to validate a field (column or index). 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
  • _fn – Method to decorate.

  • check_kwargs – Keywords arguments forwarded to Check.

Return type

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