great_expectations.expectations.core.expect_multicolumn_sum_to_equal
¶
Module Contents¶
Classes¶
|
Expects that the sum of row values is the same for each row, summing only values in columns specified in |
-
class
great_expectations.expectations.core.expect_multicolumn_sum_to_equal.
ExpectMulticolumnSumToEqual
(configuration: Optional[ExpectationConfiguration] = None)¶ Bases:
great_expectations.expectations.expectation.MulticolumnMapExpectation
Expects that the sum of row values is the same for each row, summing only values in columns specified in column_list, and equal to the specific value, sum_total.
- Parameters
column_list (tuple or list) – Set of columns to be checked
sum_total (int) – expected sum of columns
- Keyword Arguments
ignore_row_if (str) – “all_values_are_missing”, “any_value_is_missing”, “never”
- Other Parameters
result_format (str or None) – Which output mode to use: BOOLEAN_ONLY, BASIC, COMPLETE, or SUMMARY.
include_config (boolean) – If True, then include the expectation config as part of the result object. catch_exceptions (boolean or None): If True, then catch exceptions and include them as part of the result object. meta (dict or None): A JSON-serializable dictionary (nesting allowed) that will be included in the output without modification.
- Returns
An ExpectationSuiteValidationResult
-
library_metadata
¶
-
map_metric
= multicolumn_sum.equal¶
-
success_keys
= ['sum_total']¶
-
default_kwarg_values
¶
-
args_keys
= ['column_list', 'sum_total']¶
-
classmethod
_prescriptive_renderer
(cls, configuration=None, result=None, language=None, runtime_configuration=None, **kwargs)¶
-
classmethod
_diagnostic_observed_value_renderer
(cls, configuration=None, result=None, language=None, runtime_configuration=None, **kwargs)¶