map_metric_provider

class great_expectations.expectations.metrics.map_metric_provider.ColumnMapMetricProvider#

Defines metrics that are evaluated for every row for a single column. An example of a column map metric is column_values.null (which is implemented as a ColumnMapMetricProvider, a subclass ofMapMetricProvider).

-Relevant Documentation Links -

• How To Create Custom Column Map Expectations

class great_expectations.expectations.metrics.map_metric_provider.ColumnPairMapMetricProvider#

Defines metrics that are evaluated for every row for a column pair. All column pair metrics require domain keys of column_A and column_B.

expect_column_pair_values_to_be_equal is an example of an Expectation that uses this metric.

class great_expectations.expectations.metrics.map_metric_provider.MapMetricProvider#

The base class for defining metrics that are evaluated for every row. An example of a map metric iscolumn_values.null (which is implemented as a ColumnMapMetricProvider, a subclass of MapMetricProvider).

class great_expectations.expectations.metrics.map_metric_provider.MulticolumnMapMetricProvider#

Defines metrics that are evaluated for every row for a set of columns. All multi-column metrics require the domain key column_list.

expect_compound_columns_to_be_unique is an example of an Expectation that uses this metric.

great_expectations.expectations.metrics.map_metric_provider.column_condition_partial(engine: Type[great_expectations.execution_engine.execution_engine.ExecutionEngine], partial_fn_type: Optional[Union[str, great_expectations.core.metric_function_types.MetricPartialFunctionTypes]] = None, **kwargs)#

Provides engine-specific support for authoring a metric_fn with a simplified signature.

A column_condition_partial must provide a map function that evaluates to a boolean value; it will be used to provide supplemental metrics, such as the unexpected_value count, unexpected_values, and unexpected_rows.

A metric function that is decorated as a column_condition_partial will be called with the engine-specific column type and any value_kwargs associated with the Metric for which the provider function is being declared.

Parameters:

• engine – The ExecutionEngine used to to evaluate the condition

• partial_fn_type – The metric function

• **kwargs – Arguments passed to specified function

Returns:

An annotated metric_function which will be called with a simplified signature.

great_expectations.expectations.metrics.map_metric_provider.column_pair_function_partial(engine: Type[great_expectations.execution_engine.execution_engine.ExecutionEngine], partial_fn_type: Optional[str] = None, **kwargs)#

Provides engine-specific support for authoring a metric_fn with a simplified signature.

A metric function that is decorated as a column_pair_function_partial will be called with the engine-specific column_list type and any value_kwargs associated with the Metric for which the provider function is being declared.

Parameters:

• engine – The ExecutionEngine used to to evaluate the condition

• partial_fn_type – The metric function

• **kwargs – Arguments passed to specified function

Returns:

An annotated metric_function which will be called with a simplified signature.