Skip to main content
Version: 0.17.19

RegexColumnMapMetricProvider

class great_expectations.expectations.regex_based_column_map_expectation.RegexColumnMapMetricProvider#

Base class for all RegexColumnMapMetrics.

RegexColumnMapMetric classes inheriting from RegexColumnMapMetricProvider are ephemeral, defined by their regex attribute, and registered during the execution of their associated RegexColumnMapExpectation.

Metric Registration Example:

map_metric = RegexBasedColumnMapExpectation.register_metric(
    regex_camel_name='Vowel',
    regex_='^[aeiouyAEIOUY]*$',
)

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

Parameters:

  • regex (str) – A valid regex pattern.

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

-Relevant Documentation Links -