great_expectations.expectations.core.expect_column_most_common_value_to_be_in_set
¶
Module Contents¶
Classes¶
|
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
.- 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
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. For more detail, see include_config.
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
An ExpectationSuiteValidationResult
Exact fields vary depending on the values passed to result_format and include_config, catch_exceptions, and meta.
Notes
These fields in the result object are customized for this expectation:
{ "observed_value": (list) The most common values in the column }
observed_value contains a list of the most common values. Often, this will just be a single element. But if there’s 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
¶
-
validate_configuration
(self, configuration: Optional[ExpectationConfiguration])¶ Validating that user has inputted a value set and that configuration has been initialized
-
classmethod
_prescriptive_renderer
(cls, configuration=None, result=None, language=None, runtime_configuration=None, **kwargs)¶
-
_validate
(self, configuration: ExpectationConfiguration, metrics: Dict, runtime_configuration: dict = None, execution_engine: ExecutionEngine = None)¶