great_expectations.expectations.core.expect_column_most_common_value_to_be_in_set

Module Contents

Classes

ExpectColumnMostCommonValueToBeInSet(configuration: Optional[ExpectationConfiguration] = None)

Expect the most common value to be within the designated value set.

class great_expectations.expectations.core.expect_column_most_common_value_to_be_in_set.ExpectColumnMostCommonValueToBeInSet(configuration: Optional[ExpectationConfiguration] = None)

Bases: great_expectations.expectations.expectation.ColumnExpectation

Expect the most common value to be within the designated value set.

expect_column_most_common_value_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).

Parameters
  • column (str) – The column name

  • value_set (set-like) – A list of potential values to match

Keyword Arguments

ties_okay (boolean or None) – If True, then the expectation will still succeed if values outside the designated set are as common (but not more common) than designated values

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

Notes

  • observed_value field in the result object is customized for this expectation to be a list representing the most common values in the column, which is often a single element… if there is a tie for most common among multiple values, observed_value will contain a single copy of each most common value

library_metadata
metric_dependencies = ['column.most_common_value']
success_keys = ['value_set', 'ties_okay']
default_kwarg_values
args_keys = ['column', 'value_set']
validate_configuration(self, configuration: Optional[ExpectationConfiguration])

Validating that user has inputted a value set and that configuration has been initialized

classmethod _atomic_prescriptive_template(cls, configuration: Optional[ExpectationConfiguration] = None, result: Optional[ExpectationValidationResult] = None, runtime_configuration: Optional[dict] = None, **kwargs)

Template function that contains the logic that is shared by AtomicPrescriptiveRendererType.SUMMARY and LegacyRendererType.PRESCRIPTIVE.

classmethod _prescriptive_renderer(cls, configuration: Optional[ExpectationConfiguration] = None, result: Optional[ExpectationValidationResult] = None, runtime_configuration: Optional[dict] = None, **kwargs)
_validate(self, configuration: ExpectationConfiguration, metrics: Dict, runtime_configuration: Optional[dict] = None, execution_engine: Optional[ExecutionEngine] = None)