MetricPartialFunctionTypes

class great_expectations.core.metric_function_types.MetricPartialFunctionTypes(value)#

Enum type, whose members depict the nature of return value of a metric implementation function (defined for a specified “ExecutionEngine” subclass) that is a (partial) Callable to be executed once execution plan is complete.

The available types are:

• MAP_FN – metric implementation function returns a mapping transformation for “Domain” values that evaluates to a quantity (rather than a condition statement, or a series, etc.).

• MAP_SERIES – metric implementation function returns a mapping transformation for “Domain” values that evaluates to a series-valued (e.g., Pandas.Series) result (rather than a Callable for deferred execution).

• WINDOW_FN – metric implementation function returns specified windowing operation over “Domain” values (currently applicable only to “SparkDFExecutionEngine”).

• MAP_CONDITION_FN – metric implementation function returns a mapping transformation for “Domain” values that evaluates to a Callable (partial) computational component (as part of deferred execution plan) that expresses the specified condition (i.e., a logical operation).

• MAP_CONDITION_SERIES – metric implementation function returns a mapping transformation for “Domain” values that evaluates to a Callable (partial) computational component (as part of deferred execution plan) that expresses the specified condition (i.e., a logical operation) as a series-valued (e.g., Pandas.Series) result.

• WINDOW_CONDITION_FN – metric implementation function returns a windowing operation over “Domain” values that evaluates to a Callable (partial) computational component (as part of deferred execution plan) that expresses the specified condition (i.e., a logical operation).

• AGGREGATE_FN – metric implementation function returns an aggregation transformation over “Domain” values that evaluates to a Callable (partial) computational component (as part of deferred execution plan) that expresses the specified aggregated quantity.

AGGREGATE_FN = 'aggregate_fn'#

MAP_CONDITION_FN = 'map_condition_fn'#

MAP_CONDITION_SERIES = 'map_condition_series'#

MAP_FN = 'map_fn'#

MAP_SERIES = 'map_series'#

WINDOW_CONDITION_FN = 'window_condition_fn'#

WINDOW_FN = 'window_fn'#

property metric_suffix: str#

Examines the “name” property of this “Enum” and returns corresponding suffix for metric registration/usage.

Returns

(str) designated metric name suffix