great_expectations.expectations.core.expect_column_value_lengths_to_be_between
¶
Module Contents¶
Classes¶
|
Expect column entries to be strings with length between a minimum value and a maximum value (inclusive). |
-
class
great_expectations.expectations.core.expect_column_value_lengths_to_be_between.
ExpectColumnValueLengthsToBeBetween
(configuration: Optional[ExpectationConfiguration] = None)¶ Bases:
great_expectations.expectations.expectation.ColumnMapExpectation
Expect column entries to be strings with length between a minimum value and a maximum value (inclusive).
This expectation only works for string-type values. Invoking it on ints or floats will raise a TypeError.
expect_column_value_lengths_to_be_between is a
column_map_expectation
.- Parameters
column (str) – The column name.
min_value (int or None) – The minimum value for a column entry length.
max_value (int or None) – The maximum value for a column entry length.
- Keyword Arguments
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.
If min_value is None, then max_value is treated as an upper bound, and the number of acceptable rows has no minimum.
If max_value is None, then min_value is treated as a lower bound, and the number of acceptable rows has no maximum.
See also
expect_column_value_lengths_to_equal
-
library_metadata
¶
-
map_metric
= column_values.value_length.between¶
-
success_keys
= ['min_value', 'max_value', 'strict_min', 'strict_max', 'mostly']¶
-
default_kwarg_values
¶
-
args_keys
= ['column', 'min_value', 'max_value']¶
-
validate_configuration
(self, configuration: Optional[ExpectationConfiguration])¶
-
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: ExpectationConfiguration = None, result: ExpectationValidationResult = None, language: str = None, runtime_configuration: dict = None, **kwargs)¶