forked from engarde-dev/engarde
-
Notifications
You must be signed in to change notification settings - Fork 0
/
decorators.py
167 lines (142 loc) · 4.34 KB
/
decorators.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# -*- coding: utf-8 -*-
from __future__ import (unicode_literals, absolute_import, division)
from functools import wraps
import numpy as np
import engarde.checks as ck
def none_missing():
"""Asserts that no missing values (NaN) are found"""
def decorate(func):
@wraps(func)
def wrapper(*args, **kwargs):
result = func(*args, **kwargs)
ck.none_missing(result)
return result
return wrapper
return decorate
def is_shape(shape):
def decorate(func):
@wraps(func)
def wrapper(*args, **kwargs):
result = func(*args, **kwargs)
ck.is_shape(result, shape)
return result
return wrapper
return decorate
def unique_index():
def decorate(func):
@wraps(func)
def wrapper(*args, **kwargs):
result = func(*args, **kwargs)
ck.unique_index(result)
return result
return wrapper
return decorate
def is_monotonic(items=None, increasing=None, strict=False):
def decorate(func):
@wraps(func)
def wrapper(*args, **kwargs):
result = func(*args, **kwargs)
ck.is_monotonic(result, items=items, increasing=increasing,
strict=strict)
return result
return wrapper
return decorate
def within_set(items):
"""
Check that DataFrame values are within set.
@within_set({'A': {1, 3}})
def f(df):
return df
"""
def decorate(func):
@wraps(func)
def wrapper(*args, **kwargs):
result = func(*args, **kwargs)
ck.within_set(result, items)
return result
return wrapper
return decorate
def within_range(items):
"""
Check that a DataFrame's values are within a range.
Parameters
==========
items : dict or array-like
dict maps columss to (lower, upper)
array-like checks the same (lower, upper) for each column
Raises
======
ValueError
"""
def decorate(func):
@wraps(func)
def wrapper(*args, **kwargs):
result = func(*args, **kwargs)
ck.within_range(result, items)
return result
return wrapper
return decorate
def within_n_std(n=3):
"""
Tests that all values are within 3 standard deviations
of their mean.
"""
def decorate(func):
@wraps(func)
def wrapper(*args, **kwargs):
result = func(*args, **kwargs)
ck.within_n_std(result, n=n)
return result
return wrapper
return decorate
def has_dtypes(items):
"""
Tests that the dtypes are as specified in items.
"""
def decorate(func):
@wraps(func)
def wrapper(*args, **kwargs):
result = func(*args, **kwargs)
ck.has_dtypes(result, items)
return result
return wrapper
return decorate
def verify(func, *args, **kwargs):
"""
Assert that `func(df, *args, **kwargs)` is true.
"""
def decorate(operation_func):
@wraps(operation_func)
def wrapper(*operation_args, **operation_kwargs):
result = operation_func(*operation_args, **operation_kwargs)
assert func(result, *args, **kwargs)
return result
return wrapper
return decorate
def verify_all(func, *args, **kwargs):
"""
Assert that all of `func(*args, **kwargs)` are true.
"""
def decorate(operation_func):
@wraps(operation_func)
def wrapper(*operation_args, **operation_kwargs):
result = operation_func(*operation_args, **operation_kwargs)
assert np.all(func(result, *args, **kwargs))
return result
return wrapper
return decorate
def verify_any(func, *args, **kwargs):
"""
Assert that any of `func(*args, **kwargs)` are true.
"""
def decorate(operation_func):
@wraps(operation_func)
def wrapper(*operation_args, **operation_kwargs):
result = operation_func(*operation_args, **operation_kwargs)
assert np.any(func(result, *args, **kwargs))
return result
return wrapper
return decorate
__all__ = [is_monotonic, is_shape, none_missing, unique_index, within_n_std,
within_range, within_set, has_dtypes, verify, verify_all,
verify_any]