-
Notifications
You must be signed in to change notification settings - Fork 89
/
criterion.py
506 lines (393 loc) · 14.5 KB
/
criterion.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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
import inspect
import six
import pytz
from datetime import datetime
from .enums import (
Boolean,
Equality,
DateTimeOn,
Order,
)
from .exceptions import QueryTypeError
class Term(object):
@staticmethod
def wrap_constant(value, types, list_type=False):
if list_type:
if isinstance(value, (list, tuple)):
if all(type(x) in types for x in value):
return ListValueWrapper(value, types)
else:
caller = inspect.currentframe().f_back.f_code.co_name
raise QueryTypeError(
"Expected value to be a list of type %s, not %s"
% (types, type(value))
)
else:
caller = inspect.currentframe().f_back.f_code.co_name
raise QueryTypeError(
"Invalid type passed to %s() , expected list or tuple" % (caller)
)
elif isinstance(value, ValueWrapper) and (
value.type_ in types or (value.type_ == list and list_type)
):
return value
# allow other types than datetime, as long as they have strftime
elif hasattr(value, "strftime") and datetime in types:
return DateTimeValueWrapper(value)
elif not type(value) in types:
caller = inspect.currentframe().f_back.f_code.co_name
raise QueryTypeError(
"Invalid type passed to %s() , expected: %s" % (caller, types)
)
elif isinstance(value, int):
return IntValueWrapper(value)
elif isinstance(value, str):
return StringValueWrapper(value)
else:
return value
def eq(self, other):
return self == other
def gt(self, other):
return self > other
def gte(self, other):
return self >= other
def lt(self, other):
return self < other
def lte(self, other):
return self <= other
def ne(self, other):
return self != other
def is_empty(self):
return IsEmptyCriterion(self)
def is_not_empty(self):
return NotEmptyCriterion(self)
def is_empty_string(self):
return IsEmptyStringCriterion(self)
def between(self, lower, upper):
return BetweenCriterion(
self,
self.wrap_constant(lower, types=[int, datetime]),
self.wrap_constant(upper, types=[int, datetime]),
)
def starts_with(self, other):
return BasicCriterion(
"STARTSWITH", self, self.wrap_constant(other, types=[str])
)
def ends_with(self, other):
return BasicCriterion("ENDSWITH", self, self.wrap_constant(other, types=[str]))
def contains(self, other):
return self.like(other)
def not_contains(self, other):
return self.not_like(other)
def like(self, other):
return BasicCriterion("LIKE", self, self.wrap_constant(other, types=[str]))
def not_like(self, other):
return BasicCriterion("NOT LIKE", self, self.wrap_constant(other, types=[str]))
def is_in(self, other):
return BasicCriterion(
"IN", self, self.wrap_constant(other, types=[int, str], list_type=True)
)
def not_in(self, other):
return BasicCriterion(
"NOT IN", self, self.wrap_constant(other, types=[int, str], list_type=True)
)
def is_anything(self, other):
return IsAnythingCriterion(self)
def is_same(self, other):
return BasicCriterion("SAMEAS", self, self.wrap_constant(other, types=[Field]))
def is_different(self, other):
return BasicCriterion("NSAMEAS", self, self.wrap_constant(other, types=[Field]))
def __eq__(self, other):
return BasicCriterion(
Equality.eq, self, self.wrap_constant(other, types=[int, str])
)
def __ne__(self, other):
return BasicCriterion(
Equality.ne, self, self.wrap_constant(other, types=[int, str])
)
def __gt__(self, other):
return BasicCriterion(
Equality.gt, self, self.wrap_constant(other, types=[int, datetime])
)
def __ge__(self, other):
return BasicCriterion(
Equality.gte, self, self.wrap_constant(other, types=[int, datetime])
)
def __lt__(self, other):
return BasicCriterion(
Equality.lt, self, self.wrap_constant(other, types=[int, datetime])
)
def __le__(self, other):
return BasicCriterion(
Equality.lte, self, self.wrap_constant(other, types=[int, datetime])
)
# DateTime only
def on(self, other):
return DateTimeOnCriterion(
self, self.wrap_constant(other, types=[datetime, DateTimeOn])
)
def not_on(self, other):
return DateTimeNotOnCriterion(
self, self.wrap_constant(other, types=[datetime, DateTimeOn])
)
# End DateTime only
def order(self, direction):
return OrderCriterion(self, direction)
def __str__(self):
return self.get_query()
def get_query(self, **kwargs):
raise NotImplementedError()
class Criterion(Term):
def AND(self, other):
return self & other
def OR(self, other):
return self | other
def NQ(self, other):
return self ^ other
def __and__(self, other):
return BasicCriterion(Boolean.and_, self, other)
def __or__(self, other):
return BasicCriterion(Boolean.or_, self, other)
def __xor__(self, other):
"""
While not really an XOR operation, this allows us to use Python's bitwise operators
"""
return BasicCriterion(Boolean.nq_, self, other)
@staticmethod
def any(terms=()):
crit = EmptyCriterion()
for term in terms:
crit |= term
return crit
@staticmethod
def all(terms=()):
crit = EmptyCriterion()
for term in terms:
crit &= term
return crit
def get_query(self, **kwargs):
raise NotImplementedError()
class EmptyCriterion(object):
def __and__(self, other):
return other
def __or__(self, other):
return other
def __xor__(self, other):
return other
class BasicCriterion(Criterion):
def __init__(self, comparator, left, right):
"""
A wrapper for a basic criterion such as equality or inequality.
This wraps three parts, a left and right term and a comparator which
defines the type of comparison.
:param comparator:
Type: Comparator
This defines the type of comparison, such as {quote}={quote} or
{quote}>{quote}.
:param left:
The term on the left side of the expression.
:param right:
The term on the right side of the expression.
"""
super(BasicCriterion, self).__init__()
self.comparator = comparator
self.left = left
self.right = right
def get_query(self, **kwargs):
return "{left}{comparator}{right}".format(
comparator=getattr(self.comparator, "value", self.comparator),
left=self.left.get_query(**kwargs),
right=self.right.get_query(**kwargs),
)
class IsEmptyCriterion(Criterion):
def __init__(self, term):
super(IsEmptyCriterion, self).__init__()
self.term = term
def get_query(self, **kwargs):
term = self.term.get_query(**kwargs)
return "{}ISEMPTY".format(term)
class NotEmptyCriterion(Criterion):
def __init__(self, term):
super(NotEmptyCriterion, self).__init__()
self.term = term
def get_query(self, **kwargs):
term = self.term.get_query(**kwargs)
return "{}ISNOTEMPTY".format(term)
class IsAnythingCriterion(Criterion):
def __init__(self, term):
super(IsAnythingCriterion, self).__init__()
self.term = term
def get_query(self, **kwargs):
term = self.term.get_query(**kwargs)
return "{}ANYTHING".format(term)
class IsEmptyStringCriterion(Criterion):
def __init__(self, term):
super(IsEmptyStringCriterion, self).__init__()
self.term = term
def get_query(self, **kwargs):
term = self.term.get_query(**kwargs)
return "{}EMPTYSTRING".format(term)
class BetweenCriterion(Criterion):
def __init__(self, term, start, end):
super(BetweenCriterion, self).__init__()
self.term = term
self.start = start
self.end = end
def get_query(self, **kwargs):
term = self.term.get_query(**kwargs)
start = self.start.get_query(**kwargs)
end = self.end.get_query(**kwargs)
if isinstance(self.start, DateTimeValueWrapper) and isinstance(
self.end, DateTimeValueWrapper
):
dt_between = "%s@%s" % (start, end)
elif isinstance(self.start, IntValueWrapper) and isinstance(
self.end, IntValueWrapper
):
dt_between = "%d@%d" % (start, end)
else:
raise QueryTypeError(
"Expected both `start` and `end` of type `int` "
"or instance of `datetime`, not %s and %s" % (type(start), type(end))
)
return "{}BETWEEN{}".format(term, dt_between)
class DateTimeOnCriterion(Criterion):
def __init__(self, term, criteria):
super(DateTimeOnCriterion, self).__init__()
self.term = term
self.criteria = criteria
def get_query(self, **kwargs):
term = self.term.get_query(**kwargs)
if isinstance(self.criteria, DateTimeOn):
return "{term}ON{criteria}".format(term=term, criteria=self.criteria.value)
else:
return "{term}ONcustom@{start}@{end}".format(
term=term,
start=self.criteria.get_query(date_only=True, extra_param="start"),
end=self.criteria.get_query(date_only=True, extra_param="end"),
)
class DateTimeNotOnCriterion(Criterion):
def __init__(self, term, criteria):
super(DateTimeNotOnCriterion, self).__init__()
self.term = term
self.criteria = criteria
def get_query(self, **kwargs):
term = self.term.get_query(**kwargs)
if isinstance(self.criteria, DateTimeOn):
return "{term}NOTON{criteria}".format(
term=term, criteria=self.criteria.value
)
else:
return "{term}NOTONcustom@{start}@{end}".format(
term=term,
start=self.criteria.get_query(date_only=True, extra_param="start"),
end=self.criteria.get_query(date_only=True, extra_param="end"),
)
class OrderCriterion(Criterion):
def __init__(self, term, direction):
super(OrderCriterion, self).__init__()
self.term = term
self.direction = direction
def get_query(self, **kwargs):
term = self.term.get_query(**kwargs)
if self.direction == Order.asc or (
isinstance(self.direction, six.string_types)
and self.direction.lower() == "asc"
):
return "ORDERBY{term}".format(term=term)
elif self.direction == Order.desc or (
isinstance(self.direction, six.string_types)
and self.direction.lower() == "desc"
):
return "ORDERBYDESC{term}".format(term=term)
else:
raise QueryTypeError(
"Expected 'asc', 'desc', or an instance of Order, not %s"
% (type(self.direction))
)
class ValueWrapper(Term):
def __init__(self, type_):
self.type_ = type_
class IntValueWrapper(ValueWrapper):
def __init__(self, value):
super(IntValueWrapper, self).__init__(int)
self.value = value
def get_query(self, **kwargs):
if isinstance(self.value, int):
return self.value
else:
raise QueryTypeError(
"Expected value to be an instance of `int`, not %s" % type(self.value)
)
class StringValueWrapper(ValueWrapper):
def __init__(self, value):
super(StringValueWrapper, self).__init__(str)
self.value = value
def get_query(self, **kwargs):
if isinstance(self.value, six.string_types):
return self.value
else:
raise QueryTypeError(
"Expected value to be an instance of `str`, not %s" % type(self.value)
)
class DateTimeValueWrapper(ValueWrapper):
def __init__(self, value):
super(DateTimeValueWrapper, self).__init__(datetime)
self.value = value
def get_query(self, date_only=False, extra_param=None, **kwargs):
if hasattr(self.value, "strftime"):
datetime_ = datetime_as_utc(self.value)
if date_only:
value = datetime_.strftime("%Y-%m-%d")
else:
value = datetime_.strftime("%Y-%m-%d %H:%M:%S")
if extra_param:
value += '", "{}'.format(extra_param)
return 'javascript:gs.dateGenerate("{}")'.format(value)
else:
raise QueryTypeError(
"Expected value to be an instance of `datetime`, not %s"
% type(self.value)
)
class ListValueWrapper(ValueWrapper):
def __init__(self, value, types):
super(ListValueWrapper, self).__init__(list)
self.value = value
self.types = types
def get_query(self, **kwargs):
if isinstance(self.value, (list, tuple)) and all(
type(x) in self.types for x in self.value
):
return ",".join(map(str, self.value))
else:
raise QueryTypeError(
"Expected value to be a list of type %s, not %s"
% (self.types, type(self.value))
)
class Field(Criterion):
def __init__(self, name):
super(Field, self).__init__()
self.name = name
def get_query(self, **kwargs):
return self.name
class Table(object):
"""
Allows the following:
```
incident = Table(incident)
criterion = incident.company.eq('3dasd3')
```
"""
# Could be used to automate resource creation?
def __init__(self, name):
self.table_name = name
def field(self, name):
return Field(name)
def __getattr__(self, name):
return self.field(name)
def __getitem__(self, name):
return self.field(name)
def datetime_as_utc(date_obj):
if date_obj.tzinfo is not None and date_obj.tzinfo.utcoffset(date_obj) is not None:
return date_obj.astimezone(pytz.UTC)
return date_obj