/
checks.py
212 lines (157 loc) · 6.18 KB
/
checks.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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# checks.py - check application-specific invariants
import inspect
import itertools
import logging
import sqlalchemy as sa
import sqlalchemy.orm
from .backend import Session, Dataset
from .models import (FAMILY, LANGUAGE, DIALECT,
SPECIAL_FAMILIES, BOOKKEEPING,
Languoid, Altname)
from . import ENGINE
__all__ = ['check']
log = logging.getLogger(__name__)
def check(func=None, *, bind=ENGINE):
"""Run consistency/sanity checks on database."""
if func is not None:
try:
check.registered.append(func)
except AttributeError:
check.registered = [func]
return func
passed = True
with bind.connect() as conn:
for func in check.registered:
ns = {'invalid_query': staticmethod(func), '__doc__': func.__doc__}
check_cls = type(f'{func.__name__}Check', (Check,), ns)
session = Session(bind=conn)
check_inst = check_cls(session)
try:
log.debug('validate %r', func.__name__)
check_passed = check_inst.validate()
finally:
session.close()
if not check_passed:
passed = False
return passed
class Check(object):
detail = True
def __init__(self, session):
self.session = session
self.query = self.invalid_query(session)
def invalid_query(self, session): # pragma: no cover
raise NotImplementedError
def validate(self):
self.invalid_count = self.query.count()
log.debug('invalid count: %d', self.invalid_count)
print(self)
if self.invalid_count:
if self.detail:
self.invalid = self.query.all()
self.show_detail(self.invalid, self.invalid_count)
return False
else:
self.invalid = []
return True
def __str__(self):
if self.invalid_count:
msg = (f'{self.invalid_count:d} invalid\n'
f' (violating {self.__doc__})')
else:
msg = 'OK'
return f'{self.__class__.__name__}: {msg}'
@staticmethod
def show_detail(invalid, invalid_count, number=25):
ids = (i.id for i in itertools.islice(invalid, number))
cont = ', ...' if number < invalid_count else ''
print(f" {', '.join(ids)}{cont}")
def docformat(func):
sig = inspect.signature(func)
defaults = {n: p.default for n, p in sig.parameters.items()
if p.default != inspect.Parameter.empty}
func.__doc__ = func.__doc__.format_map(defaults)
return func
@check
@docformat
def valid_glottocode(session, *, pattern=r'^[a-z0-9]{4}\d{4}$'):
"""Glottocodes match {pattern!r}."""
return session.query(Languoid).order_by('id')\
.filter(~Languoid.id.op('REGEXP')(pattern))
@check
@docformat
def valid_iso639_3(session, *, pattern=r'^[a-z]{3}$'):
"""Iso codes match {pattern!r}."""
return session.query(Languoid).order_by('id')\
.filter(~Languoid.iso639_3.op('REGEXP')(pattern))
@check
@docformat
def valid_hid(session, *, pattern=r'^(?:[a-z]{3}|NOCODE_[A-Z][a-zA-Z0-9-]+)$'):
"""Hids match {pattern!r}."""
return session.query(Languoid).order_by('id')\
.filter(~Languoid.hid.op('REGEXP')(pattern))
@check
def clean_name(session):
"""Glottolog names lack problematic characters."""
def cond(col):
yield col.startswith(' ')
yield col.endswith(' ')
yield col.op('REGEXP')('[`_*:\xa4\xab\xb6\xbc]') # \xa4.. common in mojibake
return session.query(Languoid).order_by('id')\
.filter(sa.or_(
Languoid.altnames.any(sa.or_(*cond(Altname.name)), provider='glottolog'),
*cond(Languoid.name)))
@check
def family_parent(session):
"""Parent of a family is a family."""
return session.query(Languoid).filter_by(level=FAMILY).order_by('id')\
.join(Languoid.parent, aliased=True)\
.filter(Languoid.level != FAMILY)
@check
def language_parent(session):
"""Parent of a language is a family."""
return session.query(Languoid).filter_by(level=LANGUAGE).order_by('id')\
.join(Languoid.parent, aliased=True)\
.filter(Languoid.level != FAMILY)
@check
def dialect_parent(session):
"""Parent of a dialect is a language or dialect."""
return session.query(Languoid).filter_by(level=DIALECT).order_by('id')\
.join(Languoid.parent, aliased=True)\
.filter(Languoid.level.notin_([LANGUAGE, DIALECT]))
@check
def family_children(session):
"""Family has at least one subfamily or language."""
return session.query(Languoid).filter_by(level=FAMILY).order_by('id')\
.filter(~Languoid.children.any(
Languoid.level.in_([FAMILY, LANGUAGE])))
@check
def family_languages(session):
"""Family has at least two languages (except 'Unclassified ...')."""
tree = Languoid.tree(include_self=False, with_terminal=True)
Family, Child = (sa.orm.aliased(Languoid, name=n) for n in ('family', 'child'))
return session.query(Languoid).filter_by(level=FAMILY).order_by('id')\
.filter(~Languoid.name.startswith('Unclassified '))\
.filter(~session.query(Family).filter_by(level=FAMILY)
.filter(Family.name.in_(SPECIAL_FAMILIES))
.join(tree, tree.c.parent_id == Family.id)
.filter_by(child_id=Languoid.id, terminal=True)
.exists())\
.filter(session.query(sa.func.count())
.select_from(Child).filter_by(level=LANGUAGE)
.join(tree, tree.c.child_id == Child.id)
.filter_by(parent_id=Languoid.id)
.as_scalar() < 2)
@check
def bookkeeping_no_children(session):
"""Bookkeeping languoids lack children (book1242 is flat)."""
return session.query(Languoid).order_by('id')\
.filter(Languoid.parent.has(name=BOOKKEEPING))\
.filter(Languoid.children.any())
@check
def no_empty_files(session):
exclude_raw = session.query(Dataset.exclude_raw).scalar()
if exclude_raw: # pragma: no cover
return session.query(sa.true()).filter(sa.false())
from .raw import File, Value
return session.query(File)\
.filter(~sa.exists().where(Value.file_id == File.id))