great_expectations.expectations.core.expect_column_distinct_values_to_be_in_set
¶
Module Contents¶
Classes¶
|
Expect the set of distinct column values to be contained by a given set. |
-
class
great_expectations.expectations.core.expect_column_distinct_values_to_be_in_set.
ExpectColumnDistinctValuesToBeInSet
(configuration: Optional[ExpectationConfiguration] = None)¶ Bases:
great_expectations.expectations.expectation.ColumnExpectation
Expect the set of distinct column values to be contained by a given set.
expect_column_distinct_values_to_be_in_set is a [Column Aggregate Expectation](https://docs.greatexpectations.io/docs/guides/expectations/creating_custom_expectations/how_to_create_custom_column_aggregate_expectations).
The success value for this expectation will match that of [expect_column_values_to_be_in_set](https://greatexpectations.io/expectations/expect_column_values_to_be_in_set).
For example:
# my_df.my_col = [1,2,2,3,3,3] >>> my_df.expect_column_distinct_values_to_be_in_set( "my_col", [2, 3, 4] ) { "success": false "result": { "observed_value": [1,2,3], "details": { "value_counts": [ { "value": 1, "count": 1 }, { "value": 2, "count": 1 }, { "value": 3, "count": 1 } ] } } }
- Parameters
column (str) – The column name.
value_set (set-like) – A set of objects used for comparison.
- Keyword Arguments
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](https://docs.greatexpectations.io/docs/reference/expectations/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](https://docs.greatexpectations.io/docs/reference/expectations/standard_arguments/#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](https://docs.greatexpectations.io/docs/reference/expectations/standard_arguments/#meta).
- Returns
//docs.greatexpectations.io/docs/terms/validation_result)
Exact fields vary depending on the values passed to result_format, include_config, catch_exceptions, and meta.
- Return type
An [ExpectationSuiteValidationResult](https
See also
[expect_column_distinct_values_to_contain_set](https://greatexpectations.io/expectations/expect_column_distinct_values_to_contain_set) [expect_column_distinct_values_to_equal_set](https://greatexpectations.io/expectations/expect_column_distinct_values_to_equal_set)
-
library_metadata
¶
-
metric_dependencies
= ['column.value_counts']¶
-
success_keys
= ['value_set', 'parse_strings_as_datetimes']¶
-
default_kwarg_values
¶
-
args_keys
= ['column', 'value_set']¶
-
classmethod
_prescriptive_template
(cls, renderer_configuration: RendererConfiguration)¶
-
classmethod
_prescriptive_renderer
(cls, configuration: Optional[ExpectationConfiguration] = None, result: Optional[ExpectationValidationResult] = None, runtime_configuration: Optional[dict] = None)¶
-
classmethod
_descriptive_value_counts_bar_chart_renderer
(cls, configuration: Optional[ExpectationConfiguration] = None, result: Optional[ExpectationValidationResult] = None, runtime_configuration: Optional[dict] = None)¶
-
validate_configuration
(self, configuration: Optional[ExpectationConfiguration] = None)¶ Validating that user has inputted a value set and that configuration has been initialized
-
_validate
(self, configuration: ExpectationConfiguration, metrics: Dict, runtime_configuration: Optional[dict] = None, execution_engine: Optional[ExecutionEngine] = None)¶