Skip to main content
Version: 0.17.23

SetColumnMapMetricProvider

class great_expectations.expectations.set_based_column_map_expectation.SetColumnMapMetricProvider#

Base class for all SetColumnMapMetrics.

SetColumnMapMetric classes inheriting from SetColumnMapMetricProvider are ephemeral, defined by their set attribute, and registered during the execution of their associated SetColumnMapExpectation.

Metric Registration Example:

map_metric = SetBasedColumnMapExpectation.register_metric(
    set_camel_name='SolfegeScale',
    set_=['do', 're', 'mi', 'fa', 'so', 'la', 'ti'],
)

In some cases, subclasses of MetricProvider, such as SetColumnMapMetricProvider, will already have correct values that may simply be inherited by Metric classes.

Parameters:

  • set (union[list, set]) – A value set.

  • metric_name (str) – The name of the registered metric. Must be globally unique in a great_expectations installation. Constructed by the register_metric(…) function during Expectation execution.

  • domain_keys (tuple) – A tuple of the keys used to determine the domain of the metric.

  • condition_value_keys (tuple) – A tuple of the keys used to determine the value of the metric.