great_expectations.expectations.core.expect_column_values_to_be_between
¶
Module Contents¶
Classes¶
|
Expect column entries to be between a minimum value and a maximum value (inclusive). |
-
class
great_expectations.expectations.core.expect_column_values_to_be_between.
ExpectColumnValuesToBeBetween
(configuration: Optional[ExpectationConfiguration] = None)¶ Bases:
great_expectations.expectations.expectation.ColumnMapExpectation
Expect column entries to be between a minimum value and a maximum value (inclusive).
expect_column_values_to_be_between is a
column_map_expectation
.- Parameters
column (str) – The column name.
min_value (comparable type or None) – The minimum value for a column entry.
max_value (comparable type or None) – The maximum value for a column entry.
strict_min (boolean) – If True, values must be strictly larger than min_value, default=False
strict_max (boolean) – If True, values must be strictly smaller than max_value, default=False
- Keyword Arguments
allow_cross_type_comparisons (boolean or None) – If True, allow comparisons between types (e.g. integer and string). Otherwise, attempting such comparisons will raise an exception.
parse_strings_as_datetimes (boolean or None) – If True, parse min_value, max_value, and all non-null column values to datetimes before making comparisons.
output_strftime_format (str or None) – A valid strfime format for datetime output. Only used if parse_strings_as_datetimes=True.
mostly (None or a float between 0 and 1) – Return “success”: True if at least mostly fraction of values match the expectation. For more detail, see mostly.
- Other Parameters
result_format (str or None) – Which output mode to use: BOOLEAN_ONLY, BASIC, COMPLETE, or SUMMARY. For more detail, see result_format.
include_config (boolean) – If True, then include the expectation config as part of the result object. For more detail, see include_config.
catch_exceptions (boolean or None) – If True, then catch exceptions and include them as part of the result object. For more detail, see catch_exceptions.
meta (dict or None) – A JSON-serializable dictionary (nesting allowed) that will be included in the output without modification. For more detail, see meta.
- Returns
An ExpectationSuiteValidationResult
Exact fields vary depending on the values passed to result_format and include_config, catch_exceptions, and meta.
Notes
min_value and max_value are both inclusive unless strict_min or strict_max are set to True.
If min_value is None, then max_value is treated as an upper bound, and there is no minimum value checked.
If max_value is None, then min_value is treated as a lower bound, and there is no maximum value checked.
See also
expect_column_value_lengths_to_be_between
-
library_metadata
¶
-
map_metric
= column_values.between¶
-
success_keys
= ['min_value', 'max_value', 'strict_min', 'strict_max', 'allow_cross_type_comparisons', 'mostly', 'parse_strings_as_datetimes', 'auto', 'profiler_config']¶
-
default_profiler_config
:RuleBasedProfilerConfig¶
-
default_kwarg_values
¶
-
args_keys
= ['column', 'min_value', 'max_value', 'strict_min', 'strict_max']¶
-
validate_configuration
(self, configuration: Optional[ExpectationConfiguration])¶ Validates that a configuration has been set, and sets a configuration if it has yet to be set. Ensures that necessary configuration arguments have been provided for the validation of the expectation.
- Parameters
configuration (OPTIONAL[ExpectationConfiguration]) – An optional Expectation Configuration entry that will be used to configure the expectation
- Returns
True if the configuration has been validated successfully. Otherwise, raises an exception
-
classmethod
_atomic_prescriptive_template
(cls, configuration=None, result=None, language=None, runtime_configuration=None, **kwargs)¶ Template function that contains the logic that is shared by atomic.prescriptive.summary (GE Cloud) and renderer.prescriptive (OSS GE)
-
classmethod
_prescriptive_renderer
(cls, configuration=None, result=None, language=None, runtime_configuration=None, **kwargs)¶