Expect the column entries to be strings that can be matched to either any of or all of a list of regular expressions.
expect_column_values_to_match_regex_list
This expectation level is PRODUCTION
Contributors:
Tags:
Metrics:
Description
Expect the column entries to be strings that can be matched to either any of or all of a list of regular expressions.
Matches can be anywhere in the string.
expect_column_values_to_match_regex_list is a Column Map Expectation.
Args:
- column (str): The column name.
- regex_list (list): The list of regular expressions which the column entries should match
Keyword Args:
- match_on (string): "any" or "all". Use "any" if the value should match at least one regular expression in the list. Use "all" if it should match each regular expression in the list.
- mostly (None or a float between 0 and 1): Successful if at least mostly fraction of values match the expectation. For more detail, see mostly.
Other Parameters:
- result_format (str or None): Which output mode to use: BOOLEAN_ONLY, BASIC, COMPLETE, or SUMMARY. For more detail, see result_format.
- include_config (boolean): If True, then include the expectation config as part of the result object.
- catch_exceptions (boolean or None): If True, then catch exceptions and include them as part of the result object. For more detail, see catch_exceptions.
- meta (dict or None): A JSON-serializable dictionary (nesting allowed) that will be included in the output without modification. For more detail, see meta.
Returns:
Exact fields vary depending on the values passed to result_format, include_config, catch_exceptions, and meta.
See Also:
- expect_column_values_to_match_regex
- expect_column_values_to_not_match_regex
- expect_column_values_to_not_match_regex_list
- expect_column_values_to_match_like_pattern
- expect_column_values_to_match_like_pattern_list
- expect_column_values_to_not_match_like_pattern
- expect_column_values_to_not_match_like_pattern_list
Want to make your own Expectation or an improvement to this one?
We've put together some great how to guides (including videos) on how to create your own expectations in a flash!
You can see those resources here: Contributor Resources