great_expectations.expectations.core.expect_column_max_to_be_between
¶
Module Contents¶
Classes¶
|
Expect the column maximum to be between a minimum value and a maximum value. |
-
class
great_expectations.expectations.core.expect_column_max_to_be_between.
ExpectColumnMaxToBeBetween
(configuration: Optional[ExpectationConfiguration] = None)¶ Bases:
great_expectations.expectations.expectation.ColumnExpectation
Expect the column maximum to be between a minimum value and a maximum value.
expect_column_max_to_be_between is a [Column Aggregate Expectation](https://docs.greatexpectations.io/docs/guides/expectations/creating_custom_expectations/how_to_create_custom_column_aggregate_expectations)
- Parameters
column (str) – The column name
min_value (comparable type or None) – The minimum number of unique values allowed.
max_value (comparable type or None) – The maximum number of unique values allowed.
strict_min (boolean) – If True, the minimal column minimum must be strictly larger than min_value, default=False
strict_max (boolean) – If True, the maximal column minimum must be strictly smaller than max_value, default=False
- Keyword Arguments
parse_strings_as_datetimes (Boolean or None) – If True, parse min_value, max_values, 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.
- Other Parameters
result_format (str or None) – Which output mode to use: BOOLEAN_ONLY, BASIC, COMPLETE, or SUMMARY. For more detail, see [result_format](https://docs.greatexpectations.io/docs/reference/expectations/result_format).
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. For more detail, see [catch_exceptions](https://docs.greatexpectations.io/docs/reference/expectations/standard_arguments/#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](https://docs.greatexpectations.io/docs/reference/expectations/standard_arguments/#meta).
- Returns
//docs.greatexpectations.io/docs/terms/validation_result)
Exact fields vary depending on the values passed to result_format, include_config, catch_exceptions, and meta.
- Return type
An [ExpectationSuiteValidationResult](https
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
If max_value is None, then min_value is treated as a lower bound
observed_value field in the result object is customized for this expectation to be a list representing the actual column max
See also
[expect_column_min_to_be_between](https://greatexpectations.io/expectations/expect_column_min_to_be_between)
-
library_metadata
¶
-
metric_dependencies
= ['column.max']¶
-
success_keys
= ['min_value', 'strict_min', 'max_value', 'strict_max', 'parse_strings_as_datetimes', 'auto', 'profiler_config']¶
-
max_range_estimator_parameter_builder_config
¶
-
validation_parameter_builder_configs
:List[ParameterBuilderConfig]¶
-
default_profiler_config
¶
-
default_kwarg_values
¶
-
args_keys
= ['column', 'min_value', 'max_value', 'strict_min', 'strict_max']¶ A Column Map MetricProvider Decorator for the Maximum
-
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
None. Raises InvalidExpectationConfigurationError if the config is not validated successfully
-
classmethod
_atomic_prescriptive_template
(cls, configuration: Optional[ExpectationConfiguration] = None, result: Optional[ExpectationValidationResult] = None, runtime_configuration: Optional[dict] = None, **kwargs)¶ Template function that contains the logic that is shared by AtomicPrescriptiveRendererType.SUMMARY and LegacyRendererType.PRESCRIPTIVE.
-
classmethod
_prescriptive_renderer
(cls, configuration: Optional[ExpectationConfiguration] = None, result: Optional[ExpectationValidationResult] = None, runtime_configuration: Optional[dict] = None, **kwargs)¶
-
classmethod
_descriptive_stats_table_max_row_renderer
(cls, configuration: Optional[ExpectationConfiguration] = None, result: Optional[ExpectationValidationResult] = None, runtime_configuration: Optional[dict] = None, **kwargs)¶
-
_validate
(self, configuration: ExpectationConfiguration, metrics: Dict, runtime_configuration: Optional[dict] = None, execution_engine: Optional[ExecutionEngine] = None)¶