great_expectations.expectations.metrics.column_aggregate_metric

Module Contents

Classes

ColumnMetricProvider()

Base class for all metric providers.

Functions

column_aggregate_value(engine: Type[ExecutionEngine], metric_fn_type=’value’, domain_type=’column’, **kwargs)

Return the column aggregate metric decorator for the specified engine.

column_aggregate_partial(engine: Type[ExecutionEngine], **kwargs)

Return the column aggregate metric decorator for the specified engine.

great_expectations.expectations.metrics.column_aggregate_metric.logger
great_expectations.expectations.metrics.column_aggregate_metric.column_aggregate_value(engine: Type[ExecutionEngine], metric_fn_type='value', domain_type='column', **kwargs)

Return the column aggregate metric decorator for the specified engine.

Parameters
  • engine

  • **kwargs

Returns:

great_expectations.expectations.metrics.column_aggregate_metric.column_aggregate_partial(engine: Type[ExecutionEngine], **kwargs)

Return the column aggregate metric decorator for the specified engine.

Parameters
  • engine

  • **kwargs

Returns:

class great_expectations.expectations.metrics.column_aggregate_metric.ColumnMetricProvider

Bases: great_expectations.expectations.metrics.table_metric.TableMetricProvider

Base class for all metric providers.

MetricProvider classes must have the following attributes set:
  1. metric_name: the name to use. Metric Name must be globally unique in a great_expectations installation.

  1. domain_keys: a tuple of the keys used to determine the domain of the metric

  2. value_keys: a tuple of the keys used to determine the value of the metric.

In some cases, subclasses of Expectation, such as TableMetricProvider will already have correct values that may simply be inherited.

They may optionally override the default_kwarg_values attribute.

MetricProvider classes must implement the following:

1. _get_evaluation_dependencies. Note that often, _get_evaluation_dependencies should augment dependencies provided by a parent class; consider calling super()._get_evaluation_dependencies

In some cases, subclasses of Expectation, such as MapMetricProvider will already have correct implementations that may simply be inherited.

Additionally, they may provide implementations of:

1. Data Docs rendering methods decorated with the @renderer decorator. See the guide “How to create renderers for custom expectations” for more information.

domain_keys = ['batch_id', 'table', 'column', 'row_condition', 'condition_parser']
filter_column_isnull = False
classmethod _get_evaluation_dependencies(cls, metric: MetricConfiguration, configuration: Optional[ExpectationConfiguration] = None, execution_engine: Optional[ExecutionEngine] = None, runtime_configuration: Optional[dict] = None)