IsIn

classView source ↗

class IsIn(
    column_names: str | tuple[str, str | None] | Annotated[list[str], <class 'Strict'>] | Annotated[list[tuple[str, str | None]], <class 'Strict'>] | NoneType = None,
    on_missing_column: Literal['ignore', 'fail'] = 'ignore',
    on_wrong_value: Literal['ignore', 'fail'] = 'ignore',
    values: Collection,
    tags: str | list[str] | NoneType = None,
)

Bases: InClassifier

Categories: dq-classifier

A boolean classifier that checks if a value is in a specified set of values.

Properties

property

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

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

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.

property

valuesAbstractSet

Returns the set of values for the check.

Methods

method

View source ↗

supported_dtypes

def supported_dtypes() -> FrozenSet[Type]

Returns the set of data types supported by IsIn classifier.