sarkit.verification.CphdConsistency.check

CphdConsistency.check(func_name=None, *, allow_prefix=False, ignore_patterns=None)

Run checks.

Parameters:

func_namestr or list-like of str, optional

List of check functions to run. If omitted, then all check functions will be run.

allow_prefixbool

If True, runs tests with names starting with any func_name If False, runs tests with names equal to any func_name

ignore_patternslist-like of str, optional

Skips tests if zero or more characters at the beginning of their name match the regular expression patterns