Skip to content

Validate

Apply validation function(s) to schema cls_field.

Parameters:

Name Type Description Default
cls_field Attribute

Schema for field in class.

 required
data DataFrame

Data to validate field against.

 required

Returns:

Type Description
TidyError

If the validation function fails for at least one row, an error handler is returned for further logging.
Source code in src/tidy_tools/model/validate.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
def validate_field(cls_field: attrs.Attribute, data: DataFrame) -> TidyError:
    """
    Apply validation function(s) to schema cls_field.

    Parameters
    ----------
    cls_field : attrs.Attribute
        Schema for field in class.
    data : DataFrame
        Data to validate field against.

    Returns
    -------
    TidyError
        If the validation function fails for at least one row, an error handler
        is returned for further logging.
    """
    validate_func = _mapper(cls_field.validator)
    # TODO: add support for TidyDataFrame;
    # should disable messages to avoid unnecessary filter messages
    invalid_entries = data.filter(operator.inv(validate_func(cls_field.name)))
    try:
        assert invalid_entries.isEmpty()
        error = None
    except AssertionError:
        error = TidyError(cls_field.name, validate_func, invalid_entries)
    finally:
        return error

Validators

Tidy Tools comes with its own custom validators.

validate_nulls 

validate_nulls(_defaults: tuple[str] = ('\\s*', '\\bN/A\\b')) -> Callable

Return expression checking for null values in column.

Parameters:

Name Type Description Default
_defaults tuple[str]

Default values representing null. By default, checks for whitespace values and "N/A".

 ('\\s*', '\\bN/A\\b')

Returns:

Type Description
Callable

Constructs closure that can be called on column(s).
Source code in src/tidy_tools/model/validators.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
def validate_nulls(_defaults: tuple[str] = (r"\s*", r"\bN/A\b")) -> Callable:
    """
    Return expression checking for null values in column.

    Parameters
    ----------
    _defaults : tuple[str]
        Default values representing null. By default, checks for whitespace values and "N/A".

    Returns
    -------
    Callable
        Constructs closure that can be called on column(s).
    """

    def closure(column: str) -> Column:
        return operator.inv(_predicate.is_null(column, _defaults=_defaults))

    return closure

validate_pattern 

validate_pattern(pattern: str) -> Callable

Return expression checking for pattern in column.

Parameters:

Name Type Description Default
pattern str

Regular expression to check for in column.

 required

Returns:

Type Description
Callable

Constructs closure that can be called on column(s).
Source code in src/tidy_tools/model/validators.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
def validate_pattern(pattern: str) -> Callable:
    """
    Return expression checking for pattern in column.

    Parameters
    ----------
    pattern : str
        Regular expression to check for in column.

    Returns
    -------
    Callable
        Constructs closure that can be called on column(s).
    """

    def closure(column: str) -> Column:
        return _predicate.is_regex_match(column, pattern=pattern)

    return closure

validate_membership 

validate_membership(elements: Sequence) -> Callable

Return expression checking for membership in column.

Parameters:

Name Type Description Default
elements Sequence

Collection containing value(s) to check for in column.

 required

Returns:

Type Description
Callable

Constructs closure that can be called on column(s).
Source code in src/tidy_tools/model/validators.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def validate_membership(elements: Sequence) -> Callable:
    """
    Return expression checking for membership in column.

    Parameters
    ----------
    elements : Sequence
        Collection containing value(s) to check for in column.

    Returns
    -------
    Callable
        Constructs closure that can be called on column(s).
    """

    def closure(column: str) -> Column:
        return _predicate.is_member(column, elements=elements)

    return closure

validate_range 

validate_range(lower_bound: Any, upper_bound: Any) -> Callable

Return expression checking for inclusion in column.

Parameters:

Name Type Description Default
lower_bound Any

Least value to check for in column.

 required
upper_bound Any

Greatest value to check for in column.

 required

Returns:

Type Description
Callable

Constructs closure that can be called on column(s).
Source code in src/tidy_tools/model/validators.py 
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
def validate_range(lower_bound: Any, upper_bound: Any) -> Callable:
    """
    Return expression checking for inclusion in column.

    Parameters
    ----------
    lower_bound : Any
        Least value to check for in column.
    upper_bound : Any
        Greatest value to check for in column.

    Returns
    -------
    Callable
        Constructs closure that can be called on column(s).
    """

    def closure(column: str) -> Column:
        return _predicate.is_between(column, boundaries=(lower_bound, upper_bound))

    return closure