registry.py

<section class="sphinx-api-doc" id="registry"> <dl class="py function"> <dt class="sig sig-object py"> <span class="sig-prename descclassname"><span class="pre">great_expectations.expectations.registry.</span></span><span class="sig-name descname"><span class="pre">register_metric</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metric_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_domain_keys</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_value_keys</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">execution_engine</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="/docs/0.18/reference/api/execution_engine/ExecutionEngine_class" title="great_expectations.execution_engine.ExecutionEngine"><span class="pre">ExecutionEngine</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_class</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="/docs/0.18/reference/api/expectations/metrics/metric_provider/MetricProvider_class" title="great_expectations.expectations.metrics.metric_provider.MetricProvider"><span class="pre">MetricProvider</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_provider</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metric_fn_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="/docs/0.18/reference/api/core/metric_function_types/MetricFunctionTypes_class" title="great_expectations.core.metric_function_types.MetricFunctionTypes"><span class="pre">MetricFunctionTypes</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="/docs/0.18/reference/api/core/metric_function_types/MetricPartialFunctionTypes_class" title="great_expectations.core.metric_function_types.MetricPartialFunctionTypes"><span class="pre">MetricPartialFunctionTypes</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span> </dt> <dd> <p>Register a Metric class for use as a callable metric within Expectations.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>metric_name</strong> – A name identifying the metric. Metric Name must be globally unique in a great_expectations installation.</p></li> <li><p><strong>metric_domain_keys</strong> – A tuple of the keys used to determine the domain of the metric.</p></li> <li><p><strong>metric_value_keys</strong> – A tuple of the keys used to determine the value of the metric.</p></li> <li><p><strong>execution_engine</strong> – The execution_engine used to execute the metric.</p></li> <li><p><strong>metric_class</strong> – A valid Metric class containing logic to compute attributes of data.</p></li> <li><p><strong>metric_provider</strong> – The MetricProvider class from which the metric_class inherits.</p></li> <li><p><strong>metric_fn_type</strong> – The MetricFunctionType or MetricPartialFunctionType used to define the Metric class.</p></li> </ul> </dd> <dt class="field-even">Returns</dt> <dd class="field-even"> <p>A dictionary containing warnings thrown during registration if applicable, and the success status of registration.</p> </dd> </dl> </dd></dl> </section>