Expect each column value to be in a given set.
expect_column_values_to_be_in_set
This expectation level is EXPERIMENTAL
Contributors:
Tags:
core expectation
column map expectation
Metrics:
column_values.nonnull.unexpected_count
column_values.in_set.unexpected_count
table.row_count
column_values.in_set.unexpected_values
Description
Expect each column value to be in a given set.
For example:
# my_df.my_col = [1,2,2,3,3,3]
>>> my_df.expect_column_values_to_be_in_set(
"my_col",
[2,3]
)
{
"success": false
"result": {
"unexpected_count": 1
"unexpected_percent": 16.66666666666666666,
"unexpected_percent_nonmissing": 16.66666666666666666,
"partial_unexpected_list": [
1
],
},
}
expect_column_values_to_be_in_set is a Column Map Expectation.
Args:
- column (str): The column name.
- value_set (set-like): A set of objects used for comparison.
Keyword Args:
- 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.
- parse_strings_as_datetimes (boolean or None) : If True values provided in value_set will be parsed as datetimes before making comparisons.
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:
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