pandera.api.checks.Check.__call__#
- Check.__call__(check_obj, column=None)[source]#
Validate pandas DataFrame or Series.
- Parameters
- Return type
CheckResult
- Returns
CheckResult tuple containing:
check_output
: boolean scalar,Series
orDataFrame
indicating which elements passed the check.check_passed
: boolean scalar that indicating whether the check passed overall.checked_object
: the checked object itself. Depending on the options provided to theCheck
, this will be a pandas Series, DataFrame, or if thegroupby
option is specified, aDict[str, Series]
orDict[str, DataFrame]
where the keys are distinct groups.failure_cases
: subset of the check_object that failed.