IsBetween

classView source ↗

class IsBetween(
    column_names: str | tuple[str, str | None] | Annotated[list[str], <class 'Strict'>] | Annotated[list[tuple[str, str | None]], <class 'Strict'>] | NoneType = None,
    min_val: int | float | bool | str | date | time | datetime | timedelta | bytes | Decimal | NoneType = None,
    max_val: int | float | bool | str | date | time | datetime | timedelta | bytes | Decimal | NoneType = None,
    closed_on: Literal['none', 'lower', 'upper', 'both'] = 'both',
    on_missing_column: Literal['ignore', 'fail'] = 'ignore',
    on_wrong_type: Literal['ignore', 'fail'] = 'ignore',
    on_wrong_value: Literal['ignore', 'fail'] = 'ignore',
    tags: str | list[str] | NoneType = None,
)

Bases: BetweenClassifier

Categories: dq-classifier

A boolean classifier that checks if a value is inside a specified range.

Properties

property

closed_onLiteral['none', 'lower', 'upper', 'both']

Returns how the range is closed.

property

column_nameslist[tuple[str, str | None]] | None

Returns the list of columns the classifier applies to, including optional destination column names.

property

maxint | float | bool | str | date | time | datetime | timedelta | bytes | Decimal | NoneType

Returns the maximum value of the range.

property

minint | float | bool | str | date | time | datetime | timedelta | bytes | Decimal | NoneType

Returns the minimum value of the range.

property

on_missing_columnLiteral['ignore', 'fail']

Returns what do if the column is missing.

property

on_wrong_typeLiteral['ignore', 'fail']

Returns what do if the column type is incompatible with the classifier.

property

on_wrong_valueLiteral['ignore', 'fail']

Returns what do if the column type is incompatible with the classifier.

property

tagslist[str] | None

Returns the list of tags associated with the classifier.

Methods

method

View source ↗

supported_dtypes

def supported_dtypes() -> FrozenSet[Type]

Returns the set of data types supported by IsBetween classifier.