great_expectations.expectations.core.expect_column_distinct_values_to_be_in_set

Module Contents

Classes

ExpectColumnDistinctValuesToBeInSet(configuration: Optional[ExpectationConfiguration] = None)

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
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

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)