column_pair_function_partial.py

great_expectations.expectations.metrics.map_metric_provider.column_pair_function_partial.column_pair_function_partial(engine: Type[great_expectations.execution_engine.execution_engine.ExecutionEngine], partial_fn_type: Optional[great_expectations.core.metric_function_types.MetricPartialFunctionTypes] = 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.